ShellPkg/UefiShellAcpiViewCommandLib: Fix ECC issues

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

diff --git a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.c b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.c
index 3bb142538c0099dcdd2dfa3d208d3350c425accb..f5602e94291c26f91513d753601d09ddff73a4dd 100644 (file)
--- a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.c
+++ b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.c
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
   This program and the accompanying materials\r
@@ -35,8 +35,9 @@ STATIC BOOLEAN            mVerbose;
 STATIC BOOLEAN            mConsistencyCheck;\r
 STATIC BOOLEAN            mColourHighlighting;\r
 \r
-/** An array of acpiview command line parameters.\r
-*/\r
+/**\r
+  An array of acpiview command line parameters.\r
+**/\r
 STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
   {L"/?", TypeFlag},\r
   {L"-c", TypeFlag},\r
@@ -48,10 +49,11 @@ STATIC CONST SHELL_PARAM_ITEM ParamList[] = {
   {NULL, TypeMax}\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
@@ -60,9 +62,12 @@ GetColourHighlighting (
   return mColourHighlighting;\r
 }\r
 \r
-/** This function sets the colour highlighting status.\r
+/**\r
+  This function sets the colour highlighting status.\r
 \r
-*/\r
+  @param  Highlight       The Highlight status.\r
+\r
+**/\r
 VOID\r
 SetColourHighlighting (\r
   BOOLEAN Highlight\r
@@ -71,10 +76,11 @@ SetColourHighlighting (
   mColourHighlighting = Highlight;\r
 }\r
 \r
-/** This function returns the report options.\r
+/**\r
+  This function returns the report options.\r
 \r
   @retval Returns the report option.\r
-*/\r
+**/\r
 STATIC\r
 EREPORT_OPTION\r
 GetReportOption (\r
@@ -84,10 +90,11 @@ GetReportOption (
   return mReportType;\r
 }\r
 \r
-/** This function returns the selected ACPI table.\r
+/**\r
+  This function returns the selected ACPI table.\r
 \r
   @retval Returns signature of the selected ACPI table.\r
-*/\r
+**/\r
 STATIC\r
 UINT32\r
 GetSelectedAcpiTable (\r
@@ -97,13 +104,15 @@ GetSelectedAcpiTable (
   return mSelectedAcpiTable;\r
 }\r
 \r
-/** This function dumps the ACPI table to a file.\r
+/**\r
+  This function dumps the ACPI table to a file.\r
+\r
   @param [in] Ptr       Pointer to the ACPI table data.\r
   @param [in] Length    The length of the ACPI table.\r
 \r
   @retval TRUE          Success.\r
   @retval FALSE         Failure.\r
-*/\r
+**/\r
 STATIC\r
 BOOLEAN\r
 DumpAcpiTableToFile (\r
@@ -160,14 +169,15 @@ DumpAcpiTableToFile (
   return (Length == TransferBytes);\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
@@ -249,13 +259,14 @@ ProcessTableReportOptions (
   return Log;\r
 }\r
 \r
-/** This function converts a string to ACPI table signature.\r
+/**\r
+  This function converts a string to ACPI table signature.\r
 \r
   @param [in] Str   Pointer to the string to be converted to the\r
                     ACPI table signature.\r
 \r
   @retval The ACPI table signature.\r
-*/\r
+**/\r
 STATIC\r
 UINT32\r
 ConvertStrToAcpiSignature (\r
@@ -277,16 +288,16 @@ ConvertStrToAcpiSignature (
   return *(UINT32*)Ptr;\r
 }\r
 \r
-/** This function iterates the configuration table entries in the\r
-    system table, retrieves the RSDP pointer and starts parsing\r
-    the ACPI tables.\r
+/**\r
+  This function iterates the configuration table entries in the\r
+  system table, retrieves the RSDP pointer and starts parsing the ACPI tables.\r
 \r
   @param [in] SystemTable Pointer to the EFI system table.\r
 \r
   @retval Returns EFI_NOT_FOUND   if the RSDP pointer is not found.\r
           Returns EFI_UNSUPPORTED if the RSDP version is less than 2.\r
           Returns EFI_SUCCESS     if successful.\r
-*/\r
+**/\r
 STATIC\r
 EFI_STATUS\r
 EFIAPI\r
@@ -406,7 +417,7 @@ AcpiView (
 \r
   @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
-*/\r
+**/\r
 SHELL_STATUS\r
 EFIAPI\r
 ShellCommandRunAcpiView (\r