From 823887daf8065f525c23afdadc99abac667040c2 Mon Sep 17 00:00:00 2001 From: ARSanderson Date: Mon, 11 Apr 2022 23:58:18 -0600 Subject: [PATCH] Tidy/doc updates (#410) * minor updates to clarify when the dock manager should be created * fixed typos --- README.md | 5 +++-- doc/user-guide.md | 7 ++++--- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 335b7fd..8b094ce 100644 --- a/README.md +++ b/README.md @@ -286,8 +286,9 @@ MainWindow::MainWindow(QWidget *parent) : { ui->setupUi(this); - // Create the dock manager. Because the parent parameter is a QMainWindow - // the dock manager registers itself as the central widget. + // Create the dock manager after the ui is setup. Because the + // parent parameter is a QMainWindow the dock manager registers + // itself as the central widget as such the ui must be set up first. m_DockManager = new ads::CDockManager(this); // Create example content label - this can be any application specific diff --git a/doc/user-guide.md b/doc/user-guide.md index 531184f..efc6386 100644 --- a/doc/user-guide.md +++ b/doc/user-guide.md @@ -52,9 +52,10 @@ configuration will be explained in detail in the following sections. ### Setting Configuration Flags -You should set the configuration flags before you create the dock manager -instance. That means, setting the configurations flags is the first thing -you do, if you use the library. +You must set the configuration flags before creating the dock manager +instance otherwise the manager will not be created correctly and will +crash upon being created. That means, setting the configurations flags +is the first thing you must do, if you use the library. ```c++ CDockManager::setConfigFlags(CDockManager::DefaultOpaqueConfig);