28
28
* Parameters defining the advertising process.
29
29
*
30
30
* 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
33
33
* construction time, updated with setAdvertisingType() and queried by
34
34
* getAdvertisingType().
35
35
* - Time interval between advertisement. It can be set at construction time,
36
36
* 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
38
38
* construction time, modified by setTimeout() and retrieved by getTimeout().
39
39
*/
40
40
class GapAdvertisingParams {
@@ -49,7 +49,7 @@ class GapAdvertisingParams {
49
49
static const unsigned GAP_ADV_PARAMS_INTERVAL_MIN = 0x0020 ;
50
50
51
51
/* *
52
- * Minimum Advertising interval for scannable and non-connectable
52
+ * Minimum Advertising interval for scannable and nonconnectable
53
53
* undirected events in 625us units.
54
54
*
55
55
* @note Equal to 100ms.
@@ -84,7 +84,7 @@ class GapAdvertisingParams {
84
84
ADV_CONNECTABLE_UNDIRECTED,
85
85
86
86
/* *
87
- * Device is connectable and expect connection from a specific peer.
87
+ * Device is connectable and expects connection from a specific peer.
88
88
*
89
89
* @see Vol 3, Part C, Section 9.3.3 and Vol 6, Part B, Section 2.3.1.2.
90
90
*/
@@ -108,7 +108,7 @@ class GapAdvertisingParams {
108
108
/* *
109
109
* Alias for GapAdvertisingParams::AdvertisingType_t.
110
110
*
111
- * @deprecated This type alias will be dropped in future releases .
111
+ * @deprecated Future releases will drop this type alias .
112
112
*/
113
113
typedef enum AdvertisingType_t AdvertisingType;
114
114
@@ -122,7 +122,7 @@ class GapAdvertisingParams {
122
122
* @param[in] timeout Duration in seconds of the advertising process. A
123
123
* value of 0 indicate that there is no timeout of the advertising process.
124
124
*
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.
126
126
*/
127
127
GapAdvertisingParams (
128
128
AdvertisingType_t advType = ADV_CONNECTABLE_UNDIRECTED,
@@ -273,7 +273,7 @@ class GapAdvertisingParams {
273
273
AdvertisingType_t _advType;
274
274
275
275
/* *
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).
277
277
*/
278
278
uint16_t _interval;
279
279
0 commit comments