X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FUtils%2FConsole%2FMainpage.dox;h=23c86015a5a81f67ced8def5be25ec44420d0074;hb=57daeae6f2e924ce3f16f9677c3474f531cba9e5;hp=5bdd3dc44775db3cefc4391201d2a9bf54f6e137;hpb=a29a9ca13ed8105681968759066ed7788c818cb8;p=senf.git diff --git a/senf/Utils/Console/Mainpage.dox b/senf/Utils/Console/Mainpage.dox index 5bdd3dc..23c8601 100644 --- a/senf/Utils/Console/Mainpage.dox +++ b/senf/Utils/Console/Mainpage.dox @@ -137,7 +137,8 @@ \section intro_commands Implementing console/config commands - \seechapter \ref console_commands + \seechapter \ref console_commands \n + \seechapter \ref senf::console::factory The console/config language does not define, how arguments are passed to the commands, it just tokenizes the input and passes the tokens to the commands which then handle the @@ -610,15 +611,16 @@ Depending on the object added, you can also bind to a more specific node type (e.g. senf::console::SimpleCommand) if you know the type of node returned. - Depending on the type of object added, there are additional attributes which can be set. These - attributes are always set by calling them on the factory return value. It is \e not guaranteed, - you can call these members on the node reference returned by the \c add() call. + Nodes are always added using a factory from the senf::console::factory namespace. The factory + has additional (type specific) attributes. These attributes are set by calling member functions + called 'attributors' on the temporary factory instance. It is \e not guaranteed, you can call + these members on the node reference returned by the \c add() call. \code namespace fty = senf::console::factory; - dir.add("name", fty::Command(callback) - .doc("The documentation") ); + dir.add("name", fty::Command(callback) .doc("The documentation") ); \endcode sets the \e doc attribute (if that is available, otherwise this will fail to compile). + \see senf::console::factory for a list of all node factories. \section console_manualparse Manually parsing command arguments @@ -681,7 +683,7 @@ \endhtmlonly As you can see above, the arguments and tokens are returned as + href="http://www.boost.org/doc/libs/release/libs/range/doc/html/range/reference/utilities/iterator_range.html"> boost::iterator_range instances. These behave much like containers: They have \c begin() and \c end() and some other useful members.