Diff: ble/services/BatteryService.h

Revision:

993:4d62b7967c11

Parent:

992:ca834f7ae8ed

Child:

1042:21a86ac7f5b1

diff -r ca834f7ae8ed -r 4d62b7967c11 ble/services/BatteryService.h
--- a/ble/services/BatteryService.h	Wed Dec 02 10:29:44 2015 +0000
+++ b/ble/services/BatteryService.h	Wed Dec 02 10:29:44 2015 +0000
@@ -21,18 +21,18 @@
 
 /**
 * @class BatteryService
-* @brief BLE Battery Service. This service displays the battery level from 0%->100% represented as a 8bit number.<br>
-* Service:  https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.battery_service.xml <br>
+* @brief BLE Battery Service. This service displays the battery level from 0% to 100%, represented as an 8bit number.
+* Service:  https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.battery_service.xml
 * Battery Level Char:  https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.battery_level.xml
 */
 class BatteryService {
 public:
     /**
-    * @param[ref] _ble
-    *               BLE object for the underlying controller.
-    * @param[in] level
-    *               8bit batterly level. Usually used to represent percentage of batterly charge remaining.
-    */
+     * @param[ref] _ble
+     *               BLE object for the underlying controller.
+     * @param[in] level
+     *               8bit batterly level. Usually used to represent percentage of batterly charge remaining.
+     */
     BatteryService(BLE &_ble, uint8_t level = 100) :
         ble(_ble),
         batteryLevel(level),
@@ -45,11 +45,11 @@
     }
 
     /**
-     * @brief Update the battery level with a new value. Valid values range from
-     * 0..100. Anything outside this range will be ignored.
+     * @brief Update the battery level with a new value. [Valid values lie between 0 and 100];
+     * anything outside this range will be ignored.
      *
      * @param newLevel
-     *              update to battery level.
+     *              Update to battery level.
      */
     void updateBatteryLevel(uint8_t newLevel) {
         batteryLevel = newLevel;