• ...
  • Yocto
  • production

Add API documentation#

To have self containing SimpleSwitch™ packages and SimpleSwitch™ SDK templates, you can add documentation on the APIs this one offers.

Private and public API documentation#

We distinguish between

  • public APIs - interfaces that can be used from the outside, e.g. MQTT

  • private APIs - interfaces that can be linked against, e.g. libraries

Reference API documentation#

In any recipe that contributes packages, you can add

inherit simpleswitch-apidocs

This will scan ${S} for

  • API.md, that will be considered a public API

  • API-private.md, that will be considered a private API

Including API documentation in a SimpleSwitch™ package#

All SimpleSwitch™ packages automatically inherit the generated API documentation of all recipes that will provide such.

E.g. if your recipe my-custom-recipe provides API documentation, a simple

IMAGE_INSTALL += "my-custom-recipe"

will suffice.

By default only public API documentation is included.

The included API documentation can be viewed with our SimpleSwitch™-launcher.

Including API documentation in a SimpleSwitch™ SDK template#

All SimpleSwitch™ SDK templates automatically inherit the generated API documentation of all recipes that will provide such.

E.g. if your recipe my-custom-recipe provides API documentation, a simple

IMAGE_INSTALL += "my-custom-recipe"

will suffice.

By default public and private API documentation is included.

The included API documentation can be viewed using our vscode extension, see Visual Studio code integration for more details.