add documentation for QgsUserInputDockWidget

qgis · Jun 2, 2015 · 953c06b · 953c06b
1 parent d94cd88
commit 953c06b
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/src/gui/qgsuserinputdockwidget.h b/src/gui/qgsuserinputdockwidget.h
@@ -24,6 +24,13 @@
 class QFrame;
 class QBoxLayout;
 
+
+/**
+ * @brief The QgsUserInputDockWidget class is a dock widget that shall be used to display widgets for user inputs.
+ * It can be used by map tools, plugins, etc.
+ * Several widgets can be displayed at once, they will be separated by a separator. Widgets will be either layout horizontally or vertically.
+ * The dock is automatically hidden if it contains no widget.
+ */
 class GUI_EXPORT QgsUserInputDockWidget : public QDockWidget
 {
     Q_OBJECT
@@ -35,6 +42,7 @@ class GUI_EXPORT QgsUserInputDockWidget : public QDockWidget
     void addUserInputWidget( QWidget* widget );
 
   protected:
+    //! will not display the dock if it contains no widget
     void paintEvent( QPaintEvent *event ) override;
 
   private slots:
@@ -45,8 +53,7 @@ class GUI_EXPORT QgsUserInputDockWidget : public QDockWidget
     void floatingChanged( bool floating );
 
   private:
-    void createLayout();
-
+    //! change layout according to dock location
     void updateLayoutDirection();
 
     // list of widget with their corresponding line separator