diff options
| author | trialuser02 <trialuser02@90c681e8-e032-0410-971d-27865f9a5e38> | 2017-10-24 20:49:28 +0000 |
|---|---|---|
| committer | trialuser02 <trialuser02@90c681e8-e032-0410-971d-27865f9a5e38> | 2017-10-24 20:49:28 +0000 |
| commit | fc595e1a34265a1538343440f8f1e11dc59c6cf8 (patch) | |
| tree | 02b95cb3288f37afbde55d6568b01274fee82426 /src/qmmpui/commandlinemanager.h | |
| parent | 2f300cd969c2c1dc4cf91686f563c32573628601 (diff) | |
| download | qmmp-fc595e1a34265a1538343440f8f1e11dc59c6cf8.tar.gz qmmp-fc595e1a34265a1538343440f8f1e11dc59c6cf8.tar.bz2 qmmp-fc595e1a34265a1538343440f8f1e11dc59c6cf8.zip | |
updated API documentation
git-svn-id: http://svn.code.sf.net/p/qmmp-dev/code/trunk/qmmp@7637 90c681e8-e032-0410-971d-27865f9a5e38
Diffstat (limited to 'src/qmmpui/commandlinemanager.h')
| -rw-r--r-- | src/qmmpui/commandlinemanager.h | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/src/qmmpui/commandlinemanager.h b/src/qmmpui/commandlinemanager.h index 647e5a2e6..974c064fa 100644 --- a/src/qmmpui/commandlinemanager.h +++ b/src/qmmpui/commandlinemanager.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2008-2012 by Ilya Kotov * + * Copyright (C) 2008-2017 by Ilya Kotov * * forkotov02@ya.ru * * * * This program is free software; you can redistribute it and/or modify * @@ -25,28 +25,31 @@ #include "commandlineoption.h" -/*! @brief Helper class used for handle command line plugins +/*! @brief Helper class used for handle command line plugins. * @author Ilya Kotov <forkotov02@ya.ru> */ class CommandLineManager { public: /*! - * Executes command \b opt_str - * @param opt_str Command line option string - * @param args Command arguments - * @return Command output result + * Executes command \b opt_str. + * @param opt_str Command line option string. + * @param args Command arguments. + * @return Command output result. */ static QString executeCommand(const QString& opt_str, const QStringList &args = QStringList()); /*! - * Return \b true if command \b opt_str is supported, otherwise returns \b false + * Return \b true if command \b opt_str is supported, otherwise returns \b false. */ static bool hasOption(const QString &opt_str); /*! - * Prints usage to stdout + * Prints usage to stdout. */ static void printUsage(); - + /*! + * Prepares help string for output. + * @param line Specially formatted help string. Example: "--command||description". + */ static QString formatHelpString(const QString &line); private: |