doc: fix references and inches unit#19948
Merged
bors[bot] merged 5 commits intoRIOT-OS:masterfrom Sep 28, 2023
Merged
Conversation
gschorcht
requested review from
DipSwitch,
MrKevinWeiss,
aabadie,
basilfx,
fjmolinas,
haukepetersen and
vincent-d
as code owners
github-actions
bot
added
Platform: native
benpicco
added
the
CI: ready for build
gschorcht
added
CI: ready for build
Contributor
Author
|
bors merge |
Contributor
|
Build succeeded! The publicly hosted instance of bors-ng is deprecated and will go away soon. If you want to self-host your own instance, instructions are here. If you want to switch to GitHub's built-in merge queue, visit their help page.
|
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
4 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
This PR fixes the references and inches unit symbols in documentation of `{boards,cpu,drivers}.
Doxygen version 1.9.4 that is used on https://doc.riot-os.org doesn't support the following any longer:
[...]and(...)which lead either to"as inch unit wihtout\which lead to complete messed up documentatoin(e.g. in https://doc.riot-os.org/group__boards__stm32f746g-disco.html)
Testing procedure
Use doxygen 1.9.4 and
make docto generate the documentation and check the examples for correctness.Issues/PRs references