tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

SignedCapsulePkg: make Doxygen interpret ASCII art as verbatim text 

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 <rebecca@bsdio.com>
This commit is contained in:
Rebecca Cran 2024-11-26 21:35:31 -07:00 committed by mergify[bot]
parent 259e1f04c6
commit fe5c2df49e
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h
View File

@ -11,7 +11,7 @@
#define __EDKII_SYSTEM_FMP_CAPSULE_GUID_H__
/**
@verbatim
1. Capsule Layout is below:
+------------------------------------------+
| Capsule Header (OPTIONAL, WFU) | <== ESRT.FwClass (Optional)
@ -82,7 +82,7 @@
NOTE: The [Name?] entry may have different FileGuid.
Only the one, whose FileGuid matches PcdEdkiiSystemFirmwareFileGuid, takes effect.
The other entry is ignored.
@endverbatim
**/
#define EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR_SIGNATURE SIGNATURE_32('S', 'F', 'I', 'D')
@ -121,6 +121,7 @@ typedef struct {
#pragma pack()
/**
@verbatim
System Firmware Image Descriptor is below:
+----------------------+
| System Firmware (FV) |
@ -135,6 +136,7 @@ typedef struct {
| |
| |
+----------------------+
@endverbatim
**/
extern EFI_GUID gEdkiiSystemFirmwareImageDescriptorFileGuid;