diff options
author | Casper van Donderen <casper.vandonderen@nokia.com> | 2012-03-01 19:39:25 +0100 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-03-05 09:21:45 +0100 |
commit | 2efc7134d4caf48a2853cc606b9a9f31df996b43 (patch) | |
tree | 884252a2b4340fcd46427710056db74f985a90a3 /tools/xmlpatterns | |
parent | 8cdd26295be30f951213ea511e96c2b4133be27e (diff) | |
download | qtxmlpatterns-2efc7134d4caf48a2853cc606b9a9f31df996b43.tar.gz |
Remove the usage of deprecated qdoc macros.
QDoc now has support for Doxygen style commands for italics, bold
and list items. This change applies that change in QDoc to the
actual documentation.
Task-number: QTBUG-24578
Change-Id: I453169a7222ee741f8d9a10b6c063be5d15f1b76
Reviewed-by: Honglei Zhang <honglei.zhang@nokia.com>
Diffstat (limited to 'tools/xmlpatterns')
-rw-r--r-- | tools/xmlpatterns/qapplicationargument.cpp | 24 | ||||
-rw-r--r-- | tools/xmlpatterns/qapplicationargumentparser.cpp | 18 |
2 files changed, 21 insertions, 21 deletions
diff --git a/tools/xmlpatterns/qapplicationargument.cpp b/tools/xmlpatterns/qapplicationargument.cpp index a487350..d400a59 100644 --- a/tools/xmlpatterns/qapplicationargument.cpp +++ b/tools/xmlpatterns/qapplicationargument.cpp @@ -59,23 +59,23 @@ QT_BEGIN_NAMESPACE \table \header - \o Characteristic - \o Functions + \li Characteristic + \li Functions \row - \o A name. For instance, "backend" - \o setName() and name() + \li A name. For instance, "backend" + \li setName() and name() \row - \o A description, for human consumption. - \o setDescription() and description() + \li A description, for human consumption. + \li setDescription() and description() \row - \o How many times the argument can occur. For instance, whether the argument is optional or not. - \o setMinimumOccurrence() & minimumOccurrence(), setMaximumOccurrence() & maximumOccurrence() + \li How many times the argument can occur. For instance, whether the argument is optional or not. + \li setMinimumOccurrence() & minimumOccurrence(), setMaximumOccurrence() & maximumOccurrence() \row - \o The type of the argument's value, if it has one. For instance, \c int or \c bool. - \o setType() and type() + \li The type of the argument's value, if it has one. For instance, \c int or \c bool. + \li setType() and type() \row - \o The value that should be used in case the argument isn't used. - \o setDefaultValue() and defaultValue() + \li The value that should be used in case the argument isn't used. + \li setDefaultValue() and defaultValue() \endtable \sa QApplicationArgumentParser diff --git a/tools/xmlpatterns/qapplicationargumentparser.cpp b/tools/xmlpatterns/qapplicationargumentparser.cpp index 0e2e4ed..62bd3e2 100644 --- a/tools/xmlpatterns/qapplicationargumentparser.cpp +++ b/tools/xmlpatterns/qapplicationargumentparser.cpp @@ -65,13 +65,13 @@ QT_BEGIN_NAMESPACE QApplicationArgumentParser simplifies writing command line applications by taking care of: \list - \o Generating help and version arguments - \o Taking care of converting arguments to QVariant types, since each argument + \li Generating help and version arguments + \li Taking care of converting arguments to QVariant types, since each argument has a type: QApplicationArgument::type() - \o Validates the command line such that the user operates on well-defined input. For instance, + \li Validates the command line such that the user operates on well-defined input. For instance, that the argument is a valid integer if that is the case, that an argument does not occur more times than allowed, and so on. - \o Allows customization through sub-classing. + \li Allows customization through sub-classing. \endlist The user declares what arguments that can be given to the application with QApplicationArgument. Provided @@ -107,12 +107,12 @@ QT_BEGIN_NAMESPACE parse(). It would do the following: \list - \o Call input() to retrieve the strings the user specified on the command line. - \o Call declaredArguments() to retrieve the arguments that the implementor has + \li Call input() to retrieve the strings the user specified on the command line. + \li Call declaredArguments() to retrieve the arguments that the implementor has decided can be specified. - \o Parse and validate the input. Salt and pepper as per taste. - \o If an error occurred, call setExitCode() and return \c false. - \o Otherwise, call setExitCode(Success), provide access to the + \li Parse and validate the input. Salt and pepper as per taste. + \li If an error occurred, call setExitCode() and return \c false. + \li Otherwise, call setExitCode(Success), provide access to the arguments by calling setUsedArguments(), and return \c true. If a help message was requested, call setExitCode(Success) and return \c false. \endlist |