ShellPkg/UefiShellAcpiViewCommandLib: Fix ECC issues

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

diff --git a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.h b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.h
index 03561ea81686821e37c05d90f053731fde63fbb5..b035395a721b80031335a16684fe9d3bbd60cd52 100644 (file)
--- a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.h
+++ b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.h
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   Header file for AcpiView\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
@@ -14,20 +14,24 @@
 #ifndef ACPIVIEW_H_\r
 #define ACPIVIEW_H_\r
 \r
-/** A macro to define the max file name length\r
-*/\r
+/**\r
+  A macro to define the max file name length\r
+**/\r
 #define MAX_FILE_NAME_LEN    128\r
 \r
-/** Offset to the RSDP revision from the start of the RSDP\r
-*/\r
+/**\r
+  Offset to the RSDP revision from the start of the RSDP\r
+**/\r
 #define RSDP_REVISION_OFFSET 15\r
 \r
-/** Offset to the RSDP length from the start of the RSDP\r
-*/\r
+/**\r
+  Offset to the RSDP length from the start of the RSDP\r
+**/\r
 #define RSDP_LENGTH_OFFSET   20\r
 \r
-/** The EREPORT_OPTION enum describes ACPI table Reporting options.\r
-*/\r
+/**\r
+  The EREPORT_OPTION enum describes ACPI table Reporting options.\r
+**/\r
 typedef enum ReportOption {\r
   EREPORT_ALL,            ///< Report All tables.\r
   EREPORT_SELECTED,       ///< Report Selected table.\r
@@ -36,63 +40,72 @@ typedef enum ReportOption {
   EREPORT_MAX\r
 } EREPORT_OPTION;\r
 \r
-/** This function resets the ACPI table error counter to Zero.\r
-*/\r
+/**\r
+  This function resets the ACPI table error counter to Zero.\r
+**/\r
 VOID\r
 ResetErrorCount (\r
   VOID\r
   );\r
 \r
-/** This function returns the ACPI table error count.\r
+/**\r
+  This function returns the ACPI table error count.\r
 \r
   @retval Returns the count of errors detected in the ACPI tables.\r
-*/\r
+**/\r
 UINT32\r
 GetErrorCount (\r
   VOID\r
   );\r
 \r
-/** This function resets the ACPI table warning counter to Zero.\r
-*/\r
+/**\r
+  This function resets the ACPI table warning counter to Zero.\r
+**/\r
 VOID\r
 ResetWarningCount (\r
   VOID\r
   );\r
 \r
-/** This function returns the ACPI table warning count.\r
+/**\r
+  This function returns the ACPI table warning count.\r
 \r
   @retval Returns the count of warning detected in the ACPI tables.\r
-*/\r
+**/\r
 UINT32\r
 GetWarningCount (\r
   VOID\r
   );\r
 \r
-/** This function returns the colour highlighting status.\r
+/**\r
+  This function returns the colour highlighting status.\r
 \r
   @retval TRUE if colour highlighting is enabled.\r
-*/\r
+**/\r
 BOOLEAN\r
 GetColourHighlighting (\r
   VOID\r
   );\r
 \r
-/** This function sets the colour highlighting status.\r
+/**\r
+  This function sets the colour highlighting status.\r
+\r
+  @param  Highlight       The Highlight status.\r
 \r
-*/\r
+**/\r
 VOID\r
 SetColourHighlighting (\r
   BOOLEAN Highlight\r
   );\r
 \r
-/** This function processes the table reporting options for the ACPI table.\r
+/**\r
+  This function processes the table reporting options for the ACPI table.\r
 \r
   @param [in] Signature The ACPI table Signature.\r
   @param [in] TablePtr  Pointer to the ACPI table data.\r
   @param [in] Length    The length fo the ACPI table.\r
 \r
   @retval Returns TRUE if the ACPI table should be traced.\r
-*/\r
+**/\r
 BOOLEAN\r
 ProcessTableReportOptions (\r
   IN CONST UINT32  Signature,\r