X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FUtils%2FConsole%2FVariables.hh;h=de9da468d9041277eff4c05aecfec9bf5a0c7853;hb=463db052ea9d1c292bfd40301d0dc4963411485e;hp=71ed3c160c706b9afb315c15283b65416ad8cc1f;hpb=975639608e44e49058ccd52f05ffe6b21faeafef;p=senf.git diff --git a/senf/Utils/Console/Variables.hh b/senf/Utils/Console/Variables.hh index 71ed3c1..de9da46 100644 --- a/senf/Utils/Console/Variables.hh +++ b/senf/Utils/Console/Variables.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 @@ -45,7 +45,7 @@ namespace console { namespace factory { /** \brief Variable command attributes (const) - + \see VariableFactory */ template @@ -63,7 +63,7 @@ namespace factory { ConstVariableFactory formatter(Formatter formatter); OverloadedCommandNode & create(DirectoryNode & dir, std::string const & name) const; - + explicit ConstVariableFactory(Variable const & var); private: @@ -71,7 +71,7 @@ namespace factory { boost::optional doc_; boost::optional shortdoc_; }; - + /** \brief Variable command attributes Variable commands allow to register any arbitrary variable as a command node. The variable @@ -91,7 +91,7 @@ namespace factory { Since a variable command is added as a combination of two ordinary overloads, it is possible to register additional overloads with the same name before or after registering the - variable. + variable. It is also possible, to register a variable read-only. To achieve this, just wrap it with \c boost::cref(). Such a variable cannot be changed only queried. Therefore, it does not have @@ -130,7 +130,7 @@ namespace factory { \code void parser(senf::console::ParseCommandInfo::TokensRange const & tokens, value_type & out); \endcode - + where \c value_type is the type of the overload parameter. The parser must read and parse the complete \a tokens range and return the parsed value in \a