Add missing \since and \see in method docs, replace @param by \param

qgis · Oct 17, 2024 · 2a61d31 · 2a61d31
1 parent 3fa61a0
commit 2a61d31
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 3 deletions.
diff --git a/python/PyQt6/core/auto_generated/qgsdiagramrenderer.sip.in b/python/PyQt6/core/auto_generated/qgsdiagramrenderer.sip.in
@@ -1040,7 +1040,7 @@ the left (horizontal mode) or more to the top (vertical mode).
 %Docstring
 Returns the renderer at the given ``index``.
 
-:param index: index of the disired renderer in the stacked renderer
+:param index: index of the desired renderer in the stacked renderer
 %End
 
   protected:

diff --git a/python/core/auto_generated/qgsdiagramrenderer.sip.in b/python/core/auto_generated/qgsdiagramrenderer.sip.in
@@ -1040,7 +1040,7 @@ the left (horizontal mode) or more to the top (vertical mode).
 %Docstring
 Returns the renderer at the given ``index``.
 
-:param index: index of the disired renderer in the stacked renderer
+:param index: index of the desired renderer in the stacked renderer
 %End
 
   protected:

diff --git a/src/core/qgsdiagramrenderer.h b/src/core/qgsdiagramrenderer.h
@@ -1062,7 +1062,7 @@ class CORE_EXPORT QgsStackedDiagramRenderer : public QgsDiagramRenderer
     /**
      * Returns the renderer at the given \a index.
      *
-     * \param index index of the disired renderer in the stacked renderer
+     * \param index index of the desired renderer in the stacked renderer
      */
     const QgsDiagramRenderer *renderer( const int index ) const;
 

diff --git a/src/gui/vector/qgsdiagramproperties.h b/src/gui/vector/qgsdiagramproperties.h
@@ -210,12 +210,20 @@ class GUI_EXPORT QgsDiagramProperties : public QgsPanelWidget, private Ui::QgsDi
     /**
      * Sets widgets to reflect the \a enabled status of the diagram.
      * \param enabled Whether the diagram is enabled or not.
+     *
+     * \see isDiagramEnabled()
+     *
+     * \since QGIS 3.40
      */
     void setDiagramEnabled( const bool enabled );
 
     /**
      * Returns whether the current diagram should be enabled or not,
      * according to changes in the corresponding widgets.
+     *
+     * \see setDiagramEnabled()
+     *
+     * \since QGIS 3.40
      */
     bool isDiagramEnabled() const;