diff options
Diffstat (limited to 'AudioManagerDaemon')
| -rw-r--r-- | AudioManagerDaemon/docx/02_license.dox | 8 | ||||
| -rw-r--r-- | AudioManagerDaemon/docx/15_a_CommandLineParsing.dox | 45 | ||||
| -rw-r--r-- | AudioManagerDaemon/docx/Doxyfile.in | 8 | ||||
| -rwxr-xr-x | AudioManagerDaemon/src/main.cpp | 3 |
4 files changed, 56 insertions, 8 deletions
diff --git a/AudioManagerDaemon/docx/02_license.dox b/AudioManagerDaemon/docx/02_license.dox index 45f68f3..c54190e 100644 --- a/AudioManagerDaemon/docx/02_license.dox +++ b/AudioManagerDaemon/docx/02_license.dox @@ -17,9 +17,11 @@ /*! \page lic License -\section contr Code Contribution License -The contribution is done under GENIVI CLA, please see here: -https://collab.genivi.org/wiki/display/genivi/Code+Contribution+Team +\section proj Open Source Projects in the source tree +The AudioManger comes with some open source software distributed in the source tree: +- Google Mock (in \googleMock), licensed under MIT license +- Tclap ( in \tclap-1.2.1), licensed under MIT license +- The headers of the NSM, licensed under MPL 2.0 \section split License Split The licenses of this project are split into two parts:\n 1. the AudioManagerDaemon, licensed under MPL 2.0\n diff --git a/AudioManagerDaemon/docx/15_a_CommandLineParsing.dox b/AudioManagerDaemon/docx/15_a_CommandLineParsing.dox new file mode 100644 index 0000000..74dd2e0 --- /dev/null +++ b/AudioManagerDaemon/docx/15_a_CommandLineParsing.dox @@ -0,0 +1,45 @@ + /* + * Copyright (C) 2012, BMW AG + * + * This file is part of GENIVI Project AudioManager. + * + * Contributions are licensed to the GENIVI Alliance under one or more + * Contribution License Agreements. + * + * \copyright + * This Source Code Form is subject to the terms of the + * Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with + * this file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * \\author Christian Linke (christian.linke@bmw.de) + * + */ + /*! +\page cmdline CommandLineParsing +\section tclap TCLAP +Commandline parsing is accomplished via a template library that is added to the source tree of the Audiomanager: TCLAP. +The license of this libraty is MIT. +It manages commandline parsing in a handy way. More information can be found here: +http://tclap.sourceforge.net +\section cmdplugins CommandLine Parsing in the Plugins +The commandline Class that parses the commandline can be accessed via am::CAmCommandLineSingleton . This factory creates +a commandline object that can be accessed everywhere in the Audiomanager. +In the constructor of a plugin, the plugins can add commandline arguments they hold as member. +Here the member, in this case of type TCLAP::ValueArg<std::string> mCommandLineArg; + +\code +mCommandLineArg("K","controllerPluginArg","a test argument for the controller",false,"bla","string") +\endcode + +In the constructor, add the argument to the commandline like this +\code +CAmCommandLineSingleton::instance()->add(mCommandLineArg); +\endcode +And then in the startup controller routine (or later) you can get the value of the argument, like +\code +mCommandLineArg.getValue() +\endcode + +An example can be found in the plugins repository in the test controller. + +*/ diff --git a/AudioManagerDaemon/docx/Doxyfile.in b/AudioManagerDaemon/docx/Doxyfile.in index 5f04e05..8cd141f 100644 --- a/AudioManagerDaemon/docx/Doxyfile.in +++ b/AudioManagerDaemon/docx/Doxyfile.in @@ -93,9 +93,9 @@ FILE_PATTERNS = *.h *.cpp *.dox RECURSIVE = YES EXCLUDE = EXCLUDE_SYMLINKS = NO -EXCLUDE_PATTERNS = */test/* */build*/* */cmake/* */googleMock/* +EXCLUDE_PATTERNS = */test/* */build*/* */cmake/* */googleMock/* */tclap*/* EXCLUDE_SYMBOLS = -EXAMPLE_PATH = @CMAKE_SOURCE_DIR@ +EXAMPLE_PATH = EXAMPLE_PATTERNS = EXAMPLE_RECURSIVE = NO IMAGE_PATH = @CMAKE_SOURCE_DIR@/AudioManagerDaemon/docx/images @@ -231,8 +231,8 @@ SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration::additions related to external references #--------------------------------------------------------------------------- -TAGFILES = qtools_docs/qtools.tag=../../qtools_docs/html -GENERATE_TAGFILE = +TAGFILES = +GENERATE_TAGFILE = NO ALLEXTERNALS = NO EXTERNAL_GROUPS = YES PERL_PATH = /usr/bin/perl diff --git a/AudioManagerDaemon/src/main.cpp b/AudioManagerDaemon/src/main.cpp index c2bb2f2..6891a5c 100755 --- a/AudioManagerDaemon/src/main.cpp +++ b/AudioManagerDaemon/src/main.cpp @@ -255,7 +255,7 @@ void mainProgram(int argc, char *argv[]) //initialize the commandline parser, and add all neccessary commands try { - TCLAP::CmdLine* cmd(CAmCommandLineSingleton::instanciateOnce("AudioManager CommandLine Options",' ',DAEMONVERSION,true)); + TCLAP::CmdLine* cmd(CAmCommandLineSingleton::instanciateOnce("The team of the AudioManager wishes you a nice day!",' ',DAEMONVERSION,true)); cmd->add(controllerPlugin_); cmd->add(additionalCommandPluginDirs); @@ -410,6 +410,7 @@ void mainProgram(int argc, char *argv[]) int main(int argc, char *argv[], char** envp) { (void) envp; + printf("bla %s",DEFAULT_PLUGIN_COMMAND_DIR); listCommandPluginDirs.push_back(std::string(DEFAULT_PLUGIN_COMMAND_DIR)); listRoutingPluginDirs.push_back(std::string(DEFAULT_PLUGIN_ROUTING_DIR)); |