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

[CI/Meta]: Add documentation validation checking #356

Merged
merged 1 commit into from
Nov 23, 2023
Merged

Conversation

ad3154
Copy link
Member

@ad3154 ad3154 commented Nov 23, 2023

  • Added an action to validate doxygen builds with no warnings.
  • Slightly increased the warning level of doxygen to catch more issues.
  • Resolved all doxygen warnings.
  • Updated doxyfile schema.

@ad3154 ad3154 added documentation Improvements or additions to documentation ci/build system Issue relates to build pipeline or other CI labels Nov 23, 2023
@ad3154 ad3154 force-pushed the doxygen-checks branch 2 times, most recently from a7d3534 to b4ab1e5 Compare November 23, 2023 01:01
Added an action to validate doxygen builds with no warnings.
Slightly increased the warning level of doxygen to catch more issues.
Resolved all doxygen warnings.
Update doxyfile schema for doxygen version 1.9.5
@ad3154 ad3154 marked this pull request as ready for review November 23, 2023 01:25
@ad3154 ad3154 linked an issue Nov 23, 2023 that may be closed by this pull request
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

100.0% 100.0% Coverage
0.0% 0.0% Duplication

@ad3154 ad3154 requested a review from GwnDaan November 23, 2023 01:25
@ad3154 ad3154 self-assigned this Nov 23, 2023
Copy link
Member

@GwnDaan GwnDaan left a comment

Choose a reason for hiding this comment

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

LGTM!

@ad3154 ad3154 merged commit a191a18 into main Nov 23, 2023
11 checks passed
@ad3154 ad3154 deleted the doxygen-checks branch November 23, 2023 22:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/build system Issue relates to build pipeline or other CI documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add CI pipeline for checking documentation
2 participants