Improved documentation for setting dock manager flags

This commit is contained in:
Uwe Kindler 2020-02-26 13:25:17 +01:00
parent 34cb2ae917
commit f3c5d51380

View File

@ -142,6 +142,7 @@ public:
/** /**
* These global configuration flags configure some global dock manager * These global configuration flags configure some global dock manager
* settings. * settings.
* Set the dock manager flags, before you create the dock manager instance.
*/ */
enum eConfigFlag enum eConfigFlag
{ {
@ -209,12 +210,14 @@ public:
/** /**
* Sets the global configuration flags for the whole docking system. * Sets the global configuration flags for the whole docking system.
* Call this function before you create your first dock widget. * Call this function before you create the dock manager and before
* your create the first dock widget.
*/ */
static void setConfigFlags(const ConfigFlags Flags); static void setConfigFlags(const ConfigFlags Flags);
/** /**
* Set a certain config flag * Set a certain config flag.
* \see setConfigFlags()
*/ */
static void setConfigFlag(eConfigFlag Flag, bool On = true); static void setConfigFlag(eConfigFlag Flag, bool On = true);