add comments to function declarations and definitions and updated to match coding...

[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / HexEdit / MainHexEditor.h

/** @file\r
    Defines the Main Editor data type - \r
     - Global variables \r
     - Instances of the other objects of the editor\r
     - Main Interfaces\r
  \r
  Copyright (c) 2005 - 2011, 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
#ifndef _LIB_EDITOR_H_\r
#define _LIB_EDITOR_H_\r
\r
#include "HexEditor.h"\r
\r
/**\r
  Init function for MainEditor\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_LOAD_ERROR          A load error occured.\r
**/\r
EFI_STATUS\r
HMainEditorInit (\r
  VOID\r
  );\r
\r
/**\r
  Cleanup function for MainEditor.\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_LOAD_ERROR          A load error occured.\r
**/\r
EFI_STATUS\r
HMainEditorCleanup (\r
  VOID\r
  );\r
\r
/**\r
  Refresh function for MainEditor.\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
**/\r
EFI_STATUS\r
HMainEditorRefresh (\r
  VOID\r
  );\r
\r
/**\r
  Handle user key input. will route it to other components handle function.\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES    A memory allocation occured.\r
  @retval EFI_LOAD_ERROR          A load error occured.\r
**/\r
EFI_STATUS\r
HMainEditorKeyInput (\r
  VOID\r
  );\r
\r
/**\r
  Backup function for MainEditor.\r
**/\r
VOID\r
EFIAPI\r
HMainEditorBackup (\r
  VOID\r
  );\r
\r
#endif\r