Skip to content

Commit 036ea46

Browse files
author
Amanda Butler
authored
Update GattAttribute.h
Make minor copy edits for precise language and active voice.
1 parent d153af3 commit 036ea46

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

features/FEATURE_BLE/ble/GattAttribute.h

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -34,23 +34,23 @@
3434
*
3535
* Attributes are the building block of GATT servers: services are attributes,
3636
* characteristics are groups of attributes and characteristic descriptors are
37-
* attributes too.
37+
* attributes, too.
3838
*
3939
* @par Typed values
4040
*
4141
* Attributes are typed values composed of a type and its associated value. The
42-
* attribute type identifies the attribute purpose and is modelled by a UUID
43-
* read by the client during the discovery of the gatt server. The value of the
42+
* attribute type identifies the attribute purpose. A UUID read by the client
43+
* during the discovery of the GATT server models the attribute type. The value of the
4444
* attribute is an array of bytes; its length may be fixed or variable.
4545
*
46-
* As an example a primary service is declared by an attribute with the type
47-
* 0x2800 and the value of the attribute is the UUID of the service.
46+
* As an example, a primary service is declared by an attribute with the type
47+
* 0x2800, and the value of the attribute is the UUID of the service.
4848
*
4949
* @par Attribute Access
5050
*
51-
* The GATT server is an array of attributes were each of the attributes is
52-
* identified within the array by a unique index. That index is called the
53-
* attribute handle and clients use it to access to attributes within the server.
51+
* The GATT server is an array of attributes in which a unique index identifies
52+
* each of the attributes within the array. That index is called the attribute
53+
* handle, and clients use it to access to attributes within the server.
5454
*
5555
* @note Attributes do not contain information related to their permissions,
5656
* grouping or semantic. Higher level specifications define these concepts.
@@ -60,9 +60,9 @@ class GattAttribute {
6060
/**
6161
* Representation of an attribute handle.
6262
*
63-
* Each attribute in a GattServer have a unique handle that can be used by
64-
* clients to identify the attribute. The underlying BLE stack usually
65-
* generates and assign handles to attributes.
63+
* Each attribute in a GattServer has a unique handle that clients can use
64+
* to identify the attribute. The underlying BLE stack usually
65+
* generates and assigns handles to attributes.
6666
*/
6767
typedef ble::attribute_handle_t Handle_t;
6868

@@ -75,19 +75,19 @@ class GattAttribute {
7575
/**
7676
* Construct an attribute.
7777
*
78-
* Application code use attributes to model characteristic descriptors and
78+
* Application code uses attributes to model characteristic descriptors and
7979
* characteristics values.
8080
*
8181
* @param[in] uuid The type of the attribute.
82-
* @param[in] valuePtr Pointer to the memory buffer which contains the
82+
* @param[in] valuePtr Pointer to the memory buffer, which contains the
8383
* initial value of the attribute. The constructor does not make a copy of
84-
* the attribute buffer; as a consequence the memory buffer must remain
84+
* the attribute buffer; as a consequence, the memory buffer must remain
8585
* valid during the lifetime of the attribute.
8686
* @param[in] len The length in bytes of this attribute's value.
8787
* @param[in] maxLen The length in bytes of the memory buffer containing the
8888
* attribute value. It must be greater than or equal to @p len.
89-
* @param[in] hasVariableLen Flag that indicate if the attribute's value
90-
* length can changes over time.
89+
* @param[in] hasVariableLen Flag that indicates whether the attribute's value
90+
* length can change throughout time.
9191
*
9292
* @par Example
9393
*
@@ -121,7 +121,7 @@ class GattAttribute {
121121
/**
122122
* Get the attribute's handle in the ATT table.
123123
*
124-
* @note The attribute's handle is set by the GattServer when services are
124+
* @note The GattServer sets the attribute's handle when services are
125125
* inserted.
126126
*
127127
* @return The attribute's handle.
@@ -178,8 +178,8 @@ class GattAttribute {
178178
/**
179179
* Set the attribute handle.
180180
*
181-
* @important This function is used internally by the GattServer and must
182-
* not be used by application code.
181+
* @important The GattServer uses this function internally.
182+
* Application code must not use it.
183183
*
184184
* @param[in] id The new attribute handle.
185185
*/
@@ -199,7 +199,7 @@ class GattAttribute {
199199
}
200200

201201
/**
202-
* Check whether the length of the attribute's value can change over time.
202+
* Check whether the length of the attribute's value can change throughout time.
203203
*
204204
* @return true if the attribute value has a variable length and false
205205
* otherwise.
@@ -231,7 +231,7 @@ class GattAttribute {
231231
uint16_t _len;
232232

233233
/**
234-
* Whether the length of the value can change over time.
234+
* Whether the length of the value can change throughout time.
235235
*/
236236
bool _hasVariableLen;
237237

0 commit comments

Comments
 (0)