Skip to content

Setup documentation #2

@taminob

Description

@taminob

To maintain an up-to-date documentation, it should be close to the code.
For this, doxygen comments probably make the most sense.

The goal should be:

  • Add documentation to every (public) interface class and method
  • Setup doxygen generation via cmake
  • Create CI to generate documentation
  • Host documentation on Github

Metadata

Metadata

Assignees

No one assigned

    Labels

    cmakeRelated to cmake build systemdocumentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions