8000 Add doxygen API generation into our documentation · Issue #2624 · zmkfirmware/zmk · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
Add doxygen API generation into our documentation #2624
Open
@petejohanson

Description

@petejohanson

To keep our documentation in sync, we should document all public APIs ( see #2619 ) with proper doxygen annotations, and add a doxygen step to our documentation generation to integrate proper API docs into our site.

Needs:

  • Doxygen setup and generation
  • Enhance docusaurus to integrate doxygen generated pages as nicely as possible (research needed here)

Optional:

  • Add CI check (pre-commit? Something else?) for ensuring all public API types, functions, etc are properly documented?

Metadata

Metadata

Assignees

No one assigned

    Labels

    coreCore functionality/behavior of ZMKdocumentationImprovements or additions to documentationenhancementNew feature or requestgithub_actionsPull requests that update Github_actions code

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0