From fe5c2df49e7c1335b51f74396123d82571d25ae5 Mon Sep 17 00:00:00 2001 From: Rebecca Cran Date: Tue, 26 Nov 2024 21:35:31 -0700 Subject: 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 --- SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h b/SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h index 946798e204..a2ca8516aa 100644 --- a/SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h +++ b/SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h @@ -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; -- cgit