QGIS 3 style doxy

qgis · Feb 27, 2021 · 2318d76 · 2318d76
1 parent 4e36a12
commit 2318d76
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/python/core/auto_generated/layout/qgslayoutrendercontext.sip.in b/python/core/auto_generated/layout/qgslayoutrendercontext.sip.in
@@ -315,14 +315,20 @@ Returns the current list of predefined scales for use with the layout.
 
     QgsFeatureFilterProvider *featureFilterProvider() const;
 %Docstring
-Returns the possibly NULL featureFilterProvider
+Returns the possibly NULL feature filter provider.
+
+A feature filter provider allows to filter visible features or attributes.
+It is currently used by QGIS Server Access Control Plugins.
 
 .. versionadded:: 3.18
 %End
 
     void setFeatureFilterProvider( QgsFeatureFilterProvider *featureFilterProvider );
 %Docstring
-Sets ``featureFilterProvider``
+Sets feature filter provider to ``featureFilterProvider``.
+
+A feature filter provider allows to filter visible features or attributes.
+It is currently used by QGIS Server Access Control Plugins.
 
 .. versionadded:: 3.18
 %End

diff --git a/src/core/layout/qgslayoutrendercontext.h b/src/core/layout/qgslayoutrendercontext.h
@@ -298,13 +298,21 @@ class CORE_EXPORT QgsLayoutRenderContext : public QObject
     QVector<qreal> predefinedScales() const { return mPredefinedScales; }
 
     /**
-     * Returns the possibly NULL featureFilterProvider
+     * Returns the possibly NULL feature filter provider.
+     *
+     * A feature filter provider allows to filter visible features or attributes.
+     * It is currently used by QGIS Server Access Control Plugins.
+     *
      * \since QGIS 3.18
      */
     QgsFeatureFilterProvider *featureFilterProvider() const;
 
     /**
-     * Sets \a featureFilterProvider
+     * Sets feature filter provider to \a featureFilterProvider.
+     *
+     * A feature filter provider allows to filter visible features or attributes.
+     * It is currently used by QGIS Server Access Control Plugins.
+     *
      * \since QGIS 3.18
      */
     void setFeatureFilterProvider( QgsFeatureFilterProvider *featureFilterProvider );