From f72d16853cc0928280e429e5998d279358b22385 Mon Sep 17 00:00:00 2001
From: tho <tho@wiback.org>
Date: Tue, 12 Feb 2008 09:05:41 +0000
Subject: [PATCH] tiny documentation updates
---
Examples/UDPClientServer/Mainpage.dox | 6 +++---
Packets/PacketParser.hh | 2 +-
Socket/SocketHandle.hh | 4 ++--
3 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/Examples/UDPClientServer/Mainpage.dox b/Examples/UDPClientServer/Mainpage.dox
index 197e52a5c..7555d214c 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 dfc912a49..3e568438a 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 d1b425089..6d36be8c2 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
--
GitLab