Joshua Slater / BLE_API_Changed

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.

Fork of BLE_API by Bluetooth Low Energy

Files at this revision

API Documentation at this revision

Revision 237:6050833395f1, committed 2014-12-08

Comitter:
mbedAustin
Date:
Mon Dec 08 20:17:37 2014 +0000
Parent:
236:a77aefd88e78
Child:
238:905d6fc17fda
Commit message:
Added doxygen documenatation for Device Information Service

Changed in this revision

services/DeviceInformationService.h Show annotated file Show diff for this revision Revisions of this file 
--- a/services/DeviceInformationService.h	Mon Dec 08 20:13:59 2014 +0000
+++ b/services/DeviceInformationService.h	Mon Dec 08 20:17:37 2014 +0000
@@ -19,16 +19,19 @@
 
 #include "BLEDevice.h"
 
-/* Device Information Service */
-/* Service: https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.device_information.xml */
-/* Manufacturer Name String Char: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.manufacturer_name_string.xml */
+/**
+* @class DeviceInformationService
+* @breif BLE Device Information Service <br>
+* Service: https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.device_information.xml <br>
+* Manufacturer Name String Char: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.manufacturer_name_string.xml 
+*/
 class DeviceInformationService {
 public:
     /**
-     * Constructor.
+     * @breif Device Information Service Constructor. 
      *
-     * @param[in] _ble
-     *                Reference to the BLEDevice.
+     * @param[ref] _ble
+     *                BLEDevice object for the underlying controller.
      * @param[in] manufacturersName
      *                This characteristic represents the name of the
      *                manufacturer of the device. The name is copied into the