Skip to content

Commit 4853c62

Browse files
committed
Add more doc for WMS service
1 parent 67cbb27 commit 4853c62

File tree

3 files changed

+75
-74
lines changed

3 files changed

+75
-74
lines changed

src/server/services/wms/qgsmaprendererjobproxy.h

+17-14
Original file line numberDiff line numberDiff line change
@@ -27,35 +27,38 @@ namespace QgsWms
2727

2828
/**
2929
* \ingroup server
30-
* thiss class provides a proxy for sequential or parallel map render job by
31-
* reading qsettings.
32-
* \since QGIS 3.0
33-
*/
30+
* \class QgsWms::QgsMapRendererJobProxy
31+
* \brief Proxy for sequential or parallel map render job by reading qsettings.
32+
* \since QGIS 3.0
33+
*/
3434
class QgsMapRendererJobProxy
3535
{
3636
public:
3737

3838
/**
39-
* Constructor.
40-
* \param featureFilterProvider Does not take ownership of QgsFeatureFilterProvider
41-
*/
39+
* Constructor for QgsMapRendererJobProxy. Does not take ownership of
40+
* QgsFeatureFilterProvider.
41+
* \param parallelRendering True to activate parallel rendering, false otherwise
42+
* \param maxThreads The number of threads to use in case of parallel rendering
43+
* \param featureFilterProvider Features filtering
44+
*/
4245
QgsMapRendererJobProxy(
4346
bool parallelRendering
4447
, int maxThreads
4548
, QgsFeatureFilterProvider *featureFilterProvider
4649
);
4750

4851
/**
49-
* Sequential or parallel map rendering according to qsettings.
50-
* \param mapSettings passed to MapRendererJob
51-
* \param the rendered image
52-
*/
52+
* Sequential or parallel map rendering according to QSettings.
53+
* \param mapSettings Passed to MapRendererJob
54+
* \param image The resulting image
55+
*/
5356
void render( const QgsMapSettings &mapSettings, QImage *image );
5457

5558
/**
56-
* Take ownership of the painter used for rendering.
57-
* \returns painter
58-
*/
59+
* Takes ownership of the painter used for rendering.
60+
* \returns painter
61+
*/
5962
QPainter *takePainter();
6063

6164
private:

src/server/services/wms/qgswmsgetcapabilities.h

+9-11
Original file line numberDiff line numberDiff line change
@@ -72,19 +72,17 @@ namespace QgsWms
7272
QgsServerResponse &response, bool projectSettings = false );
7373

7474
/**
75-
* Create WMS GetCapabilities document
76-
*
77-
* Returns an XML document with the capabilities description (as described in the WMS specs)
75+
* Creates the WMS GetCapabilities XML document.
76+
* \param serverIface Interface for plugins
77+
* \param project Project
7878
* \param version WMS version
79-
* \param projectSettings If true: add extended project information (does not validate against WMS schema)
79+
* \param request WMS request
80+
* \param projectSettings If true, adds extended project information (does not validate against WMS schema)
81+
* \returns GetCapabilities XML document
8082
*/
8183
QDomDocument getCapabilities( QgsServerInterface *serverIface, const QgsProject *project,
82-
const QString &version, const QgsServerRequest &request, bool projectSettings );
83-
84-
85-
} // samespace QgsWms
86-
84+
const QString &version, const QgsServerRequest &request,
85+
bool projectSettings );
86+
} // namespace QgsWms
8787

8888
#endif
89-
90-

0 commit comments

Comments
 (0)