ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Copy edit DiscoveredCharacteristicDescriptor.h 

Copy edit, mostly for active voice.
pull/5392/head
Amanda Butler 2017-11-07 15:56:05 -06:00 committed by GitHub
parent 08ba159cf6
commit 7a4ac93eb1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
features/FEATURE_BLE/ble/DiscoveredCharacteristicDescriptor.h
View File

@ -35,20 +35,20 @@
/**
* Representation of a characteristic descriptor discovered.
*
* Characteristic descriptors can be seen as the meta data of the characteristic.
* Characteristic descriptors can be seen as the metadata of the characteristic.
* They can contain things such as the unit of the characteristic value, extra
* permission informations or the Client Configuration state regards to
* permission informations or the Client Configuration state in regard to
* notification or indication.
*
* The descriptors of a characterstic are discovered by a Characteristic
* Descriptor Discovery Procedure which can be initiated by either
* Descriptor Discovery Procedure, which can be initiated by either
* GattClient::discoverCharacteristicDescriptors() or
* DiscoveredCharacteristic::discoverDescriptors().
*
* The discovery procedure returns the UUID of the descriptor (its type) and its
* handle.
*
* Read and write of the descriptor value can initiated respectively by
* Read and write of the descriptor value can be initiated by
* GattClient::read and GattClient::write.
*
* @todo read member function
@ -62,14 +62,14 @@ public:
/**
* Construct a new instance of a DiscoveredCharacteristicDescriptor.
*
* @param[in] client The client which has discovered the descriptor.
* @param[in] client The client that has discovered the descriptor.
* @param[in] connectionHandle Handle of the connection to the GATT server
* containing the descriptor.
* @param[in] attributeHandle GATT attribute handle of the descriptor.
* @param[in] uuid UUID of the descriptor.
*
* @note This constructor is not meant to be called directly by application
* code. Descriptors discovered are generated by the GattClient class.
* code. The Gattclient class generates descriptors discovered.
*/
DiscoveredCharacteristicDescriptor(
GattClient *client,
@ -83,9 +83,9 @@ public:
}
/**
* Return the GattClient which can operate on this descriptor.
* Return the GattClient, which can operate on this descriptor.
*
* @return GattClient which can operate on this descriptor.
* @return GattClient, which can operate on this descriptor.
*/
GattClient* getGattClient()
{
@ -93,9 +93,9 @@ public:
}
/**
* Return the GattClient which can operate on this descriptor.
* Return the GattClient, which can operate on this descriptor.
*
* @return GattClient which can operate on this descriptor.
* @return GattClient, which can operate on this descriptor.
*/
const GattClient* getGattClient() const
{