From: tho <tho@270642c3-0616-0410-b53a-bc976706d245>
Date: Fri, 8 Feb 2008 12:54:55 +0000 (+0000)
Subject: minor documentation updates
X-Git-Url: http://g0dil.de/git?p=senf.git;a=commitdiff_plain;h=1aa319962e09f32d2dfd612ca1854e8d85e443ba

minor documentation updates

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

diff --git a/Examples/Sniffer/Doxyfile b/Examples/Sniffer/Doxyfile
index da7fce1..ff66a7c 100644
--- a/Examples/Sniffer/Doxyfile
+++ b/Examples/Sniffer/Doxyfile
@@ -6,6 +6,7 @@ EXAMPLE_PATH = .
 TAGFILES = \
 	"$(TOPDIR)/Scheduler/doc/Scheduler.tag" \
 	"$(TOPDIR)/Packets/doc/Packets.tag" \
+	"$(TOPDIR)/Packets/DefaultBundle/doc/DefaultBundle.tag" \
 	"$(TOPDIR)/Socket/doc/Socket.tag" \
 	"$(TOPDIR)/Utils/doc/Utils.tag" \
     "$(TOPDIR)/doc/overview.tag"
diff --git a/Examples/Sniffer/Mainpage.dox b/Examples/Sniffer/Mainpage.dox
index 981a1ed..3e0159d 100644
--- a/Examples/Sniffer/Mainpage.dox
+++ b/Examples/Sniffer/Mainpage.dox
@@ -43,15 +43,12 @@
     code starts out by including the necessary headers
 
     \skip // Custom includes
-    \until membind
+    \until #include <senf/Scheduler/Scheduler.hh>
 
-    (The additional includes found in the source but not shown here are part of a short-time fix
-    which will be removed as soon as possible). The example application now contains a helper
-    routine to produce a packet hexdump. We will skip this routine here. The example includes two
-    implementations, one using blocking calls and a while loop, the other using the senf::Scheduler
-    for asynchronous event notification. They are implemented in \c loop_main() and \c
-    scheduler_main(). They will be documented below. For now, we skip these implementations and go
-    straight to the \c main() function
+    The example includes two implementations, one using blocking calls and a while loop, the other
+    using the senf::Scheduler for asynchronous event notification. They are implemented in 
+    \c loop_main() and \c scheduler_main(). They will be documented below. For now, we skip these 
+    implementations and go straight to the \c main() function
 
     \skip int main(
     \until return 1;
@@ -75,21 +72,23 @@
     the application, it might be better to let the exception \c abort the execution so you can get a
     backtrace of the exception origin in the debugger.
 
-    We now create a packet socket and bind it to the \c eth0 interface. A packet socket is a linux
-    specific type of socket which returns ethernet packets directly from the network wire. By
-    uncommenting the last line, you may switch the interface into promiscuous mode.
+    We now create a packet socket and bind it to the interface given as second command line argument.
+    A packet socket is a linux specific type of socket which returns ethernet packets directly from 
+    the network wire. By uncommenting the last line, you may switch the interface into promiscuous mode.
 
     \until //
 
     We will now read packets from the socket forever, that is until the user hits Ctrl-C
 
     \skip while
-    \until read
+    \until while
 
     The next step is, to parse the data read from the socket as an Ethernet packet
 
-    \until ;
+    \until sock.read
 
+    \doc the following section is obsolete!
+    
     Lets digest this line step by step: We declare a variable named \c packet as a smart pointer to
     an \c EthernetPacket instance. \c ptr is a typedef member of all Packet classes for the
     corresponding smart pointer type. We then initialize this pointer with a call to the static \c
diff --git a/Examples/Sniffer/Sniffer.cc b/Examples/Sniffer/Sniffer.cc
index 7e60a23..0c53e5f 100644
--- a/Examples/Sniffer/Sniffer.cc
+++ b/Examples/Sniffer/Sniffer.cc
@@ -30,10 +30,10 @@
 #include <iostream>
 #include <iomanip>
 #include <senf/Socket/Protocols/Raw.hh>
-#include <senf/Scheduler/Scheduler.hh>
 #include <senf/Utils/membind.hh>
 #include <senf/Utils/hexdump.hh>
 #include <senf/Packets/DefaultBundle/EthernetPacket.hh>
+#include <senf/Scheduler/Scheduler.hh>
 
 //#include "Sniffer.mpp"
 #define prefix_
diff --git a/Utils/Daemon/Daemon.hh b/Utils/Daemon/Daemon.hh
index 4f75e1c..30d6b24 100644
--- a/Utils/Daemon/Daemon.hh
+++ b/Utils/Daemon/Daemon.hh
@@ -34,9 +34,9 @@
 
 namespace senf {
 
-    /** \brief Daemon process
+    /** \brief %Daemon process
 
-        senf::Daemon provides simple management for daemon processes. Specifically, the Daemon class
+        %senf::Daemon provides simple management for daemon processes. Specifically, the %Daemon class
         implements
         \li <i>Safe startup.</i> If the startup fails, the foreground process which launches the
             daemon will terminate with an appropriate error exit code.