Skip to content
Permalink
Browse files

Update doc for QgsConfigCache

  • Loading branch information
pblottiere committed Jul 9, 2018
1 parent 66c78f7 commit 3cf7c341460e91289eacecee0d5817ca2ab50c77
Showing with 17 additions and 3 deletions.
  1. +8 −1 python/server/auto_generated/qgsconfigcache.sip.in
  2. +9 −2 src/server/qgsconfigcache.h
@@ -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
@@ -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

0 comments on commit 3cf7c34

Please sign in to comment.
You can’t perform that action at this time.