Add documentation for onlyActive parameter

qgis · Mar 29, 2018 · 810e531 · 810e531
1 parent 624e446
commit 810e531
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/python/core/symbology/qgsrulebasedrenderer.sip.in b/python/core/symbology/qgsrulebasedrenderer.sip.in
@@ -326,7 +326,12 @@ Returns which legend keys match the feature
 
         QgsRuleBasedRenderer::RuleList rulesForFeature( QgsFeature &feat, QgsRenderContext *context = 0, bool onlyActive = true );
 %Docstring
-tell which rules will be used to render the feature
+Returns the list of rules used to render the feature in a specific
+context.
+
+:param feat: The feature for which rules have to be find
+:param context: The rendering context
+:param onlyActive: True to search for active rules only, false otherwise
 %End
 
         void stopRender( QgsRenderContext &context );

diff --git a/src/core/symbology/qgsrulebasedrenderer.h b/src/core/symbology/qgsrulebasedrenderer.h
@@ -342,7 +342,14 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer
          */
         QSet< QString > legendKeysForFeature( QgsFeature &feat, QgsRenderContext *context = nullptr );
 
-        //! tell which rules will be used to render the feature
+        /**
+         * Returns the list of rules used to render the feature in a specific
+         * context.
+         *
+         * \param feat The feature for which rules have to be find
+         * \param context The rendering context
+         * \param onlyActive True to search for active rules only, false otherwise
+         */
         QgsRuleBasedRenderer::RuleList rulesForFeature( QgsFeature &feat, QgsRenderContext *context = nullptr, bool onlyActive = true );
 
         /**