Diff: api/UDPSocket.h

Revision:

8:93fa3cfc0219

Parent:

6:b7dd7cde8ad2

Child:

9:c79fa4034f5b

--- a/api/UDPSocket.h	Wed Jul 28 11:55:27 2010 +0000
+++ b/api/UDPSocket.h	Wed Jul 28 12:45:32 2010 +0000
@@ -21,28 +21,32 @@
 THE SOFTWARE.
 */
 
+/** \file
+UDP Socket header file
+*/
+
 #ifndef UDPSOCKET_H
 #define UDPSOCKET_H
 
 #include "if/net/net.h"
 //Essentially it is a safe interface to NetUdpSocket
 
-///UDP Socket Errors
+///UDP Socket error codes
 enum UDPSocketErr
 {
   __UDPSOCKET_MIN = -0xFFFF,
-  UDPSOCKET_SETUP, ///UDPSocket not properly configured
-  UDPSOCKET_IF, ///Interface has problems, does not exist or is not initialized
-  UDPSOCKET_MEM, ///Not enough mem
-  UDPSOCKET_INUSE, ///Interface / Port is in use
+  UDPSOCKET_SETUP, ///<UDPSocket not properly configured
+  UDPSOCKET_IF, ///<Interface has problems, does not exist or is not initialized
+  UDPSOCKET_MEM, ///<Not enough mem
+  UDPSOCKET_INUSE, ///<Interface / Port is in use
 //...
-  UDPSOCKET_OK = 0
+  UDPSOCKET_OK = 0 ///<Success
 };
 
 ///UDP Socket Event(s)
-enum UDPSocketEvent //Only one lonely event here... but who knows, maybe some day there'll be another one!
+enum UDPSocketEvent //Only one event here for now, but keeps that model in case we need to implement some others
 {
-  UDPSOCKET_READABLE, ///Data in buf
+  UDPSOCKET_READABLE, ///<Data in buf
 };
 
 ///This is a simple UDP Socket class