New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Runtime API Documentation #559

Open

4 tasks

kris-rowe opened this issue Mar 23, 2022 · 0 comments

Labels

help wanted runtime user docs

Milestone

Community Profile...

Member

kris-rowe commented Mar 23, 2022

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 added user docs help wanted labels

kris-rowe added this to the Community Profile Refresh milestone

kris-rowe added the runtime label

kris-rowe pinned this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment