ShellPkg/UefiShellAcpiViewCommandLib: Fix ECC issues

[mirror_edk2.git] / ShellPkg / Library / UefiShellAcpiViewCommandLib / AcpiParser.h

diff --git a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
index 4dadd4d10423cb60ca17c1b1d285c55e2e58a0e0..ecf7dae9038a4ebcb3e3764964f0c16ca3ef51f6 100644 (file)
--- a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
+++ b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   Header file for ACPI parser\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
@@ -22,23 +22,26 @@
 /// that allows us to process the log options.\r
 #define RSDP_TABLE_INFO  SIGNATURE_32('R', 'S', 'D', 'P')\r
 \r
-/** This function increments the ACPI table error counter.\r
-*/\r
+/**\r
+  This function increments the ACPI table error counter.\r
+**/\r
 VOID\r
 EFIAPI\r
 IncrementErrorCount (\r
   VOID\r
   );\r
 \r
-/** This function increments the ACPI table warning counter.\r
-*/\r
+/**\r
+  This function increments the ACPI table warning counter.\r
+**/\r
 VOID\r
 EFIAPI\r
 IncrementWarningCount (\r
   VOID\r
   );\r
 \r
-/** This function verifies the ACPI table checksum.\r
+/**\r
+  This function verifies the ACPI table checksum.\r
 \r
   This function verifies the checksum for the ACPI table and optionally\r
   prints the status.\r
@@ -49,7 +52,7 @@ IncrementWarningCount (
 \r
   @retval TRUE         The checksum is OK.\r
   @retval FALSE        The checksum failed.\r
-*/\r
+**/\r
 BOOLEAN\r
 EFIAPI\r
 VerifyChecksum (\r
@@ -58,11 +61,12 @@ VerifyChecksum (
   IN UINT32  Length\r
   );\r
 \r
-/** This function performs a raw data dump of the ACPI table.\r
+/**\r
+  This function performs a raw data dump of the ACPI table.\r
 \r
   @param [in] Ptr     Pointer to the start of the table buffer.\r
   @param [in] Length  The length of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpRaw (\r
@@ -70,12 +74,12 @@ DumpRaw (
   IN UINT32 Length\r
   );\r
 \r
-/** This function traces 1 byte of datum as specified in the\r
-    format string.\r
+/**\r
+  This function traces 1 byte of datum as specified in the format string.\r
 \r
   @param [in] Format  The format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpUint8 (\r
@@ -83,12 +87,12 @@ DumpUint8 (
   IN UINT8*        Ptr\r
   );\r
 \r
-/** This function traces 2 bytes of data as specified in the\r
-    format string.\r
+/**\r
+  This function traces 2 bytes of data as specified in the format string.\r
 \r
   @param [in] Format  The format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpUint16 (\r
@@ -96,12 +100,12 @@ DumpUint16 (
   IN UINT8*        Ptr\r
   );\r
 \r
-/** This function traces 4 bytes of data as specified in the\r
-    format string.\r
+/**\r
+  This function traces 4 bytes of data as specified in the format string.\r
 \r
   @param [in] Format  The format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpUint32 (\r
@@ -109,12 +113,12 @@ DumpUint32 (
   IN UINT8*        Ptr\r
   );\r
 \r
-/** This function traces 8 bytes of data as specified by the\r
-    format string.\r
+/**\r
+  This function traces 8 bytes of data as specified by the format string.\r
 \r
   @param [in] Format  The format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpUint64 (\r
@@ -122,14 +126,15 @@ DumpUint64 (
   IN UINT8*        Ptr\r
   );\r
 \r
-/** This function traces 3 characters which can be optionally\r
-   formated using the format string if specified.\r
+/**\r
+  This function traces 3 characters which can be optionally\r
+  formated using the format string if specified.\r
 \r
   If no format string is specified the Format must be NULL.\r
 \r
   @param [in] Format  Optional format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 Dump3Chars (\r
@@ -137,14 +142,15 @@ Dump3Chars (
   IN UINT8*        Ptr\r
   );\r
 \r
-/** This function traces 4 characters which can be optionally\r
-   formated using the format string if specified.\r
+/**\r
+  This function traces 4 characters which can be optionally\r
+  formated using the format string if specified.\r
 \r
   If no format string is specified the Format must be NULL.\r
 \r
   @param [in] Format  Optional format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 Dump4Chars (\r
@@ -152,14 +158,15 @@ Dump4Chars (
   IN UINT8*        Ptr\r
   );\r
 \r
-/** This function traces 6 characters which can be optionally\r
-   formated using the format string if specified.\r
+/**\r
+  This function traces 6 characters which can be optionally\r
+  formated using the format string if specified.\r
 \r
   If no format string is specified the Format must be NULL.\r
 \r
   @param [in] Format  Optional format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 Dump6Chars (\r
@@ -167,14 +174,15 @@ Dump6Chars (
   IN UINT8*        Ptr\r
   );\r
 \r
-/** This function traces 8 characters which can be optionally\r
-   formated using the format string if specified.\r
+/**\r
+  This function traces 8 characters which can be optionally\r
+  formated using the format string if specified.\r
 \r
   If no format string is specified the Format must be NULL.\r
 \r
   @param [in] Format  Optional format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 Dump8Chars (\r
@@ -182,7 +190,8 @@ Dump8Chars (
   IN UINT8*        Ptr\r
   );\r
 \r
-/** This function indents and prints the ACPI table Field Name.\r
+/**\r
+  This function indents and prints the ACPI table Field Name.\r
 \r
   @param [in] Indent      Number of spaces to add to the global table\r
                           indent. The global table indent is 0 by default;\r
@@ -192,33 +201,36 @@ Dump8Chars (
                           the total indent in the output is dependent on from\r
                           where this function is called.\r
   @param [in] FieldName   Pointer to the Field Name.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 PrintFieldName (\r
   IN UINT32         Indent,\r
   IN CONST CHAR16*  FieldName\r
-);\r
+  );\r
 \r
-/** This function pointer is the template for customizing the trace output\r
+/**\r
+  This function pointer is the template for customizing the trace output\r
 \r
   @param [in] Format  Format string for tracing the data as specified by\r
                       the 'Format' member of ACPI_PARSER.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 typedef VOID (EFIAPI *FNPTR_PRINT_FORMATTER)(CONST CHAR16* Format, UINT8* Ptr);\r
 \r
-/** This function pointer is the template for validating an ACPI table field.\r
+/**\r
+  This function pointer is the template for validating an ACPI table field.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information as specified by\r
                       the 'Context' member of the ACPI_PARSER.\r
                       e.g. this could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 typedef VOID (EFIAPI *FNPTR_FIELD_VALIDATOR)(UINT8* Ptr, VOID* Context);\r
 \r
-/** The ACPI_PARSER structure describes the fields of an ACPI table and\r
-    provides means for the parser to interpret and trace appropriately.\r
+/**\r
+  The ACPI_PARSER structure describes the fields of an ACPI table and\r
+  provides means for the parser to interpret and trace appropriately.\r
 \r
   The first three members are populated based on information present in\r
   in the ACPI table specifications. The remaining members describe how\r
@@ -234,7 +246,7 @@ typedef VOID (EFIAPI *FNPTR_FIELD_VALIDATOR)(UINT8* Ptr, VOID* Context);
 \r
   The 'Format' and 'PrintFormatter' members allow flexibility for\r
   representing the field data.\r
-*/\r
+**/\r
 typedef struct AcpiParser {\r
 \r
   /// String describing the ACPI table field\r
@@ -278,9 +290,10 @@ typedef struct AcpiParser {
   VOID*                 Context;\r
 } ACPI_PARSER;\r
 \r
-/** A structure used to store the pointers to the members of the\r
-    ACPI description header structure that was parsed.\r
-*/\r
+/**\r
+  A structure used to store the pointers to the members of the\r
+  ACPI description header structure that was parsed.\r
+**/\r
 typedef struct AcpiDescriptionHeaderInfo {\r
   /// ACPI table signature\r
   UINT32* Signature;\r
@@ -302,7 +315,8 @@ typedef struct AcpiDescriptionHeaderInfo {
   UINT32* CreatorRevision;\r
 } ACPI_DESCRIPTION_HEADER_INFO;\r
 \r
-/** This function is used to parse an ACPI table buffer.\r
+/**\r
+  This function is used to parse an ACPI table buffer.\r
 \r
   The ACPI table buffer is parsed using the ACPI table parser information\r
   specified by a pointer to an array of ACPI_PARSER elements. This parser\r
@@ -326,7 +340,7 @@ typedef struct AcpiDescriptionHeaderInfo {
   @param [in] ParserItems  Number of items in the ACPI_PARSER array.\r
 \r
   @retval Number of bytes parsed.\r
-*/\r
+**/\r
 UINT32\r
 EFIAPI\r
 ParseAcpi (\r
@@ -337,19 +351,21 @@ ParseAcpi (
   IN UINT32             Length,\r
   IN CONST ACPI_PARSER* Parser,\r
   IN UINT32             ParserItems\r
-);\r
+  );\r
 \r
-/** This is a helper macro to pass parameters to the Parser functions.\r
+/**\r
+   This is a helper macro to pass parameters to the Parser functions.\r
 \r
   @param [in] Parser The name of the ACPI_PARSER array describing the\r
               ACPI table fields.\r
-*/\r
+**/\r
 #define PARSER_PARAMS(Parser) Parser, sizeof (Parser) / sizeof (Parser[0])\r
 \r
-/** This is a helper macro for describing the ACPI header fields.\r
+/**\r
+  This is a helper macro for describing the ACPI header fields.\r
 \r
   @param [out] Info  Pointer to retrieve the ACPI table header information.\r
-*/\r
+**/\r
 #define PARSE_ACPI_HEADER(Info)                   \\r
   { L"Signature", 4, 0, NULL, Dump4Chars,         \\r
     (VOID**)&(Info)->Signature , NULL, NULL },    \\r
@@ -370,30 +386,32 @@ ParseAcpi (
   { L"Creator Revision", 4, 32, L"0x%X", NULL,    \\r
     (VOID**)&(Info)->CreatorRevision, NULL, NULL }\r
 \r
-/** Length of the ACPI GAS structure.\r
+/**\r
+  Length of the ACPI GAS structure.\r
 \r
   NOTE: This might normally be defined as\r
         sizeof (EFI_ACPI_6_2_GENERIC_ADDRESS_STRUCTURE).\r
         However, we deliberately minimise any reference to the EDK2 ACPI\r
         headers in an attempt to provide cross checking.\r
-*/\r
+**/\r
 #define GAS_LENGTH                     12\r
 \r
-/** Length of the ACPI Header structure.\r
+/**\r
+  Length of the ACPI Header structure.\r
 \r
   NOTE: This might normally be defined as\r
         sizeof (EFI_ACPI_DESCRIPTION_HEADER).\r
         However, we deliberately minimise any reference to the EDK2 ACPI\r
         headers in an attempt to provide cross checking.\r
-*/\r
+**/\r
 #define ACPI_DESCRIPTION_HEADER_LENGTH  36\r
 \r
-/** This function indents and traces the GAS structure as described\r
-    by the GasParser.\r
+/**\r
+  This function indents and traces the GAS structure as described by the GasParser.\r
 \r
   @param [in] Ptr     Pointer to the start of the buffer.\r
   @param [in] Indent  Number of spaces to indent the output.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpGasStruct (\r
@@ -401,11 +419,12 @@ DumpGasStruct (
   IN UINT32        Indent\r
   );\r
 \r
-/** This function traces the GAS structure as described by the GasParser.\r
+/**\r
+  This function traces the GAS structure as described by the GasParser.\r
 \r
   @param [in] Format  Optional format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpGas (\r
@@ -413,19 +432,21 @@ DumpGas (
   IN UINT8*        Ptr\r
   );\r
 \r
-/** This function traces the ACPI header as described by the AcpiHeaderParser.\r
+/**\r
+  This function traces the ACPI header as described by the AcpiHeaderParser.\r
 \r
   @param [in] Ptr          Pointer to the start of the buffer.\r
 \r
   @retval Number of bytes parsed.\r
-*/\r
+**/\r
 UINT32\r
 EFIAPI\r
 DumpAcpiHeader (\r
   IN UINT8* Ptr\r
   );\r
 \r
-/** This function parses the ACPI header as described by the AcpiHeaderParser.\r
+/**\r
+  This function parses the ACPI header as described by the AcpiHeaderParser.\r
 \r
   This function optionally returns the Signature, Length and revision of the\r
   ACPI table.\r
@@ -436,7 +457,7 @@ DumpAcpiHeader (
   @param [out] Revision   Gets location of the revision of the ACPI table.\r
 \r
   @retval Number of bytes parsed.\r
-*/\r
+**/\r
 UINT32\r
 EFIAPI\r
 ParseAcpiHeader (\r
@@ -446,7 +467,8 @@ ParseAcpiHeader (
   OUT CONST UINT8**  Revision\r
   );\r
 \r
-/** This function parses the ACPI BGRT table.\r
+/**\r
+  This function parses the ACPI BGRT table.\r
   When trace is enabled this function parses the BGRT table and\r
   traces the ACPI table fields.\r
 \r
@@ -456,7 +478,7 @@ ParseAcpiHeader (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiBgrt (\r
@@ -466,7 +488,8 @@ ParseAcpiBgrt (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI DBG2 table.\r
+/**\r
+  This function parses the ACPI DBG2 table.\r
   When trace is enabled this function parses the DBG2 table and\r
   traces the ACPI table fields.\r
 \r
@@ -476,7 +499,7 @@ ParseAcpiBgrt (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiDbg2 (\r
@@ -486,7 +509,8 @@ ParseAcpiDbg2 (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI DSDT table.\r
+/**\r
+  This function parses the ACPI DSDT table.\r
   When trace is enabled this function parses the DSDT table and\r
   traces the ACPI table fields.\r
   For the DSDT table only the ACPI header fields are parsed and\r
@@ -496,7 +520,7 @@ ParseAcpiDbg2 (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiDsdt (\r
@@ -506,7 +530,8 @@ ParseAcpiDsdt (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI FADT table.\r
+/**\r
+  This function parses the ACPI FADT table.\r
   This function parses the FADT table and optionally traces the ACPI\r
   table fields.\r
 \r
@@ -516,7 +541,7 @@ ParseAcpiDsdt (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiFadt (\r
@@ -526,7 +551,8 @@ ParseAcpiFadt (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI GTDT table.\r
+/**\r
+  This function parses the ACPI GTDT table.\r
   When trace is enabled this function parses the GTDT table and\r
   traces the ACPI table fields.\r
 \r
@@ -540,7 +566,7 @@ ParseAcpiFadt (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiGtdt (\r
@@ -550,7 +576,8 @@ ParseAcpiGtdt (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI IORT table.\r
+/**\r
+  This function parses the ACPI IORT table.\r
   When trace is enabled this function parses the IORT table and\r
   traces the ACPI fields.\r
 \r
@@ -568,7 +595,7 @@ ParseAcpiGtdt (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiIort (\r
@@ -578,7 +605,8 @@ ParseAcpiIort (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI MADT table.\r
+/**\r
+  This function parses the ACPI MADT table.\r
   When trace is enabled this function parses the MADT table and\r
   traces the ACPI table fields.\r
 \r
@@ -596,7 +624,7 @@ ParseAcpiIort (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiMadt (\r
@@ -606,7 +634,8 @@ ParseAcpiMadt (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI MCFG table.\r
+/**\r
+  This function parses the ACPI MCFG table.\r
   When trace is enabled this function parses the MCFG table and\r
   traces the ACPI table fields.\r
 \r
@@ -616,7 +645,7 @@ ParseAcpiMadt (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiMcfg (\r
@@ -626,7 +655,8 @@ ParseAcpiMcfg (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI RSDP table.\r
+/**\r
+  This function parses the ACPI RSDP table.\r
 \r
   This function invokes the parser for the XSDT table.\r
   * Note - This function does not support parsing of RSDT table.\r
@@ -638,7 +668,7 @@ ParseAcpiMcfg (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiRsdp (\r
@@ -648,7 +678,8 @@ ParseAcpiRsdp (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI SLIT table.\r
+/**\r
+  This function parses the ACPI SLIT table.\r
   When trace is enabled this function parses the SLIT table and\r
   traces the ACPI table fields.\r
 \r
@@ -661,7 +692,7 @@ ParseAcpiRsdp (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiSlit (\r
@@ -671,7 +702,8 @@ ParseAcpiSlit (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI SPCR table.\r
+/**\r
+  This function parses the ACPI SPCR table.\r
   When trace is enabled this function parses the SPCR table and\r
   traces the ACPI table fields.\r
 \r
@@ -681,7 +713,7 @@ ParseAcpiSlit (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiSpcr (\r
@@ -691,7 +723,8 @@ ParseAcpiSpcr (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI SRAT table.\r
+/**\r
+  This function parses the ACPI SRAT table.\r
   When trace is enabled this function parses the SRAT table and\r
   traces the ACPI table fields.\r
 \r
@@ -707,7 +740,7 @@ ParseAcpiSpcr (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiSrat (\r
@@ -717,7 +750,8 @@ ParseAcpiSrat (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI SSDT table.\r
+/**\r
+  This function parses the ACPI SSDT table.\r
   When trace is enabled this function parses the SSDT table and\r
   traces the ACPI table fields.\r
   For the SSDT table only the ACPI header fields are\r
@@ -727,7 +761,7 @@ ParseAcpiSrat (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiSsdt (\r
@@ -737,7 +771,8 @@ ParseAcpiSsdt (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI XSDT table\r
+/**\r
+  This function parses the ACPI XSDT table\r
   and optionally traces the ACPI table fields.\r
 \r
   This function also performs validation of the XSDT table.\r
@@ -746,7 +781,7 @@ ParseAcpiSsdt (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiXsdt (\r