Skip to content

doc: generate API documentation and require everything to be documented #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 16 commits into from
Dec 6, 2023
Merged

doc: generate API documentation and require everything to be documented #28

merged 16 commits into from
Dec 6, 2023

Conversation

@c-dilks
Copy link
Member

@c-dilks c-dilks commented Nov 30, 2023 •
edited
Loading

  • generates API documentation with doxygen
  • deploys it to GitHub pages
  • bonus feature: the CI now enforces that everything is documented

@c-dilks c-dilks marked this pull request as ready for review December 6, 2023 23:52
@c-dilks c-dilks changed the title doc: generate doxygen documentation doc: generate API documentation and require everything to be documented Dec 6, 2023
@c-dilks c-dilks merged commit 87f85ad into main Dec 6, 2023
@c-dilks c-dilks deleted the doxygen branch December 6, 2023 23:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@c-dilks