some small doc fixes

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

diff --git a/PPI/Connectors.hh b/PPI/Connectors.hh
index ea79933..4779c30 100644 (file)
--- a/PPI/Connectors.hh
+++ b/PPI/Connectors.hh
@@ -277,7 +277,7 @@ namespace connector {
                                              logic error in the module implementation and an
                                              exception is raised. */
 
-        Packet read();                  ///< Alias for \ref operator()()
+        Packet read();                  ///< Alias for operator()()
 
         OutputConnector & peer() const;
 
@@ -315,7 +315,7 @@ namespace connector {
     public:
         void operator()(Packet p);      ///< Send out a packet
 
-        void write(Packet p);           ///< Alias for \ref operator()()
+        void write(Packet p);           ///< Alias for operator()(Packet p)
 
         InputConnector & peer() const;
 

diff --git a/PPI/Mainpage.dox b/PPI/Mainpage.dox
index 08fd879..8ab4d4b 100644 (file)
--- a/PPI/Mainpage.dox
+++ b/PPI/Mainpage.dox
@@ -102,9 +102,9 @@
     Of these modules, normally only the application modules need to be implemented since the library
     provides an extensive set of reusable modules.
     
-    The following example module declares three \ref ppi_connectors: \c payload, \c stuffing and
-    \c output. These connectors are defined as \e public data members so they can be accessed from
-    the outside. This is important as we will see below.
+    The following example module declares three \ref ppi_connectors "Connectors": \c payload, 
+    \c stuffing and \c output. These connectors are defined as \e public data members so they
+    can be accessed from the outside. This is important as we will see below.
 
     \code
       class RateStuffer
@@ -306,11 +306,11 @@
     example by manually throttling some passive connector (see \ref
     senf::ppi::connector::PassiveConnector). 
 
-    To enable/disable automatic throttling, the \ref senf::ppi::Module::route() command returns a
-    reference to a \ref senf::ppi::Route instance. If this route is \e forwarding route, (that is,
-    of the connectors is passive and the other is active), the return value will be derived from
-    \ref senf::ppi::ForwardingRoute which provides members to control the throttle notification
-    forwarding.
+    To enable/disable automatic throttling, the \ref senf::ppi::module::Module::route() command 
+    returns a reference to a \ref senf::ppi::Route instance. If this route is \e forwarding route,
+    (that is, of the connectors is passive and the other is active), the return value will be 
+    derived from \ref senf::ppi::ForwardingRoute which provides members to control the throttle
+    notification forwarding.
     
     \see 
         senf::ppi::module::Module \n

diff --git a/PPI/Module.hh b/PPI/Module.hh
index 03fa40f..1404a3b 100644 (file)
--- a/PPI/Module.hh
+++ b/PPI/Module.hh
@@ -198,9 +198,9 @@ namespace module {
                                              The return value may be used to alter routing
                                              parameters like throttling parameters.
 
-                                             \param[in] source Data source, object which controls
+                                             \param[in] input Data source, object which controls
                                                  incoming data (connector or event)
-                                             \param[in] target Data target, object which controls
+                                             \param[in] output Data target, object which controls
                                                  outgoing data (connector or event)
                                              \returns Route instance describing this route 
                                              \see \ref ppi_throttling
@@ -227,8 +227,8 @@ namespace module {
         route(EventDescriptor & input, connector::OutputConnector & output);
                                         ///< Define flow information
                                         /**< Route from an event to a connector. Routing from an
-                                             event to a connector defeines the event as the
-                                             conceptual 'source' of the data. THis means, the event
+                                             event to a connector defines the event as the
+                                             conceptual 'source' of the data. This means, the event
                                              controls how packets are sent (Example: Routing from an
                                              IOEVent to an output defines, that output data will be
                                              generated whenever the event is signaled).

diff --git a/PPI/SocketSource.hh b/PPI/SocketSource.hh
index 92c0cda..de4dbe6 100644 (file)
--- a/PPI/SocketSource.hh
+++ b/PPI/SocketSource.hh
@@ -44,8 +44,8 @@ namespace ppi {
 
         This read helper will read a datagram from a datagram socket. This datagram will then be
         interpreted as a packet of type \a Packet as defined in the packet library. \a Packet
-        defaults to \ref DataPacket, which will place the data uninterpreted into a packet data
-        structure.
+        defaults to DataPacket (type DataPacketType), which will place the data uninterpreted 
+        into a packet data structure.
      */
     template <class Packet=DataPacket>
     class PacketSource