Diff: api/TCPSocket.h

Revision:

8:93fa3cfc0219

Parent:

5:dd63a1e02b1b

Child:

9:c79fa4034f5b

--- a/api/TCPSocket.h	Wed Jul 28 11:55:27 2010 +0000
+++ b/api/TCPSocket.h	Wed Jul 28 12:45:32 2010 +0000
@@ -21,39 +21,43 @@
 THE SOFTWARE.
 */
 
+/** \file
+TCP Socket header file
+*/
+
 #ifndef TCPSOCKET_H
 #define TCPSOCKET_H
 
 #include "if/net/net.h"
 //Essentially it is a safe interface to NetTcpSocket
 
-///TCP Socket Errors
+///TCP Socket error codes
 enum TCPSocketErr
 {
   __TCPSOCKET_MIN = -0xFFFF,
-  TCPSOCKET_SETUP, ///TCPSocket not properly configured
-  TCPSOCKET_TIMEOUT,
-  TCPSOCKET_IF, ///Interface has problems, does not exist or is not initialized
-  TCPSOCKET_MEM, ///Not enough mem
-  TCPSOCKET_INUSE, ///Interface / Port is in use
-  TCPSOCKET_EMPTY, ///Connections queue is empty
-  TCPSOCKET_RST, ///Connection was reset by remote host
+  TCPSOCKET_SETUP, ///<TCPSocket not properly configured
+  TCPSOCKET_TIMEOUT, ///<Connection timed out
+  TCPSOCKET_IF, ///<Interface has problems, does not exist or is not initialized
+  TCPSOCKET_MEM, ///<Not enough mem
+  TCPSOCKET_INUSE, ///<Interface / Port is in use
+  TCPSOCKET_EMPTY, ///<Connections queue is empty
+  TCPSOCKET_RST, ///<Connection was reset by remote host
 //...
-  TCPSOCKET_OK = 0
+  TCPSOCKET_OK = 0 ///<Success
 };
 
 ///TCP Socket Events
 enum TCPSocketEvent
 {
-  TCPSOCKET_CONNECTED, ///Connected to host
-  TCPSOCKET_ACCEPT,  ///Client is connected, must call accept() to get a new Socket
-  TCPSOCKET_READABLE, ///Data in buf
-  TCPSOCKET_WRITEABLE, ///Can write data to buf
-  TCPSOCKET_CONTIMEOUT, ///Connection timed out
-  TCPSOCKET_CONRST, ///Connection was reset by remote host
-  TCPSOCKET_CONABRT, ///Connection was aborted
-  TCPSOCKET_ERROR, ///Unknown error
-  TCPSOCKET_DISCONNECTED ///Disconnected
+  TCPSOCKET_CONNECTED, ///<Connected to host
+  TCPSOCKET_ACCEPT,  ///<Client is connected, must call accept() to get a new Socket
+  TCPSOCKET_READABLE, ///<Data in buf
+  TCPSOCKET_WRITEABLE, ///<Can write data to buf
+  TCPSOCKET_CONTIMEOUT, ///<Connection timed out
+  TCPSOCKET_CONRST, ///<Connection was reset by remote host
+  TCPSOCKET_CONABRT, ///<Connection was aborted
+  TCPSOCKET_ERROR, ///<Unknown error
+  TCPSOCKET_DISCONNECTED ///<Disconnected
 };
 
 ///This is a simple TCP Socket class