summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJake Petroules <jake.petroules@petroules.com>2013-09-02 23:31:26 -0400
committerJoerg Bornemann <joerg.bornemann@digia.com>2013-09-19 13:52:37 +0200
commit32f42d797063cd474778301ff9759dc76ec63a91 (patch)
tree9b6402540cfea6fc00c9df20caf66844840edec9 /doc
parent05c9a9b7c51351311446a96749f1e2b1e902e6a7 (diff)
downloadqbs-32f42d797063cd474778301ff9759dc76ec63a91.tar.gz
Add support for C, Objective-C and Objective-C++ precompiled headers.
Task-number: QBS-278 Change-Id: I2999a64168f70aff21007e55d52314433425e84e Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/modules/cpp-module.qdoc50
1 files changed, 47 insertions, 3 deletions
diff --git a/doc/reference/modules/cpp-module.qdoc b/doc/reference/modules/cpp-module.qdoc
index 24e3d3eca..818bf578b 100644
--- a/doc/reference/modules/cpp-module.qdoc
+++ b/doc/reference/modules/cpp-module.qdoc
@@ -155,20 +155,64 @@
\section2 precompiledHeader
\table
- \row \li \b{Type:} \li \c{string}
+ \row \li \b{Type:} \li \c{path}
\row \li \b{Default:} \li \c{undefined}
\endtable
+ Name of the header file to be precompiled.
+
+ If you want to use the same precompiled header for all languages (C, C++,
+ Objective-C and Objective-C++), set this property and ensure that the header
+ contains appropriate ifdefs.
+
+ Otherwise, use the \c{cPrecompiledHeader}, \c{cppPrecompiledHeader},
+ \c{objcPrecompiledHeader} and \c{objcppPrecompiledHeader} to specify
+ precompiled headers per-language.
+
+ \section2 cPrecompiledHeader
+
+ \table
+ \row \li \b{Type:} \li \c{path}
+ \row \li \b{Default:} \li \c{precompiledHeader}
+ \endtable
+
+ Name of the C header file to be precompiled.
+
+ \section2 cxxPrecompiledHeader
+
+ \table
+ \row \li \b{Type:} \li \c{path}
+ \row \li \b{Default:} \li \c{precompiledHeader}
+ \endtable
+
Name of the C++ header file to be precompiled.
+ \section2 objcPrecompiledHeader
+
+ \table
+ \row \li \b{Type:} \li \c{path}
+ \row \li \b{Default:} \li \c{precompiledHeader}
+ \endtable
+
+ Name of the Objective-C header file to be precompiled.
+
+ \section2 objcxxPrecompiledHeader
+
+ \table
+ \row \li \b{Type:} \li \c{path}
+ \row \li \b{Default:} \li \c{precompiledHeader}
+ \endtable
+
+ Name of the Objective-C++ header file to be precompiled.
+
\section2 precompiledHeaderDir
\table
- \row \li \b{Type:} \li \c{string}
+ \row \li \b{Type:} \li \c{path}
\row \li \b{Default:} \li \c{product.buildDirectory}
\endtable
- The directory that will contain the precompiled C++ header file.
+ The directory that will contain the precompiled header files.
Usually you won't need to set this.
\section2 optimization