1 files changed, 54 insertions, 7 deletions
diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/DiskImage.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/DiskImage.h
index eaa8e2615d..06fb53020a 100644
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/DiskImage.h
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/DiskImage.h
@@ -18,31 +18,78 @@
 
 #include "HexEditor.h"
 
+/**
+  Initialization function for HDiskImage.
+ 
+  @retval EFI_SUCCESS     The operation was successful.
+  @retval EFI_LOAD_ERROR  A load error occured.
+**/
 EFI_STATUS
 HDiskImageInit (
   VOID
   );
+
+/**
+  Cleanup function for HDiskImage.
+
+  @retval EFI_SUCCESS           The operation was successful.
+**/
 EFI_STATUS
 HDiskImageCleanup (
   VOID
   );
+
+/**
+  Backup function for HDiskImage. Only a few fields need to be backup.   
+  This is for making the Disk buffer refresh as few as possible.
+
+  @retval EFI_SUCCESS           The operation was successful.
+  @retval EFI_OUT_OF_RESOURCES  gST->ConOut of resources.
+**/
 EFI_STATUS
 HDiskImageBackup (
   VOID
   );
 
+/**
+  Read a disk from disk into HBufferImage.
+
+  @param[in] DeviceName   filename to read.
+  @param[in] Offset       The offset.
+  @param[in] Size         The size.
+  @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.
+  @retval EFI_INVALID_PARAMETER A parameter was invalid.  
+**/
 EFI_STATUS
 HDiskImageRead (
-  IN CONST CHAR16   *,
-  IN          UINTN,
-  IN          UINTN,
-  IN          BOOLEAN
+  IN CONST CHAR16   *DeviceName,
+  IN UINTN    Offset,
+  IN UINTN    Size,
+  IN BOOLEAN  Recover
   );
+
+/**
+  Save lines in HBufferImage to disk.
+  NOT ALLOW TO WRITE TO ANOTHER DISK!!!!!!!!!
+
+  @param[in] DeviceName   The device name.
+  @param[in] Offset       The offset.
+  @param[in] Size         The size.
+
+  @retval EFI_SUCCESS           The operation was successful.
+  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.
+  @retval EFI_LOAD_ERROR        A load error occured.
+  @retval EFI_INVALID_PARAMETER A parameter was invalid.  
+**/
 EFI_STATUS
 HDiskImageSave (
-  IN CHAR16   *,
-  IN          UINTN,
-  IN          UINTN
+  IN CHAR16 *DeviceName,
+  IN UINTN  Offset,
+  IN UINTN  Size
   );
 
 #endif