Fix: broken output in Documentation Code Snippets #4919
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
AdarshRawat1
changed the title
AdarshRawat1
changed the title
Note: Changes may take a few seconds to appear on GitHub Pages. Please refresh the page if you do not see the updates immediately. |
|
Is this ready for review? |
I was a bit occupied with university formalities, I'll complete this ASAP. |
AdarshRawat1
force-pushed
the
Fix-Output
branch
from
906b7eb
to
497f527
Compare
fruffy
approved these changes
Oct 1, 2024
AdarshRawat1
force-pushed
the
Fix-Output
branch
from
501dfcb
to
9edb285
Compare
Signed-off-by: Adarsh <[email protected]>
Signed-off-by: Adarsh <[email protected]>
Signed-off-by: Adarsh <[email protected]>
This syntax is processed correctly by Doxygen Signed-off-by: Adarsh <[email protected]>
AdarshRawat1
force-pushed
the
Fix-Output
branch
from
2a01e6c
to
333770d
Compare
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.
Recent Update to PR
I'm pushing a temporary fix for the code output renders. I'll be reaching out to the Doxygen team about the issue, and hopefully, it will be resolved in the next release.
The issue arises when we include one README file within another; in this case, the code blocks are not processed correctly.
What was done
I made a copy of broken code snippets
\internalcommand. )\code{.c}&\endcodecommands of Doxygen. Because these commands are capable of rendering the snippets correctly even when included from external Markdown.Changes
Minor fixes in documentation output.
Screenshots of Changes
Current - https://p4lang.github.io/p4c/intermediate_representation_ir.html#visitors-and-transforms
Updated
Screenshots of Broken codes for multiple Markdowns
Broken Code snippets for merged Markdown files
Fixed
