Search code examples
swiftrxiosble

RxBluetoothKit documentation?

I'm trying out RxBluetoothKit and one of the bullet point features is "Documentation", but the link for that leads to a page which is just a copy of the README with a sidebar saying "Error Parsing Pod Could not find Objective-C Classes."

The README is quite detailed, and the sample code is useful, but an API reference would be nice for the more tricky details. For example, the README has an example with this code:

peripheral.connect()
.flatMap { $0.discoverServices([serviceId]) }

I have no idea what type serviceId is - I presume it's not a string.

Solution

  • All of the documentation is written above the methods so while typing discoverServices in Xcode you should be able to click on method with options key and little popup will come up with formatted documentation. Our doc is formatted by the CocoaDocs - it appears that it has some problems. I'm working on fixing it - here you can find the issue Github issue