treewide: fix Doxygen documentation errors - #22512
Open
LasseRosenow wants to merge 14 commits into
Open
Conversation
LasseRosenow
requested review from
MrKevinWeiss,
aabadie and
nandojve
as code owners
July 27, 2026 10:20
github-actions
Bot
added
Area: network
AnnsAnns
added
CI: ready for build
crasbe
reviewed
Jul 27, 2026
crasbe
added
the
Type: bug
crasbe
changed the title
kfessel
reviewed
Jul 28, 2026
Contributor
Strangely non of these seem to have shown up. for xmega ebi that is the case its missing form the api.riot-os.org due to the '#if defined' check |
Co-authored-by: Karl Fessel <karl.fessel@gmail.com>
github-actions
Bot
added
the
Platform: ARM
maribu
reviewed
Jul 29, 2026
maribu
left a comment
maribu
left a comment
Member
There was a problem hiding this comment.
Thx for doing this. Sadly, fixing the group command results in Doxygen being able to parse the file and stop more undocumented values :/
| * occasionally use ASPACE instead of ASIZE for some MCUs, while new AVR libc | ||
| * uses ASIZE as name consistently */ | ||
| #ifndef EBI_CS_ASIZE_gm | ||
| typedef EBI_CS_ASPACE_t EBI_CS_ASIZE_t; |
Member
There was a problem hiding this comment.
Suggested change
| typedef EBI_CS_ASPACE_t EBI_CS_ASIZE_t; /**< Enum over EBI chip select address space options */ |
| * uses ASIZE as name consistently */ | ||
| #ifndef EBI_CS_ASIZE_gm | ||
| typedef EBI_CS_ASPACE_t EBI_CS_ASIZE_t; | ||
| #define EBI_CS_ASIZE_256B_gc EBI_CS_ASPACE_256B_gc |
Member
There was a problem hiding this comment.
Suggested change
| # define EBI_CS_ASIZE_256B_gc EBI_CS_ASPACE_256B_gc /**< EBI CS for 256 B */ |
| typedef EBI_CS_ASPACE_t EBI_CS_ASIZE_t; | ||
| #define EBI_CS_ASIZE_256B_gc EBI_CS_ASPACE_256B_gc | ||
| #define EBI_CS_ASIZE_512B_gc EBI_CS_ASPACE_512B_gc | ||
| #define EBI_CS_ASIZE_1KB_gc EBI_CS_ASPACE_1KB_gc |
Member
There was a problem hiding this comment.
Suggested change
| # define BI_CS_ASIZE_1KB_gc EBI_CS_ASPACE_1KB_gc /**< EBI CS for 1 KiB */ |
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
6 participants
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.
Contribution description
While working on a secret project I was finding these issues in our documentation and here are the fixes.
Testing procedure
Issues/PRs references
Declaration of AI-Tools / LLMs usage:
AI-Tools / LLMs that were used are: