Skip to content

Add ability to generate API reference docs with Doxygen#96

Merged
crandmck merged 11 commits into
mainfrom
doxygen-docs
Oct 24, 2025
Merged

Add ability to generate API reference docs with Doxygen#96
crandmck merged 11 commits into
mainfrom
doxygen-docs

Conversation

@crandmck
Copy link
Copy Markdown
Contributor

@crandmck crandmck commented Sep 16, 2025

This adds a script to generate API reference docs using Doxygen.

NOTE: The generated HTML docs are not committed to the repo in this PR.

To do this properly, we need to add a GH worfkow similar to this https://github.com/creator-assertions/creator-assertions.github.io/blob/main/.github/workflows/publish.yml, which will build the docs using Sphinx and deploy them to GH Pages for consumption. We can then link to that from the OS doc site.

When this is working, we should have API docs published to https://contentauth.github.io/c2pa-c/

@crandmck crandmck changed the title Add script to generate API reference docs with Doxygen Add ability to generate API reference docs with Doxygen Sep 16, 2025
@crandmck crandmck marked this pull request as draft September 17, 2025 16:59
@crandmck crandmck marked this pull request as ready for review September 18, 2025 22:46
Copy link
Copy Markdown
Collaborator

@tmathern tmathern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving - as long as the scripting errors that make the Github action fail get fixed.

@crandmck
Copy link
Copy Markdown
Contributor Author

@crandmck crandmck merged commit 6475f64 into main Oct 24, 2025
3 checks passed
@tmathern tmathern deleted the doxygen-docs branch November 9, 2025 18:38
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.

3 participants