treewide: Add Doxygen-generated docs #189
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The existing snRuntime docs setup uses Doxygen to document the C sources, and then converts the generated XML code to Markdown for inclusion in our MkDocs documentation. The tool used for the conversion is no longer maintained. I searched and tried some alternatives (
moxygen
,mkdoxy
) but they didn’t seem robust enough. The best approach would be to use Sphinx+breathe, but our doc engine is MkDocs and shifting to Sphinx would probably require more work.This PR implements the following contributions:
team
,alloc_v2
,sync
,dma
andssr
modules of the snRuntime, containing the minimum set of functions a user would need to implement optimized code for Snitch.