projectsyn / documentation

The Project Syn main documentation repository
https://docs.syn.tools/
BSD 3-Clause "New" or "Revised" License
6 stars 3 forks source link

Generate documentation from Commodore components #39

Open simu opened 4 years ago

simu commented 4 years ago

We previously experimented with Doxygen to auto-generate some API documentation for components (especially components which provide libraries for other components to use). Integrate generating documentation from Doxygen comments into the documentation infrastructure and document how to document components (e.g. using file-level Doxygen comments).

This will only become relevant once components have been migrated from the VSHN internal GitLab to GitHub.

Task deliverables