X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FUtils%2FConsole%2FUtility.hh;h=6cf243308d28dc2b131e4f09acb8200cd007ee0b;hb=9cb871b939efe93e35dd96808d25089399acfc46;hp=0e30fb470002972513084ff271f918c32bea25ec;hpb=3a43b572a2c0028b353d47e86fa7546633d6e2cf;p=senf.git diff --git a/senf/Utils/Console/Utility.hh b/senf/Utils/Console/Utility.hh index 0e30fb4..6cf2433 100644 --- a/senf/Utils/Console/Utility.hh +++ b/senf/Utils/Console/Utility.hh @@ -1,6 +1,6 @@ // $Id$ // -// Copyright (C) 2009 +// Copyright (C) 2009 // Fraunhofer Institute for Open Communication Systems (FOKUS) // Competence Center NETwork research (NET), St. Augustin, GERMANY // Stefan Bund @@ -51,7 +51,7 @@ namespace console { argument/return type \a CharT to CharAsString: \code char foo(char v) { return v; } - + senf::console::root().add( "foo", boost::function< CharAsString (CharAsString) >(&foo)); \endcode @@ -67,7 +67,7 @@ namespace console { CharAsString(CharT value_); operator CharT () const; CharT value; - }; + }; #ifndef DOXYGEN @@ -76,7 +76,7 @@ namespace console { { typedef CharAsString type; static bool const singleToken = true; - + static void parse(ParseCommandInfo::TokensRange const & tokens, CharAsString & out); static std::string description(); static std::string str(CharAsString value); @@ -86,14 +86,14 @@ namespace console { struct ReturnValueTraits< CharAsString > { typedef CharAsString type; - + static void format(CharAsString value, std::ostream & os); }; #endif /** \brief Value range - + A value range may be represented in the console either by a single value (setting both \a low and \a high to the same value) or as a lower and upper bound seperated by a colon. @@ -132,7 +132,7 @@ namespace console { /** \brief Bit-mask flag argument type senf::console::FlagCollection supplies a special argument type for use in registering - console commands. This argument type is used to represent a bit-mask of single flags. + console commands. This argument type is used to represent a bit-mask of single flags. \code // Function taking a flags argument @@ -144,7 +144,7 @@ namespace console { Baz = 4, Doo = 8 }; SENF_CONSOLE_REGISTER_ENUM(MyFlags, (Foo)(Bar)(Baz)(Boo)); - + // Register the function with a FlagCollection argument type consoleDir.add("func", boost::function)>(&func)); \endcode @@ -157,7 +157,7 @@ namespace console { The nice thing is, that \c boot::function supports compatible argument types and does automatic type conversion. Since a FlagCollection is convertible to and from unsigned long, - this conversion will work. + this conversion will work. After registering this function, you can call it with a collection of flags as argument