some minor documentation updates

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

diff --git a/Utils/Console/ConfigFile.cc b/Utils/Console/ConfigFile.cc
index 6674c4c..dd22b58 100644 (file)
--- a/Utils/Console/ConfigFile.cc
+++ b/Utils/Console/ConfigFile.cc
@@ -34,6 +34,7 @@
 
 ///////////////////////////////////////////////////////////////////////////
 // senf::console::detail::ConfigFileSource
+#ifndef DOXYGEN
 
 prefix_ void senf::console::detail::ConfigFileSource::v_parse(RestrictedExecutor & executor)
 {
@@ -47,6 +48,7 @@ prefix_ void senf::console::detail::ConfigFileSource::v_parse(RestrictedExecutor
             throw;
     }
 }
+#endif 
 
 ///////////////////////////////////////////////////////////////////////////
 

diff --git a/Utils/Console/ConfigFile.cci b/Utils/Console/ConfigFile.cci
index a655592..cff5ced 100644 (file)
--- a/Utils/Console/ConfigFile.cci
+++ b/Utils/Console/ConfigFile.cci
@@ -32,6 +32,7 @@
 
 ///////////////////////////////////////////////////////////////////////////
 // senf::console::detail::ConfigFileSource
+#ifndef DOXYGEN
 
 prefix_ senf::console::detail::ConfigFileSource::ptr
 senf::console::detail::ConfigFileSource::create(std::string const & filename)
@@ -49,6 +50,7 @@ senf::console::detail::ConfigFileSource::ignoreMissing()
 prefix_ senf::console::detail::ConfigFileSource::ConfigFileSource(std::string const & filename)
     : filename_ (filename), ignoreMissing_ (true)
 {}
+#endif 
 
 ///////////////////////////////////////////////////////////////////////////
 // senf::console::ConfigFile

diff --git a/Utils/Console/Node.cc b/Utils/Console/Node.cc
index 69e1bfb..335eb73 100644 (file)
--- a/Utils/Console/Node.cc
+++ b/Utils/Console/Node.cc
@@ -201,6 +201,7 @@ prefix_ std::string senf::console::DirectoryNode::v_shorthelp()
 
 ///////////////////////////////////////////////////////////////////////////
 // senf::console::detail::NodeTraverser
+#ifndef DOXYGEN
 
 prefix_ void senf::console::detail::NodeTraverser::operator()(std::string const & name)
 {
@@ -245,6 +246,7 @@ prefix_ senf::console::GenericNode & senf::console::detail::NodeTraverser::node(
     else
         return * dir_;
 }
+#endif
 
 ///////////////////////////////////////////////////////////////////////////
 // senf::console::SimpleCommandNode

diff --git a/Utils/Console/Node.cci b/Utils/Console/Node.cci
index e0e3d77..f1935b3 100644 (file)
--- a/Utils/Console/Node.cci
+++ b/Utils/Console/Node.cci
@@ -273,12 +273,14 @@ prefix_ senf::console::DirectoryNode::cptr senf::console::DirectoryNode::thisptr
 
 ///////////////////////////////////////////////////////////////////////////
 // senf::console::detail::NodeTraverser
+#ifndef DOXYGEN
 
 prefix_ senf::console::detail::NodeTraverser::NodeTraverser(DirectoryNode & root,
                                                             DirectoryNode & dir,
                                                             bool autocomplete)
     : root_ (root), dir_ (dir.thisptr()), autocomplete_ (autocomplete), init_ (false)
 {}
+#endif
 
 ///////////////////////////////////////////////////////////////////////////
 // senf::console::CommandNode

diff --git a/Utils/Console/Node.hh b/Utils/Console/Node.hh
index b8702be..e96ea8e 100644 (file)
--- a/Utils/Console/Node.hh
+++ b/Utils/Console/Node.hh
@@ -632,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) 
@@ -641,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;
@@ -649,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;
@@ -667,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:

diff --git a/Utils/Console/OverloadedCommand.hh b/Utils/Console/OverloadedCommand.hh
index 4402742..3be6b42 100644 (file)
--- a/Utils/Console/OverloadedCommand.hh
+++ b/Utils/Console/OverloadedCommand.hh
@@ -90,7 +90,7 @@ namespace console {
                                              empty before this call.
                                              \pre \a index < numArguments()
                                              \param[in] index Argument index
-                                             \param[outp doc Argument documentation */
+                                             \param[out] doc Argument documentation */
 
         std::string doc() const;        ///< Get overload documentation
         

diff --git a/Utils/Termlib/Editor.hh b/Utils/Termlib/Editor.hh
index d7cadde..7db6faf 100644 (file)
--- a/Utils/Termlib/Editor.hh
+++ b/Utils/Termlib/Editor.hh
@@ -225,9 +225,9 @@ namespace term {
 
         LineEditor(AbstractTerminal & terminal, AcceptCallback cb);
                                         ///< Create a LineEditor
-                                        /**< \parm[in] terminal abstract terminal interface
-                                             \parm[in] cb callback to call for complete input
-                                             line */
+                                        /**< \param[in] terminal abstract terminal interface
+                                             \param[in] cb callback to call for complete input
+                                                 line */
         
         ///////////////////////////////////////////////////////////////////////////
 

diff --git a/Utils/hexdump.cc b/Utils/hexdump.cc
index 3cf9b73..e332a6f 100644 (file)
--- a/Utils/hexdump.cc
+++ b/Utils/hexdump.cc
@@ -32,6 +32,7 @@
 //#include "hexdump.mpp"
 #define prefix_
 ///////////////////////////////cc.p////////////////////////////////////////
+#ifndef DOXYGEN
 
 prefix_ void senf::detail::HexDumper::operator()(unsigned char ch)
 {
@@ -65,6 +66,7 @@ prefix_ senf::detail::HexDumper::~HexDumper()
     }
 }
 
+#endif 
 ///////////////////////////////cc.e////////////////////////////////////////
 #undef prefix_
 //#include "hexdump.mpp"

diff --git a/Utils/hexdump.cci b/Utils/hexdump.cci
index 7544966..1b1d2ca 100644 (file)
--- a/Utils/hexdump.cci
+++ b/Utils/hexdump.cci
@@ -32,12 +32,13 @@
 
 ///////////////////////////////////////////////////////////////////////////
 //senf::detail::HexDumper
+#ifndef DOXYGEN
 
 prefix_ senf::detail::HexDumper::HexDumper(std::ostream & os, unsigned block_size)
     : os_ (os), ias_ (os_), block_size_ (block_size), offset_ (0)
 {}
 
-
+#endif 
 ///////////////////////////////cci.e///////////////////////////////////////
 #undef prefix_