// Add a new directory to the root and document it. All the mutators return the node object
// itself so operations can be chained.
- senf::console::DirectoryNode & mydir (
+ senf::console::DirectoryNode & mydir ( senf::console::root()
.mkdir("myserver")
.doc("My server specific directory"));
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
///< 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)
/**< \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;
/**< 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;
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: