Skip to content

Commit 65f9c91

Browse files
committed
[Server] Fixing spelling and doc coverage
1 parent 9463d04 commit 65f9c91

File tree

4 files changed

+17
-16
lines changed

4 files changed

+17
-16
lines changed

src/server/qgsservercachefilter.h

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ class QgsServerInterface;
3737
* \ingroup server
3838
* \class QgsServerCacheFilter
3939
* \brief Class defining cache interface for QGIS Server plugins.
40+
* \since QGIS 3.4
4041
*/
4142
class SERVER_EXPORT QgsServerCacheFilter
4243
{
@@ -56,7 +57,7 @@ class SERVER_EXPORT QgsServerCacheFilter
5657
* Returns cached document (or 0 if document not in cache) like capabilities
5758
* \param project the project used to generate the document to provide path
5859
* \param request the request used to generate the document to provider parameters or data
59-
* \param key the key provided by the access control to identify differents documents for the same request
60+
* \param key the key provided by the access control to identify different documents for the same request
6061
* \returns QByteArray of the cached document or an empty one if no corresponding document found
6162
*/
6263
virtual QByteArray getCachedDocument( const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;
@@ -66,7 +67,7 @@ class SERVER_EXPORT QgsServerCacheFilter
6667
* \param doc the document to cache
6768
* \param project the project used to generate the document to provide path
6869
* \param request the request used to generate the document to provider parameters or data
69-
* \param key the key provided by the access control to identify differents documents for the same request
70+
* \param key the key provided by the access control to identify different documents for the same request
7071
* \returns true if the document has been cached
7172
*/
7273
virtual bool setCachedDocument( const QDomDocument *doc, const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;
@@ -75,7 +76,7 @@ class SERVER_EXPORT QgsServerCacheFilter
7576
* Deletes the cached document
7677
* \param project the project used to generate the document to provide path
7778
* \param request the request used to generate the document to provider parameters or data
78-
* \param key the key provided by the access control to identify differents documents for the same request
79+
* \param key the key provided by the access control to identify different documents for the same request
7980
* \returns true if the document has been deleted
8081
*/
8182
virtual bool deleteCachedDocument( const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;
@@ -91,7 +92,7 @@ class SERVER_EXPORT QgsServerCacheFilter
9192
* Returns cached image (or 0 if document not in cache) like tiles
9293
* \param project the project used to generate the image to provide path
9394
* \param request the request used to generate the image to provider parameters or data
94-
* \param key the key provided by the access control to identify differents images for the same request
95+
* \param key the key provided by the access control to identify different images for the same request
9596
* \returns QByteArray of the cached image or an empty one if no corresponding image found
9697
*/
9798
virtual QByteArray getCachedImage( const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;
@@ -101,7 +102,7 @@ class SERVER_EXPORT QgsServerCacheFilter
101102
* \param img the document to cache
102103
* \param project the project used to generate the image to provide path
103104
* \param request the request used to generate the image to provider parameters or data
104-
* \param key the key provided by the access control to identify differents images for the same request
105+
* \param key the key provided by the access control to identify different images for the same request
105106
* \returns true if the image has been cached
106107
*/
107108
virtual bool setCachedImage( const QByteArray *img, const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;
@@ -110,7 +111,7 @@ class SERVER_EXPORT QgsServerCacheFilter
110111
* Deletes the cached image
111112
* \param project the project used to generate the image to provide path
112113
* \param request the request used to generate the image to provider parameters or data
113-
* \param key the key provided by the access control to identify differents images for the same request
114+
* \param key the key provided by the access control to identify different images for the same request
114115
* \returns true if the image has been deleted
115116
*/
116117
virtual bool deleteCachedImage( const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;

src/server/qgsservercachemanager.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ class SERVER_EXPORT QgsServerCacheManager
7070
* Returns cached document (or 0 if document not in cache) like capabilities
7171
* \param project the project used to generate the document to provide path
7272
* \param request the request used to generate the document to provider parameters or data
73-
* \param key the key provided by the access control to identify differents documents for the same request
73+
* \param key the key provided by the access control to identify different documents for the same request
7474
* \returns the cached document or 0 if no corresponding document found
7575
*/
7676
QByteArray getCachedDocument( const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;
@@ -80,7 +80,7 @@ class SERVER_EXPORT QgsServerCacheManager
8080
* \param doc the document to cache
8181
* \param project the project used to generate the document to provide path
8282
* \param request the request used to generate the document to provider parameters or data
83-
* \param key the key provided by the access control to identify differents documents for the same request
83+
* \param key the key provided by the access control to identify different documents for the same request
8484
* \returns true if the document has been cached
8585
*/
8686
bool setCachedDocument( const QDomDocument *doc, const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;
@@ -89,7 +89,7 @@ class SERVER_EXPORT QgsServerCacheManager
8989
* Deletes the cached document
9090
* \param project the project used to generate the document to provide path
9191
* \param request the request used to generate the document to provider parameters or data
92-
* \param key the key provided by the access control to identify differents documents for the same request
92+
* \param key the key provided by the access control to identify different documents for the same request
9393
* \returns true if the document has been deleted
9494
*/
9595
bool deleteCachedDocument( const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;
@@ -105,7 +105,7 @@ class SERVER_EXPORT QgsServerCacheManager
105105
* Returns cached image (or 0 if image not in cache) like tiles
106106
* \param project the project used to generate the image to provide path
107107
* \param request the request used to generate the image to provider parameters or data
108-
* \param key the key provided by the access control to identify differents images for the same request
108+
* \param key the key provided by the access control to identify different images for the same request
109109
* \returns the cached image or 0 if no corresponding image found
110110
*/
111111
QByteArray getCachedImage( const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;
@@ -115,7 +115,7 @@ class SERVER_EXPORT QgsServerCacheManager
115115
* \param img the image to cache
116116
* \param project the project used to generate the image to provide path
117117
* \param request the request used to generate the image to provider parameters or data
118-
* \param key the key provided by the access control to identify differents images for the same request
118+
* \param key the key provided by the access control to identify different images for the same request
119119
* \returns true if the image has been cached
120120
*/
121121
bool setCachedImage( const QByteArray *img, const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;
@@ -124,7 +124,7 @@ class SERVER_EXPORT QgsServerCacheManager
124124
* Deletes the cached image
125125
* \param project the project used to generate the image to provide path
126126
* \param request the request used to generate the image to provider parameters or data
127-
* \param key the key provided by the access control to identify differents images for the same request
127+
* \param key the key provided by the access control to identify different images for the same request
128128
* \returns true if the image has been deleted
129129
*/
130130
bool deleteCachedImage( const QgsProject *project, const QgsServerRequest &request, const QString &key ) const;

src/server/services/wmts/qgswmtsgetcapabilities.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ namespace QgsWmts
216216
serviceElem.appendChild( onlineResourceElem );
217217
}
218218

219-
//Contact informations
219+
//Contact information
220220
QString contactPerson = QgsServerProjectUtils::owsServiceContactPerson( *project );
221221
QString contactPosition = QgsServerProjectUtils::owsServiceContactPosition( *project );
222222
QString contactMail = QgsServerProjectUtils::owsServiceContactMail( *project );

tests/src/python/test_qgsserver_cachemanager.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ def test_getcapabilities(self):
250250

251251
cacheManager = self._server_iface.cacheManager()
252252

253-
self.assertTrue(cacheManager.deleteCachedDocuments(None), 'deleteCachedDocuments does not retrun True')
253+
self.assertTrue(cacheManager.deleteCachedDocuments(None), 'deleteCachedDocuments does not return True')
254254

255255
filelist = [f for f in os.listdir(self._servercache._cache_dir) if f.endswith(".xml")]
256256
self.assertEqual(len(filelist), 0, 'All files in cache are not deleted ')
@@ -275,7 +275,7 @@ def test_getcapabilities(self):
275275
self.assertTrue(cDoc.setContent(cContent), 'cachedDocument not XML doc')
276276
self.assertEqual(doc.documentElement().tagName(), cDoc.documentElement().tagName(), 'cachedDocument not equal to provide document')
277277

278-
self.assertTrue(cacheManager.deleteCachedDocuments(None), 'deleteCachedDocuments does not retrun True')
278+
self.assertTrue(cacheManager.deleteCachedDocuments(None), 'deleteCachedDocuments does not return True')
279279

280280
def test_gettile(self):
281281
project = self._project_path
@@ -386,7 +386,7 @@ def test_gettile(self):
386386

387387
cacheManager = self._server_iface.cacheManager()
388388

389-
self.assertTrue(cacheManager.deleteCachedImages(None), 'deleteCachedImages does not retrun True')
389+
self.assertTrue(cacheManager.deleteCachedImages(None), 'deleteCachedImages does not return True')
390390

391391
filelist = [f for f in os.listdir(self._servercache._tile_cache_dir) if f.endswith(".png")]
392392
self.assertEqual(len(filelist), 0, 'All images in cache are not deleted ')

0 commit comments

Comments
 (0)