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

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

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