@@ -3,11 +3,11 @@ import CoreBluetooth
3
3
@testable import RxBluetoothKit
4
4
import RxSwift
5
5
6
- /// _PeripheralManager is a class implementing ReactiveX API which wraps all Core Bluetooth _Peripheral's functions allowing to
7
- /// advertising, publishing L2CAP channels and more.
8
- /// You can start using this class by add services and starting advertising.
6
+ /// _PeripheralManager is a class implementing ReactiveX API which wraps all the Core Bluetooth _Peripheral's functions, that allow to
7
+ /// advertise, to publish L2CAP channels and more.
8
+ /// You can start using this class by adding services and starting advertising.
9
9
/// Before calling any public `_PeripheralManager`'s functions you should make sure that Bluetooth is turned on and powered on. It can be done
10
- /// by calling and observing returned value of `observeState()` and then chaining it with `add(_:)` with `startAdvertising(_:)`:
10
+ /// by `observeState()`, observing it's value and then chaining it with `add(_:)` and `startAdvertising(_:)`:
11
11
/// ```
12
12
/// let disposable = centralManager.observeState
13
13
/// .startWith(centralManager.state)
@@ -16,7 +16,7 @@ import RxSwift
16
16
/// .flatMap { centralManager.add(myService) }
17
17
/// .flatMap { centralManager.startAdvertising(myAdvertisementData) }
18
18
/// ```
19
- /// As a result your peripheral will start advertising. To stop advertising simply dispose it:
19
+ /// As a result, your peripheral will start advertising. To stop advertising simply dispose it:
20
20
/// ```
21
21
/// disposable.dispose()
22
22
/// ```
@@ -86,12 +86,12 @@ class _PeripheralManager: _ManagerType {
86
86
/// refer to ``StartAdvertisingResult` documentation.
87
87
///
88
88
/// There can be only one ongoing advertising (CoreBluetooth limit).
89
- /// It will return `advertisingInProgress` error if this method will be called when
89
+ /// It will return `advertisingInProgress` error if this method is called when
90
90
/// it is already advertising.
91
91
///
92
92
/// Advertising is automatically stopped just after disposing of the subscription.
93
93
///
94
- /// It can return `_BluetoothError.advertisingStartFailed` error when start advertisement failed
94
+ /// It can return `_BluetoothError.advertisingStartFailed` error, when start advertisement failed
95
95
///
96
96
/// - parameter advertisementData: Services of peripherals to search for. Nil value will accept all peripherals.
97
97
/// - returns: Infinite observable which emit `StartAdvertisingResult` when advertisement started.
@@ -150,9 +150,9 @@ class _PeripheralManager: _ManagerType {
150
150
151
151
// MARK: Services
152
152
153
- /// Function that triggers `CBPeripheralManagerMock.add(_:)` method and waits for
153
+ /// Function that triggers `CBPeripheralManagerMock.add(_:)` and waits for
154
154
/// delegate `CBPeripheralManagerDelegate.peripheralManager(_:didAdd:error:)` result.
155
- /// If it will receive non nil error in result than `Observable` will emit `_BluetoothError.addingServiceFailed` error.
155
+ /// If it receives a non nil in the result, it will emit `_BluetoothError.addingServiceFailed` error.
156
156
/// Add method is called after subscription to `Observable` is made.
157
157
/// - Parameter service: `_Characteristic` to read value from
158
158
/// - Returns: `Single` which emits `next` with given characteristic when value is ready to read.
@@ -295,7 +295,7 @@ class _PeripheralManager: _ManagerType {
295
295
296
296
#if os(iOS) || os(tvOS) || os(watchOS)
297
297
298
- /// Starts publishing L2CAP channel on subscription. It create inifinite observable
298
+ /// Starts publishing L2CAP channel on a subscription. It creates an infinite observable
299
299
/// which emits only one next value, of `CBL2CAPPSM` type, just
300
300
/// after L2CAP channel has been published.
301
301
///
0 commit comments