Skip to content
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.

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

Add doxygen github action to generate doc and doc coverage. #20

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

shamitha-shashidhara
Copy link

Generated comprehensive documentation using Doxygen comments. Generated documentation coverage numbers using Covrxygen. Generating DoxygenWarningLog.txt, which includes warnings about undocumented elements.

Files Added
doxygen-build.yml: Workflow file to build the Doxygen documentation.
doxygen-publish.yml: Workflow file to publish the Doxygen documentation.
Doxyfile: Configuration file for Doxygen.
DoxygenMainPage.md: Main entry page for Doxygen documentation.
README.md: Updated to include instructions on how to generate and view the Doxygen documentation.

@frankdarcyacn
Copy link
Contributor

frankdarcyacn commented Nov 13, 2024

We need to be careful that Doxyfile in this PR does not conflict with the one currently in gerrit's referenceApp workspace main branch - that version has GENERATE_XML=NO whereas in this PR GENERATE_XML=YES (as needed to generate coverage).
Maybe its easiest to set GENERATE_XML=YES in gerrit first, but that would mean that XML is always generated, even when we just want HTML, and it would take twice as long (roughly).
@marcmo - do we know when gerrit will next be synced to github?
Alternatively, perhaps we could leave is at GENERATE_XML=NO and if we want to generate XML for coverage then change it on the command line like this...

sed -i '/GENERATE_XML.*=.*NO/c\GENERATE_XML = YES' ./Doxyfile
doxygen Doxyfile

Just a thought.

@shamitha-shashidhara shamitha-shashidhara marked this pull request as draft November 15, 2024 11:51
@shamitha-shashidhara shamitha-shashidhara force-pushed the Doxygen_action branch 3 times, most recently from 4a9fc46 to ef54acf Compare November 18, 2024 11:20
@shamitha-shashidhara shamitha-shashidhara changed the title Add doxygen github action to generate documentation and coverage. Add doxygen github action to generate doc and doc coverage. Nov 18, 2024
@shamitha-shashidhara shamitha-shashidhara marked this pull request as ready for review November 20, 2024 05:55
@ThoFrank ThoFrank mentioned this pull request Nov 20, 2024
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.

2 participants