SignedCapsulePkg: make Doxygen interpret ASCII art as unparsed code #6476
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
tianocore-assign-reviewers
bot
requested review from
ajfish,
leiflindholm and
mdkinney
bexcran
force-pushed
the
fmp-capsule-ascii-doc
branch
from
fb4b053
to
9fc682b
Compare
By default, Doxygen tries to nicely format all text within doc blocks. Unfortunately this mangles ASCII art: add @code{.unparsed} statements to EdkiiSystemFmpCapsule.h to cause Doxygen to display the text as provided. Signed-off-by: Rebecca Cran <[email protected]>
bexcran
force-pushed
the
fmp-capsule-ascii-doc
branch
from
9fc682b
to
d7ddbca
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.
Description
By default, Doxygen tries to nicely format all text within doc blocks. Unfortunately this mangles ASCII art: add @code{.unparsed} statements to EdkiiSystemFmpCapsule.h to cause Doxygen to display the text as provided.
How This Was Tested
Ran Doxygen after making the changes and verified the page at https://bsdio.com/edk2/docs/master/_edkii_system_fmp_capsule_8h.html is now displayed correctly.
Integration Instructions
N/A