Utils/Console: New add() API documentation updates

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

diff --git a/senf/Utils/Console/ScopedDirectory.hh b/senf/Utils/Console/ScopedDirectory.hh
index ddbf292..e5f1248 100644 (file)
--- a/senf/Utils/Console/ScopedDirectory.hh
+++ b/senf/Utils/Console/ScopedDirectory.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 <g0dil@berlios.de>
@@ -59,10 +59,16 @@ namespace console {
         CommandNode & getCommand(std::string const & name) const;
         CommandNode & operator()(std::string const & name) const;
         GenericNode & get(std::string const & name) const;
-        DirectoryNode & mkdir(std::string const & name);
-        void link(std::string const & name, GenericNode & node);
         DirectoryNode::ChildrenRange children() const;
         DirectoryNode & doc(std::string const & doc);
+        std::string const & name() const;
+        bool active() const;
+        std::string path() const;
+        std::string path(DirectoryNode const & root) const;
+        boost::shared_ptr<DirectoryNode> parent() const;
+        GenericNode::ptr unlink();
+        void help(std::ostream & output) const;
+        std::string shorthelp() const;
 
         ///\}
 
@@ -88,9 +94,9 @@ namespace console {
         public:
             ScopedDirectory<MyClass> configDir;
 
-            MyClass() : configDir(this) 
+            MyClass() : configDir(this)
             {
-                configDIr.add(...);
+                configDir.add(...);
             }
         };
         \endcode
@@ -114,7 +120,7 @@ namespace console {
     public:
         ///////////////////////////////////////////////////////////////////////////
         // Types
-        
+
         typedef Owner owner;
 
         ///////////////////////////////////////////////////////////////////////////