Added documentationstrings to new methods

qgis · Apr 5, 2018 · 98621d7 · 98621d7
1 parent 924e2ec
commit 98621d7
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/python/gui/layertree/qgslayertreeviewdefaultactions.sip.in b/python/gui/layertree/qgslayertreeviewdefaultactions.sip.in
@@ -53,7 +53,14 @@ Action to check a group and all its parents
     QAction *actionZoomToGroup( QgsMapCanvas *canvas, QObject *parent = 0 ) /Factory/;
 
     QAction *actionMakeTopLevel( QObject *parent = 0 ) /Factory/;
+
     QAction *actionMoveToTop( QObject *parent = 0 ) /Factory/;
+%Docstring
+
+.. seealso:: :py:func:`moveToTop`
+
+.. versionadded:: 3.2
+%End
     QAction *actionGroupSelected( QObject *parent = 0 ) /Factory/;
 
     QAction *actionMutuallyExclusiveGroup( QObject *parent = 0 ) /Factory/;
@@ -77,7 +84,14 @@ Action to enable/disable mutually exclusive flag of a group (only one child node
     void zoomToLayer();
     void zoomToGroup();
     void makeTopLevel();
+
     void moveToTop();
+%Docstring
+Moves selected layer(s) and/or group(s) to the top of the layer panel
+or the top of the group if the layer/group is placed within a group.
+
+.. versionadded:: 3.2
+%End
     void groupSelected();
 
     void mutuallyExclusiveGroup();

diff --git a/src/gui/layertree/qgslayertreeviewdefaultactions.h b/src/gui/layertree/qgslayertreeviewdefaultactions.h
@@ -62,6 +62,11 @@ class GUI_EXPORT QgsLayerTreeViewDefaultActions : public QObject
     // TODO: zoom to selected
 
     QAction *actionMakeTopLevel( QObject *parent = nullptr ) SIP_FACTORY;
+
+    /**
+     * \see moveToTop()
+     * \since QGIS 3.2
+     */
     QAction *actionMoveToTop( QObject *parent = nullptr ) SIP_FACTORY;
     QAction *actionGroupSelected( QObject *parent = nullptr ) SIP_FACTORY;
 
@@ -85,6 +90,12 @@ class GUI_EXPORT QgsLayerTreeViewDefaultActions : public QObject
     void zoomToLayer();
     void zoomToGroup();
     void makeTopLevel();
+
+    /**
+     * Moves selected layer(s) and/or group(s) to the top of the layer panel
+     * or the top of the group if the layer/group is placed within a group.
+     * \since QGIS 3.2
+     */
     void moveToTop();
     void groupSelected();