Donatien Garnier / NetServicesSource

NetServices Stack source

Dependents:   HelloWorld ServoInterfaceBoardExample1 4180_Lab4

Diff: services/ntp/NTPClient.h

Revision:
6:b7dd7cde8ad2
Parent:
5:dd63a1e02b1b
Child:
9:c79fa4034f5b
--- a/services/ntp/NTPClient.h	Tue Jul 27 15:59:42 2010 +0000
+++ b/services/ntp/NTPClient.h	Wed Jul 28 10:18:21 2010 +0000
@@ -21,6 +21,10 @@
 THE SOFTWARE.
 */
 
+/** \file
+NTP Client header file
+*/
+
 #ifndef NTP_CLIENT_H
 #define NTP_CLIENT_H
 
@@ -32,11 +36,11 @@
 ///NTP Client results
 enum NTPResult
 {
-  NTP_OK,
-  NTP_PROCESSING,
-  NTP_PRTCL, ///Protocol error
-  NTP_TIMEOUT, ///Connection timeout
-  NTP_DNS ///Could not resolve DNS Addr
+  NTP_OK, ///<Success
+  NTP_PROCESSING, ///<Processing
+  NTP_PRTCL, ///<Protocol error
+  NTP_TIMEOUT, ///<Connection timeout
+  NTP_DNS ///<Could not resolve DNS hostname
 };
 
 ///A NTP Client