NordicSemiconductor / IOS-DFU-Library

OTA DFU Library for Mac and iOS, compatible with nRF5x SoCs
http://www.nordicsemi.com
BSD 3-Clause "New" or "Revised" License
525 stars 214 forks source link

Missing Documentation?? #467

Open nissaba opened 2 years ago

nissaba commented 2 years ago

Hi, I am looking for the Documentation. And I do not mean the snippet of Documentation link on the main page of the Github repo page. aka: https://github.com/NordicSemiconductor/IOS-DFU-Library/blob/master/documentation.md

near the end it talks about the "DFUServiceController" which as 0 information on, and code completion for the most part does not offer any information on methods or classes.

Unless no one as taken the time to write it and that the nrfToolbox project is considered as the "Documentation" in which case this is sad as an example project is never a replacement for actual Documentation.

Really hopping to find real Documentation.

philips77 commented 2 years ago

Hello, thank you for the feedback. I'm afraid we don't have more than what's in GitHub.

Isn't that class self explanatory? It's returned here: https://github.com/NordicSemiconductor/IOS-DFU-Library/blob/fc05e4629df3f71de7492dea9a377b82d5500a24/iOSDFULibrary/Classes/Implementation/DFUServiceInitiator.swift#L490-L492

What would you like to know more?