From 2e02eef28b1e44a753ee101dbf27470fd9fe733a Mon Sep 17 00:00:00 2001
From: wmayer <wmayer@users.sourceforge.net>
Date: Wed, 12 Mar 2014 12:33:25 +0100
Subject: [PATCH] + clarify documentation of class DockWindowManager

---
 src/Gui/DockWindowManager.h | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/src/Gui/DockWindowManager.h b/src/Gui/DockWindowManager.h
index 90732c75dc..fa15019a98 100644
--- a/src/Gui/DockWindowManager.h
+++ b/src/Gui/DockWindowManager.h
@@ -69,11 +69,21 @@ public:
     bool registerDockWindow(const char* name, QWidget* widget);
     void setup(DockWindowItems*);
 
+    /// Adds a QDockWidget to the main window and sets \a widget as its widget
     QDockWidget* addDockWindow(const char* name, QWidget* widget,  
                  Qt::DockWidgetArea pos = Qt::AllDockWidgetAreas);
+    /// Removes and destroys the QDockWidget and returns the widget
+    /// with name \a name added with @ref addDockWindow.
     QWidget* removeDockWindow(const char* name);
+    /// Removes and destroys the QDockWidget that conains \a dock. \a dock
+    /// does not get destroyed.
     void removeDockWindow(QWidget* dock);
+    /// Returns the widget with name \a name added with @ref addDockWindow.
+    /// @note The returned widget is not the QDockWidget instance
+    /// returned from @ref addDockWindow. If you want to access the QDockWidget
+    /// you get it with parentWidget() of the returned widget.
     QWidget* getDockWindow(const char* name) const;
+    /// Returns a list of all widgets which set to a QDockWidget.
     QList<QWidget*> getDockWindows() const;
 
     void saveState();