MdeModulePkg/EbcDxe: Make the comments align with EDKII coding style

[mirror_edk2.git] / MdeModulePkg / Universal / EbcDxe / EbcDebugger / EdbCmdExtPci.c

diff --git a/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbCmdExtPci.c b/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbCmdExtPci.c
index adb29f8c34b1f8cb105885ae22262fe15378ea17..07b5e4854a4ca20462c3f159b60f54914756c8d5 100644 (file)
--- a/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbCmdExtPci.c
+++ b/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbCmdExtPci.c
@@ -1,7 +1,7 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2007, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2007, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
@@ -9,17 +9,23 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-Module Name:\r
 \r
-  EdbCmdExtPci.c\r
+**/\r
 \r
-Abstract:\r
+#include "Edb.h"\r
 \r
+/**\r
 \r
---*/\r
+  DebuggerCommand - PCIL.\r
 \r
-#include "Edb.h"\r
+  @param  CommandArg      - The argument for this command\r
+  @param  DebuggerPrivate - EBC Debugger private data structure\r
+  @param  ExceptionType   - Interrupt type.\r
+  @param  SystemContext   - EBC system context.\r
 \r
+  @retval EFI_DEBUG_CONTINUE - formal return value\r
+\r
+**/\r
 EFI_DEBUG_STATUS\r
 DebuggerExtPciPCIL (\r
   IN     CHAR16                    *CommandArg,\r
@@ -27,24 +33,6 @@ DebuggerExtPciPCIL (
   IN     EFI_EXCEPTION_TYPE        ExceptionType,\r
   IN OUT EFI_SYSTEM_CONTEXT        SystemContext\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  DebuggerCommand - PCIL\r
-\r
-Arguments:\r
-\r
-  CommandArg      - The argument for this command\r
-  DebuggerPrivate - EBC Debugger private data structure\r
-  InterruptType   - Interrupt type.\r
-  SystemContext   - EBC system context.\r
-\r
-Returns:\r
-\r
-  EFI_DEBUG_CONTINUE - formal return value\r
-\r
---*/\r
 {\r
   EDBPrint (L"Unsupported\n");\r
   //\r
@@ -53,6 +41,18 @@ Returns:
   return EFI_DEBUG_CONTINUE;\r
 }\r
 \r
+/**\r
+\r
+  DebuggerCommand - PCID.\r
+\r
+  @param  CommandArg      - The argument for this command\r
+  @param  DebuggerPrivate - EBC Debugger private data structure\r
+  @param  ExceptionType   - Interrupt type.\r
+  @param  SystemContext   - EBC system context.\r
+\r
+  @retval EFI_DEBUG_CONTINUE - formal return value\r
+\r
+**/\r
 EFI_DEBUG_STATUS\r
 DebuggerExtPciPCID (\r
   IN     CHAR16                    *CommandArg,\r
@@ -60,24 +60,6 @@ DebuggerExtPciPCID (
   IN     EFI_EXCEPTION_TYPE        ExceptionType,\r
   IN OUT EFI_SYSTEM_CONTEXT        SystemContext\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  DebuggerCommand - PCID\r
-\r
-Arguments:\r
-\r
-  CommandArg      - The argument for this command\r
-  DebuggerPrivate - EBC Debugger private data structure\r
-  InterruptType   - Interrupt type.\r
-  SystemContext   - EBC system context.\r
-\r
-Returns:\r
-\r
-  EFI_DEBUG_CONTINUE - formal return value\r
-\r
---*/\r
 {\r
   EDBPrint (L"Unsupported\n");\r
   //\r
@@ -86,6 +68,18 @@ Returns:
   return EFI_DEBUG_CONTINUE;\r
 }\r
 \r
+/**\r
+\r
+  DebuggerCommand - CFGB.\r
+\r
+  @param  CommandArg      - The argument for this command\r
+  @param  DebuggerPrivate - EBC Debugger private data structure\r
+  @param  ExceptionType   - Interrupt type.\r
+  @param  SystemContext   - EBC system context.\r
+\r
+  @retval EFI_DEBUG_CONTINUE - formal return value\r
+\r
+**/\r
 EFI_DEBUG_STATUS\r
 DebuggerExtPciCFGB (\r
   IN     CHAR16                    *CommandArg,\r
@@ -93,24 +87,6 @@ DebuggerExtPciCFGB (
   IN     EFI_EXCEPTION_TYPE        ExceptionType,\r
   IN OUT EFI_SYSTEM_CONTEXT        SystemContext\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  DebuggerCommand - CFGB\r
-\r
-Arguments:\r
-\r
-  CommandArg      - The argument for this command\r
-  DebuggerPrivate - EBC Debugger private data structure\r
-  InterruptType   - Interrupt type.\r
-  SystemContext   - EBC system context.\r
-\r
-Returns:\r
-\r
-  EFI_DEBUG_CONTINUE - formal return value\r
-\r
---*/\r
 {\r
   EDBPrint (L"Unsupported\n");\r
   //\r
@@ -119,6 +95,19 @@ Returns:
   return EFI_DEBUG_CONTINUE;\r
 }\r
 \r
+\r
+/**\r
+\r
+  DebuggerCommand - CFGW.\r
+\r
+  @param  CommandArg      - The argument for this command\r
+  @param  DebuggerPrivate - EBC Debugger private data structure\r
+  @param  ExceptionType   - Interrupt type.\r
+  @param  SystemContext   - EBC system context.\r
+\r
+  @retval EFI_DEBUG_CONTINUE - formal return value\r
+\r
+**/\r
 EFI_DEBUG_STATUS\r
 DebuggerExtPciCFGW (\r
   IN     CHAR16                    *CommandArg,\r
@@ -126,24 +115,6 @@ DebuggerExtPciCFGW (
   IN     EFI_EXCEPTION_TYPE        ExceptionType,\r
   IN OUT EFI_SYSTEM_CONTEXT        SystemContext\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  DebuggerCommand - CFGW\r
-\r
-Arguments:\r
-\r
-  CommandArg      - The argument for this command\r
-  DebuggerPrivate - EBC Debugger private data structure\r
-  InterruptType   - Interrupt type.\r
-  SystemContext   - EBC system context.\r
-\r
-Returns:\r
-\r
-  EFI_DEBUG_CONTINUE - formal return value\r
-\r
---*/\r
 {\r
   EDBPrint (L"Unsupported\n");\r
   //\r
@@ -152,6 +123,18 @@ Returns:
   return EFI_DEBUG_CONTINUE;\r
 }\r
 \r
+/**\r
+\r
+  DebuggerCommand - CFGD.\r
+\r
+  @param  CommandArg      - The argument for this command\r
+  @param  DebuggerPrivate - EBC Debugger private data structure\r
+  @param  ExceptionType   - Interrupt type.\r
+  @param  SystemContext   - EBC system context.\r
+\r
+  @retval EFI_DEBUG_CONTINUE - formal return value\r
+\r
+**/\r
 EFI_DEBUG_STATUS\r
 DebuggerExtPciCFGD (\r
   IN     CHAR16                    *CommandArg,\r
@@ -159,24 +142,6 @@ DebuggerExtPciCFGD (
   IN     EFI_EXCEPTION_TYPE        ExceptionType,\r
   IN OUT EFI_SYSTEM_CONTEXT        SystemContext\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  DebuggerCommand - CFGD\r
-\r
-Arguments:\r
-\r
-  CommandArg      - The argument for this command\r
-  DebuggerPrivate - EBC Debugger private data structure\r
-  InterruptType   - Interrupt type.\r
-  SystemContext   - EBC system context.\r
-\r
-Returns:\r
-\r
-  EFI_DEBUG_CONTINUE - formal return value\r
-\r
---*/\r
 {\r
   EDBPrint (L"Unsupported\n");\r
   //\r