Revision 236:a77aefd88e78, committed 2014-12-08

Comitter:

mbedAustin

Date:

Mon Dec 08 20:13:59 2014 +0000

Parent:

235:448f29f4ae7f

Child:

237:6050833395f1

Commit message:

Added doxygen documentation on DFUService.h

Changed in this revision

--- a/services/DFUService.h	Mon Dec 08 19:59:40 2014 +0000
+++ b/services/DFUService.h	Mon Dec 08 20:13:59 2014 +0000
@@ -30,16 +30,28 @@
 extern const uint8_t  DFUServiceControlCharacteristicUUID[];
 extern const uint8_t  DFUServicePacketCharacteristicUUID[];
 
+/**
+* @class DFUService
+* @breif Device Firmware Update Service. 
+*/
 class DFUService {
 public:
     /**
-     * Signature for the handover callback. The application may provide such a
+     * @breif Signature for the handover callback. The application may provide such a
      * callback when setting up the DFU service, in which case it will be
      * invoked before handing control over to the bootloader.
      */
     typedef void (*ResetPrepare_t)(void);
 
 public:
+    /**
+    * @breif Adds Device Firmware Update service to an existing ble object. 
+    *
+    * @param[ref] _ble
+    *               BLEDevice object for the underlying controller.
+    * @param[in] _handoverCallback
+    *                Application specific handover callback.
+    */
     DFUService(BLEDevice &_ble, ResetPrepare_t _handoverCallback = NULL) :
         ble(_ble),
         controlBytes(),
@@ -68,14 +80,21 @@
         ble.onDataWritten(this, &DFUService::onDataWritten);
     }
 
+    /**
+    * @breif 
+    * @return 
+    */
     uint16_t getControlHandle(void) {
         return controlPoint.getValueAttribute().getHandle();
     }
 
     /**
-     * This callback allows the DFU service to receive the initial trigger to
+     * @breif This callback allows the DFU service to receive the initial trigger to
      * handover control to the bootloader; but first the application is given a
      * chance to clean up.
+     *
+     * @param[in]
+     *              
      */
     virtual void onDataWritten(const GattCharacteristicWriteCBParams *params) {
         if (params->charHandle == controlPoint.getValueAttribute().getHandle()) {

--- a/services/HealthThermometerService.h	Mon Dec 08 19:59:40 2014 +0000
+++ b/services/HealthThermometerService.h	Mon Dec 08 20:13:59 2014 +0000
@@ -21,7 +21,7 @@
 
 /** 
 * @class HealthThermometerService
-* @breif BLE Health Thermometer Service. This service provides the location of the thermometer and the temperature. <br>
+* @breif BLE Health Thermometer Service. This service provides the location of the thermometer and the temperature.  <br>
 * Service:  https://developer.bluetooth.org/gatt/profiles/Pages/ProfileViewer.aspx?u=org.bluetooth.profile.health_thermometer.xml <br>
 * Temperature Measurement: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.temperature_measurement.xml <br>
 * Temperature Type: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.temperature_type.xml