sys/net/ipv6: use markdown links in doc#21356
Merged
maribu merged 1 commit intoRIOT-OS:masterfrom Apr 4, 2025
Merged
Conversation
This makes the header a lot more readable and `clang -Wdocumentation` happy, which does not like HTML tags (`<a href="...">...</a>`) to contain random line breaks.
maribu
added
Area: doc
Member
Author
|
|
maribu
requested review from
MrKevinWeiss,
PeterKietzmann,
basilfx,
bergzand,
dylad,
gschorcht,
kaspar030,
keestux and
miri64
as code owners
github-actions
bot
added
Platform: ARM
github-actions
bot
added
Area: OTA
maribu
force-pushed
the
sys/net/ipv6/markdown-links
branch
from
3a1049d to
7ac196f
Compare
github-actions
bot
removed
Platform: ARM
benpicco
approved these changes
Apr 4, 2025
Contributor
|
Nice fix and it shortens the header by 80 lines without loosing anyhing, which is great as well. |
Member
|
Belated 👍 from my side. Back when I introduced those comments the markdown links either did not exist yet in Doxygen or I did not know about them yet and I never bothered to change it. |
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
This makes the header a lot more readable and
clang -Wdocumentationhappy, which does not like HTML tags (<a href="...">...</a>) to contain random line breaks.Testing procedure
The Doxygen output should still contain the same links as before.
(I tested this with Doxygen
1.14.0 (75f8cf7020304421786ec3ab3aaea99de7c49354)locally, where it worked. But let's see if the one in the CI also likes this.)Issues/PRs references
None