Skip to content

Commit 823887d

Browse files
authored
Tidy/doc updates (#410)
* minor updates to clarify when the dock manager should be created * fixed typos
1 parent 78a4166 commit 823887d

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -286,8 +286,9 @@ MainWindow::MainWindow(QWidget *parent) :
286286
{
287287
ui->setupUi(this);
288288

289-
// Create the dock manager. Because the parent parameter is a QMainWindow
290-
// the dock manager registers itself as the central widget.
289+
// Create the dock manager after the ui is setup. Because the
290+
// parent parameter is a QMainWindow the dock manager registers
291+
// itself as the central widget as such the ui must be set up first.
291292
m_DockManager = new ads::CDockManager(this);
292293

293294
// Create example content label - this can be any application specific

doc/user-guide.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,10 @@ configuration will be explained in detail in the following sections.
5252

5353
### Setting Configuration Flags
5454

55-
You should set the configuration flags before you create the dock manager
56-
instance. That means, setting the configurations flags is the first thing
57-
you do, if you use the library.
55+
You must set the configuration flags before creating the dock manager
56+
instance otherwise the manager will not be created correctly and will
57+
crash upon being created. That means, setting the configurations flags
58+
is the first thing you must do, if you use the library.
5859

5960
```c++
6061
CDockManager::setConfigFlags(CDockManager::DefaultOpaqueConfig);

0 commit comments

Comments
 (0)