Skip to content

Commit c9931f3

Browse files
author
Amanda Butler
authored
Copy edit CharacteristicDescriptorDiscovery.h
Make minor copy edits, mostly for active voice.
1 parent 0f91ea2 commit c9931f3

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

features/FEATURE_BLE/ble/CharacteristicDescriptorDiscovery.h

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ class DiscoveredCharacteristicDescriptor; // forward declaration
3030
*/
3131

3232
/**
33-
* Definitions of events and event handlers used by the characteristic descriptor
34-
* discovery procedure.
33+
* Definitions of events and event handlers that the characteristic descriptor
34+
* discovery procedure uses.
3535
*
36-
* This class act like a namespace for characteristic descriptor discovery
37-
* types. Like ServiceDiscovery it provides callbacks and callbacks parameters
38-
* types related to the characteristic descriptor discovery process but contrary
36+
* This class acts like a namespace for characteristic descriptor discovery
37+
* types. Like ServiceDiscovery, it provides callbacks and callbacks parameters
38+
* types related to the characteristic descriptor discovery process, but contrary
3939
* to the ServiceDiscovery class, it does not force the porter to use a specific
4040
* interface for the characteristic descriptor discovery process.
4141
*/
@@ -100,12 +100,12 @@ class CharacteristicDescriptorDiscovery {
100100
/**
101101
* Characteristic descriptor discovered event handler.
102102
*
103-
* As parameter it expects a pointer to a DiscoveryCallbackParams_t instance.
103+
* As a parameter, it expects a pointer to a DiscoveryCallbackParams_t instance.
104104
*
105105
* @note The object passed in parameter will remain valid for the lifetime
106-
* of the callback. Memory for this object is owned by the BLE_API eventing
107-
* framework. The application can safely make a persistent shallow-copy of
108-
* this object in order to work with the service beyond the callback.
106+
* of the callback. The BLE_API eventing framework owns memory for this
107+
* object. The application can safely make a persistent shallow-copy of
108+
* this object to work with the service beyond the callback.
109109
*
110110
* @see DiscoveryCallbackParams_t
111111
* GattClient::discoverCharacteristicDescriptors
@@ -117,12 +117,12 @@ class CharacteristicDescriptorDiscovery {
117117
/**
118118
* Handler of Characteristic descriptor discovery ended event.
119119
*
120-
* As parameter it expects a pointer to a TerminationCallbackParams_t instance.
120+
* As a parameter, it expects a pointer to a TerminationCallbackParams_t instance.
121121
*
122122
* @note The object passed in parameter will remain valid for the lifetime
123-
* of the callback. Memory for this object is owned by the BLE_API eventing
124-
* framework. The application can safely make a persistent shallow-copy of
125-
* this object in order to work with the service beyond the callback.
123+
* of the callback. The BLE_API eventing framework owns the memory for this
124+
* object. The application can safely make a persistent shallow-copy of
125+
* this object to work with the service beyond the callback.
126126
*
127127
* @see TerminationCallbackParams_t
128128
* GattClient::discoverCharacteristicDescriptors

0 commit comments

Comments
 (0)