occa icon indicating copy to clipboard operation
occa copied to clipboard

Runtime API Documentation

Open kris-rowe opened this issue 3 years ago • 0 comments

Documentation for many of the runtime classes is available via the libocca.org website, however there are gaps in several areas.

Currently this is auto generated from source code comments using Doxygen.

Todo

  • [ ] Review existing runtime API documentation at libocca.org
  • [ ] Identify classes or concepts which are have incomplete or missing documentation (e.g. Streams, Background Device etc.)
  • [ ] Add documentation via source code and separate files as appropriate
  • [ ] Determine the optimal means of incorporating auto-generated (Doxygen) files into the OCCA GitHub wiki

kris-rowe avatar Mar 23 '22 19:03 kris-rowe