Skip to content

Commit

Permalink
Add missing \since and \see in method docs, replace @param by \param
Browse files Browse the repository at this point in the history
  • Loading branch information
gacarrillor committed Oct 16, 2024
1 parent 81e7bc8 commit 8c8dcfc
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 13 deletions.
13 changes: 8 additions & 5 deletions python/PyQt6/core/auto_generated/qgsdiagramrenderer.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -1022,21 +1022,24 @@ Writes stacked renderers state to a DOM element.
QList< QgsDiagramRenderer * > renderers( bool sortByDiagramMode = false ) const;
%Docstring
Returns an ordered list with the renderers of the stacked renderer object.
@param sortByDiagramMode If true, the list is returned backwards for vertical orientation.

:param sortByDiagramMode: If true, the list is returned backwards for vertical orientation.
%End

void addRenderer( QgsDiagramRenderer *renderer );
%Docstring
Adds a renderer to the stacked renderer object.
@param renderer diagram renderer to be added to the stacked renderer
Renderers added first will render their diagrams first, i.e., more to
the left (horizontal mode) or more to the top (vertical mode).

:param renderer: diagram renderer to be added to the stacked renderer
Renderers added first will render their diagrams first, i.e., more to
the left (horizontal mode) or more to the top (vertical mode).
%End

const QgsDiagramRenderer *renderer( const int index ) const;
%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:
Expand Down
13 changes: 8 additions & 5 deletions python/core/auto_generated/qgsdiagramrenderer.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -1022,21 +1022,24 @@ Writes stacked renderers state to a DOM element.
QList< QgsDiagramRenderer * > renderers( bool sortByDiagramMode = false ) const;
%Docstring
Returns an ordered list with the renderers of the stacked renderer object.
@param sortByDiagramMode If true, the list is returned backwards for vertical orientation.

:param sortByDiagramMode: If true, the list is returned backwards for vertical orientation.
%End

void addRenderer( QgsDiagramRenderer *renderer );
%Docstring
Adds a renderer to the stacked renderer object.
@param renderer diagram renderer to be added to the stacked renderer
Renderers added first will render their diagrams first, i.e., more to
the left (horizontal mode) or more to the top (vertical mode).

:param renderer: diagram renderer to be added to the stacked renderer
Renderers added first will render their diagrams first, i.e., more to
the left (horizontal mode) or more to the top (vertical mode).
%End

const QgsDiagramRenderer *renderer( const int index ) const;
%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:
Expand Down
6 changes: 3 additions & 3 deletions src/core/qgsdiagramrenderer.h
Original file line number Diff line number Diff line change
Expand Up @@ -1044,21 +1044,21 @@ class CORE_EXPORT QgsStackedDiagramRenderer : public QgsDiagramRenderer

/**
* Returns an ordered list with the renderers of the stacked renderer object.
* @param sortByDiagramMode If true, the list is returned backwards for vertical orientation.
* \param sortByDiagramMode If true, the list is returned backwards for vertical orientation.
*/
QList< QgsDiagramRenderer * > renderers( bool sortByDiagramMode = false ) const;

/**
* Adds a renderer to the stacked renderer object.
* @param renderer diagram renderer to be added to the stacked renderer
* \param renderer diagram renderer to be added to the stacked renderer
* Renderers added first will render their diagrams first, i.e., more to
* the left (horizontal mode) or more to the top (vertical mode).
*/
void addRenderer( QgsDiagramRenderer *renderer );

/**
* 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;

Expand Down
8 changes: 8 additions & 0 deletions src/gui/vector/qgsdiagramproperties.h
Original file line number Diff line number Diff line change
Expand Up @@ -206,12 +206,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;

Expand Down

0 comments on commit 8c8dcfc

Please sign in to comment.