Skip to content

Generate documentation from Commodore components #39

@simu

Description

@simu

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

  • Commodore component Doxygen comments are rendered and displayed alongside the rest of the documentation
  • How to document components is documented

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions