From 9fc682b0934994d4992b69c06874fa0c7a2a5ee1 Mon Sep 17 00:00:00 2001 From: Rebecca Cran Date: Tue, 26 Nov 2024 21:35:31 -0700 Subject: [PATCH] SignedCapsulePkg: make Doxygen interpret ASCII art as unparsed code 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 --- 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 946798e204c4..48220c7055c4 100644 --- a/SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h +++ b/SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h @@ -11,7 +11,7 @@ #define __EDKII_SYSTEM_FMP_CAPSULE_GUID_H__ /** - + @code{.unparsed} 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. - + @endcode **/ #define EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR_SIGNATURE SIGNATURE_32('S', 'F', 'I', 'D') @@ -121,6 +121,7 @@ typedef struct { #pragma pack() /** + @code{.unparsed} System Firmware Image Descriptor is below: +----------------------+ | System Firmware (FV) | @@ -135,6 +136,7 @@ typedef struct { | | | | +----------------------+ + @endcode **/ extern EFI_GUID gEdkiiSystemFirmwareImageDescriptorFileGuid;