From: g0dil <g0dil@270642c3-0616-0410-b53a-bc976706d245>
Date: Mon, 9 Aug 2010 12:25:22 +0000 (+0000)
Subject: more documentation fixes
X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=6aae6e526573187ece558842e928578e5aa4cc4c;p=senf.git

more documentation fixes

git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@1668 270642c3-0616-0410-b53a-bc976706d245
---

diff --git a/senf/Utils/Console/Mainpage.dox b/senf/Utils/Console/Mainpage.dox
index 5bdd3dc..3cee767 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
diff --git a/senf/Utils/Console/ParsedCommand.hh b/senf/Utils/Console/ParsedCommand.hh
index e14fd1c..86a2000 100644
--- a/senf/Utils/Console/ParsedCommand.hh
+++ b/senf/Utils/Console/ParsedCommand.hh
@@ -311,6 +311,8 @@ namespace console {
         \endhtmlonly
 
         \see \ref senf::console::ParsedArgumentAttributor::arg()
+
+        \ingroup console_commands
      */
     namespace kw {
         BOOST_PARAMETER_KEYWORD(type, name) ///< Argument name