ShellPkg/UefiShellAcpiViewCommandLib: Fix ECC issues

Make the function comments follow EDK2 coding style.

Cc: Sami Mujawar <sami.mujawar@arm.com>
Cc: Evan Lloyd <evan.lloyd@arm.com>
Cc: Jaben Carsey <jaben.carsey@intel.com>
Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>

1 files changed, 23 insertions, 16 deletions

diff --git a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiTableParser.h b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiTableParser.h
index a69d56da6c..ca33b93576 100644
--- a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiTableParser.h
+++ b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiTableParser.h
@@ -1,4 +1,4 @@
-/**

+/** @file

   Header file for ACPI table parser

 

   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.

@@ -14,7 +14,8 @@
 #ifndef ACPITABLEPARSER_H_

 #define ACPITABLEPARSER_H_

 

-/** The maximum number of ACPI table parsers.

+/**

+  The maximum number of ACPI table parsers.

 */

 #define MAX_ACPI_TABLE_PARSERS          16

 

@@ -22,13 +23,14 @@
 */

 #define ACPI_PARSER_SIGNATURE_NULL      0

 

-/** A function that parses the ACPI table.

+/**

+  A function that parses the ACPI table.

 

   @param [in] Trace              If TRUE, trace the ACPI fields.

   @param [in] Ptr                Pointer to the start of the buffer.

   @param [in] AcpiTableLength    Length of the ACPI table.

   @param [in] AcpiTableRevision  Revision of the ACPI table.

-*/

+**/

 typedef

 VOID

 (EFIAPI * PARSE_ACPI_TABLE_PROC) (

@@ -38,8 +40,9 @@ VOID
   IN UINT8   AcpiTableRevision

   );

 

-/** The ACPI table parser information

-*/

+/**

+  The ACPI table parser information

+**/

 typedef struct AcpiTableParser {

   /// ACPI table signature

   UINT32                  Signature;

@@ -48,7 +51,8 @@ typedef struct AcpiTableParser {
   PARSE_ACPI_TABLE_PROC   Parser;

 } ACPI_TABLE_PARSER;

 

-/** Register the ACPI table Parser

+/**

+  Register the ACPI table Parser

 

   This function registers the ACPI table parser.

 

@@ -61,15 +65,16 @@ typedef struct AcpiTableParser {
                                 was already registered.

   @retval EFI_OUT_OF_RESOURCES  No space to register the

                                 parser.

-*/

+**/

 EFI_STATUS

 EFIAPI

 RegisterParser (

   IN  UINT32                  Signature,

   IN  PARSE_ACPI_TABLE_PROC   ParserProc

-);

+  );

 

-/** Deregister the ACPI table Parser

+/**

+  Deregister the ACPI table Parser

 

   This function deregisters the ACPI table parser.

 

@@ -78,14 +83,15 @@ RegisterParser (
   @retval EFI_SUCCESS           The parser was deregistered.

   @retval EFI_INVALID_PARAMETER A parameter is invalid.

   @retval EFI_NOT_FOUND         A registered parser was not found.

-*/

+**/

 EFI_STATUS

 EFIAPI

 DeregisterParser (

   IN  UINT32                  Signature

-);

+  );

 

-/** This function processes the ACPI tables.

+/**

+  This function processes the ACPI tables.

   This function calls ProcessTableReportOptions() to list the ACPI

   tables, perform binary dump of the tables and determine if the

   ACPI fields should be traced.

@@ -97,14 +103,15 @@ DeregisterParser (
 

   @param [in] Ptr                Pointer to the start of the ACPI

                                  table data buffer.

-*/

+**/

 VOID

 EFIAPI

 ProcessAcpiTable (

   IN UINT8* Ptr

   );

 

-/** Get the ACPI table Parser

+/**

+  Get the ACPI table Parser

 

   This function returns the ACPI table parser proc from the list of

   registered parsers.

@@ -115,7 +122,7 @@ ProcessAcpiTable (
   @retval EFI_SUCCESS           The parser was returned successfully.

   @retval EFI_INVALID_PARAMETER A parameter is invalid.

   @retval EFI_NOT_FOUND         A registered parser was not found.

-*/

+**/

 EFI_STATUS

 EFIAPI

 GetParser (