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

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11505 6f19259b-4bc3-4df7-8a09-765794883524

ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/FileImage.h

@@ -18,39 +18,66 @@
 
 #include "HexEditor.h"
 
+/**
+  Initialization function for HFileImage
+ 
+  @retval EFI_SUCCESS     The operation was successful.
+**/
 EFI_STATUS
 HFileImageInit (
   VOID
   );
+
+/**
+  Cleanup function for HFileImage.
+
+  @retval EFI_SUCCESS           The operation was successful.
+**/
 EFI_STATUS
 HFileImageCleanup (
   VOID
   );
+
+/**
+  Backup function for HFileImage. Only a few fields need to be backup. 
+  This is for making the file buffer refresh as few as possible.
+
+  @retval EFI_SUCCESS           The operation was successful.
+  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.
+**/
 EFI_STATUS
 HFileImageBackup (
   VOID
   );
 
-EFI_STATUS
-HFileImageSetFileName (
-  IN CONST CHAR16 *
-  );
+/**
+  Read a file from disk into HBufferImage.
 
-EFI_STATUS
-HFileImageGetFileInfo (
-  EFI_FILE_HANDLE,
-  CHAR16          *,
-  EFI_FILE_INFO   **
-  );
+  @param[in] FileName     filename to read.
+  @param[in] Recover      if is for recover, no information print.
 
+  @retval EFI_SUCCESS           The operation was successful.
+  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.
+  @retval EFI_LOAD_ERROR        A load error occured.
+**/
 EFI_STATUS
 HFileImageRead (
-  IN CONST CHAR16   *,
-  IN          BOOLEAN
+  IN CONST CHAR16  *FileName,
+  IN BOOLEAN Recover
   );
+
+/**
+  Save lines in HBufferImage to disk.
+
+  @param[in] FileName     The file name.
+
+  @retval EFI_SUCCESS           The operation was successful.
+  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.
+  @retval EFI_LOAD_ERROR        A load error occured.
+**/
 EFI_STATUS
 HFileImageSave (
-  IN CHAR16 *
+  IN CHAR16 *FileName
   );
 
 #endif