Skip to content

Commit d00ad8b

Browse files
author
Amanda Butler
authored
Edit ScanParameters.h
Edit file, mostly to fix typos.
1 parent fa784c2 commit d00ad8b

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

features/FEATURE_BLE/ble/gap/ScanParameters.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ namespace ble {
4444
* requests to the advertiser that respond with a scan response. It is possible
4545
* to select what type of address is used to issue the scan request.
4646
*
47-
* With Bluetooth 5, devices can advertise on more physical channels and by
48-
* extension they can scan on more physical channel. It is possible to define
47+
* With Bluetooth 5, devices can advertise on more physical channels, and by
48+
* extension, they can scan on more physical channels. It is possible to define
4949
* independent scan parameters for every scannable physical channel.
5050
*/
5151
class ScanParameters {
@@ -58,7 +58,7 @@ class ScanParameters {
5858
/**
5959
* Construct a phy_configuration_t.
6060
* @param scan_interval The scan interval.
61-
* @param scan_window The scan window
61+
* @param scan_window The scan window.
6262
* @param active_scanning True if scan request should be sent and false
6363
* otherwise.
6464
*/
@@ -107,12 +107,12 @@ class ScanParameters {
107107
};
108108

109109
/**
110-
* Construct a ScanParameters object that operate on a selected phy.
110+
* Construct a ScanParameters object that operates on a selected PHY.
111111
*
112112
* @param phy The phy to configure.
113113
* @param scan_interval The scan interval.
114114
* @param scan_window The scan window.
115-
* @param active_scanning active scanning flag
115+
* @param active_scanning active scanning flag.
116116
* @param own_address_type Address type used in scan requests.
117117
* @param scanning_filter_policy Filter applied.
118118
*/
@@ -159,7 +159,7 @@ class ScanParameters {
159159

160160
/**
161161
* Set the filter to apply during scanning.
162-
* @param filter_policy The filter to apply during scannong.
162+
* @param filter_policy The filter to apply during scanning.
163163
* @return A reference to this object.
164164
*/
165165
ScanParameters &setFilter(scanning_filter_policy_t filter_policy)
@@ -177,7 +177,7 @@ class ScanParameters {
177177
}
178178

179179
/**
180-
* Enable or disable phys that should be used during scanning .
180+
* Enable or disable PHYs that should be used during scanning.
181181
* @param enable_1m True to enable the 1M phy and false to disable it.
182182
* @param enable_coded True to enable the coded phy and false to disable it.
183183
* @return A reference to this object.
@@ -190,7 +190,7 @@ class ScanParameters {
190190
}
191191

192192
/**
193-
* Get the phys to use during scanning.
193+
* Get the PHYs to use during scanning.
194194
*/
195195
phy_set_t getPhys() const
196196
{
@@ -226,7 +226,7 @@ class ScanParameters {
226226
}
227227

228228
/**
229-
* Set the coded phy scan configuration.
229+
* Set the coded PHY scan configuration.
230230
* @param interval The scan interval to use.
231231
* @param window The scan window to use.
232232
* @param active_scanning The active scanning flag.
@@ -246,7 +246,7 @@ class ScanParameters {
246246
}
247247

248248
/**
249-
* Get the coded phy scan configuration.
249+
* Get the coded PHY scan configuration.
250250
*/
251251
phy_configuration_t getCodedPhyConfiguration() const
252252
{

0 commit comments

Comments
 (0)