Add more doc to constructors

qgis · Jul 13, 2018 · 135bb87 · 135bb87
1 parent 275fa84
commit 135bb87
Show file tree

Hide file tree

Showing 18 changed files with 166 additions and 117 deletions.
diff --git a/src/server/qgsaccesscontrol.h b/src/server/qgsaccesscontrol.h
@@ -33,7 +33,7 @@ class QgsAccessControlPlugin;
 /**
  * \ingroup server
  * \class QgsAccessControl
- * \brief A helper class that centralize the restrictions given by all the access control filter plugins.
+ * \brief A helper class that centralizes restrictions given by all the access control filter plugins.
  * \since QGIS 2.14
  */
 class SERVER_EXPORT QgsAccessControl : public QgsFeatureFilterProvider

diff --git a/src/server/qgsconfigcache.h b/src/server/qgsconfigcache.h
@@ -47,6 +47,7 @@ class SERVER_EXPORT QgsConfigCache : public QObject
 
     /**
      * Removes an entry from cache.
+     * \param path The path of the project
      */
     void removeEntry( const QString &path );
 

diff --git a/src/server/qgsfcgiserverresponse.h b/src/server/qgsfcgiserverresponse.h
@@ -38,7 +38,8 @@ class SERVER_EXPORT QgsFcgiServerResponse: public QgsServerResponse
   public:
 
     /**
-     * Constructor.
+     * Constructor for QgsFcgiServerResponse.
+     * \param method The HTTP method (Get by default)
      */
     QgsFcgiServerResponse( QgsServerRequest::Method method = QgsServerRequest::GetMethod );
 

diff --git a/src/server/qgsfilterresponsedecorator.h b/src/server/qgsfilterresponsedecorator.h
@@ -36,7 +36,9 @@ class QgsFilterResponseDecorator: public QgsServerResponse
   public:
 
     /**
-     * Constructor.
+     * Constructor for QgsFilterResponseDecorator.
+     * \param filters Map of filters to apply before terminating the response
+     * \param response Server response
      */
     QgsFilterResponseDecorator( QgsServerFiltersMap filters, QgsServerResponse &response );
 

diff --git a/src/server/qgsfilterrestorer.h b/src/server/qgsfilterrestorer.h
@@ -38,7 +38,7 @@ class SERVER_EXPORT QgsOWSServerFilterRestorer
   public:
 
     /**
-     * Constructor.
+     * Default constructor for QgsOWSServerFilterRestorer.
      */
     QgsOWSServerFilterRestorer() = default;
 

diff --git a/src/server/qgsmapserviceexception.h b/src/server/qgsmapserviceexception.h
@@ -42,7 +42,9 @@ class SERVER_EXPORT QgsMapServiceException : public QgsOgcServiceException
   public:
 
     /**
-     * Constructor.
+     * Constructor for QgsMapServiceException.
+     * \param code HTTP error code
+     * \param message Exception message to return to the client
      */
     QgsMapServiceException( const QString &code, const QString &message )
       : QgsOgcServiceException( code, message )

diff --git a/src/server/qgsserverplugins.h b/src/server/qgsserverplugins.h
@@ -37,12 +37,12 @@ class SERVER_EXPORT QgsServerPlugins
   public:
 
     /**
-     * Constructor.
+     * Default constructor for QgsServerPlugins.
      */
     explicit QgsServerPlugins() = default;
 
     /**
-     * Initialize the Python plugins
+     * Initializes the Python plugins
      * \param interface QgsServerInterface
      * \returns bool true on success
      */

diff --git a/src/server/qgsserversettings.h b/src/server/qgsserversettings.h
@@ -29,8 +29,8 @@
 
 /**
  * \ingroup server
- * QgsServerSettingsEnv provides some enum describing the environment
- * currently supported for configuration.
+ * \class QgsServerSettingsEnv
+ * \brief Provides some enum describing the environment currently supported for configuration.
  * \since QGIS 3.0
  */
 #ifndef SIP_RUN
@@ -42,33 +42,33 @@ class SERVER_EXPORT QgsServerSettingsEnv : public QObject
     //! Source of the parameter used in the configuration
     enum Source
     {
-      DEFAULT_VALUE, //!< Default value
-      ENVIRONMENT_VARIABLE, //!< Environment variable
-      INI_FILE //<! Configuration file
+      DEFAULT_VALUE,
+      ENVIRONMENT_VARIABLE,
+      INI_FILE
     };
     Q_ENUM( Source )
 
     //! Environment variables to configure the server
     enum EnvVar
     {
-      QGIS_OPTIONS_PATH, //!< Override the default path for user configuration
-      QGIS_SERVER_PARALLEL_RENDERING, //!< Activate/deactivate parallel rendering
-      QGIS_SERVER_MAX_THREADS, //!< Number of threads to use when parallel rendering is activated
-      QGIS_SERVER_LOG_LEVEL, //!< Log level
-      QGIS_SERVER_LOG_FILE, //!< Log file
-      QGIS_PROJECT_FILE, //!< QGIS project file
-      MAX_CACHE_LAYERS, //!< Maximum number of cached layers
-      QGIS_SERVER_CACHE_DIRECTORY, //!< Cache directory
-      QGIS_SERVER_CACHE_SIZE //!< Cache size
+      QGIS_OPTIONS_PATH,
+      QGIS_SERVER_PARALLEL_RENDERING,
+      QGIS_SERVER_MAX_THREADS,
+      QGIS_SERVER_LOG_LEVEL,
+      QGIS_SERVER_LOG_FILE,
+      QGIS_PROJECT_FILE,
+      MAX_CACHE_LAYERS,
+      QGIS_SERVER_CACHE_DIRECTORY,
+      QGIS_SERVER_CACHE_SIZE
     };
     Q_ENUM( EnvVar )
 };
 #endif
 
 /**
  * \ingroup server
- * QgsServerSettings provides a way to retrieve settings by prioritizing
- * according to environment variables, ini file and default values.
+ * \class QgsServerSettings
+ * \brief Provides a way to retrieve settings by prioritizing according to environment variables, ini file and default values.
  * \since QGIS 3.0
  */
 class SERVER_EXPORT QgsServerSettings

diff --git a/src/server/qgsservicenativeloader.cpp b/src/server/qgsservicenativeloader.cpp
@@ -42,7 +42,8 @@ class QgsServiceNativeModuleEntry
   public:
 
     /**
-     * Constructor.
+     * Constructor for QgsServiceNativeModuleEntry.
+     * \param location Relative path of the module
      */
     QgsServiceNativeModuleEntry( const QString &location )
       : mLocation( location )

diff --git a/src/server/services/wcs/qgswcsserviceexception.h b/src/server/services/wcs/qgswcsserviceexception.h
@@ -36,15 +36,21 @@ namespace QgsWcs
     public:
 
       /**
-       * Constructor
+       * Constructor for QgsServiceException (empty locator attribute).
+       * \param code Error code name
+       * \param Exception message to return to the client
+       * \param responseCode HTTP error code
        */
       QgsServiceException( const QString &code, const QString &message,
                            int responseCode = 200 )
         : QgsOgcServiceException( code, message, QString(), responseCode, QStringLiteral( "1.2.0" ) )
       {}
 
       /**
-       * Constructor
+       * Constructor for QgsServiceException.
+       * \param code Error code name
+       * \param message Exception message to return to the client
+       * \param locator Locator attribute according to OGC specifications
        */
       QgsServiceException( const QString &code, const QString &message, const QString &locator,
                            int responseCode = 200 )
@@ -64,7 +70,9 @@ namespace QgsWcs
     public:
 
       /**
-       * Constructor
+       * Constructor for QgsSecurityAccessException (Security code name).
+       * \param message Exception message to return to the client
+       * \param locator Locator attribute according to OGC specifications
        */
       QgsSecurityAccessException( const QString &message, const QString &locator = QString() )
         : QgsServiceException( QStringLiteral( "Security" ), message, locator, 403 )
@@ -82,7 +90,9 @@ namespace QgsWcs
     public:
 
       /**
-       * Constructor
+       * Constructor for QgsRequestNotWellFormedException (RequestNotWellFormed code name).
+       * \param message Exception message to return to the client
+       * \param locator Locator attribute according to OGC specifications
        */
       QgsRequestNotWellFormedException( const QString &message, const QString &locator = QString() )
         : QgsServiceException( QStringLiteral( "RequestNotWellFormed" ), message, locator, 400 )

diff --git a/src/server/services/wfs/qgswfs.cpp b/src/server/services/wfs/qgswfs.cpp
@@ -47,7 +47,7 @@ namespace QgsWfs
 
       /**
        * Constructor for WFS service.
-       * \param serverIface Interface for plugin.
+       * \param serverIface Interface for plugins.
        */
       Service( QgsServerInterface *serverIface )
         : mServerIface( serverIface )
@@ -131,7 +131,7 @@ namespace QgsWfs
 /**
  * \ingroup server
  * \class QgsWfsModule
- * \brief Service module specialized for WFS
+ * \brief Module specialized for WFS service
  * \since QGIS 3.0
  */
 class QgsWfsModule: public QgsServiceModule

diff --git a/src/server/services/wfs/qgswfsparameters.h b/src/server/services/wfs/qgswfsparameters.h
@@ -60,7 +60,7 @@ namespace QgsWfs
       };
       Q_ENUM( ParameterName )
 
-      //! Output format
+      //! Output format for the response
       enum Format
       {
         NONE,

diff --git a/src/server/services/wfs/qgswfsserviceexception.h b/src/server/services/wfs/qgswfsserviceexception.h
@@ -36,15 +36,22 @@ namespace QgsWfs
     public:
 
       /**
-       * Constructor.
+       * Constructor for QgsServiceException.
+       * \param code Error code name
+       * \param message Exception message to return to the client
+       * \param responseCode HTTP error code
        */
       QgsServiceException( const QString &code, const QString &message,
                            int responseCode = 200 )
         : QgsOgcServiceException( code, message, QString(), responseCode, QStringLiteral( "1.2.0" ) )
       {}
 
       /**
-       * Constructor.
+       * Constructor for QgsServiceException.
+       * \param code Error code name
+       * \param message Exception message to return to the client
+       * \param locator Locator attribute according to OGC specifications
+       * \param responseCode HTTP error code
        */
       QgsServiceException( const QString &code, const QString &message, const QString &locator,
                            int responseCode = 200 )
@@ -64,7 +71,10 @@ namespace QgsWfs
     public:
 
       /**
-       * Constructor.
+       * Constructor for QgsSecurityAccessException (HTTP error code 403 with
+       * Security code name).
+       * \param message Exception message to return to the client
+       * \param locator Locator attribute according to OGC specifications
        */
       QgsSecurityAccessException( const QString &message, const QString &locator = QString() )
         : QgsServiceException( QStringLiteral( "Security" ), message, locator, 403 )
@@ -82,7 +92,10 @@ namespace QgsWfs
     public:
 
       /**
-       * Constructor.
+       * Constructor for QgsRequestNotWellFormedException (HTTP error code 400
+       * with RequestNotWellFormed code name).
+       * \param message Exception message to return to the client
+       * \param locator Locator attribute according to OGC specifications
        */
       QgsRequestNotWellFormedException( const QString &message, const QString &locator = QString() )
         : QgsServiceException( QStringLiteral( "RequestNotWellFormed" ), message, locator, 400 )
@@ -100,7 +113,10 @@ namespace QgsWfs
     public:
 
       /**
-       * Constructor.
+       * Constructor for QgsBadRequestException (HTTP error code 400).
+       * \param code Error code name
+       * \param message Exception message to return to the client
+       * \param locator Locator attribute according to OGC specifications
        */
       QgsBadRequestException( const QString &code, const QString &message, const QString &locator = QString() )
         : QgsServiceException( code, message, locator, 400 )

diff --git a/src/server/services/wms/qgslayerrestorer.h b/src/server/services/wms/qgslayerrestorer.h
@@ -43,12 +43,15 @@ class QgsLayerRestorer
   public:
 
     /**
-     * Constructor.
+     * Constructor for QgsLayerRestorer.
+     * \param layers List of layers to restore in their initial states
      */
     QgsLayerRestorer( const QList<QgsMapLayer *> &layers );
 
     /**
      * Destructor.
+     *
+     * Restores layers in their initial states.
      */
     ~QgsLayerRestorer();
 

diff --git a/src/server/services/wms/qgsmaprendererjobproxy.h b/src/server/services/wms/qgsmaprendererjobproxy.h
@@ -28,7 +28,7 @@ namespace QgsWms
   /**
    * \ingroup server
    * \class QgsWms::QgsMapRendererJobProxy
-   * \brief Proxy for sequential or parallel map render job by reading qsettings.
+   * \brief Proxy for sequential or parallel map render job
    * \since QGIS 3.0
    */
   class QgsMapRendererJobProxy
@@ -37,7 +37,7 @@ namespace QgsWms
 
       /**
        * Constructor for QgsMapRendererJobProxy. Does not take ownership of
-       * QgsFeatureFilterProvider.
+       * \a featureFilterProvider.
        * \param parallelRendering True to activate parallel rendering, false otherwise
        * \param maxThreads The number of threads to use in case of parallel rendering
        * \param featureFilterProvider Features filtering
@@ -49,7 +49,7 @@ namespace QgsWms
       );
 
       /**
-       * Sequential or parallel map rendering according to QSettings.
+       * Sequential or parallel map rendering.
        * \param mapSettings Passed to MapRendererJob
        * \param image The resulting image
        */

diff --git a/src/server/services/wms/qgswms.cpp b/src/server/services/wms/qgswms.cpp
@@ -164,7 +164,7 @@ namespace QgsWms
 /**
  * \ingroup server
  * \class QgsWmsModule
- * \brief Service module specialized for WMS
+ * \brief Module specialized for WMS service
  * \since QGIS 3.0
  */
 class QgsWmsModule: public QgsServiceModule