Merge pull request #7378 from pblottiere/server_doc

[server] Update doc path for server
qgis · Jul 13, 2018 · bf56bd3 · bf56bd3
2 parents 48195e0 + dcb86a0
commit bf56bd3
Show file tree

Hide file tree

Showing 47 changed files with 465 additions and 674 deletions.
diff --git a/.ci/travis/code_layout/install.sh b/.ci/travis/code_layout/install.sh
@@ -19,6 +19,6 @@ export CORES=2
 mkdir build
 pushd build || exit
 
-cmake -DUSE_CCACHE=OFF -DWITH_CORE=OFF -DWITH_APIDOC=ON -DWITH_ASTYLE=ON -DENABLE_TESTS=ON ..
+cmake -DWITH_SERVER=ON -DUSE_CCACHE=OFF -DWITH_CORE=OFF -DWITH_APIDOC=ON -DWITH_ASTYLE=ON -DENABLE_TESTS=ON ..
 
 popd || exit
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
@@ -104,23 +104,16 @@ IF(WITH_APIDOC)
       ${CMAKE_SOURCE_DIR}/src/quickgui/plugin
     )
 
-    IF(WITH_SERVER_PLUGINS)
+    IF(WITH_SERVER)
       SET(DOXYGEN_INPUT
         ${DOXYGEN_INPUT}
-        ${CMAKE_SOURCE_DIR}/src/server/qgsserver.h
-        ${CMAKE_SOURCE_DIR}/src/server/qgscapabilitiescache.h
-        ${CMAKE_SOURCE_DIR}/src/server/qgsserverexception.h
-        ${CMAKE_SOURCE_DIR}/src/server/qgsrequesthandler.h
-        ${CMAKE_SOURCE_DIR}/src/server/qgsserverfilter.h
-        ${CMAKE_SOURCE_DIR}/src/server/qgsaccesscontrolfilter.h
-        ${CMAKE_SOURCE_DIR}/src/server/qgsserverinterface.h
-        ${CMAKE_SOURCE_DIR}/src/server/qgsserverrequest.h
-        ${CMAKE_SOURCE_DIR}/src/server/qgsserverresponse.h
-        ${CMAKE_SOURCE_DIR}/src/server/qgsserverrequest.h
-        ${CMAKE_SOURCE_DIR}/src/server/qgsservice.h
-        ${CMAKE_SOURCE_DIR}/src/server/qgsserviceregistry.h
+        ${CMAKE_SOURCE_DIR}/src/server/
+        ${CMAKE_SOURCE_DIR}/src/server/services/
+        ${CMAKE_SOURCE_DIR}/src/server/services/wms
+        ${CMAKE_SOURCE_DIR}/src/server/services/wfs
+        ${CMAKE_SOURCE_DIR}/src/server/services/wcs
       )
-    ENDIF(WITH_SERVER_PLUGINS)
+    ENDIF(WITH_SERVER)
 
     SET(DOXYGEN_FILE_PATTERNS *.h *.cpp *.dox)
 

diff --git a/python/server/auto_generated/qgsaccesscontrol.sip.in b/python/server/auto_generated/qgsaccesscontrol.sip.in
@@ -16,8 +16,9 @@
 class QgsAccessControl : QgsFeatureFilterProvider
 {
 %Docstring
-A helper class that centralize the restrictions given by all the
-access control filter plugins.
+A helper class that centralizes restrictions given by all the access control filter plugins.
+
+.. versionadded:: 2.14
 %End
 
 %TypeHeaderCode

diff --git a/python/server/auto_generated/qgsbufferserverrequest.sip.in b/python/server/auto_generated/qgsbufferserverrequest.sip.in
@@ -12,8 +12,9 @@
 class QgsBufferServerRequest : QgsServerRequest
 {
 %Docstring
-QgsBufferServerRequest
-Class defining request with  data
+Class defining request with data
+
+.. versionadded:: 3.0
 %End
 
 %TypeHeaderCode

diff --git a/python/server/auto_generated/qgsbufferserverresponse.sip.in b/python/server/auto_generated/qgsbufferserverresponse.sip.in
@@ -13,6 +13,8 @@ class QgsBufferServerResponse: QgsServerResponse
 {
 %Docstring
 Class defining buffered response
+
+.. versionadded:: 3.0
 %End
 
 %TypeHeaderCode

diff --git a/python/server/auto_generated/qgsconfigcache.sip.in b/python/server/auto_generated/qgsconfigcache.sip.in
@@ -15,19 +15,30 @@ class QgsConfigCache : QObject
 {
 %Docstring
 Cache for server configuration.
+
+.. versionadded:: 2.8
 %End
 
 %TypeHeaderCode
 #include "qgsconfigcache.h"
 %End
   public:
+
     static QgsConfigCache *instance();
+%Docstring
+Returns the current instance.
+%End
 
     void removeEntry( const QString &path );
+%Docstring
+Removes an entry from cache.
+
+:param path: The path of the project
+%End
 
     const QgsProject *project( const QString &path );
 %Docstring
-If the project is not cached yet, then the project is read thank to the
+If the project is not cached yet, then the project is read thanks to the
 path. If the project is not available, then a None is returned.
 
 :param path: the filename of the QGIS project

diff --git a/python/server/auto_generated/qgsmapserviceexception.sip.in b/python/server/auto_generated/qgsmapserviceexception.sip.in
@@ -29,7 +29,14 @@ The most important codes are:
 #include "qgsmapserviceexception.h"
 %End
   public:
+
     QgsMapServiceException( const QString &code, const QString &message );
+%Docstring
+Constructor for QgsMapServiceException.
+
+:param code: HTTP error code
+:param message: Exception message to return to the client
+%End
 };
 
 /************************************************************************

diff --git a/python/server/auto_generated/qgsserversettings.sip.in b/python/server/auto_generated/qgsserversettings.sip.in
@@ -15,8 +15,7 @@
 class QgsServerSettings
 {
 %Docstring
-QgsServerSettings provides a way to retrieve settings by prioritizing
-according to environment variables, ini file and default values.
+Provides a way to retrieve settings by prioritizing according to environment variables, ini file and default values.
 
 .. versionadded:: 3.0
 %End

diff --git a/python/server/auto_generated/qgsservicemodule.sip.in b/python/server/auto_generated/qgsservicemodule.sip.in
@@ -14,12 +14,14 @@
 class QgsServiceModule
 {
 %Docstring
-QgsServiceModule
 Class defining the service module interface for QGIS server services
 
 This class acts as a service registrar for services.
 
-For dynamic modules, a QgsServiceModule instance is returned from the QGS_ServiceModule_Init() entry point
+For dynamic modules, a QgsServiceModule instance is returned from the
+QGS_ServiceModule_Init() entry point.
+
+.. versionadded:: 3.0
 %End
 
 %TypeHeaderCode
@@ -29,21 +31,21 @@ For dynamic modules, a QgsServiceModule instance is returned from the QGS_Servic
 
     QgsServiceModule();
 %Docstring
-Constructor
+Default constructor for QgsServiceModule.
 %End
 
-    virtual ~QgsServiceModule() = 0;
+    virtual ~QgsServiceModule();
 
     virtual void registerSelf( QgsServiceRegistry &registry,
                                QgsServerInterface *serverIface = 0 ) = 0;
 %Docstring
-Ask module to register all provided services
+Asks the module to register all provided services.
 
-:param registry: :py:class:`QgsServiceRegistry`
+:param registry: Service registry
+:param serverIface: Interface for plugins
 %End
 };
 
-
 /************************************************************************
  * This file has been generated automatically from                      *
  *                                                                      *

diff --git a/python/server/server_auto.sip b/python/server/server_auto.sip
@@ -1,4 +1,5 @@
 // Include auto-generated SIP files
+%Include auto_generated/qgsservicemodule.sip
 %Include auto_generated/qgsmapserviceexception.sip
 %Include auto_generated/qgscapabilitiescache.sip
 %Include auto_generated/qgsconfigcache.sip
@@ -15,7 +16,6 @@
 %Include auto_generated/qgsserverrequest.sip
 %Include auto_generated/qgsserverresponse.sip
 %Include auto_generated/qgsservice.sip
-%Include auto_generated/qgsservicemodule.sip
 %Include auto_generated/qgsserviceregistry.sip
 %Include auto_generated/qgsfeaturefilterprovidergroup.sip
 %Include auto_generated/qgsfeaturefilter.sip

diff --git a/src/server/CMakeLists.txt b/src/server/CMakeLists.txt
@@ -24,7 +24,6 @@ SET(QGIS_SERVER_SRCS
   qgsbufferserverresponse.cpp
   qgscapabilitiescache.cpp
   qgsconfigcache.cpp
-  qgsconfigparserutils.cpp
   qgsfcgiserverrequest.cpp
   qgsfcgiserverresponse.cpp
   qgsfilterresponsedecorator.cpp
@@ -40,14 +39,14 @@ SET(QGIS_SERVER_SRCS
   qgsserverresponse.cpp
   qgsserversettings.cpp
   qgsservice.cpp
-  qgsservicemodule.cpp
   qgsservicenativeloader.cpp
   qgsserviceregistry.cpp
   qgsfeaturefilterprovidergroup.cpp
   qgsfeaturefilter.cpp
 )
 
 SET (QGIS_SERVER_HDRS
+  qgsservicemodule.h
   qgsmapserviceexception.h
 )
 

diff --git a/src/server/qgsaccesscontrol.h b/src/server/qgsaccesscontrol.h
@@ -33,9 +33,9 @@ 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
 {
 #ifdef SIP_RUN

diff --git a/src/server/qgsbufferserverrequest.h b/src/server/qgsbufferserverrequest.h
@@ -28,8 +28,9 @@
 
 /**
  * \ingroup server
- * QgsBufferServerRequest
- * Class defining request with  data
+ * \class QgsBufferServerRequest
+ * \brief Class defining request with data
+ * \since QGIS 3.0
  */
 class SERVER_EXPORT QgsBufferServerRequest : public QgsServerRequest
 {

diff --git a/src/server/qgsbufferserverresponse.h b/src/server/qgsbufferserverresponse.h
@@ -30,7 +30,8 @@
 /**
  * \ingroup server
  * \class QgsBufferServerResponse
- * Class defining buffered response
+ * \brief Class defining buffered response
+ * \since QGIS 3.0
  */
 class SERVER_EXPORT QgsBufferServerResponse: public QgsServerResponse
 {

diff --git a/src/server/qgsconfigcache.h b/src/server/qgsconfigcache.h
@@ -31,20 +31,29 @@
 #include "qgsproject.h"
 
 /**
- * Cache for server configuration.
  * \ingroup server
+ * \brief Cache for server configuration.
+ * \since QGIS 2.8
  */
 class SERVER_EXPORT QgsConfigCache : public QObject
 {
     Q_OBJECT
   public:
+
+    /**
+     * Returns the current instance.
+     */
     static QgsConfigCache *instance();
 
+    /**
+     * Removes an entry from cache.
+     * \param path The path of the project
+     */
     void removeEntry( const QString &path );
 
     /**
-     * If the project is not cached yet, then the project is read thank to the
-     *  path. If the project is not available, then a nullptr is returned.
+     * If the project is not cached yet, then the project is read thanks to the
+     * path. If the project is not available, then a nullptr is returned.
      * \param path the filename of the QGIS project
      * \returns the project or nullptr if an error happened
      * \since QGIS 3.0