Added server module to dox

elpaso · elpaso · commit 0312dbf3cb78 · 2015-07-10T14:50:20.000+02:00
Added a server group and module for the server library
diff --git a/doc/modules.dox b/doc/modules.dox
@@ -22,3 +22,6 @@ high level tools for carrying out spatial analysis on vector and raster data.
 
 The network analysis library provides high level tool for build topology and analysis it.
 */
+
+
+/** @defgroup server QGIS Server library.*/
diff --git a/src/server/qgsrequesthandler.h b/src/server/qgsrequesthandler.h
@@ -37,8 +37,13 @@ class QDomDocument;
 class QImage;
 class QgsMapServiceException;
 
-/** This class is an interface hiding the details of reading input and writing output from/to a wms request mechanism.
-Examples of possible mechanisms are cgi Get, cgi Post, SOAP or the usage as a standalone command line executable*/
+/**
+ * \ingroup server
+ * This class is an interface hiding the details of reading input and writing
+ * output from/to a wms request mechanism.
+ * Examples of possible mechanisms are cgi Get, cgi Post, SOAP or the usage
+ * as a standalone command line executable
+ */
 class QgsRequestHandler
 {
 
diff --git a/src/server/qgsserver.h b/src/server/qgsserver.h
@@ -41,24 +41,26 @@
 #endif
 
 
-/**
+/** \ingroup server
  * The QgsServer class provides OGC web services.
  */
-class  SERVER_EXPORT QgsServer
+class SERVER_EXPORT QgsServer
 {
   public:
     QgsServer();
     ~QgsServer();
     /** Server initialisation: intialise QGIS ang QT core application.
      * This method is automatically called by handleRequest if it wasn't
-     * explicitly called before */
+     * explicitly called before
+     * @note Not available in Python bindings
+     */
     static bool init( int & argc, char ** argv );
     //! The following is mainly for python bindings, that do not pass argc/argv
     static bool init();
 
-    /** Handle the request. The output is normally printed trough FCGI printf
+    /** Handles the request. The output is normally printed trough FCGI printf
      * by the request handler or, in case the server has been invoked from python
-     * bindings, a flag is set that capures all the output headers and body, instead
+     * bindings, a flag is set that captures all the output headers and body, instead
      * of printing it returns the output as a QByteArray.
      * When calling handleRequest() from python bindings an additional argument
      * specify if we only want the headers or the body back, this is mainly useful
diff --git a/src/server/qgsserverfilter.h b/src/server/qgsserverfilter.h
@@ -25,6 +25,7 @@
 class QgsServerInterface;
 
 /**
+ * \ingroup server
  * \class QgsServerFilter
  * \brief Class defining I/O filters for QGIS Server and
  * implemented in plugins.
diff --git a/src/server/qgsserverinterface.h b/src/server/qgsserverinterface.h
@@ -25,6 +25,7 @@
 #include "qgsserverfilter.h"
 
 /**
+ * \ingroup server
  * QgsServerInterface
  * Class defining interfaces exposed by QGIS Server and
  * made available to plugins.
diff --git a/src/server/qgsserverplugins.h b/src/server/qgsserverplugins.h
@@ -24,15 +24,18 @@
 // This is needed by SIP otherwise it doesn't find QgsPythonUtils header
 class QgsPythonUtils;
 
+/**
+ * @brief Init Python server plugins and store a list of server plugin names
+ */
 class SERVER_EXPORT QgsServerPlugins
 {
   public:
     explicit QgsServerPlugins();
     /**
-       * Initialise the python plugins
-       * @param interface QgsServerInterface
-       * @return bool true on success
-       */
+     * Initialise the python plugins
+     * @param interface QgsServerInterface
+     * @return bool true on success
+     */
     static bool initPlugins( QgsServerInterface* interface );
     //! Pointer to QgsPythonUtils
     static QgsPythonUtils* mPythonUtils;
