Skip to content

Commit 4702ff2

Browse files
author
Amanda Butler
authored
Copy edit GapAdvertisingParams.h
Make minor copy edits, mostly for active voice and comma use.
1 parent 6e45541 commit 4702ff2

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

features/FEATURE_BLE/ble/GapAdvertisingParams.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@
2828
* Parameters defining the advertising process.
2929
*
3030
* Advertising parameters are a triplet of three value:
31-
* - The Advertising mode which is modeled after AdvertisingType_t. It defines
32-
* if the device is connectable, scanable, ... This value can be set at
31+
* - The Advertising mode modeled after AdvertisingType_t. It defines
32+
* if the device is connectable and scannable. This value can be set at
3333
* construction time, updated with setAdvertisingType() and queried by
3434
* getAdvertisingType().
3535
* - Time interval between advertisement. It can be set at construction time,
3636
* updated by setInterval() and obtained from getInterval().
37-
* - Duration of the advertising process. As others it can be set at
37+
* - Duration of the advertising process. As others, it can be set at
3838
* construction time, modified by setTimeout() and retrieved by getTimeout().
3939
*/
4040
class GapAdvertisingParams {
@@ -49,7 +49,7 @@ class GapAdvertisingParams {
4949
static const unsigned GAP_ADV_PARAMS_INTERVAL_MIN = 0x0020;
5050

5151
/**
52-
* Minimum Advertising interval for scannable and non-connectable
52+
* Minimum Advertising interval for scannable and nonconnectable
5353
* undirected events in 625us units.
5454
*
5555
* @note Equal to 100ms.
@@ -84,7 +84,7 @@ class GapAdvertisingParams {
8484
ADV_CONNECTABLE_UNDIRECTED,
8585

8686
/**
87-
* Device is connectable and expect connection from a specific peer.
87+
* Device is connectable and expects connection from a specific peer.
8888
*
8989
* @see Vol 3, Part C, Section 9.3.3 and Vol 6, Part B, Section 2.3.1.2.
9090
*/
@@ -108,7 +108,7 @@ class GapAdvertisingParams {
108108
/**
109109
* Alias for GapAdvertisingParams::AdvertisingType_t.
110110
*
111-
* @deprecated This type alias will be dropped in future releases.
111+
* @deprecated Future releases will drop this type alias.
112112
*/
113113
typedef enum AdvertisingType_t AdvertisingType;
114114

@@ -122,7 +122,7 @@ class GapAdvertisingParams {
122122
* @param[in] timeout Duration in seconds of the advertising process. A
123123
* value of 0 indicate that there is no timeout of the advertising process.
124124
*
125-
* @note If value in input are out of range they will be normalized.
125+
* @note If value in input are out of range, they will be normalized.
126126
*/
127127
GapAdvertisingParams(
128128
AdvertisingType_t advType = ADV_CONNECTABLE_UNDIRECTED,
@@ -273,7 +273,7 @@ class GapAdvertisingParams {
273273
AdvertisingType_t _advType;
274274

275275
/**
276-
* The advertising interval in ADV duration units (i.e. 0.625ms).
276+
* The advertising interval in ADV duration units (in other words, 0.625ms).
277277
*/
278278
uint16_t _interval;
279279

0 commit comments

Comments
 (0)