ShellPkg: Clean up source files

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

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/FileImage.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/FileImage.h
index ae386d2fc94414723fd694741366d596ae5734b8..5f5b2cfe77ea47ebece7b7e04e0a3d4ee6b71736 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/FileImage.h
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/FileImage.h
@@ -1,8 +1,8 @@
 /** @file\r
-  Defines FileImage - the view of the file that is visible at any point, \r
+  Defines FileImage - the view of the file that is visible at any point,\r
   as well as the event handlers for editing the file\r
-  \r
-  Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved. <BR>\r
+\r
+  Copyright (c) 2005 - 2018, 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
@@ -18,39 +18,66 @@
 \r
 #include "HexEditor.h"\r
 \r
+/**\r
+  Initialization function for HFileImage\r
+\r
+  @retval EFI_SUCCESS     The operation was successful.\r
+**/\r
 EFI_STATUS\r
 HFileImageInit (\r
   VOID\r
   );\r
+\r
+/**\r
+  Cleanup function for HFileImage.\r
+\r
+  @retval EFI_SUCCESS           The operation was successful.\r
+**/\r
 EFI_STATUS\r
 HFileImageCleanup (\r
   VOID\r
   );\r
+\r
+/**\r
+  Backup function for HFileImage. Only a few fields need to be backup.\r
+  This is for making the file buffer refresh as few as possible.\r
+\r
+  @retval EFI_SUCCESS           The operation was successful.\r
+  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
+**/\r
 EFI_STATUS\r
 HFileImageBackup (\r
   VOID\r
   );\r
 \r
-EFI_STATUS\r
-HFileImageSetFileName (\r
-  IN CONST CHAR16 *\r
-  );\r
+/**\r
+  Read a file from disk into HBufferImage.\r
 \r
-EFI_STATUS\r
-HFileImageGetFileInfo (\r
-  EFI_FILE_HANDLE,\r
-  CHAR16          *,\r
-  EFI_FILE_INFO   **\r
-  );\r
+  @param[in] FileName     filename to read.\r
+  @param[in] Recover      if is for recover, no information print.\r
 \r
+  @retval EFI_SUCCESS           The operation was successful.\r
+  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
+  @retval EFI_LOAD_ERROR        A load error occured.\r
+**/\r
 EFI_STATUS\r
 HFileImageRead (\r
-  IN CONST CHAR16   *,\r
-  IN          BOOLEAN\r
+  IN CONST CHAR16  *FileName,\r
+  IN BOOLEAN Recover\r
   );\r
+\r
+/**\r
+  Save lines in HBufferImage to disk.\r
+\r
+  @param[in] FileName     The file name.\r
+\r
+  @retval EFI_SUCCESS           The operation was successful.\r
+  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
+  @retval EFI_LOAD_ERROR        A load error occured.\r
+**/\r
 EFI_STATUS\r
 HFileImageSave (\r
-  IN CHAR16 *\r
+  IN CHAR16 *FileName\r
   );\r
 \r
 #endif\r