Skip to content

docs(doxygen): enforce warn if undocumented - #5337

Merged
ReenigneArcher merged 9 commits into
masterfrom
chore/various-updates
Jun 26, 2026
Merged

docs(doxygen): enforce warn if undocumented#5337
ReenigneArcher merged 9 commits into
masterfrom
chore/various-updates

Conversation

@ReenigneArcher

@ReenigneArcherReenigneArcher commented Jun 26, 2026

Copy link
Copy Markdown
Member

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

  • feat: New feature (non-breaking change which adds functionality)
  • fix: Bug fix (non-breaking change which fixes an issue)
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc.)
  • refactor: Code change that neither fixes a bug nor adds a feature
  • perf: Code change that improves performance
  • test: Adding missing tests or correcting existing tests
  • build: Changes that affect the build system or external dependencies
  • ci: Changes to CI configuration files and scripts
  • chore: Other changes that don't modify src or test files
  • revert: Reverts a previous commit
  • BREAKING CHANGE: Introduces a breaking change (can be combined with any type above)

Checklist

  • Code follows the style guidelines of this project
  • Code has been self-reviewed
  • Code has been commented, particularly in hard-to-understand areas
  • Code docstring/documentation-blocks for new or existing methods/components have been added or updated
  • Unit tests have been added or updated for any new or modified functionality

AI Usage

  • None: No AI tools were used in creating this PR
  • Light: AI provided minor assistance (formatting, simple suggestions)
  • Moderate: AI helped with code generation or debugging specific parts
  • Heavy: AI generated most or all of the code changes

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.
@codecov

codecovBot commented Jun 26, 2026

Copy link
Copy Markdown

Bundle Report

Bundle size has no change ✅

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.
Adds a SonarCloud quality gate badge to the README status badges section, making project code quality status visible alongside existing CI and coverage badges.
@codecov

codecovBot commented Jun 26, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 40.86022% with 110 lines in your changes missing coverage. Please review.
✅ Project coverage is 27.53%. Comparing base (be7c1bc) to head (ea5ac2e).
⚠️ Report is 2 commits behind head on master.
✅ All tests successful. No failed tests found.

Files with missing linesPatch %Lines
src/config.cpp0.00%48 Missing and 1 partial ⚠️
src/platform/linux/kwingrab.cpp0.00%8 Missing ⚠️
src/platform/windows/input.cpp0.00%8 Missing ⚠️
src/platform/linux/pipewire.cpp0.00%7 Missing ⚠️
src/platform/common.h75.00%5 Missing and 1 partial ⚠️
src/platform/linux/portalgrab.cpp0.00%6 Missing ⚠️
src/nvenc/nvenc_base.cpp0.00%5 Missing ⚠️
src/platform/windows/display_vram.cpp16.66%5 Missing ⚠️
src/input.cpp66.66%2 Missing ⚠️
src/platform/macos/input.cpp85.71%2 Missing ⚠️
... and 9 more
Additional details and impacted files

Impacted file tree graph

@@ 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 
FlagCoverage Δ
Archlinux11.50% <0.00%> (ø)
FreeBSD-amd6413.29% <53.12%> (-0.01%)⬇️
Homebrew-macos-1421.03% <0.00%> (-0.05%)⬇️
Homebrew-macos-1521.19% <0.00%> (-0.05%)⬇️
Homebrew-macos-2621.30% <0.00%> (-0.06%)⬇️
Homebrew-ubuntu-24.0413.53% <0.00%> (ø)
Linux-AppImage12.40% <0.00%> (ø)
Windows-AMD6415.27% <ø> (-0.01%)⬇️
Windows-ARM6413.30% <54.90%> (+<0.01%)⬆️
macOS-arm6419.26% <89.74%> (+0.03%)⬆️
macOS-x86_6418.72% <83.92%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing linesCoverage Δ
src/audio.cpp85.79% <100.00%> (-0.27%)⬇️
src/audio.h100.00% <ø> (ø)
src/cbs.cpp24.83% <100.00%> (+0.50%)⬆️
src/cbs.h33.33% <ø> (ø)
src/config.h0.00% <ø> (ø)
src/confighttp.cpp43.75% <100.00%> (+0.30%)⬆️
src/confighttp.h100.00% <ø> (ø)
src/crypto.cpp65.69% <ø> (ø)
src/crypto.h50.00% <ø> (ø)
src/display_device.cpp68.03% <ø> (ø)
... and 89 more

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update be7c1bc...ea5ac2e. Read the comment docs.

@ReenigneArcher
ReenigneArcher merged commit a991a96 into masterJun 26, 2026
70 of 71 checks passed
@ReenigneArcher
ReenigneArcher deleted the chore/various-updates branch June 26, 2026 02:43
@sonarqubecloud

Copy link
Copy Markdown

Quality Gate FailedQuality Gate failed

Failed conditions
5 Duplicated Blocks on New Code (required ≤ 0)

See analysis details on SonarQube Cloud

Sign up for freeto 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.

1 participant

@ReenigneArcher