From: g0dil <g0dil@270642c3-0616-0410-b53a-bc976706d245>
Date: Fri, 28 Nov 2008 10:15:52 +0000 (+0000)
Subject: Documentation updates
X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=ee01b9007d97c64d0a34b91a3dc87ad5c5697df5;p=senf.git

Documentation updates

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

diff --git a/PPI/AnnotationRouter.hh b/PPI/AnnotationRouter.hh
index 2d331a8..0787cbb 100644
--- a/PPI/AnnotationRouter.hh
+++ b/PPI/AnnotationRouter.hh
@@ -41,9 +41,10 @@ namespace module {
     /** \brief Route packets to destination according to some annotation value
 
         This router takes packet on a single input and directs them to one of it outputs depending
-        on a packet annotation. Each output connected will be associated with a single annotation
-        value. Incoming packets for which no matching output is found are directed to a default
-        output. If this output is left unconnected, those packets will be dropped.
+        on a \link packet_usage_annotation packet annotation\endlink. Each output connected
+        will be associated with a single annotation value. Incoming packets for which no matching
+        output is found are directed to a default output. If this output is left unconnected, those
+        packets will be dropped.
 
         The \a AnnotationType template parameter defines the routing key. This annotation must
         support the following operations:
diff --git a/PPI/Setup.hh b/PPI/Setup.hh
index 9a06fa4..7c4c217 100644
--- a/PPI/Setup.hh
+++ b/PPI/Setup.hh
@@ -37,6 +37,8 @@
 namespace senf {
 namespace ppi {
 
+#ifdef DOXYGEN
+
     /** \brief Connect modules
 
         senf::ppi::connect() establishes a connection between two modules or, to be more precise,
@@ -52,17 +54,23 @@ namespace ppi {
         \li Either or both of the connectors are untyped (they accept/send arbitrary senf::Packet's)
         \li Both connectors send/accept the exactly same packet type.
 
+        Depending on the type of input or output, the connect call may require additional
+        arguments. See the respective module documentation for more information
+
         \throws connector::IncompatibleConnectorsException if the two connectors are not type
             compatible.
         
         \see \ref ppi_connections
      */
-    void connect(connector::GenericActiveOutput & source, connector::GenericPassiveInput & target);
+    void connect(connector::Connector & source, connector::Connector & target, ...);
 
-    /** \brief Connect modules
-        \see connect() */
+#else
+
+    void connect(connector::GenericActiveOutput & source, connector::GenericPassiveInput & target);
     void connect(connector::GenericPassiveOutput & source, connector::GenericActiveInput & target);
 
+#endif
+
 #ifndef DOXYGEN    
 
     template <class T, class C>
diff --git a/Scheduler/Console/Mainpage.dox b/Scheduler/Console/Mainpage.dox
index 1314b5d..3a378e2 100644
--- a/Scheduler/Console/Mainpage.dox
+++ b/Scheduler/Console/Mainpage.dox
@@ -119,26 +119,25 @@
 
 
     \section intro_usage Using the Console: Configuration files, Network console
+    \seechapter \ref console_access
 
     There are several ways to access the node tree:
     \li By parsing configuration files
     \li By parsing command line parameters
     \li By providing interactive or non-interactive network console access
 
-    \see console_access
-
 
     \section intro_nodes The node tree
+    \seechapter \ref node_tree
 
     The basic idea is, that the console/config library manages a directory structure of parameters
     and auxiliary commands. Parameters are just commands which set a parameter value so everything
     is either a directory entry (senf::console::DirectoryNode) or a command
     (senf::console::CommandNode).
     
-    \see \ref node_tree
-
 
     \section intro_commands Implementing console/config commands
+    \seechapter \ref console_commands
 
     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
@@ -150,8 +149,6 @@
     which will be called with an already parsed integer value (or throw a
     senf::console::SyntaxErrorException if the conversion fails). This will be the most often used
     command.
-
-    \see \ref console_commands
  */
 
 /** \defgroup console_access Accessing the Console/Config tree