Skip to content

doc/porting-boards.md: fix code snippets in Riot web page/doxygen #19219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 1, 2023

Conversation

krzysztof-cabaj
Copy link
Contributor

Contribution description

PR #19206 fix issues with code snippets in the 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.

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

@github-actions github-actions bot added the Area: doc Area: Documentation label Jan 31, 2023
@benpicco benpicco added Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer 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 labels Jan 31, 2023
@riot-ci
Copy link

riot-ci commented Jan 31, 2023

Murdock results

✔️ PASSED

dba9c27 doc/porting-boards.md: fix code snippets in Riot web page/doxygen

Success Failures Total Runtime
1 0 1 46s

Artifacts

@benpicco
Copy link
Contributor

bors merge

@bors
Copy link
Contributor

bors bot commented Feb 1, 2023

Build succeeded:

@bors bors bot merged commit 2c52576 into RIOT-OS:master Feb 1, 2023
@krzysztof-cabaj
Copy link
Contributor Author

Thanks for rapid support for this PR (my smallest commit - only one char :D) and PR #19206 .

@MrKevinWeiss MrKevinWeiss added this to the Release 2023.04 milestone Apr 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation 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 Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants