Skip to content

a VERY WIP draft of automated api level docs with exhale and breathe#1409

Draft
obra wants to merge 1 commit into
masterfrom
f/exhale-docs
Draft

a VERY WIP draft of automated api level docs with exhale and breathe#1409
obra wants to merge 1 commit into
masterfrom
f/exhale-docs

Conversation

@obra

@obra obra commented Mar 13, 2024

Copy link
Copy Markdown
Member

Right now, classes and structs aren't docced with their namespaces in nav, which is a deal breaker

  • A first pass at trying to get doxygen and exhale and breathe to play nice so we can have api-level docs
  • Update Doxyfile config for better group and inline class display
  • Update INPUT path in Doxyfile for plugin documentation inclusion
  • Update copyright year in conf.py and adjust Sphinx settings
  • Add conditional compilation directives to skip specific sections in HIDTables.h and key_indexes.h files
  • Doc cRGB struct in None.h for RGB values representation

  nice so we can have api-level docs

- Update Doxyfile config for better group and inline class display
- Update INPUT path in Doxyfile for plugin documentation inclusion
- Update copyright year in conf.py and adjust Sphinx settings
- Add conditional compilation directives to skip specific sections in HIDTables.h and key_indexes.h files
- Doc cRGB struct in None.h for RGB values representation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant