SignedCapsulePkg: make Doxygen interpret ASCII art as verbatim text #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
2 times, most recently
from
9fc682b to
d7ddbca
Compare
|
This PR has been automatically marked as stale because it has not had activity in 60 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions. |
github-actions
bot
added
the
stale
|
This is still relevant. |
mdkinney
reviewed
Feb 1, 2025
github-actions
bot
removed
the
stale
bexcran
added a commit
to bexcran/edk2
that referenced
this pull request
Feb 3, 2025
Per the discussion in tianocore#6476, update Ecc code to allow the @verbatim Doxygen tag. Signed-off-by: Rebecca Cran <[email protected]>
bexcran
added a commit
to bexcran/edk2
that referenced
this pull request
Feb 3, 2025
Per the discussion in tianocore#6476, update Ecc code to allow the @verbatim Doxygen tag. Signed-off-by: Rebecca Cran <[email protected]>
3 tasks
bexcran
force-pushed
the
fmp-capsule-ascii-doc
branch
2 times, most recently
from
899f42f to
d463018
Compare
bexcran
changed the title
mdkinney
approved these changes
Feb 3, 2025
bexcran
added a commit
to bexcran/edk2
that referenced
this pull request
Feb 3, 2025
Per the discussion in tianocore#6476, update Ecc code to allow the @verbatim Doxygen tag. Signed-off-by: Rebecca Cran <[email protected]>
mergify bot
pushed a commit
that referenced
this pull request
Feb 4, 2025
Per the discussion in #6476, update Ecc code to allow the @verbatim Doxygen tag. Signed-off-by: Rebecca Cran <[email protected]>
By default, Doxygen tries to nicely format all text within doc blocks. Unfortunately this mangles ASCII art: add @verbatim 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
d463018 to
c956799
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 @verbatim 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
Depends on #10714.