Add doclib/fix-links.py to temporarily fix/remove bad doxygen links

[senf.git] / PPI / Mainpage.dox

diff --git a/PPI/Mainpage.dox b/PPI/Mainpage.dox
index 2cd9212..5ed72b9 100644 (file)
--- a/PPI/Mainpage.dox
+++ b/PPI/Mainpage.dox
@@ -20,9 +20,8 @@
 
 /** \mainpage libPPI : The Packet Processing Infrastructure
 
-    The PPI provides an infrastructure to create packet oriented network processing
-    applications. A PPI application is built by combining processing modules in a very flexible
-    manner.
+    The PPI provides an infrastructure to create packet oriented network processing applications. A
+    PPI application is built by combining processing modules in a very flexible manner.
 
     \image html scenario.png Target Scenario
     
@@ -41,14 +40,22 @@
     performance optimizations for TCP traffic (PEP). This router is built by combining several
     modules.
 
+    \see \ref overview \n
+        <a href="../../../Examples/RateStuffer/doc/html/index.html">PPI Example Application:
+        RateStuffer</a> \n
+        \ref senf::ppi::module "Modules" \n
+        \ref senf::ppi::connector "Connectors" \n
+        \ref event_group
+ */
+
+/** \page overview PPI Overview and Concepts
+
     \section design Design considerations
 
     The PPI interface is designed to be as simple as possible. It provides sane defaults for all
     configurable parameters to simplify getting started. It also automates all resource
-    management. Especially to simplify resource management, the PPI will take many configuration
-    objects by value. Even though this is not as efficient, it frees the user from most resource
-    management chores. This decision does not affect the runtime performance since it only affects
-    the configuration step.
+    management. The throttling infrastructure handles blocking conditions (like input exhaustion)
+    automatically 
 
     \section packets Packets
 
@@ -331,11 +338,10 @@
     route statement as defining the 'conceptual data flow' since this is also how control messages
     should flow (sans the direction, which is defined by the connectors active/passive property).
 
-    \see \ref ppi_implementation \n
-        <a href="http://openfacts.berlios.de/index-en.phtml?title=SENF:_Packet_Processing_Infrastructure">Implementation plan</a>
+    \see \ref ppi_implementation
  */
 
-/** \page ppi_implementation Implementation Overview
+/** \page ppi_implementation Implementation Notes
     
     \section processing Data Processing
 
@@ -394,9 +400,6 @@
     \section class_diagram Class Diagram
 
     \image html classes.png
-
-    \fixme Implement Spliters: PassiveSplitter, PrioritySplitter, CloneSplitter
-    \fixme Implement DiscardSink, CloneSource
  */
 
 \f