diff options
| author | trialuser02 <trialuser02@90c681e8-e032-0410-971d-27865f9a5e38> | 2009-03-11 19:16:16 +0000 |
|---|---|---|
| committer | trialuser02 <trialuser02@90c681e8-e032-0410-971d-27865f9a5e38> | 2009-03-11 19:16:16 +0000 |
| commit | 53693eaf4b75b5aa6767989a1e2d3ebfc2f443aa (patch) | |
| tree | a0b71f45a18af1e3e17e09d3492cbf2e3c8762cb /src/qmmpui/commandlinemanager.h | |
| parent | 8308415095dfcbff8d5b7c27045c47f310d6d755 (diff) | |
| download | qmmp-53693eaf4b75b5aa6767989a1e2d3ebfc2f443aa.tar.gz qmmp-53693eaf4b75b5aa6767989a1e2d3ebfc2f443aa.tar.bz2 qmmp-53693eaf4b75b5aa6767989a1e2d3ebfc2f443aa.zip | |
command line api documentation
git-svn-id: http://svn.code.sf.net/p/qmmp-dev/code/trunk/qmmp@840 90c681e8-e032-0410-971d-27865f9a5e38
Diffstat (limited to 'src/qmmpui/commandlinemanager.h')
| -rw-r--r-- | src/qmmpui/commandlinemanager.h | 36 |
1 files changed, 22 insertions, 14 deletions
diff --git a/src/qmmpui/commandlinemanager.h b/src/qmmpui/commandlinemanager.h index a6039c7c3..8f0660fb6 100644 --- a/src/qmmpui/commandlinemanager.h +++ b/src/qmmpui/commandlinemanager.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2008 by Ilya Kotov * + * Copyright (C) 2008-2009 by Ilya Kotov * * forkotov02@hotmail.ru * * * * This program is free software; you can redistribute it and/or modify * @@ -24,26 +24,34 @@ #include "commandlineoption.h" -/** - @author Ilya Kotov <forkotov02@hotmail.ru> -*/ +/*! @brief Helper class used for handle command line plugins + * @author Ilya Kotov <forkotov02@hotmail.ru> + */ class CommandLineManager : public General { -Q_OBJECT + Q_OBJECT public: + /*! + * Constructs a command line manager. + * @param parent QObject parent + */ CommandLineManager(QObject *parent = 0); - + /*! + * Object destructor. + */ ~CommandLineManager(); - - //general - - //properties - - //command line + /*! + * Executes command \b opt_str + * @param opt_str Command line option string + */ void executeCommand(const QString& opt_str); - - //static methods + /*! + * Return \b true if command \b opt_str is supported, otherwise \b false + */ static bool hasOption(const QString &opt_str); + /*! + * Prints usage to stdout + */ static void printUsage(); private: |