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

[mirror_edk2.git] / MdeModulePkg / Universal / EbcDxe / EbcDebugger / EdbCommand.h

diff --git a/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbCommand.h b/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbCommand.h
index 7acf4deb86751191c7761700b00bf51fd7722452..141879f433616a2b9a9152452723d74e7c352471 100644 (file)
--- a/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbCommand.h
+++ b/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbCommand.h
@@ -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,14 +9,8 @@ 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
-  EdbCommand.h\r
-\r
-Abstract:\r
-\r
-\r
---*/\r
+**/\r
 \r
 #ifndef _EFI_EDB_COMMAND_H_\r
 #define _EFI_EDB_COMMAND_H_\r
@@ -29,12 +23,33 @@ typedef enum {
   EdbWidthMax\r
 } EDB_DATA_WIDTH;\r
 \r
+/**\r
+\r
+  Find the command according to name.\r
+\r
+  @param  CommandName   - Command Name\r
+  @param  CommandArg    - Command Argument\r
+\r
+  @return Not NULL        - The DebuggerCommand is found successfully\r
+  @return NULL            - not found\r
+\r
+**/\r
 EFI_DEBUGGER_COMMAND\r
 MatchDebuggerCommand (\r
   IN CHAR16    *CommandName,\r
   IN CHAR16    **CommandArg\r
   );\r
 \r
+/**\r
+\r
+  Find the command name according to the function key.\r
+\r
+  @param  CommandKey    - Command Function Key\r
+\r
+  @return Not NULL        - The DebuggerName is found successfully\r
+  @return NULL            - not found\r
+\r
+**/\r
 CHAR16 *\r
 GetCommandNameByKey (\r
   IN EFI_INPUT_KEY CommandKey\r