Diff: api/DNSRequest.h

Revision:

8:93fa3cfc0219

Parent:

6:b7dd7cde8ad2

Child:

9:c79fa4034f5b

--- a/api/DNSRequest.h	Wed Jul 28 11:55:27 2010 +0000
+++ b/api/DNSRequest.h	Wed Jul 28 12:45:32 2010 +0000
@@ -21,23 +21,27 @@
 THE SOFTWARE.
 */
 
+/** \file
+DNS Request header file
+*/
+
 #ifndef DNSREQUEST_H
 #define DNSREQUEST_H
 
 #include "if/net/net.h"
 //Essentially it is a safe interface to NetDnsRequest
 
-///DNS Request Errors
+///DNS Request error codes
 enum DNSRequestErr
 {
   __DNS_MIN = -0xFFFF,
-  DNS_SETUP, ///DNSRequest not properly configured
-  DNS_IF, ///Interface has problems, does not exist or is not initialized
-  DNS_MEM, ///Not enough mem
-  DNS_INUSE, ///Interface / Port is in use
-  DNS_PROCESSING, ///Request has not completed
+  DNS_SETUP, ///<DNSRequest not properly configured
+  DNS_IF, ///<Interface has problems, does not exist or is not initialized
+  DNS_MEM, ///<Not enough mem
+  DNS_INUSE, ///<Interface / Port is in use
+  DNS_PROCESSING, ///<Request has not completed
 //...
-  DNS_OK = 0
+  DNS_OK = 0 ///<Success
 };
 
 ///DNS Request Result Events