Lancaster University / BLE_API

Lancaster University's fork of the mbed BLE API. Lives on github, https://github.com/lancaster-university/BLE_API

Dependents:   microbit-dal microbit-dal microbit-ble-open microbit-dal ... more

Fork of BLE_API by Bluetooth Low Energy

Files at this revision

API Documentation at this revision

Revision 901:8c53e3af2619, committed 2015-11-26

Comitter:
rgrover1
Date:
Thu Nov 26 12:52:01 2015 +0000
Parent:
900:1e6785897fbd
Child:
902:127e282cf1f9
Commit message:
Synchronized with git rev ac283680
Author: Irit Arkin
New version

Based on the main repo's master version, with edits to the API.

Changed in this revision

ble/GattAttribute.h Show annotated file Show diff for this revision Revisions of this file 
--- a/ble/GattAttribute.h	Thu Nov 26 12:52:01 2015 +0000
+++ b/ble/GattAttribute.h	Thu Nov 26 12:52:01 2015 +0000
@@ -27,16 +27,16 @@
 public:
     /**
      *  @brief  Creates a new GattAttribute using the specified
-     *          UUID, value length, and inital value
+     *          UUID, value length, and inital value.
      *
      *  @param[in]  uuid
-     *              The UUID to use for this attribute
+     *              The UUID to use for this attribute.
      *  @param[in]  valuePtr
      *              The memory holding the initial value.
      *  @param[in]  initialLen
-     *              The min length in bytes of this attribute's value
+     *              The min length in bytes of this attribute's value.
      *  @param[in]  maxLen
-     *              The max length in bytes of this attribute's value
+     *              The max length in bytes of this attribute's value.
      *
      *  @section EXAMPLE
      *
@@ -49,7 +49,7 @@
      */
     GattAttribute(const UUID &uuid, uint8_t *valuePtr = NULL, uint16_t initialLen = 0, uint16_t maxLen = 0) :
         _uuid(uuid), _valuePtr(valuePtr), _initialLen(initialLen), _lenMax(maxLen), _len(initialLen), _handle() {
-        /* empty */
+        /* Empty */
     }
 
 public:
@@ -63,15 +63,15 @@
     uint8_t    *getValuePtr(void)            {return _valuePtr;  }
 
 private:
-    UUID      _uuid;        /* Characteristic UUID */
+    UUID      _uuid;        /* Characteristic UUID. */
     uint8_t  *_valuePtr;
-    uint16_t  _initialLen;  /* Initial length of the value */
-    uint16_t  _lenMax;      /* Maximum length of the value */
-    uint16_t  _len;         /* Current length of the value */
+    uint16_t  _initialLen;  /* Initial length of the value. */
+    uint16_t  _lenMax;      /* Maximum length of the value. */
+    uint16_t  _len;         /* Current length of the value. */
     Handle_t  _handle;
 
 private:
-    /* disallow copy and assignment */
+    /* Disallow copy and assignment. */
     GattAttribute(const GattAttribute &);
     GattAttribute& operator=(const GattAttribute &);
 };