sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-02-27 00:33:48 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update doc for QgsConfigCache

Browse Source
This commit is contained in:
Blottiere Paul 2018-07-09 16:54:42 +01:00
parent 66c78f7806
commit 3cf7c34146
2 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
python/server/auto_generated/qgsconfigcache.sip.in
View File

@ -21,13 +21,20 @@ Cache for server configuration.
#include "qgsconfigcache.h"
%End
public:
static QgsConfigCache *instance();
%Docstring
Returns the current instance.
%End
void removeEntry( const QString &path );
%Docstring
Removes an entry from cache.
%End
const QgsProject *project( const QString &path );
%Docstring
If the project is not cached yet, then the project is read thank to the
If the project is not cached yet, then the project is read thanks to the
path. If the project is not available, then a None is returned.
:param path: the filename of the QGIS project

11
src/server/qgsconfigcache.h
View File

@ -38,13 +38,20 @@ class SERVER_EXPORT QgsConfigCache : public QObject
{
Q_OBJECT
public:
/**
* Returns the current instance.
*/
static QgsConfigCache *instance();
/**
* Removes an entry from cache.
*/
void removeEntry( const QString &path );
/**
* If the project is not cached yet, then the project is read thank to the
* path. If the project is not available, then a nullptr is returned.
* If the project is not cached yet, then the project is read thanks to the
* path. If the project is not available, then a nullptr is returned.
* \param path the filename of the QGIS project
* \returns the project or nullptr if an error happened
* \since QGIS 3.0