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

Edit AdvertisingParameters.h 

Edit file, mostly for active voice and U.S. spelling.
pull/8738/head
Amanda Butler 2018-11-26 18:32:35 -06:00 committed by GitHub
parent 31a73fc007
commit c904ac898a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
features/FEATURE_BLE/ble/gap/AdvertisingParameters.h
View File

@ -40,30 +40,30 @@ namespace ble {
* *
* Advertising parameters for legacy advertising are a mainly defined by a pair * Advertising parameters for legacy advertising are a mainly defined by a pair
* of values: * of values:
* - The Advertising mode modelled after advertising_type_t. It defines * - The Advertising mode modeled after advertising_type_t. It defines
* if the device is connectable and scannable. This value can be set at * whether the device is connectable and scannable. You can set this value at
* construction time, updated with setType() and queried by getType(). * construction time, update it with setType() and query it with getType().
* - Time interval between advertisement. It can be set at construction time, * - Time interval between advertisement. You can set it at construction time,
* updated by setPrimaryInterval() and obtained from getMinPrimaryInterval() * update it with setPrimaryInterval() and obtain it from getMinPrimaryInterval()
* and getMaxPrimaryInterval(). * and getMaxPrimaryInterval().
* *
* In addition, it is possible to adjust other parameters: * In addition, it is possible to adjust other parameters:
* - The advertising channels can be selected with setPrimaryChannels() and * - You can select the advertising channels with setPrimaryChannels() and
* queried by getChannel37(), getChannel38() and getChannel39(). * queried them with getChannel37(), getChannel38() and getChannel39().
* - The address type used by the local device can be set with setOwnAddressType() * - You can set the address type used by the local device with setOwnAddressType()
* and queried by getOwnAddressType(). * and query it by getOwnAddressType().
* - The filter policy for scan and connection requests can be set with * - You can set the filter policy for scan and connection requests with
* setFilter() and queried by getFilter(). * setFilter() and query it with getFilter().
* *
* For directed advertising, the address of the target can be set with the help * For directed advertising, you can set the address of the target with the help
* of setPeer() and queried by getPeerAddress() and getPeerAddressType(). * of setPeer() and query it with getPeerAddress() and getPeerAddressType().
* *
* @par Extended advertising: * @par Extended advertising:
* *
* To use extended advertising features, legacy advertising should be disabled * To use extended advertising features, first disable legacy advertising
* first with setUseLegacyPDU(). * with setUseLegacyPDU().
* *
* Extended advertising add new features to BLE advertising: * Extended advertising adds new features to BLE advertising:
* - Control the advertising power with setTxPower(). * - Control the advertising power with setTxPower().
* - Include the Tx power in advertising packet with includeTxPowerInHeader(). * - Include the Tx power in advertising packet with includeTxPowerInHeader().
* - Set a secondary phy_t channel with setPhy(). * - Set a secondary phy_t channel with setPhy().
@ -73,8 +73,8 @@ namespace ble {
* *
* @par Fluent interface: * @par Fluent interface:
* *
* This API is designed with usability in mind. It is perfectly legal to * This API is designed for usability. You can construct
* construct it and pass it in place. To achieve this the fluent interface pattern * it and pass it in place. To achieve this, the fluent interface pattern
* is used. Every setter returns a reference to the object modified and can be * is used. Every setter returns a reference to the object modified and can be
* chained. * chained.
* *
@ -121,10 +121,10 @@ public:
* *
* @param[in] advType Type of advertising. * @param[in] advType Type of advertising.
* @param[in] minInterval, maxInterval Time interval between two advertisement. * @param[in] minInterval, maxInterval Time interval between two advertisement.
* A range is provided to the LE subsystem so it can adjust the advertising * A range is provided to the LE subsystem, so it can adjust the advertising
* interval with other transmission happening on the BLE radio. * interval with other transmission happening on the BLE radio.
* *
* @note If value in input are out of range, they will be normalized. * @note If values in input are out of range, they will be normalized.
*/ */
AdvertisingParameters( AdvertisingParameters(
advertising_type_t advType = advertising_type_t::CONNECTABLE_UNDIRECTED, advertising_type_t advType = advertising_type_t::CONNECTABLE_UNDIRECTED,
@ -184,8 +184,8 @@ public:
/** Set the advertising intervals on the primary channels. /** Set the advertising intervals on the primary channels.
* *
* @param[in] min, max Time interval between two advertisement. * @param[in] min, max Time interval between two advertisements.
* A range is provided to the LE subsystem so it can adjust the advertising * A range is provided to the LE subsystem, so it can adjust the advertising
* interval with other transmission happening on the BLE radio. * interval with other transmission happening on the BLE radio.
* *
* @return reference to this object. * @return reference to this object.
@ -218,7 +218,7 @@ public:
} }
/** Set which channels are to be used for primary advertising. /** Set which channels are to be used for primary advertising.
* At least must be used. If all are set to disabled all channels will be used. * At least must be used. If all are set to disabled, all channels will be used.
* *
* @param channel37 Use channel 37. * @param channel37 Use channel 37.
* @param channel38 Use channel 38. * @param channel38 Use channel 38.
@ -446,7 +446,7 @@ public:
/** Use legacy PDU during advertising. /** Use legacy PDU during advertising.
* *
* @param enable If true legacy PDU will be used. * @param enable If true, legacy PDU will be used.
* *
* @return A reference to this object. * @return A reference to this object.
*/ */
@ -467,7 +467,7 @@ public:
/** Set if TX power should be included in the header. /** Set if TX power should be included in the header.
* *
* @param enable If true include the TX power in the header. * @param enable If true, include the TX power in the header.
* *
* @return A reference to this object. * @return A reference to this object.
*/ */