diff options
author | David Faure <david.faure@kdab.com> | 2013-08-31 00:32:21 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-09-10 19:07:13 +0200 |
commit | be3ff4176f125b35f3d4b4a8dc3b0ff65562e852 (patch) | |
tree | da6d510fb562ef8b49457900c7ae154f6c94e9e1 /src/corelib/doc/snippets/code/src_corelib_tools_qcommandlineparser.cpp | |
parent | 32fa8ab70471a6fdaba53d3241688364baef5ce2 (diff) |
QCommandLineParser: improve documentation
Based on feedback from Thiago
Change-Id: I8912447197e636732e5b8ac37e77d18b54e9b43d
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Diffstat (limited to 'src/corelib/doc/snippets/code/src_corelib_tools_qcommandlineparser.cpp')
-rw-r--r-- | src/corelib/doc/snippets/code/src_corelib_tools_qcommandlineparser.cpp | 79 |
1 files changed, 38 insertions, 41 deletions
diff --git a/src/corelib/doc/snippets/code/src_corelib_tools_qcommandlineparser.cpp b/src/corelib/doc/snippets/code/src_corelib_tools_qcommandlineparser.cpp index 569cb6af80..0ec45e04a7 100644 --- a/src/corelib/doc/snippets/code/src_corelib_tools_qcommandlineparser.cpp +++ b/src/corelib/doc/snippets/code/src_corelib_tools_qcommandlineparser.cpp @@ -38,11 +38,32 @@ ** ****************************************************************************/ +#include <qcommandlineparser.h> + +int main(int argc, char **argv) +{ + +{ +QCommandLineParser parser; //! [0] bool verbose = parser.isSet("verbose"); //! [0] +} +{ //! [1] +QCoreApplication app(argc, argv); +QCommandLineParser parser; +QCommandLineOption verboseOption("verbose"); +parser.addOption(verboseOption); +parser.process(app); +bool verbose = parser.isSet(verboseOption); +//! [1] +} + +{ +QCommandLineParser parser; +//! [2] // Usage: image-editor file // // Arguments: @@ -62,9 +83,14 @@ parser.addPositionalArgument("urls", QCoreApplication::translate("main", "URLs t // destination Destination directory. parser.addPositionalArgument("source", QCoreApplication::translate("main", "Source file to copy.")); parser.addPositionalArgument("destination", QCoreApplication::translate("main", "Destination directory.")); -//! [1] - //! [2] +} + +{ +//! [3] +QCoreApplication app(argc, argv); +QCommandLineParser parser; + parser.addPositionalArgument("command", "The command to execute."); // Call parse() to find out the positional arguments. @@ -80,6 +106,7 @@ if (command == "resize") { // ... } +/* This code results in context-dependent help: $ tool --help @@ -96,46 +123,16 @@ Options: Arguments: resize Resize the object to a new size. - -//! [2] - +*/ //! [3] -int main(int argc, char *argv[]) -{ - QCoreApplication app(argc, argv); - app.setApplicationName("my-copy-program"); - app.setApplicationVersion("1.0"); - - QCommandLineParser parser; - parser.addHelpOption("Test helper"); - parser.addVersionOption(); - parser.addRemainingArgument("source", QCoreApplication::translate("main", "Source file to copy.")); - parser.addRemainingArgument("destination", QCoreApplication::translate("main", "Destination directory.")); - - // A boolean option with a single name (-p) - QCommandLineOption showProgressOption("p", QCoreApplication::translate("main", "Show progress during copy")); - parser.addOption(showProgressOption); - - // A boolean option with multiple names (-f, --force) - QCommandLineOption forceOption(QStringList() << "f" << "force", "Overwrite existing files."); - parser.addOption(forceOption); - - // An option with a value - QCommandLineOption targetDirectoryOption(QStringList() << "t" << "target-directory", - QCoreApplication::translate("main", "Copy all source files into <directory>."), - QCoreApplication::translate("main", "directory")); - parser.addOption(targetDirectoryOption); - - // Process the actual command line arguments given by the user - parser.process(app); - - const QStringList args = parser.remainingArguments(); - // source is args.at(0), destination is args.at(1) +} - bool showProgress = parser.isSet(showProgressOption); - bool force = parser.isSet(forceOption); - QString targetDir = parser.value(targetDirectoryOption); - // ... +{ +//! [4] +QCommandLineParser parser; +parser.setApplicationDescription(QCoreApplication::translate("main", "The best application in the world")); +parser.addHelpOption(); +//! [4] } -//! [3] +} |