diff options
author | Oswald Buddenhagen <oswald.buddenhagen@digia.com> | 2014-04-15 19:45:01 +0200 |
---|---|---|
committer | Oswald Buddenhagen <oswald.buddenhagen@digia.com> | 2014-05-19 14:28:17 +0200 |
commit | 07f06ca9826a8e53ba25b9b210536cc8f548f654 (patch) | |
tree | 50fc10138800cd570c379e41bb7a60ee9b518ba2 /doc | |
parent | ed3606a61ed8a558724528767143c57ce63b55fe (diff) |
random doc improvements
Change-Id: I5dca4ca660ee6423c26e33e3b4643a67d99f1ad2
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/reference/items/depends.qdoc | 2 | ||||
-rw-r--r-- | doc/reference/items/group.qdoc | 11 | ||||
-rw-r--r-- | doc/reference/items/product.qdoc | 2 | ||||
-rw-r--r-- | doc/reference/items/rule.qdoc | 8 |
4 files changed, 12 insertions, 11 deletions
diff --git a/doc/reference/items/depends.qdoc b/doc/reference/items/depends.qdoc index ce633e5fa..17816a455 100644 --- a/doc/reference/items/depends.qdoc +++ b/doc/reference/items/depends.qdoc @@ -35,7 +35,7 @@ \ingroup list-of-items \title Depends Item - \brief Represents dependencies between between products and modules. + \brief Represents dependencies between products and modules. A \c Depends item can appear inside a \l{Product Item} or \l{Module Item}. diff --git a/doc/reference/items/group.qdoc b/doc/reference/items/group.qdoc index 5c03a4c97..89acd08f7 100644 --- a/doc/reference/items/group.qdoc +++ b/doc/reference/items/group.qdoc @@ -60,7 +60,7 @@ name: "Files to install" qbs.install: true qbs.installDir: "share" - files "runtime_resource.txt" + files: "runtime_resource.txt" } } \endcode @@ -129,10 +129,11 @@ \li overrideTags \li bool \li true - \li If the same file appears in the files list of both the top level of a product and - a group and this property is true, then the file tags set via the group - replace the ones set via the product. If it is false, the "group tags" are added to - the "product tags". + \li Determines how tags on files that are listed both at the top level of + a product and a group are handled. + If this property is true, then the file tags set via the group + replace the ones set via the product. + If it is false, the "group tags" are added to the "product tags". \row \li excludeFiles \li list diff --git a/doc/reference/items/product.qdoc b/doc/reference/items/product.qdoc index f973d2b8c..28737c9b9 100644 --- a/doc/reference/items/product.qdoc +++ b/doc/reference/items/product.qdoc @@ -123,7 +123,7 @@ \li stringList \li project.qbsSearchPaths \li See the documentation of the \l {Project Item} property of the same name. - Setting this property here will overwrite the default value inherited from + Setting this property here will override the default value inherited from the project, so use the \c concat() function if you want to add something. \row \li version diff --git a/doc/reference/items/rule.qdoc b/doc/reference/items/rule.qdoc index c31f8d776..9a174e49c 100644 --- a/doc/reference/items/rule.qdoc +++ b/doc/reference/items/rule.qdoc @@ -39,10 +39,10 @@ A \e {multiplex rule} creates one \e transformer that takes all input artifacts with the matching input file tag and creates one or more artifacts (e.g. C++ linker). - A \e {non-multiplex rule} creates one transformer per matching input file (e.g. C++ - compiler). - As a real-world example of a non-multiplex rule, here is a simplified version of \QBS' rule for - transforming C++ sources into object files using gcc: + A \e {simplex rule} creates one transformer per matching input file + (e.g. C++ compiler). + As a real-world example of a simplex rule, here is a simplified version + of \QBS' rule for transforming C++ sources into object files using gcc: \code Rule { id: compiler |