Skip to content

Commit

Permalink
Update Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
PSchmiedmayer committed Nov 15, 2023
1 parent 6718be7 commit 4b364b2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,9 @@ public class MyDeviceModule: DefaultInitializable, Module {
public required init() {}


/// Configuration method to register the `MyDevice` as a ``BluetoothMessageHandler`` for the Bluetooth module.
@_documentation(visibility: internal)
/// Configuration method to create the `MyDevice` and pass in the Bluetooth module.
public func configure() {
bluetooth.add(messageHandler: myDevice)
self.myDevice = MyDevice(bluetooth: bluetooth)
}
}
```
Expand Down Expand Up @@ -163,7 +162,6 @@ public class MyDevice: BluetoothMessageHandler {
}

// Example implementation of the ``BluetoothMessageHandler`` requirements.
@_documentation(visibility: internal)
public func recieve(_ data: Data, service: CBUUID, characteristic: CBUUID) {
switch service {
case MyDeviceBluetoothConstants.exampleService.serviceUUID:
Expand Down
6 changes: 2 additions & 4 deletions Sources/SpeziBluetooth/SpeziBluetooth.docc/SpeziBluetooth.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,9 @@ public class MyDeviceModule: DefaultInitializable, Module {
public required init() {}


/// Configuration method to register the `MyDevice` as a ``BluetoothMessageHandler`` for the Bluetooth module.
@_documentation(visibility: internal)
/// Configuration method to create the `MyDevice` and pass in the Bluetooth module.
public func configure() {
bluetooth.add(messageHandler: myDevice)
self.myDevice = MyDevice(bluetooth: bluetooth)
}
}
```
Expand Down Expand Up @@ -152,7 +151,6 @@ public class MyDevice: BluetoothMessageHandler {
}

// Example implementation of the ``BluetoothMessageHandler`` requirements.
@_documentation(visibility: internal)
public func recieve(_ data: Data, service: CBUUID, characteristic: CBUUID) {
switch service {
case MyDeviceBluetoothConstants.exampleService.serviceUUID:
Expand Down

0 comments on commit 4b364b2

Please sign in to comment.