Javier Velasco / 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_iBeacon

Fork of BLE_API by Bluetooth Low Energy

Diff: ble/DiscoveredCharacteristic.h

Revision:
1177:f9060dc8c5ab
Parent:
1158:fc9f3dbbb34e
Child:
1179:4ab722f8dca0
--- a/ble/DiscoveredCharacteristic.h	Wed Apr 06 19:15:24 2016 +0100
+++ b/ble/DiscoveredCharacteristic.h	Wed Apr 06 19:15:26 2016 +0100
@@ -43,7 +43,7 @@
 class DiscoveredCharacteristic {
 public:
     /**
-     * Enumeration that encapsulates the properties of a discovered
+     * Structure that encapsulates the properties of a discovered
      * characteristic.
      */
     struct Properties_t {
@@ -57,8 +57,7 @@
 
     public:
         /**
-         * @brief   Check the value of the Properties_t::_broadcast property
-         *          of the discovered characteristic.
+         * @brief   Check if broadcasting is permitted.
          *
          * @return  true if broadcasting the value is permitted, and false
          *          otherwise.
@@ -68,8 +67,7 @@
         }
 
         /**
-         * @brief   Check the value of the Properties_t::_read property of the
-         *          discovered characteristic.
+         * @brief   Check reading is permitted.
          *
          * @return  true if reading the value is permitted, and false
          *          otherwise.
@@ -79,8 +77,7 @@
         }
 
         /**
-         * @brief   Check the value of the Properties_t::_writeWoResp property
-         *          of the discovered characteristic.
+         * @brief   Check if writing with Write Command is permitted.
          *
          * @return  true if writing the value with Write Command is permitted,
          *          false otherwise.
@@ -90,8 +87,7 @@
         }
 
         /**
-         * @brief   Check the value of the Properties_t::_write property of the
-         *          discovered characteristic.
+         * @brief   Check if writing with Write Request is permitted.
          *
          * @return  true if writing the value with Write Request is permitted,
          *          false otherwise.
@@ -101,8 +97,7 @@
         }
 
         /**
-         * @brief   Check the value of the Properties_t::_notify property of the
-         *          discovered characteristic.
+         * @brief   Check notifications are permitted.
          *
          * @return  true if notifications of the value are permitted, false
          *          otherwise.
@@ -112,8 +107,7 @@
         }
 
         /**
-         * @brief   Check the value of the Properties_t::_indicate property of
-         *          the discovered characteristic.
+         * @brief   Check if indications are permitted.
          *
          * @return  true if indications of the value are permitted, false
          *          otherwise.
@@ -123,8 +117,7 @@
         }
 
         /**
-         * @brief   Check the value of the Properties_t::_authSignedWrite
-         *          property of the discovered characteristic.
+         * @brief   Check if writing with Signed Write Command is permitted.
          *
          * @return  true if writing the value with Signed Write Command is
          *          permitted, false otherwise.