Diff: hw/bleradio.h

Revision:

19:a6f33421746c

Parent:

7:5e1f0d7f7c7d

Child:

23:f19c60478e1b

diff -r 86fe1e247a54 -r a6f33421746c hw/bleradio.h
--- a/hw/bleradio.h	Wed Dec 18 19:39:19 2013 +0000
+++ b/hw/bleradio.h	Wed Dec 18 20:11:45 2013 +0000
@@ -6,18 +6,32 @@
 #include "GapAdvertisingData.h"
 #include "GapAdvertisingParams.h"
 
+/**************************************************************************/
+/*!
+    \brief
+    The base class used to abstract away BLE capable radio transceivers
+    or SOCs, to enable this BLE API to work with any radio transparently.
+*/
+/**************************************************************************/
 class BLERadio
 {
     protected:
         FunctionPointer _callback_event;
         
     public:
+        /******************************************************************/
+        /*!
+            \brief
+            Identifies events generated by the radio HW when an event
+            callback occurs
+        */
+        /******************************************************************/
         typedef enum radio_event_e
         {
-            RADIO_EVENT_CONNECT     = 0x01,
-            RADIO_EVENT_DISCONNECT  = 0x02,
-            RADIO_EVENT_WRITE       = 0x03,
-            RADIO_EVENT_RADIOERROR  = 0x80
+            RADIO_EVENT_CONNECT     = 0x01, /**< A BLE connection was established by the radio */
+            RADIO_EVENT_DISCONNECT  = 0x02, /**< The BLE device was disconnected */
+            RADIO_EVENT_WRITE       = 0x03, /**< A BLE write request occured */
+            RADIO_EVENT_RADIOERROR  = 0x80  /**< A low level error occured on the radio */
         } radioEvent_t;
         
         uint8_t serviceCount;