Skip to content

Commit 7a4ac93

Browse files
author
Amanda Butler
authored
Copy edit DiscoveredCharacteristicDescriptor.h
Copy edit, mostly for active voice.
1 parent 08ba159 commit 7a4ac93

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

features/FEATURE_BLE/ble/DiscoveredCharacteristicDescriptor.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,20 +35,20 @@
3535
/**
3636
* Representation of a characteristic descriptor discovered.
3737
*
38-
* Characteristic descriptors can be seen as the meta data of the characteristic.
38+
* Characteristic descriptors can be seen as the metadata of the characteristic.
3939
* They can contain things such as the unit of the characteristic value, extra
40-
* permission informations or the Client Configuration state regards to
40+
* permission informations or the Client Configuration state in regard to
4141
* notification or indication.
4242
*
4343
* The descriptors of a characterstic are discovered by a Characteristic
44-
* Descriptor Discovery Procedure which can be initiated by either
44+
* Descriptor Discovery Procedure, which can be initiated by either
4545
* GattClient::discoverCharacteristicDescriptors() or
4646
* DiscoveredCharacteristic::discoverDescriptors().
4747
*
4848
* The discovery procedure returns the UUID of the descriptor (its type) and its
4949
* handle.
5050
*
51-
* Read and write of the descriptor value can initiated respectively by
51+
* Read and write of the descriptor value can be initiated by
5252
* GattClient::read and GattClient::write.
5353
*
5454
* @todo read member function
@@ -62,14 +62,14 @@ class DiscoveredCharacteristicDescriptor {
6262
/**
6363
* Construct a new instance of a DiscoveredCharacteristicDescriptor.
6464
*
65-
* @param[in] client The client which has discovered the descriptor.
65+
* @param[in] client The client that has discovered the descriptor.
6666
* @param[in] connectionHandle Handle of the connection to the GATT server
6767
* containing the descriptor.
6868
* @param[in] attributeHandle GATT attribute handle of the descriptor.
6969
* @param[in] uuid UUID of the descriptor.
7070
*
7171
* @note This constructor is not meant to be called directly by application
72-
* code. Descriptors discovered are generated by the GattClient class.
72+
* code. The Gattclient class generates descriptors discovered.
7373
*/
7474
DiscoveredCharacteristicDescriptor(
7575
GattClient *client,
@@ -83,19 +83,19 @@ class DiscoveredCharacteristicDescriptor {
8383
}
8484

8585
/**
86-
* Return the GattClient which can operate on this descriptor.
86+
* Return the GattClient, which can operate on this descriptor.
8787
*
88-
* @return GattClient which can operate on this descriptor.
88+
* @return GattClient, which can operate on this descriptor.
8989
*/
9090
GattClient* getGattClient()
9191
{
9292
return _client;
9393
}
9494

9595
/**
96-
* Return the GattClient which can operate on this descriptor.
96+
* Return the GattClient, which can operate on this descriptor.
9797
*
98-
* @return GattClient which can operate on this descriptor.
98+
* @return GattClient, which can operate on this descriptor.
9999
*/
100100
const GattClient* getGattClient() const
101101
{

0 commit comments

Comments
 (0)