Diff: ble/services/DeviceInformationService.h

Revision:

1183:1589830dbdb7

Parent:

1179:4ab722f8dca0

--- a/ble/services/DeviceInformationService.h	Wed Apr 06 19:15:34 2016 +0100
+++ b/ble/services/DeviceInformationService.h	Wed Apr 06 19:15:36 2016 +0100
@@ -28,21 +28,21 @@
 class DeviceInformationService {
 public:
     /**
-     * @brief Device Information Service Constructor: copies device-specific information 
+     * @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
      *                The model number that is assigned by the device vendor.
      * @param[in] serialNumber
-     *                The serial number for a particular instance of the device. 
+     *                The serial number for a particular instance of the device.
      * @param[in] hardwareRevision
      *                The hardware revision for the hardware within the device.
      * @param[in] firmwareRevision
-     *                The device's firmware version. 
+     *                The device's firmware version.
      * @param[in] softwareRevision
      *                The device's software version.
      */
@@ -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;
 };