drv/tdma_client: fix doc build by suppressing frame.h doxygen auto-link#24
Merged
Merged
Conversation
The `%` prefix tells Doxygen not to auto-link `frame.h` to its file page. Without it the generated cross-reference targets an unresolved `frame_8h` label and the `-W` Sphinx doc build fails. It looks like a typo but is load-bearing - keep it. AI-assisted: Claude Opus 4.8
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.
Summary
The
docCI job ondevelop(and therefore on the open develop→main PR #23) fails on a single fatal Sphinx warning:The deprecated
drv/tdma_client.hgroup comment name-drops`drv/frame.h`(the header added alongside the TDMA deprecation). Doxygen auto-links that filename to the file labelframe_8heven inside a code span; breathe can't resolve it, and the build's-W(warnings-as-errors) flag makes it fatal.Fix: prefix the filename with
%(`drv/%frame.h`), Doxygen's auto-link suppression. Rendered text is unchanged and matches the sibling code spans in the same comment.Verification
Reproduced the warning locally against the pinned
doc/sphinx/requirements.txt, applied the fix, rebuilt:build succeeded.with theframe_8hwarning gone. Diff is one character.Test plan
docjob passes on this PRdevelop, thedoccheck on Merge develop into main #23 (develop→main) goes green