From 7674db0eb5e0cb3cf48dd042593971143e9e70e5 Mon Sep 17 00:00:00 2001
From: boercher <boercher@users.sourceforge.net>
Date: Tue, 25 Oct 2005 22:38:19 +0000
Subject: [PATCH] avoid Doxygen warnings

---
 server/drivers/CFontz633io.c | 6 +++---
 server/menuitem.h            | 2 +-
 shared/sockets.c             | 4 +++-
 3 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/server/drivers/CFontz633io.c b/server/drivers/CFontz633io.c
index 3c8ee56..345aabf 100644
--- a/server/drivers/CFontz633io.c
+++ b/server/drivers/CFontz633io.c
@@ -79,7 +79,7 @@ int AddKeyToKeyRing(KeyRing *kr, unsigned char key)
 }
 
 
-/** get byte from key ring (or '\0' if key ring is empty) */
+/** get byte from key ring (or '\\0' if key ring is empty) */
 unsigned char GetKeyFromKeyRing(KeyRing *kr)
 {
 	unsigned char retval = '\0';
@@ -318,7 +318,7 @@ int BytesAvail(ReceiveBuffer *rb)
 }
 
 
-/** get next byte from receive buffer (return '\0' if buffer is empty) */
+/** get next byte from receive buffer (return '\\0' if buffer is empty) */
 unsigned char GetByte(ReceiveBuffer *rb)
 {
 	unsigned char return_byte = '\0';
@@ -365,7 +365,7 @@ void AcceptPeekedData(ReceiveBuffer *rb)
 }
 
 
-/** peek next byte from receive buffer (return '\0' if buffer is empty) */
+/** peek next byte from receive buffer (return '\\0' if buffer is empty) */
 unsigned char PeekByte(ReceiveBuffer *rb)
 {
 	unsigned char return_byte = '\0';
diff --git a/server/menuitem.h b/server/menuitem.h
index 306c42d..9d8cf5d 100644
--- a/server/menuitem.h
+++ b/server/menuitem.h
@@ -240,7 +240,7 @@ MenuItem *menuitem_create_checkbox (char *id, MenuEventFunc(*event_func),
 
 /** Creates a ring with the given string, separated by tabs.
  * value is the (initial) index in the strings.
- * eg: if strings="abc\tdef" the value=1 means that "def" is selected.
+ * eg: if strings="abc\\tdef" the value=1 means that "def" is selected.
  * Generated events: MENUEVENT_UPDATE when user changes value (immediately).
  */
 MenuItem *menuitem_create_ring (char *id, MenuEventFunc(*event_func),
diff --git a/shared/sockets.c b/shared/sockets.c
index 864afd0..2a0e27e 100644
--- a/shared/sockets.c
+++ b/shared/sockets.c
@@ -303,8 +303,10 @@ int sock_send_error(int fd, char* message)
 
 /** prints printf-like formatted output to logfile and sends it to the
  * client.
+ * @note don't add a the "huh? " to the message. This is done by this
+ *   method
  * @param fd socket
- * @param message the message to send (without the "huh? ") */
+ * @param format a printf format */
 int
 sock_printf_error(int fd, const char *format, .../*args*/ )
 {