doc/porting-boards: Fix Doxygen Comment Block Style #21252
Closed
Conversation
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
dylad
approved these changes
Feb 28, 2025
mguetschow
requested changes
Feb 28, 2025
|
Yes. The changes to Previously documentation was contained in `doc.txt` files with C-style comment
blocks. This style has been deprecated in favor of using `doc.md` files in
Markdown format, which eliminates formatting and interpretation issues.
Old style files will continually be replaced by the new format.@kfessel do you want to add these changes to |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
As described in Issue #21220, many
doc.txtfiles use the comment block of Doxygen incorrectly, possibly leading to weird side effects with asterisks used for bold/italic/...The example in the
Porting Boardstutorial also has the incorrect comment block style and this PR aims to fix that.Current Master:
This PR:
Testing procedure
Generate the documentation and check if everything looks good.
Issues/PRs references
Details described in #21220.