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

This commit is contained in:
Germán Carrillo 2024-10-15 19:18:40 -05:00 committed by Nyall Dawson
parent d9f340f018
commit cc6feb11f6
4 changed files with 11 additions and 3 deletions

View File

@ -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:

View File

@ -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:

View File

@ -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;

View File

@ -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;