Add doc for new function

qgis · Jan 5, 2019 · 4e29558 · 4e29558
1 parent 492ee5f
commit 4e29558
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/python/server/auto_generated/qgsserverprojectutils.sip.in b/python/server/auto_generated/qgsserverprojectutils.sip.in
@@ -155,6 +155,13 @@ Returns the quality for WMS images defined in a QGIS project.
 %End
 
   int wmsMaxAtlasFeatures( const QgsProject &project );
+%Docstring
+Returns the maximum number of atlas features which can be printed in a request
+
+:param project: the QGIS project
+
+:return: the number of atlas features
+%End
 
   bool wmsUseLayerIds( const QgsProject &project );
 %Docstring

diff --git a/src/server/qgsserverprojectutils.h b/src/server/qgsserverprojectutils.h
@@ -147,6 +147,11 @@ namespace QgsServerProjectUtils
    */
   SERVER_EXPORT int wmsImageQuality( const QgsProject &project );
 
+  /**
+   * Returns the maximum number of atlas features which can be printed in a request
+   * \param project the QGIS project
+   * \return the number of atlas features
+   */
   SERVER_EXPORT int wmsMaxAtlasFeatures( const QgsProject &project );
 
   /**