MdeModulePkg/EbcDxe: Add comments for functions

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

/** @file\r
\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
\r
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
\r
**/\r
\r
#include "Edb.h"\r
\r
/**\r
\r
  DebuggerCommand - Help.\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
DebuggerHelp (\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
  UINTN Index;\r
\r
  //\r
  // if no argument, print all the command title\r
  //\r
  if (CommandArg == NULL) {\r
    for (Index = 0; DebuggerPrivate->DebuggerCommandSet[Index].CommandName != NULL; Index++) {\r
      EDBPrint (DebuggerPrivate->DebuggerCommandSet[Index].ClassName);\r
      if (StrCmp (DebuggerPrivate->DebuggerCommandSet[Index].CommandTitle, L"") != 0) {\r
        EDBPrint (L"  ");\r
        EDBPrint (DebuggerPrivate->DebuggerCommandSet[Index].CommandTitle);\r
      }\r
    }\r
    return EFI_DEBUG_CONTINUE;\r
  }\r
\r
  //\r
  // If there is argument, the argument should be command name.\r
  // Find the command and print the detail information.\r
  //\r
  for (Index = 0; DebuggerPrivate->DebuggerCommandSet[Index].CommandName != NULL; Index++) {\r
    if (StriCmp (CommandArg, DebuggerPrivate->DebuggerCommandSet[Index].CommandName) == 0) {\r
      EDBPrint (DebuggerPrivate->DebuggerCommandSet[Index].CommandHelp);\r
      EDBPrint (DebuggerPrivate->DebuggerCommandSet[Index].CommandSyntax);\r
      return EFI_DEBUG_CONTINUE;\r
    }\r
  }\r
\r
  //\r
  // Command not found.\r
  //\r
  EDBPrint (L"No help info for this command\n");\r
\r
  //\r
  // Done\r
  //\r
  return EFI_DEBUG_CONTINUE;\r
}\r