• State Verified Answer
  • Replies 3 replies
  • Subscribers 62 subscribers
  • Views 1385 views
  • Users 0 members are here
Attachments (0)
Nordic Case Info
  • Case ID: 105066
Options
This post is older than 2 years and might not be relevant anymore
More Info: Consider searching for newer posts

formatted documention for s120 v2.0?

pabigot

The only documentation I can find for s120 is part of the nRF51 SDK. Though it isn't clearly stated the SDK assumes release 1.0.1 of S120 is being used.

The v2.0.0 S120 package has a ble_api.dox file, but it depends on an external tool. There's also no doxygen.cfg for generating material from the headers.

I'm aware of the migration-document, but it's inconvenient to read the full documentation then look somewhere else to see if what we just read is no longer true. Is per-release self-contained soft-device documentation available somewhere decoupled from SDK releases?

If not, please make it available. Thanks.

  • 0

    There's none I know of. I spent an afternoon messing around with doxygen trying to roll my own but I suspect there's more goes into the input for documentation than just the header files and didn't end up with a very good result.

    What I'd love myself is if Nordic would build a 'docset', something which doxygen does support with a couple of command-line options although I expect it would take a little work to get a good one. That you could then read with any docset reader like Dash, search, link, bookmark.

  • 0

    Unfortunately, we don't have such documentation available. Usually, this is not a big issue, because the time between a SoftDevice release and the next SDK release is short.

    I have reported this, and we will look into having a separate API documentation for the SoftDevices.

  • 0 in reply to Petter Myhre

    Part of the problem may be that S110 1.0.1 is the only one marked as stable; SDK 7.2.0 came out after S110 v2.0.0 but still has S110 1.0.1 in it. I do think you should have API documentation for each released soft device version and make it available in a permanent location. Some of us do use the soft devices without using the rest of the SDK (except the CMSIS headers which don't change very often) and that would make it easier to know which SD version we're using (because SD version information is not obvious from SDK version information in the URL).

Related