small documentation fixes

[senf.git] / Examples / RateStuffer / Mainpage.dox

diff --git a/Examples/RateStuffer/Mainpage.dox b/Examples/RateStuffer/Mainpage.dox
index 95864eb..fcc7303 100644 (file)
--- a/Examples/RateStuffer/Mainpage.dox
+++ b/Examples/RateStuffer/Mainpage.dox
@@ -1,8 +1,8 @@
 // $Id$
 //
-// Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// Copyright (C) 2007
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
 //     Stefan Bund <g0dil@berlios.de>
 //
 // This program is free software; you can redistribute it and/or modify
@@ -20,7 +20,7 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-/** \mainpage RateStuffer: A simple example featuring the Packet Processing Infrastructure
+/** \mainpage Example introducing the Packet Processing Infrastructure
 
     This example application implements a simple PPI application: It will read UDP packets from an
     input port and will forward them to another port at a fixed packet rate. If the input stream
@@ -63,7 +63,7 @@
     \image html ratestuffer.png
 
     Above image depicts the module setup implementing the rate stuffer. A
-    senf::ppi::module::ActiveSocketReader reads the incoming UDP packets and sends them into a
+    senf::ppi::module::ActiveSocketSource reads the incoming UDP packets and sends them into a
     senf::ppi::module::PassiveQueue (via a senf::ppi::module::ThrottleBarrier).
 
     The \a queue feeds the packets into a senf::ppi::module::PriorityJoin. The CloneSource
@@ -111,7 +111,7 @@
 
     \until }
 
-    The event is initialized to fire eery \a interval nanoseconds.  The traffic is routed 'across'
+    The event is initialized to fire every \a interval nanoseconds.  The traffic is routed 'across'
     the timer which controls the traffic. This routing lets the module automatically handle
     throttling events. The timer is registered to call RateFilter::timeout().
 
@@ -174,7 +174,7 @@
     port 44345 on localhost. The \a outputSocket uses the senf::ConnectedUDPv4SocketProtocol which
     is compatible with the senf::ppi::module::PassiveSocketWriter module.
 
-    \until udpWriter
+    \until udpSink
 
     Here we allocate the components:
 
@@ -182,12 +182,10 @@
     \li \a stuffer for the real work and
     \li \a udpWriter to send the packets to \a outputSocket
 
-    \until udpWriter
+    \until udpSink
 
     The \ref senf::ppi::connect() calls setup the necessary connections.
     
-    \until run
-
     The module setup is complete, \ref senf::ppi::run() is called to enter the event loop.
 
     \until }