Add missing docs

qgis · Jun 3, 2016 · 60df926 · 60df926
1 parent 6f4b6a6
commit 60df926
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 0 deletions.
diff --git a/src/gui/layertree/qgslayertreeembeddedconfigwidget.h b/src/gui/layertree/qgslayertreeembeddedconfigwidget.h
@@ -29,6 +29,10 @@ class GUI_EXPORT QgsLayerTreeEmbeddedConfigWidget : public QWidget, protected Ui
 {
     Q_OBJECT
   public:
+    /**
+     * A widget to configure layer tree embedded widgets for a particular map layer.
+     * @param parent The parent of the widget.
+     */
     QgsLayerTreeEmbeddedConfigWidget( QWidget* parent = nullptr );
 
     //! Initialize widget with a map layer

diff --git a/src/gui/symbology-ng/qgsrendererv2widget.h b/src/gui/symbology-ng/qgsrendererv2widget.h
@@ -89,6 +89,11 @@ class GUI_EXPORT QgsRendererV2Widget : public QWidget
      */
     void widgetChanged();
 
+    /**
+     * @brief Emitted when a sub panel for the widget is opened.
+     * The renderer can open inline sub panels instead of dialogs.
+     * @param opened
+     */
     void panelOpened( bool opened );
 
   protected:

diff --git a/src/gui/symbology-ng/qgsrendererwidgetcontainer.h b/src/gui/symbology-ng/qgsrendererwidgetcontainer.h
@@ -53,6 +53,10 @@ class GUI_EXPORT QgsRendererWidgetContainer : public QWidget, private Ui::QgsRen
   public slots:
 
   protected:
+    /**
+     * @brief Overriden key press event to handle the esc event on the widget.
+     * @param event The key event
+     */
     void keyPressEvent( QKeyEvent* event );
 
 };

diff --git a/src/gui/symbology-ng/qgssymbolv2selectordialog.h b/src/gui/symbology-ng/qgssymbolv2selectordialog.h
@@ -106,6 +106,10 @@ class GUI_EXPORT QgsSymbolV2SelectorDialog : public QDialog, private Ui::QgsSymb
      */
     void setMapCanvas( QgsMapCanvas* canvas );
 
+    /**
+     * @brief Return the symbol that is currently active in the widget. Can be null.
+     * @return The active symbol.
+     */
     QgsSymbolV2* symbol() { return mSymbol; }
 
   protected: