ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #8879 from pan-/ble-extended-advertising-doc-fixes 

Ble extended advertising doc fixes
pull/9050/head
Cruz Monrreal 2018-12-04 11:51:44 -06:00 committed by GitHub
parent 0f0e63aaac 8c4a1a7b7a
commit b3b050170e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
features/FEATURE_BLE/ble/common/Duration.h
View File

@ -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.
@ -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))
{
@ -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.
*
@ -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) :
@ -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
*/

4
features/FEATURE_BLE/ble/gap/ScanParameters.h
View File

@ -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