Skip to content

[SKIP SOFCI-TEST] doc: doxygen: do not fail on warnings #10338

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.

Sign up for GitHub

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

Merged
lgirdwood merged 1 commit into from
Oct 29, 2025
Merged

[SKIP SOFCI-TEST] doc: doxygen: do not fail on warnings #10338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/sof-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ jobs:
run: pip install -r sof-docs/scripts/requirements.txt

- name: build sof-docs
run: make -C sof-docs/ html SOF_DOC_BUILD="$(pwd)"/doxybuild/
run: LAX=1 make -C sof-docs/ html SOF_DOC_BUILD="$(pwd)"/doxybuild/
1 change: 1 addition & 0 deletions doc/sof.doxygen.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,4 @@ TYPEDEF_HIDES_STRUCT = YES
#FILTER_SOURCE_FILES = YES

HTML_TIMESTAMP = NO
WARN_AS_ERROR = NO
Copy link

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

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

[nitpick] Setting WARN_AS_ERROR = NO creates technical debt by allowing documentation warnings to accumulate. Consider creating a tracking issue to address the existing warnings and restore this setting to YES, or implement a gradual improvement plan to prevent new warnings while cleaning up existing ones.

Suggested change
WARN_AS_ERROR = NO
WARN_AS_ERROR = YES

Copilot uses AI. Check for mistakes.
Loading