Nicer documentation

qgis · Mar 8, 2023 · 74c11ee · 74c11ee
1 parent 56d1e71
commit 74c11ee
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 6 deletions.
diff --git a/python/core/auto_generated/symbology/qgsrenderer.sip.in b/python/core/auto_generated/symbology/qgsrenderer.sip.in
@@ -306,21 +306,25 @@ used from subclasses to create SLD Rule elements following SLD v1.1 specs
 
     virtual bool legendSymbolItemsCheckable() const;
 %Docstring
-items of symbology items in legend should be checkable
+Returns ``True`` if symbology items in legend are checkable.
 
 .. versionadded:: 2.5
 %End
 
     virtual bool legendSymbolItemChecked( const QString &key );
 %Docstring
-items of symbology items in legend is checked
+Returns ``True`` if the legend symbology item with the specified ``key`` is checked.
+
+.. seealso:: :py:func:`checkLegendSymbolItem`
 
 .. versionadded:: 2.5
 %End
 
     virtual void checkLegendSymbolItem( const QString &key, bool state = true );
 %Docstring
-item in symbology was checked
+Sets whether the legend symbology item with the specified ``ley`` should be checked.
+
+.. seealso:: :py:func:`legendSymbolItemChecked`
 
 .. versionadded:: 2.5
 %End

diff --git a/src/core/symbology/qgsrenderer.h b/src/core/symbology/qgsrenderer.h
@@ -340,19 +340,26 @@ class CORE_EXPORT QgsFeatureRenderer
     }
 
     /**
-     * items of symbology items in legend should be checkable
+     * Returns TRUE if symbology items in legend are checkable.
+     *
      * \since QGIS 2.5
      */
     virtual bool legendSymbolItemsCheckable() const;
 
     /**
-     * items of symbology items in legend is checked
+     * Returns TRUE if the legend symbology item with the specified \a key is checked.
+     *
+     * \see checkLegendSymbolItem()
+     *
      * \since QGIS 2.5
      */
     virtual bool legendSymbolItemChecked( const QString &key );
 
     /**
-     * item in symbology was checked
+     * Sets whether the legend symbology item with the specified \a ley should be checked.
+     *
+     * \see legendSymbolItemChecked()
+     *
      * \since QGIS 2.5
      */
     virtual void checkLegendSymbolItem( const QString &key, bool state = true );