[layertree] More doxygen docs

qgis · May 30, 2014 · 17d9849 · 17d9849
1 parent 592356a
commit 17d9849
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/src/gui/layertree/qgscustomlayerorderwidget.h b/src/gui/layertree/qgscustomlayerorderwidget.h
@@ -25,6 +25,16 @@ class QgsLayerTreeNode;
 class QCheckBox;
 class QListView;
 
+/**
+ * The QgsCustomLayerOrderWidget class provides a list box where the user can define
+ * custom order for drawing of layers. It also features a checkbox for enabling
+ * or disabling the custom order. Any changes made by the user are automatically
+ * propagated to the assigned QgsLayerTreeMapCanvasBridge. Also, any updates
+ * to the layer tree cause refresh of the list.
+ *
+ * @see QgsLayerTreeMapCanvasBridge
+ * @note added in 2.4
+ */
 class GUI_EXPORT QgsCustomLayerOrderWidget : public QWidget
 {
     Q_OBJECT

diff --git a/src/gui/layertree/qgslayertreeviewdefaultactions.h b/src/gui/layertree/qgslayertreeviewdefaultactions.h
@@ -25,6 +25,14 @@ class QgsLayerTreeView;
 class QgsMapCanvas;
 class QgsMapLayer;
 
+
+/**
+ * The QgsLayerTreeViewDefaultActions class serves as a factory of actions
+ * that can be used together with a layer tree view.
+ *
+ * @see QgsLayerTreeView
+ * @note added in 2.4
+ */
 class GUI_EXPORT QgsLayerTreeViewDefaultActions : public QObject
 {
     Q_OBJECT