X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FUtils%2FConsole%2FProgramOptions.hh;h=2baecb201b86aa930d8d40af782b7b990a4ec64a;hb=99c145da3884f5c20a74337927ef2cbc073d80d7;hp=2f985f3494952f3bee2703efb6948a0619c6f8d3;hpb=601d1f509f5bb24df167a4dd5a20da67a0af9af8;p=senf.git diff --git a/senf/Utils/Console/ProgramOptions.hh b/senf/Utils/Console/ProgramOptions.hh index 2f985f3..2baecb2 100644 --- a/senf/Utils/Console/ProgramOptions.hh +++ b/senf/Utils/Console/ProgramOptions.hh @@ -1,6 +1,6 @@ // $Id$ // -// Copyright (C) 2008 +// Copyright (C) 2008 // Fraunhofer Institute for Open Communication Systems (FOKUS) // Competence Center NETwork research (NET), St. Augustin, GERMANY // Stefan Bund @@ -32,7 +32,7 @@ //#include "ProgramOptions.mpp" #include "ProgramOptions.ih" -///////////////////////////////hh.p//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// namespace senf { namespace console { @@ -54,7 +54,7 @@ namespace console { // Parse only options under the directory of some object. The object 'ob' // must have been registered somewhere in the node tree cf.parse(ob.dir); - + // Parse rest of the config file cf.parse(); \endcode @@ -68,19 +68,19 @@ namespace console { : public detail::BundleMixin { public: - /////////////////////////////////////////////////////////////////////////// + //-//////////////////////////////////////////////////////////////////////// ///\name Structors and default members - ///@{ - + //\{ + ProgramOptions(int argc, char const ** argv, DirectoryNode & root = root()); ///< Create ProgramOptions parser for given options /**< The given argc/argv values are those passed to main by the operating system. Especially argv[0] is \e not an option and is ignored. */ - ///@} - /////////////////////////////////////////////////////////////////////////// - + //\} + //-//////////////////////////////////////////////////////////////////////// + template ProgramOptions & nonOptions(Container & container); ///< Set container to add non-option arguments to @@ -96,7 +96,7 @@ namespace console { line. This argument will be appended (with an additional '=') to \a longOpt. If \a withArg is \c false (the default), \a longOpt may optional contain an - argument. + argument. \param[in] letter option letter \param[in] longOpt long option alias \param[in] withArg \c true, if the option should take @@ -108,7 +108,7 @@ namespace console { /** \brief Parse command line options - The command line otpions in \a argc / \a argv will be parsed, interpreting all node's + The command line options in \a argc / \a argv will be parsed, interpreting all node's relative to \a root as root node. \related ProgramOptions @@ -117,7 +117,7 @@ namespace console { /** \brief ConfigBundle source reading command line options - This cosntructor is used to create aconfig source parsing the given command line options to + This constructor is used to create a config source parsing the given command line options to add to a ConfigBundle. \related ProgramOptions @@ -125,7 +125,7 @@ namespace console { detail::ProgramOptionsSource::ptr OptionsConfig(int argc, char const ** argv); }} -///////////////////////////////hh.e//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// #include "ProgramOptions.cci" //#include "ProgramOptions.ct" #include "ProgramOptions.cti"