summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKonstantin Shegunov <kshegunov@gmail.com>2016-07-24 22:14:49 +0300
committerKonstantin Shegunov <kshegunov@gmail.com>2016-07-29 21:18:07 +0000
commitf0685992a3412b059a0952ac591f40856ffffb6f (patch)
tree9bbde2b5daa3521d5f0cf512b4a5ee465b646c78
parent8a33077853e851e2795476cd502444c2d8535f9a (diff)
Docs changed to reflect that valueName is required with value parsing
When the option expects a value the valueName parameter of the constructor isn't optional; it must be set. This requirement is made explicit in the documentation. Task-number: QTBUG-54855 Change-Id: I190884aff2fa8e96bc5c5e82cdfed85be761d6e3 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com> Reviewed-by: David Faure <david.faure@kdab.com>
-rw-r--r--src/corelib/tools/qcommandlineoption.cpp4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/corelib/tools/qcommandlineoption.cpp b/src/corelib/tools/qcommandlineoption.cpp
index 8c0ba8cb2b..93d20577c3 100644
--- a/src/corelib/tools/qcommandlineoption.cpp
+++ b/src/corelib/tools/qcommandlineoption.cpp
@@ -144,7 +144,7 @@ QCommandLineOption::QCommandLineOption(const QStringList &names)
The description is set to \a description. It is customary to add a "."
at the end of the description.
- In addition, the \a valueName can be set if the option expects a value.
+ In addition, the \a valueName needs to be set if the option expects a value.
The default value for the option is set to \a defaultValue.
In Qt versions before 5.4, this constructor was \c explicit. In Qt 5.4
@@ -180,7 +180,7 @@ QCommandLineOption::QCommandLineOption(const QString &name, const QString &descr
The description is set to \a description. It is customary to add a "."
at the end of the description.
- In addition, the \a valueName can be set if the option expects a value.
+ In addition, the \a valueName needs to be set if the option expects a value.
The default value for the option is set to \a defaultValue.
In Qt versions before 5.4, this constructor was \c explicit. In Qt 5.4