CARLO TARALLO / BLE_API

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   BLE_HeartRate_IDB04A1

Fork of BLE_API by Bluetooth Low Energy

Files at this revision

API Documentation at this revision

Revision 1152:1c10f851f4f9, committed 2016-04-06

Comitter:
vcoubard
Date:
Wed Apr 06 19:14:27 2016 +0100
Parent:
1151:575efbdcc905
Child:
1153:6ea3b6a5cdc7
Commit message:
Synchronized with git rev c8c30b27
Author: Andres Amaya Garcia
Fix doxygen warnings in DeviceInformationService.h

Changed in this revision

ble/services/DeviceInformationService.h Show annotated file Show diff for this revision Revisions of this file 
--- a/ble/services/DeviceInformationService.h	Wed Apr 06 19:14:19 2016 +0100
+++ b/ble/services/DeviceInformationService.h	Wed Apr 06 19:14:27 2016 +0100
@@ -31,8 +31,8 @@
      * @brief Device Information Service Constructor: copies device-specific information
      * into the BLE stack.
      *
-     * @param[ref] _ble
-     *                BLE object for the underlying controller.
+     * @param[in] _ble
+     *                A reference to a BLE object for the underlying controller.
      * @param[in] manufacturersName
      *                The name of the manufacturer of the device.
      * @param[in] modelNumber
@@ -104,12 +104,34 @@
     }
 
 protected:
+    /**
+     * A reference to the BLE instance object to which the services and
+     * characteristics will be added.
+     */
     BLE                &ble;
+    /**
+     * BLE characterising to allow BLE peers access to the manufacturer's name.
+     */
     GattCharacteristic  manufacturersNameStringCharacteristic;
+    /**
+     * BLE characterising to allow BLE peers access to the model number.
+     */
     GattCharacteristic  modelNumberStringCharacteristic;
+    /**
+     * BLE characterising to allow BLE peers access to the serial number.
+     */
     GattCharacteristic  serialNumberStringCharacteristic;
+    /**
+     * BLE characterising to allow BLE peers access to the hardware revision string.
+     */
     GattCharacteristic  hardwareRevisionStringCharacteristic;
+    /**
+     * BLE characterising to allow BLE peers access to the firmware revision string.
+     */
     GattCharacteristic  firmwareRevisionStringCharacteristic;
+    /**
+     * BLE characterising to allow BLE peers access to the software revision string.
+     */
     GattCharacteristic  softwareRevisionStringCharacteristic;
 };