Skip to content

Commit f3c5d51

Browse files
Improved documentation for setting dock manager flags
1 parent 34cb2ae commit f3c5d51

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/DockManager.h

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,7 @@ class ADS_EXPORT CDockManager : public CDockContainerWidget
142142
/**
143143
* These global configuration flags configure some global dock manager
144144
* settings.
145+
* Set the dock manager flags, before you create the dock manager instance.
145146
*/
146147
enum eConfigFlag
147148
{
@@ -209,12 +210,14 @@ class ADS_EXPORT CDockManager : public CDockContainerWidget
209210

210211
/**
211212
* Sets the global configuration flags for the whole docking system.
212-
* Call this function before you create your first dock widget.
213+
* Call this function before you create the dock manager and before
214+
* your create the first dock widget.
213215
*/
214216
static void setConfigFlags(const ConfigFlags Flags);
215217

216218
/**
217-
* Set a certain config flag
219+
* Set a certain config flag.
220+
* \see setConfigFlags()
218221
*/
219222
static void setConfigFlag(eConfigFlag Flag, bool On = true);
220223

0 commit comments

Comments
 (0)