Skip to content

Commit 8944465

Browse files
committed
Update doc
1 parent 0fe739d commit 8944465

File tree

2 files changed

+30
-9
lines changed

2 files changed

+30
-9
lines changed

src/server/services/wms/qgswmsparameters.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,10 @@ namespace QgsWms
283283
*/
284284
void raiseError() const;
285285

286+
/**
287+
* Returns the name of the parameter.
288+
* \since QGIS 3.8
289+
*/
286290
QString name() const;
287291

288292
/**
@@ -352,6 +356,10 @@ namespace QgsWms
352356

353357
virtual ~QgsWmsParameters() = default;
354358

359+
/**
360+
* Returns the parameter corresponding to \a name.
361+
* \since QGIS 3.8
362+
*/
355363
QgsWmsParameter operator[]( QgsWmsParameter::Name name ) const;
356364

357365
/**

src/server/services/wms/qgswmsserviceexception.h

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,6 @@ namespace QgsWms
3131
* \ingroup server
3232
* \class QgsWms::QgsServiceException
3333
* \brief Exception class for WMS service exceptions.
34-
*
35-
* The most important codes are:
36-
* * "InvalidFormat"
37-
* * "Invalid CRS"
38-
* * "LayerNotDefined" / "StyleNotDefined"
39-
* * "OperationNotSupported"
40-
*
4134
* \since QGIS 3.0
4235
*/
4336
class QgsServiceException : public QgsOgcServiceException
@@ -87,10 +80,24 @@ namespace QgsWms
8780
: QgsOgcServiceException( code, message, QString(), responseCode, QStringLiteral( "1.3.0" ) )
8881
{}
8982

83+
/**
84+
* Constructor for QgsServiceException (empty locator attribute).
85+
* \param code Error code
86+
* \param message Exception message to return to the client
87+
* \param responseCode HTTP error code
88+
* \since QGIS 3.8
89+
*/
9090
QgsServiceException( ExceptionCode code, const QString &message, int responseCode )
9191
: QgsServiceException( formatCode( code ), message, QString(), responseCode )
9292
{}
9393

94+
/**
95+
* Constructor for QgsServiceException (empty locator attribute).
96+
* \param code Error code
97+
* \param parameter The WMS parameter on which an error has been detected
98+
* \param responseCode HTTP error code
99+
* \since QGIS 3.8
100+
*/
94101
QgsServiceException( ExceptionCode code, const QgsWmsParameter &parameter, int responseCode )
95102
: QgsServiceException( formatCode( code ), formatMessage( code, parameter ), QString(), responseCode )
96103
{}
@@ -213,14 +220,20 @@ namespace QgsWms
213220

214221
/**
215222
* Constructor for QgsBadRequestException (HTTP error code 400).
216-
* \param code Error code name
223+
* \param code Error code
217224
* \param message Exception message to return to the client
218-
* \param locator Locator attribute according to OGC specifications
225+
* \since QGIS 3.8
219226
*/
220227
QgsBadRequestException( ExceptionCode code, const QString &message )
221228
: QgsServiceException( code, message, 400 )
222229
{}
223230

231+
/**
232+
* Constructor for QgsBadRequestException (HTTP error code 400).
233+
* \param code Error code
234+
* \param parameter The WMS parameter on which an error has been detected
235+
* \since QGIS 3.8
236+
*/
224237
QgsBadRequestException( ExceptionCode code, const QgsWmsParameter &parameter )
225238
: QgsServiceException( code, parameter, 400 )
226239
{}

0 commit comments

Comments
 (0)