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

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

diff --git a/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbCmdBreak.c b/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbCmdBreak.c
index ab3c7d8fd6d23adaee3d9024999c22fb20e1ab1e..5759a3b9f90a496593a5e27f10b690404d7796a9 100644 (file)
--- a/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbCmdBreak.c
+++ b/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbCmdBreak.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,24 @@ 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
-  EdbCmdBreak.c\r
+**/\r
 \r
-Abstract:\r
+#include "Edb.h"\r
 \r
 \r
---*/\r
+/**\r
 \r
-#include "Edb.h"\r
+  DebuggerCommand - BreakOnCALL.\r
+\r
+  @param  CommandArg          The argument for this command\r
+  @param  DebuggerPrivate     EBC Debugger private data structure\r
+  @param  ExceptionType       Exception type.\r
+  @param  SystemContext       EBC system context.\r
 \r
+  @retval EFI_DEBUG_CONTINUE  formal return value\r
+\r
+**/\r
 EFI_DEBUG_STATUS\r
 DebuggerBreakOnCALL (\r
   IN     CHAR16                    *CommandArg,\r
@@ -27,24 +34,6 @@ DebuggerBreakOnCALL (
   IN     EFI_EXCEPTION_TYPE        ExceptionType,\r
   IN OUT EFI_SYSTEM_CONTEXT        SystemContext\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  DebuggerCommand - BreakOnCALL\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
   //\r
   // Check argument\r
@@ -71,6 +60,19 @@ Returns:
   return EFI_DEBUG_CONTINUE;\r
 }\r
 \r
+/**\r
+\r
+  DebuggerCommand    BreakOnCALLEX.\r
+\r
+\r
+  @param  CommandArg           The argument for this command\r
+  @param  DebuggerPrivate      EBC Debugger private data structure\r
+  @param  ExceptionType        Exceptiont type.\r
+  @param  SystemContext        EBC system context.\r
+\r
+  @retval EFI_DEBUG_CONTINUE   formal return value\r
+\r
+**/\r
 EFI_DEBUG_STATUS\r
 DebuggerBreakOnCALLEX (\r
   IN     CHAR16                    *CommandArg,\r
@@ -78,24 +80,6 @@ DebuggerBreakOnCALLEX (
   IN     EFI_EXCEPTION_TYPE        ExceptionType,\r
   IN OUT EFI_SYSTEM_CONTEXT        SystemContext\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  DebuggerCommand - BreakOnCALLEX\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
   //\r
   // Check argument\r
@@ -122,6 +106,19 @@ Returns:
   return EFI_DEBUG_CONTINUE;\r
 }\r
 \r
+/**\r
+\r
+  DebuggerCommand - BreakOnRET.\r
+\r
+\r
+  @param  CommandArg          The argument for this command\r
+  @param  DebuggerPrivate     EBC Debugger private data structure\r
+  @param  ExceptionType       Exception type.\r
+  @param  SystemContext       EBC system context.\r
+\r
+  @retval EFI_DEBUG_CONTINUE  formal return value\r
+\r
+**/\r
 EFI_DEBUG_STATUS\r
 DebuggerBreakOnRET (\r
   IN     CHAR16                    *CommandArg,\r
@@ -129,24 +126,6 @@ DebuggerBreakOnRET (
   IN     EFI_EXCEPTION_TYPE        ExceptionType,\r
   IN OUT EFI_SYSTEM_CONTEXT        SystemContext\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  DebuggerCommand - BreakOnRET\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
   //\r
   // Check argument\r
@@ -173,6 +152,19 @@ Returns:
   return EFI_DEBUG_CONTINUE;\r
 }\r
 \r
+/**\r
+\r
+  DebuggerCommand - BreakOnEntrypoint.\r
+\r
+\r
+  @param  CommandArg           The argument for this command\r
+  @param  DebuggerPrivate      EBC Debugger private data structure\r
+  @param  ExceptionType        Exception type.\r
+  @param  SystemContext        EBC system context.\r
+\r
+  @retval EFI_DEBUG_CONTINUE   formal return value\r
+\r
+**/\r
 EFI_DEBUG_STATUS\r
 DebuggerBreakOnEntrypoint (\r
   IN     CHAR16                    *CommandArg,\r
@@ -180,24 +172,6 @@ DebuggerBreakOnEntrypoint (
   IN     EFI_EXCEPTION_TYPE        ExceptionType,\r
   IN OUT EFI_SYSTEM_CONTEXT        SystemContext\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  DebuggerCommand - BreakOnEntrypoint\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
   //\r
   // Check argument\r
@@ -224,31 +198,28 @@ Returns:
   return EFI_DEBUG_CONTINUE;\r
 }\r
 \r
-EFI_DEBUG_STATUS\r
-DebuggerBreakOnThunk (\r
-  IN     CHAR16                    *CommandArg,\r
-  IN     EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,\r
-  IN     EFI_EXCEPTION_TYPE        ExceptionType,\r
-  IN OUT EFI_SYSTEM_CONTEXT        SystemContext\r
-  )\r
-/*++\r
+/**\r
 \r
-Routine Description:\r
 \r
-  DebuggerCommand - BreakOnThunk\r
+  DebuggerCommand - BreakOnThunk.\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
+  @param  CommandArg          The argument for this command\r
+  @param  DebuggerPrivate     EBC Debugger private data structure\r
+  @param  ExceptionType       Exception type.\r
+  @param  SystemContext       EBC system context.\r
 \r
-Returns:\r
 \r
-  EFI_DEBUG_CONTINUE - formal return value\r
+  @retval EFI_DEBUG_CONTINUE  formal return value\r
 \r
---*/\r
+**/\r
+EFI_DEBUG_STATUS\r
+DebuggerBreakOnThunk (\r
+  IN     CHAR16                    *CommandArg,\r
+  IN     EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,\r
+  IN     EFI_EXCEPTION_TYPE        ExceptionType,\r
+  IN OUT EFI_SYSTEM_CONTEXT        SystemContext\r
+  )\r
 {\r
   //\r
   // Check argument\r
@@ -275,6 +246,20 @@ Returns:
   return EFI_DEBUG_CONTINUE;\r
 }\r
 \r
+/**\r
+\r
+  DebuggerCommand - BreakOnKey.\r
+\r
+\r
+  @param  CommandArg           The argument for this command\r
+  @param  DebuggerPrivate      EBC Debugger private data structure\r
+  @param  ExceptionType        Exception type.\r
+  @param  SystemContext        EBC system context.\r
+\r
+\r
+  @retval EFI_DEBUG_CONTINUE   formal return value\r
+\r
+**/\r
 EFI_DEBUG_STATUS\r
 DebuggerBreakOnKey (\r
   IN     CHAR16                    *CommandArg,\r
@@ -282,24 +267,6 @@ DebuggerBreakOnKey (
   IN     EFI_EXCEPTION_TYPE        ExceptionType,\r
   IN OUT EFI_SYSTEM_CONTEXT        SystemContext\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  DebuggerCommand - BreakOnKey\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
   //\r
   // Check argument\r