path: root/doc
diff options
authorAlexandru Croitor <alexandru.croitor@qt.io>2018-08-02 15:59:27 +0200
committerJoerg Bornemann <joerg.bornemann@qt.io>2019-01-29 14:25:28 +0000
commiteb83cf69323cb47bd9fb0418b814806bc42b6bbc (patch)
tree490d6a3089d19d85e2e2a3aad12732879cff52b3 /doc
parent5c84373d8d60a8b13df1fcdcd77480736952c095 (diff)
Clarify documentation of qbs.enableDebugCode
Change-Id: I441acf3b494756b0c123383a68f50bed37c6e6cb Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Diffstat (limited to 'doc')
1 files changed, 14 insertions, 1 deletions
diff --git a/doc/reference/modules/qbs-module.qdoc b/doc/reference/modules/qbs-module.qdoc
index 8b95d248f..2ca034397 100644
--- a/doc/reference/modules/qbs-module.qdoc
+++ b/doc/reference/modules/qbs-module.qdoc
@@ -123,7 +123,20 @@
\qmlproperty bool qbs::enableDebugCode
- Whether to compile debug code in the product.
+ Whether to enable debug functionality in the product. Not to be confused
+ with generation of debug symbols or the code optimization level.
+ The property changes the following things when enabled:
+ \list
+ \li Passes a flag to the Windows linker to link against a debug
+ Windows CRT (common runtime) library
+ (for example /MTd instead of /MT)
+ \endlist
+ The property changes the following things when disabled:
+ \list
+ \li Passes the \c{NDEBUG} define to the compiler
+ \endlist
Typically, this property is enabled for debug builds and disabled for
release builds.