Skip to content

Commit

Permalink
Add ingroup
Browse files Browse the repository at this point in the history
  • Loading branch information
pblottiere committed Jul 13, 2018
1 parent d49c0d0 commit 5aff40d
Show file tree
Hide file tree
Showing 14 changed files with 40 additions and 21 deletions.
3 changes: 3 additions & 0 deletions src/server/qgsconfigparserutils.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ class QDomDocument;
class QDomElement;
class QString;

/**
* \ingroup server
*/
class QgsConfigParserUtils
{
public:
Expand Down
1 change: 1 addition & 0 deletions src/server/qgsfilterrestorer.h
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ class QgsMapLayer;
class QgsAccessControl;

/**
* \ingroup server
* RAII class to restore layer filters on destruction
*/
class SERVER_EXPORT QgsOWSServerFilterRestorer
Expand Down
3 changes: 1 addition & 2 deletions src/server/qgsserverinterfaceimpl.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{

Expand Down
5 changes: 4 additions & 1 deletion src/server/qgsserverlogger.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion src/server/qgsserverplugins.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
9 changes: 5 additions & 4 deletions src/server/qgsserversettings.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
8 changes: 6 additions & 2 deletions src/server/services/wcs/qgswcs.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@
namespace QgsWcs
{

/**
* \ingroup server
*/
class Service: public QgsService
{
public:
Expand Down Expand Up @@ -97,8 +100,9 @@ namespace QgsWcs

} // namespace QgsWfs


// Module
/**
* \ingroup server
*/
class QgsWcsModule: public QgsServiceModule
{
public:
Expand Down
6 changes: 0 additions & 6 deletions src/server/services/wcs/qgswcsserviceexception.h
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,6 @@ namespace QgsWcs
: QgsServiceException( QStringLiteral( "RequestNotWellFormed" ), message, locator, 400 )
{}
};






} // namespace QgsWcs

#endif
Expand Down
8 changes: 6 additions & 2 deletions src/server/services/wfs/qgswfs.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@
namespace QgsWfs
{

/**
* \ingroup server
*/
class Service: public QgsService
{
public:
Expand Down Expand Up @@ -121,8 +124,9 @@ namespace QgsWfs

} // namespace QgsWfs


// Module
/**
* \ingroup server
*/
class QgsWfsModule: public QgsServiceModule
{
public:
Expand Down
2 changes: 1 addition & 1 deletion src/server/services/wfs/qgswfsparameters.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions src/server/services/wms/qgslayerrestorer.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
#include "qgsmaplayer.h"

/**
* \ingroup server
* RAII class to restore layer configuration on destruction (opacity,
* filters, ...)
* \since QGIS 3.0
Expand Down
8 changes: 6 additions & 2 deletions src/server/services/wms/qgswms.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@
namespace QgsWms
{

/**
* \ingroup server
*/
class Service: public QgsService
{
public:
Expand Down Expand Up @@ -155,8 +158,9 @@ namespace QgsWms

} // namespace QgsWms


// Module
/**
* \ingroup server
*/
class QgsWmsModule: public QgsServiceModule
{
public:
Expand Down
1 change: 1 addition & 0 deletions src/server/services/wms/qgswmsparameters.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions src/server/services/wms/qgswmsrenderer.h
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ class QgsLayerTreeGroup;
namespace QgsWms
{

/**
* \ingroup server
*/
class QgsRenderer
{
public:
Expand Down

0 comments on commit 5aff40d

Please sign in to comment.