diff options
| author | Christian Kandeler <christian.kandeler@digia.com> | 2013-09-23 12:20:18 +0200 |
|---|---|---|
| committer | Joerg Bornemann <joerg.bornemann@digia.com> | 2013-09-24 12:31:02 +0200 |
| commit | a75c868a87429ed3fb68ff38d2ad6a433594418a (patch) | |
| tree | 4fbd573a80b43592fc7f814c7d8c48c4402b6804 /doc | |
| parent | f9468db030f013d9a7d31fe73485f6b322c884af (diff) | |
| download | qbs-a75c868a87429ed3fb68ff38d2ad6a433594418a.tar.gz | |
Fix some documentation bugs.
- It's FileInfo.{to,from}WindowsSeparator*s* (plural), of course.
- It is plain wrong that the "inputs" and "outputs" variables are
mutually exclusive with "input" and "output", respectively, and it would
not make sense either.
Change-Id: I00c6eca9a6207cb50d5258834e4dfdc7a4345c8e
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/transformer.qdoc | 8 | ||||
| -rw-r--r-- | doc/reference/jsextensions/jsextension-fileinfo.qdoc | 8 |
2 files changed, 8 insertions, 8 deletions
diff --git a/doc/reference/items/transformer.qdoc b/doc/reference/items/transformer.qdoc index 2f3e26777..625bb02c1 100644 --- a/doc/reference/items/transformer.qdoc +++ b/doc/reference/items/transformer.qdoc @@ -63,10 +63,10 @@ \endcode This example exhibits some interesting features of transformers: \list - \li If there is only one input file, the property \c input is available to refer to it; - the \c inputs property is disabled. - \li The filenames of the output artifacts are available as \c outputs, unless there is - only one of them, in which case the same rule applies as for inputs. + \li If there is only one input file, the property \c input is available as syntactic sugar + for \c inputs[0]. + \li The filenames of the output artifacts are available as \c outputs. If there is only one + of these, it can be referred to it as \c output. \endlist A \c Transformer is always attached to a \c Product, possibly indirectly via a \c Module. diff --git a/doc/reference/jsextensions/jsextension-fileinfo.qdoc b/doc/reference/jsextensions/jsextension-fileinfo.qdoc index 76237f5aa..8535612ed 100644 --- a/doc/reference/jsextensions/jsextension-fileinfo.qdoc +++ b/doc/reference/jsextensions/jsextension-fileinfo.qdoc @@ -66,9 +66,9 @@ \endcode Returns the last component of \c filePath, i.e. everything after the last '/' character. - \section2 fromWindowsSeparator + \section2 fromWindowsSeparators \code - FileInfo.fromWindowsSeparator(filePath) + FileInfo.fromWindowsSeparators(filePath) \endcode Returns \c filePath with all '\\' characters replaced by '/'. @@ -102,9 +102,9 @@ The function assumes \c dirPath and \c filePath to be absolute paths and \c dirPath to be a directory. - \section2 toWindowsSeparator + \section2 toWindowsSeparators \code - FileInfo.toWindowsSeparator(filePath) + FileInfo.toWindowsSeparators(filePath) \endcode Returns \c filePath with all '/' characters replaced by '\\'. */ |