doc/porting-boards.md: fix code snippets in md view #19206
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
benpicco
added
CI: ready for build
|
Build succeeded: |
bors bot
added a commit
that referenced
this pull request
Feb 1, 2023
19219: doc/porting-boards.md: fix code snippets in Riot web page/doxygen r=benpicco a=krzysztof-cabaj ### Contribution description PR #19206 fix issues with code snippets in the[ `porting-boards.md`](https://github.com/RIOT-OS/RIOT/blob/master/doc/doxygen/src/porting-boards.md) presented by GitHub. However, in Riot web page comments in code snippets are not presented and in effect section `doc.txt` shows empty area - see [dox.txt section](https://doc.riot-os.org/porting-boards.html). This PR should fix this - it change for this code snippet C code to generic code. ### Testing procedure Generation of doxygen documentation by CI process and manual check if this change fix the problem. ### Issues/PRs references PR #19206 Co-authored-by: krzysztof-cabaj <kcabaj@gmail.com>
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
Current version of the file
porting-boards.mddid not present correctly in the github preview two snippets, presented in the sections:doc.txtandUsing Common code.This PR fix this issue.
Testing procedure
Check if these changes do not corrupt generated doxygen.
Issues/PRs references
None