Add ingroup

pblottiere · pblottiere · commit 5aff40d28b5e · 2018-07-13T08:22:28.000+01:00
diff --git a/src/server/qgsconfigparserutils.h b/src/server/qgsconfigparserutils.h
@@ -30,6 +30,9 @@ class QDomDocument;
 class QDomElement;
 class QString;
 
+/**
+ * \ingroup server
+ */
 class QgsConfigParserUtils
 {
   public:
diff --git a/src/server/qgsfilterrestorer.h b/src/server/qgsfilterrestorer.h
@@ -29,6 +29,7 @@ class QgsMapLayer;
 class QgsAccessControl;
 
 /**
+ * \ingroup server
  * RAII class to restore layer filters on destruction
  */
 class SERVER_EXPORT QgsOWSServerFilterRestorer
diff --git a/src/server/qgsserverinterfaceimpl.h b/src/server/qgsserverinterfaceimpl.h
@@ -26,12 +26,11 @@
 #include "qgscapabilitiescache.h"
 
 /**
+ * \ingroup server
  * QgsServerInterface
  * Class defining interfaces exposed by QGIS Server and
  * made available to plugins.
- *
  */
-
 class QgsServerInterfaceImpl : public QgsServerInterface
 {
 
diff --git a/src/server/qgsserverlogger.h b/src/server/qgsserverlogger.h
@@ -28,7 +28,10 @@
 #include <QString>
 #include <QTextStream>
 
-//! Writes message log into server logfile
+/**
+ * \ingroup server
+ * \brief Writes message log into server logfile
+ */
 class QgsServerLogger: public QObject
 {
     Q_OBJECT
diff --git a/src/server/qgsserverplugins.h b/src/server/qgsserverplugins.h
@@ -28,7 +28,8 @@
 class QgsPythonUtils;
 
 /**
- * \brief Init Python server plugins and store a list of server plugin names
+ * \ingroup server
+ * \brief Initializes Python server plugins and stores a list of server plugin names
  */
 class SERVER_EXPORT QgsServerPlugins
 {
diff --git a/src/server/qgsserversettings.h b/src/server/qgsserversettings.h
@@ -28,10 +28,11 @@
 #include "qgis_sip.h"
 
 /**
-  * QgsServerSettingsEnv provides some enum describing the environment
-  * currently supported for configuration.
-  * \since QGIS 3.0
-  */
+ * \ingroup server
+ * QgsServerSettingsEnv provides some enum describing the environment
+ * currently supported for configuration.
+ * \since QGIS 3.0
+ */
 #ifndef SIP_RUN
 class SERVER_EXPORT QgsServerSettingsEnv : public QObject
 {
diff --git a/src/server/services/wcs/qgswcs.cpp b/src/server/services/wcs/qgswcs.cpp
@@ -29,6 +29,9 @@
 namespace QgsWcs
 {
 
+  /**
+   * \ingroup server
+   */
   class Service: public QgsService
   {
     public:
@@ -97,8 +100,9 @@ namespace QgsWcs
 
 } // namespace QgsWfs
 
-
-// Module
+/**
+ * \ingroup server
+ */
 class QgsWcsModule: public QgsServiceModule
 {
   public:
diff --git a/src/server/services/wcs/qgswcsserviceexception.h b/src/server/services/wcs/qgswcsserviceexception.h
@@ -86,12 +86,6 @@ namespace QgsWcs
         : QgsServiceException( QStringLiteral( "RequestNotWellFormed" ), message, locator, 400 )
       {}
   };
-
-
-
-
-
-
 } // namespace QgsWcs
 
 #endif
diff --git a/src/server/services/wfs/qgswfs.cpp b/src/server/services/wfs/qgswfs.cpp
@@ -35,6 +35,9 @@
 namespace QgsWfs
 {
 
+  /**
+   * \ingroup server
+   */
   class Service: public QgsService
   {
     public:
@@ -121,8 +124,9 @@ namespace QgsWfs
 
 } // namespace QgsWfs
 
-
-// Module
+/**
+ * \ingroup server
+ */
 class QgsWfsModule: public QgsServiceModule
 {
   public:
diff --git a/src/server/services/wfs/qgswfsparameters.h b/src/server/services/wfs/qgswfsparameters.h
@@ -28,13 +28,13 @@
 #include "qgsprojectversion.h"
 
 /**
+ * \ingroup server
  * QgsWfsParameters provides an interface to retrieve and manipulate WFS
  *  parameters received from the client.
  * \since QGIS 3.0
  */
 namespace QgsWfs
 {
-
   class QgsWfsParameters
   {
       Q_GADGET
diff --git a/src/server/services/wms/qgslayerrestorer.h b/src/server/services/wms/qgslayerrestorer.h
@@ -23,6 +23,7 @@
 #include "qgsmaplayer.h"
 
 /**
+ * \ingroup server
  * RAII class to restore layer configuration on destruction (opacity,
  * filters, ...)
  * \since QGIS 3.0
diff --git a/src/server/services/wms/qgswms.cpp b/src/server/services/wms/qgswms.cpp
@@ -38,6 +38,9 @@
 namespace QgsWms
 {
 
+  /**
+   * \ingroup server
+   */
   class Service: public QgsService
   {
     public:
@@ -155,8 +158,9 @@ namespace QgsWms
 
 } // namespace QgsWms
 
-
-// Module
+/**
+ * \ingroup server
+ */
 class QgsWmsModule: public QgsServiceModule
 {
   public:
diff --git a/src/server/services/wms/qgswmsparameters.h b/src/server/services/wms/qgswmsparameters.h
@@ -31,6 +31,7 @@
 #include "qgsprojectversion.h"
 
 /**
+ * \ingroup server
  * QgsWmsParameters provides an interface to retrieve and manipulate WMS
  *  parameters received from the client.
  * \since QGIS 3.0
diff --git a/src/server/services/wms/qgswmsrenderer.h b/src/server/services/wms/qgswmsrenderer.h
@@ -75,6 +75,9 @@ class QgsLayerTreeGroup;
 namespace QgsWms
 {
 
+  /**
+   * \ingroup server
+   */
   class QgsRenderer
   {
     public:

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,9 @@ class QDomDocument;`
`30`	`30`	`class QDomElement;`
`31`	`31`	`class QString;`
`32`	`32`
	`33`	`+/**`
	`34`	`+ * \ingroup server`
	`35`	`+ */`
`33`	`36`	`class QgsConfigParserUtils`
`34`	`37`	`{`
`35`	`38`	`public:`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,8 @@`
`28`	`28`	`class QgsPythonUtils;`
`29`	`29`
`30`	`30`	`/**`
`31`		`- * \brief Init Python server plugins and store a list of server plugin names`
	`31`	`+ * \ingroup server`
	`32`	`+ * \brief Initializes Python server plugins and stores a list of server plugin names`
`32`	`33`	`*/`
`33`	`34`	`class SERVER_EXPORT QgsServerPlugins`
`34`	`35`	`{`
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,9 @@`
`29`	`29`	`namespace QgsWcs`
`30`	`30`	`{`
`31`	`31`
	`32`	`+ /**`
	`33`	`+ * \ingroup server`
	`34`	`+ */`
`32`	`35`	`class Service: public QgsService`
`33`	`36`	`{`
`34`	`37`	`public:`
`@@ -97,8 +100,9 @@ namespace QgsWcs`
`97`	`100`
`98`	`101`	`} // namespace QgsWfs`
`99`	`102`
`100`		`-`
`101`		`-// Module`
	`103`	`+/**`
	`104`	`+ * \ingroup server`
	`105`	`+ */`
`102`	`106`	`class QgsWcsModule: public QgsServiceModule`
`103`	`107`	`{`
`104`	`108`	`public:`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,9 @@`
`35`	`35`	`namespace QgsWfs`
`36`	`36`	`{`
`37`	`37`
	`38`	`+ /**`
	`39`	`+ * \ingroup server`
	`40`	`+ */`
`38`	`41`	`class Service: public QgsService`
`39`	`42`	`{`
`40`	`43`	`public:`
`@@ -121,8 +124,9 @@ namespace QgsWfs`
`121`	`124`
`122`	`125`	`} // namespace QgsWfs`
`123`	`126`
`124`		`-`
`125`		`-// Module`
	`127`	`+/**`
	`128`	`+ * \ingroup server`
	`129`	`+ */`
`126`	`130`	`class QgsWfsModule: public QgsServiceModule`
`127`	`131`	`{`
`128`	`132`	`public:`
Original file line number	Diff line number	Diff line change
`@@ -28,13 +28,13 @@`
`28`	`28`	`#include "qgsprojectversion.h"`
`29`	`29`
`30`	`30`	`/**`
	`31`	`+ * \ingroup server`
`31`	`32`	`* QgsWfsParameters provides an interface to retrieve and manipulate WFS`
`32`	`33`	`* parameters received from the client.`
`33`	`34`	`* \since QGIS 3.0`
`34`	`35`	`*/`
`35`	`36`	`namespace QgsWfs`
`36`	`37`	`{`
`37`		`-`
`38`	`38`	`class QgsWfsParameters`
`39`	`39`	`{`
`40`	`40`	`Q_GADGET`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,9 @@`
`38`	`38`	`namespace QgsWms`
`39`	`39`	`{`
`40`	`40`
	`41`	`+ /**`
	`42`	`+ * \ingroup server`
	`43`	`+ */`
`41`	`44`	`class Service: public QgsService`
`42`	`45`	`{`
`43`	`46`	`public:`
`@@ -155,8 +158,9 @@ namespace QgsWms`
`155`	`158`
`156`	`159`	`} // namespace QgsWms`
`157`	`160`
`158`		`-`
`159`		`-// Module`
	`161`	`+/**`
	`162`	`+ * \ingroup server`
	`163`	`+ */`
`160`	`164`	`class QgsWmsModule: public QgsServiceModule`
`161`	`165`	`{`
`162`	`166`	`public:`
Original file line number	Diff line number	Diff line change
`@@ -75,6 +75,9 @@ class QgsLayerTreeGroup;`
`75`	`75`	`namespace QgsWms`
`76`	`76`	`{`
`77`	`77`
	`78`	`+ /**`
	`79`	`+ * \ingroup server`
	`80`	`+ */`
`78`	`81`	`class QgsRenderer`
`79`	`82`	`{`
`80`	`83`	`public:`