Donatien Garnier / NetServicesSource

NetServices Stack source

Dependents:   HelloWorld ServoInterfaceBoardExample1 4180_Lab4

Diff: drv/umtsstick/UMTSStick.h

Revision:
6:b7dd7cde8ad2
Parent:
4:fd826cad83c0
--- a/drv/umtsstick/UMTSStick.h	Tue Jul 27 15:59:42 2010 +0000
+++ b/drv/umtsstick/UMTSStick.h	Wed Jul 28 10:18:21 2010 +0000
@@ -21,6 +21,10 @@
 THE SOFTWARE.
 */
 
+/** \file
+UMTS Stick driver header file
+*/
+
 #ifndef UMTS_STICK_H
 #define UMTS_STICK_H
 
@@ -49,14 +53,15 @@
 
 extern const UMTSSwitchingInfo UMTSwitchingTable[UMTS_SWITCHING_COUNT];
 
+///UMTS Stick error codes
 enum UMTSStickErr
 {
   __UMTSERR_MIN = -0xFFFF,
-  UMTSERR_NOTFOUND,
-  UMTSERR_NOTIMPLEMENTED,
-  UMTSERR_USBERR,
-  UMTSERR_DISCONNECTED,
-  UMTSERR_OK = 0
+  UMTSERR_NOTFOUND, ///<Stick was not found
+  UMTSERR_NOTIMPLEMENTED, ///<This model is not implemented
+  UMTSERR_USBERR, ///<USB Error
+  UMTSERR_DISCONNECTED, ///<Stick disconnected
+  UMTSERR_OK = 0 ///<Success
 };
 
 class UMTSStick