From: tho <tho@270642c3-0616-0410-b53a-bc976706d245>
Date: Tue, 12 Feb 2008 09:05:41 +0000 (+0000)
Subject: tiny documentation updates
X-Git-Url: http://g0dil.de/git?p=senf.git;a=commitdiff_plain;h=2cf8d7ad86c57dd87314c1ea7bf980a189d48552

tiny documentation updates

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

diff --git a/Examples/UDPClientServer/Mainpage.dox b/Examples/UDPClientServer/Mainpage.dox
index 197e52a..7555d21 100644
--- a/Examples/UDPClientServer/Mainpage.dox
+++ b/Examples/UDPClientServer/Mainpage.dox
@@ -31,11 +31,11 @@
     senf/Example/udpServer directory and compiled with
 
     <pre>
-        #scons -u
+        # scons -u
         <Then you can start the client/server with>
 
-        #./udpServer
-        #./udpClient
+        # ./udpServer
+        # ./udpClient
     </pre>
 
     When we take a look to the code, we start with the Server:
diff --git a/Packets/PacketParser.hh b/Packets/PacketParser.hh
index dfc912a..3e56843 100644
--- a/Packets/PacketParser.hh
+++ b/Packets/PacketParser.hh
@@ -339,7 +339,7 @@ namespace senf {
                                              parsers if needed. */
 
         Packet packet() const;          ///< Get packet this parser is parsing from
-                                        /**< \important This member should only be used from packet
+                                        /**< \note This member should only be used from packet
                                              parsers when access to previous or following packets is
                                              needed e.g. for calculating checksums etc. */
 
diff --git a/Socket/SocketHandle.hh b/Socket/SocketHandle.hh
index d1b4250..6d36be8 100644
--- a/Socket/SocketHandle.hh
+++ b/Socket/SocketHandle.hh
@@ -127,7 +127,7 @@ namespace senf {
 
                                              \param map string to string mapping to be filled with
                                                  state information
-                                             \param lod level of detail requested. The
+                                             \param lod level of %detail requested. The
                                                  interpretation of this value is protocol specific
 
                                              \implementation This member will be re-implemented in
@@ -140,7 +140,7 @@ namespace senf {
                                         /**< Formats the complete state map value and returns it as
                                              a single multi-line string.
 
-                                             \param lod level of detail requested. The
+                                             \param lod level of %detail requested. The
                                                 interpretation of this value is protocol specific
                                              
                                              \implementation This member will be re-implemented in