Skip to content

Commit 3cf7c34

Browse files
committed
Update doc for QgsConfigCache
1 parent 66c78f7 commit 3cf7c34

File tree

2 files changed

+17
-3
lines changed

2 files changed

+17
-3
lines changed

python/server/auto_generated/qgsconfigcache.sip.in

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,20 @@ Cache for server configuration.
2121
#include "qgsconfigcache.h"
2222
%End
2323
public:
24+
2425
static QgsConfigCache *instance();
26+
%Docstring
27+
Returns the current instance.
28+
%End
2529

2630
void removeEntry( const QString &path );
31+
%Docstring
32+
Removes an entry from cache.
33+
%End
2734

2835
const QgsProject *project( const QString &path );
2936
%Docstring
30-
If the project is not cached yet, then the project is read thank to the
37+
If the project is not cached yet, then the project is read thanks to the
3138
path. If the project is not available, then a None is returned.
3239

3340
:param path: the filename of the QGIS project

src/server/qgsconfigcache.h

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,20 @@ class SERVER_EXPORT QgsConfigCache : public QObject
3838
{
3939
Q_OBJECT
4040
public:
41+
42+
/**
43+
* Returns the current instance.
44+
*/
4145
static QgsConfigCache *instance();
4246

47+
/**
48+
* Removes an entry from cache.
49+
*/
4350
void removeEntry( const QString &path );
4451

4552
/**
46-
* If the project is not cached yet, then the project is read thank to the
47-
* path. If the project is not available, then a nullptr is returned.
53+
* If the project is not cached yet, then the project is read thanks to the
54+
* path. If the project is not available, then a nullptr is returned.
4855
* \param path the filename of the QGIS project
4956
* \returns the project or nullptr if an error happened
5057
* \since QGIS 3.0

0 commit comments

Comments
 (0)