-
Notifications
You must be signed in to change notification settings - Fork 2k
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
doc: fix references and inches unit #19948
Merged
Merged
Conversation
This file contains 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
MrKevinWeiss
approved these changes
Sep 27, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, ACK
bors merge |
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.
|
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Labels
Area: boards
Area: Board ports
Area: cpu
Area: CPU/MCU ports
Area: doc
Area: Documentation
Area: drivers
Area: Device drivers
CI: ready for build
If set, CI server will compile all applications for all available boards for the labeled PR
CI: skip compile test
If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs
Platform: ARM
Platform: This PR/issue effects ARM-based platforms
Platform: ESP
Platform: This PR/issue effects ESP-based platforms
Platform: native
Platform: This PR/issue effects the native platform
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 doc
to generate the documentation and check the examples for correctness.Issues/PRs references