docs(doxygen): enforce warn if undocumented#5337
Merged
Merged
Conversation
Move Python tool dependencies (gcovr, clang-format, etc.) from the lizardbyte-common subproject into Sunshine's own pyproject.toml via the lizardbyte-common[c] extra. Update CI workflows and contributing docs to use `uv sync --locked` and `uv run --project ..` instead of referencing the subproject directly.
Bundle ReportBundle size has no change ✅ |
ReenigneArcher
force-pushed
the
chore/various-updates
branch
from
e2a1bca to
b316af2
Compare
Fixes indentation of several Doxygen blocks in Linux and Windows platform code to match the project’s comment style, and removes a redundant multi-line Doxygen block in `video::config_t` where an inline field doc already provides the same context.
ReenigneArcher
force-pushed
the
chore/various-updates
branch
from
b316af2 to
80841bd
Compare
Adds a SonarCloud quality gate badge to the README status badges section, making project code quality status visible alongside existing CI and coverage badges.
38 tasks
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## master #5337 +/- ##
==========================================
- Coverage 27.55% 27.53% -0.03%
==========================================
Files 113 113
Lines 25556 25589 +33
Branches 11231 11238 +7
==========================================
+ Hits 7042 7045 +3
- Misses 16996 17580 +584
+ Partials 1518 964 -554
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report in Codecov by Harness.
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The main change of this PR is Doxygen will now warn/error for any undocumented code. In the age of AI, there's not much reason to continue allowing the code to go undocumented.
Additionally:
Screenshot
Issues Fixed or Closed
Roadmap Issues
Type of Change
Checklist
AI Usage