summaryrefslogtreecommitdiffstats
path: root/src/corelib/tools/qcommandlineparser.cpp
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@digia.com>2014-12-12 10:38:07 +0100
committerNico Vertriest <nico.vertriest@digia.com>2014-12-12 15:33:14 +0100
commitfff996e8ad39ff2d32dc2214b3af7fba401f1eda (patch)
treefc65c03bed237fef2c62df10b6aac24bcbbb572c /src/corelib/tools/qcommandlineparser.cpp
parentdc583a0576343cfcd5544a21b8625af61e299e6f (diff)
Doc: corrected documentation addOptions()
Task-number: QTBUG-43259 Change-Id: If27c0658f7abaa4ce01de343ce90c14bd911212f Reviewed-by: Martin Smith <martin.smith@digia.com>
Diffstat (limited to 'src/corelib/tools/qcommandlineparser.cpp')
-rw-r--r--src/corelib/tools/qcommandlineparser.cpp8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/corelib/tools/qcommandlineparser.cpp b/src/corelib/tools/qcommandlineparser.cpp
index c3edba0514..01772b2ad5 100644
--- a/src/corelib/tools/qcommandlineparser.cpp
+++ b/src/corelib/tools/qcommandlineparser.cpp
@@ -340,11 +340,13 @@ bool QCommandLineParser::addOption(const QCommandLineOption &option)
/*!
\since 5.4
- Adds the options \a options to look for while parsing.
+ Adds the options to look for while parsing. The options are specified by
+ the parameter \a options.
- Returns \c false if adding any of the options failed; otherwise returns \c false.
+ Returns \c true if adding all of the options was successful; otherwise
+ returns \c false.
- Cf. addOption() for when it may fail.
+ See the documentation for addOption() for when this function may fail.
*/
bool QCommandLineParser::addOptions(const QList<QCommandLineOption> &options)
{