Skip to content
Permalink
Browse files

Add doc for some parameters/constructor

  • Loading branch information
pblottiere committed Jul 13, 2018
1 parent 721e309 commit 5c11f411231394e4acd8d522be4483d95dc844da
@@ -40,7 +40,8 @@ namespace QgsWcs
public:

/**
* Constructor.
* Constructor for WCS service.
* \param serverIface Interface for plugins.
*/
Service( QgsServerInterface *serverIface )
: mServerIface( serverIface )
@@ -46,7 +46,8 @@ namespace QgsWfs
public:

/**
* Constructor.
* Constructor for WFS service.
* \param serverIface Interface for plugin.
*/
Service( QgsServerInterface *serverIface )
: mServerIface( serverIface )
@@ -86,19 +86,19 @@ namespace QgsWfs
};

/**
* Constructor.
* \param map of parameters where keys are parameters' names.
* Constructor for WFS parameters with specific values.
* \param parameters Map of parameters where keys are parameters' names.
*/
QgsWfsParameters( const QgsServerRequest::Parameters &parameters );

/**
* Constructor.
* Constructor for WFS parameters with default values only.
*/
QgsWfsParameters();

/**
* Loads new parameters.
* \param map of parameters
* \param parameters Map of parameters
*/
void load( const QgsServerRequest::Parameters &parameters );

@@ -109,14 +109,14 @@ namespace QgsWfs

/**
* Returns REQUEST parameter as a string or an empty string if not
* defined.
* defined.
* \returns request
*/
QString request() const;

/**
* Returns VERSION parameter as a string or an empty string if not
* defined.
* defined.
* \returns version
*/
QString version() const;
@@ -135,7 +135,7 @@ namespace QgsWfs

/**
* Returns format. If the OUTPUTFORMAT parameter is not used, then the
* default value is GML2 or GML3.
* default value is GML2 or GML3.
* \returns format
*/
Format outputFormat() const;
@@ -148,7 +148,7 @@ namespace QgsWfs

/**
* Returns resultType. If the RESULTTYPE parameter is not used, then the
* default value is RESULTS.
* default value is RESULTS.
* \returns resultType
*/
ResultType resultType() const;
@@ -167,7 +167,7 @@ namespace QgsWfs

/**
* Returns MAXFEATURES parameter as an int or its default value if not
* defined. An exception is raised if I is defined and cannot be
* defined. An exception is raised if I is defined and cannot be
* converted.
* \returns maxFeatures parameter
* \throws QgsBadRequestException
@@ -182,8 +182,8 @@ namespace QgsWfs

/**
* Returns STARTINDEX parameter as an int or its default value if not
* defined. An exception is raised if I is defined and cannot be
* converted.
* defined. An exception is raised if I is defined and cannot be
* converted.
* \returns startIndex parameter
* \throws QgsBadRequestException
*/
@@ -221,7 +221,7 @@ namespace QgsWfs

/**
* Returns BBOX as a rectangle if defined and valid. An exception is
* raised if the BBOX string cannot be converted into a rectangle.
* raised if the BBOX string cannot be converted into a rectangle.
* \returns bbox as rectangle
* \throws QgsBadRequestException
*/
@@ -49,7 +49,9 @@ namespace QgsWms
public:

/**
* Constructor.
* Constructor for WMS service.
* \param version Version of the WMS service.
* \param serverIface Interface for plugins.
*/
Service( const QString &version, QgsServerInterface *serverIface )
: mVersion( version )

0 comments on commit 5c11f41

Please sign in to comment.
You can’t perform that action at this time.