some minor documentation updates

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

diff --git a/Utils/Console/Node.hh b/Utils/Console/Node.hh
index 4772b45..e96ea8e 100644 (file)
--- a/Utils/Console/Node.hh
+++ b/Utils/Console/Node.hh
@@ -223,8 +223,19 @@ namespace console {
     class DirectoryNode;
     class CommandNode;
 
+    /** \brief Get console root node */
     DirectoryNode & root();
 
+    /** \brief Dump console directory structure
+
+        Recursively dumps the console directory structure starting at \a dir. By default, dumps the
+        complete tree beginning at the root node.
+        
+        In contrast to the console 'lr' command, links are dumped by showing the \e absolute path
+        to the target node.
+     */
+    void dump(std::ostream & os, DirectoryNode & dir=root());
+
     /** \brief Config/console node tree base-class
 
         GenericNode is the base class of all node objects. There are two basic node types derived
@@ -621,7 +632,7 @@ namespace console {
                                         ///< Execute the command
                                         /**< \param[in] output stream where result messages may be
                                                  written to
-                                             \param[in] arguments command arguments. This is a
+                                             \param[in] command command arguments. This is a
                                                  range of ranges of Token instances. */
 
         void execute(boost::any & rv, std::ostream & output, ParseCommandInfo const & command) 
@@ -630,7 +641,7 @@ namespace console {
                                         /**< \param[out] rv command return value
                                              \param[in] output stream where result messages may be
                                                  written to
-                                             \param[in] arguments command arguments. This is a
+                                             \param[in] command command arguments. This is a
                                                  range of ranges of Token instances. */
 
         void operator()(std::ostream & output, ParseCommandInfo const & command) const;
@@ -638,7 +649,7 @@ namespace console {
                                         /**< Same as execute()
                                              \param[in] output stream where result messages may be
                                                  written to
-                                             \param[in] arguments command arguments. This is a
+                                             \param[in] command command arguments. This is a
                                                  range of ranges of Token instances. */
         void operator()(boost::any & rv, std::ostream & output, ParseCommandInfo const & command)
             const;
@@ -656,7 +667,9 @@ namespace console {
             const = 0;
                                         ///< Called to execute the command
                                         /**< \param[out] rv return value holder
-                                             \param[in] arguments command arguments. This is a
+                                              \param[in] os stream where result messages may be
+                                                 written to
+                                             \param[in] command command arguments. This is a
                                                  range of ranges of Token instances. */
 
     private: