Skip to content

Ble extended advertising doc fixes #8879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 4, 2018
Merged

Ble extended advertising doc fixes #8879

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da37201
BLE: Fix common/Duration.h doc.
pan- Nov 27, 2018
8c4a1a7
BLE: Improve scan response process explanation.
pan- Nov 27, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions features/FEATURE_BLE/ble/common/Duration.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ struct Value {
* Model BLE durations.
*
* @tparam Rep The representation type of the duration.
* @tparam TB The time base in us.
* @tparam TB The time base in micro seconds.
* @tparam Range Closed interval of the duration
* @tparam Forever The special value (if applicable) that represents a forever
* duration.
Expand Down Expand Up @@ -115,7 +115,7 @@ struct Duration {
/**
* Construct a Duration from an integer value.
*
* @param v The value of the duration in TN units.
* @param v The value of the duration in TIME_BASE units.
*/
explicit Duration(Rep v) : duration(clamp(v))
{
Expand All @@ -124,10 +124,10 @@ struct Duration {
/**
* Construct a Duration from another Duration.
*
* @note The operation fail at compile time of there is a loss of precision.
* @note The operation fail at compile time if there is a loss of precision.
*
* @tparam OtherRep The type used to represent the other Duration.
* @tparam OtherTB The time base in us units of the other Duration.
* @tparam OtherTB The time base in micro seconds of the other Duration.
* @tparam OtherRange The range of the other Duration.
* @tparam OtherF The forever value of the other type.
*
Expand All @@ -149,7 +149,7 @@ struct Duration {
* @tparam OtherRange The range used by other_ms.
* @tparam OtherF The forever value used by other_ms.
*
* @param other_ms The Duration in ms to convert.
* @param other_ms The Duration in millisecond to convert.
*/
template<typename OtherRep, typename OtherRange, typename OtherF>
explicit Duration(Duration<OtherRep, 1000, OtherRange, OtherF> other_ms, void* = NULL) :
Expand Down Expand Up @@ -270,7 +270,7 @@ typedef Duration<uint32_t, 1000 * millisecond_t::TIME_BASE> second_t;
* @tparam RangeIn The range of duration.
* @tparam FIn The Forever value of duration.
* @param duration The duration to convert.
* @return The converted duration. It is rounded up if precision is loss.
* @return The converted duration. It is rounded up if precision is lost.
*
* @related Duration
*/
Expand Down
4 changes: 2 additions & 2 deletions features/FEATURE_BLE/ble/gap/ScanParameters.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ namespace ble {
* same value.
*
* To get extra data from the advertising device, the scanner can send scan
* requests to the advertiser that respond with a scan response. It is possible
* to select what type of address is used to issue the scan request.
* requests to the advertiser; the advertiser may respond with scan responses.
* It is possible to select what type of address is used to issue the scan request.
*
* With Bluetooth 5, devices can advertise on more physical channels, and by
* extension, they can scan on more physical channels. It is possible to define
Expand Down