Skip to content

Commit b3b0501

Browse files
author
Cruz Monrreal
authored
Merge pull request #8879 from pan-/ble-extended-advertising-doc-fixes
Ble extended advertising doc fixes
2 parents 0f0e63a + 8c4a1a7 commit b3b0501

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

features/FEATURE_BLE/ble/common/Duration.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ struct Value {
8686
* Model BLE durations.
8787
*
8888
* @tparam Rep The representation type of the duration.
89-
* @tparam TB The time base in us.
89+
* @tparam TB The time base in micro seconds.
9090
* @tparam Range Closed interval of the duration
9191
* @tparam Forever The special value (if applicable) that represents a forever
9292
* duration.
@@ -115,7 +115,7 @@ struct Duration {
115115
/**
116116
* Construct a Duration from an integer value.
117117
*
118-
* @param v The value of the duration in TN units.
118+
* @param v The value of the duration in TIME_BASE units.
119119
*/
120120
explicit Duration(Rep v) : duration(clamp(v))
121121
{
@@ -124,10 +124,10 @@ struct Duration {
124124
/**
125125
* Construct a Duration from another Duration.
126126
*
127-
* @note The operation fail at compile time of there is a loss of precision.
127+
* @note The operation fail at compile time if there is a loss of precision.
128128
*
129129
* @tparam OtherRep The type used to represent the other Duration.
130-
* @tparam OtherTB The time base in us units of the other Duration.
130+
* @tparam OtherTB The time base in micro seconds of the other Duration.
131131
* @tparam OtherRange The range of the other Duration.
132132
* @tparam OtherF The forever value of the other type.
133133
*
@@ -149,7 +149,7 @@ struct Duration {
149149
* @tparam OtherRange The range used by other_ms.
150150
* @tparam OtherF The forever value used by other_ms.
151151
*
152-
* @param other_ms The Duration in ms to convert.
152+
* @param other_ms The Duration in millisecond to convert.
153153
*/
154154
template<typename OtherRep, typename OtherRange, typename OtherF>
155155
explicit Duration(Duration<OtherRep, 1000, OtherRange, OtherF> other_ms, void* = NULL) :
@@ -270,7 +270,7 @@ typedef Duration<uint32_t, 1000 * millisecond_t::TIME_BASE> second_t;
270270
* @tparam RangeIn The range of duration.
271271
* @tparam FIn The Forever value of duration.
272272
* @param duration The duration to convert.
273-
* @return The converted duration. It is rounded up if precision is loss.
273+
* @return The converted duration. It is rounded up if precision is lost.
274274
*
275275
* @related Duration
276276
*/

features/FEATURE_BLE/ble/gap/ScanParameters.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ namespace ble {
4141
* same value.
4242
*
4343
* To get extra data from the advertising device, the scanner can send scan
44-
* requests to the advertiser that respond with a scan response. It is possible
45-
* to select what type of address is used to issue the scan request.
44+
* requests to the advertiser; the advertiser may respond with scan responses.
45+
* It is possible to select what type of address is used to issue the scan request.
4646
*
4747
* With Bluetooth 5, devices can advertise on more physical channels, and by
4848
* extension, they can scan on more physical channels. It is possible to define

0 commit comments

Comments
 (0)