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 <[email protected]>
tianocore · Nov 27, 2024 · 9fc682b · 9fc682b
1 parent d90bf1f
commit 9fc682b
Showing 1 changed file with 4 additions and 2 deletions.
diff --git 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;