Fix documentation build under maverick (doxygen 1.7.1)

[senf.git] / senf / Utils / Console / Utility.hh

diff --git a/senf/Utils/Console/Utility.hh b/senf/Utils/Console/Utility.hh
index 5c2b263..8f37737 100644 (file)
--- 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 <g0dil@berlios.de>
@@ -28,14 +28,38 @@
 
 // Custom includes
 #include "Parse.hh"
-#include "Traits.hh"
 
 //#include "Utility.mpp"
-///////////////////////////////hh.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
+
+/** \defgroup senf_console_utilities Special console utility types
+
+    These types are provided by the %console library to support special argument or return value
+    formatting rules.
+ */
 
 namespace senf {
 namespace console {
 
+    /** \brief Parse character value as single-char string
+
+        This helper types is a wrapper around \a CharT which must be a character type. A value of
+        this type will be represented as a single character string, not as numeric value (the
+        default interpretation of char arguments in the console library).
+
+        This wrapper is used via type conversion using \c boost::function to convert the
+        argument/return type \a CharT  to CharAsString<CharT>:
+        \code
+        char foo(char v) { return v; }
+
+        senf::console::root().add(
+            "foo", fty::Command< CharAsString<char> (CharAsString<char>) >(&foo));
+        \endcode
+
+        \tparam CharT character type, one of \c char, \c signed \c char or \c unsigned \c char
+
+        \ingroup senf_console_utilities
+     */
     template <class CharT>
     struct CharAsString
     {
@@ -43,7 +67,7 @@ namespace console {
         CharAsString(CharT value_);
         operator CharT () const;
         CharT value;
-    };    
+    };
 
 #ifndef DOXYGEN
 
@@ -52,7 +76,7 @@ namespace console {
     {
         typedef CharAsString<CharT> type;
         static bool const singleToken = true;
-        
+
         static void parse(ParseCommandInfo::TokensRange const & tokens, CharAsString<CharT> & out);
         static std::string description();
         static std::string str(CharAsString<CharT> value);
@@ -62,16 +86,18 @@ namespace console {
     struct ReturnValueTraits< CharAsString<CharT> >
     {
         typedef CharAsString<CharT> type;
-        
+
         static void format(CharAsString<CharT> 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
+        low and \a high to the same value) or as a lower and upper bound seperated by a colon.
+
+        \ingroup senf_console_utilities
      */
     template <class T>
     struct ValueRange
@@ -106,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
@@ -118,9 +144,9 @@ 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<void (FlagCollection<MyFlags>)>(&func));
+        consoleDir.add("func", fty::Command<void (FlagCollection<MyFlags>)>(&func));
         \endcode
 
         To use the FlagCollection class
@@ -131,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
 
@@ -142,6 +168,8 @@ namespace console {
         console:/$ func Foo
         console:/$ func (Foo Boo)
         </pre>
+
+        \ingroup senf_console_utilities
      */
     template <class Enum>
     struct FlagCollection
@@ -176,7 +204,7 @@ namespace console {
 
 }}
 
-///////////////////////////////hh.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 //#include "Utility.cci"
 #include "Utility.ct"
 #include "Utility.cti"