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

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

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MainHexEditor.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MainHexEditor.h
index c4f2ea6382602754cf1a3043657847d8f0ec0034..ad9a7b4be8f8cd4be1092ff1f25b3cab006ec5db 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MainHexEditor.h
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MainHexEditor.h
@@ -20,18 +20,45 @@
 \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
@@ -45,4 +72,5 @@ EFIAPI
 HMainEditorBackup (\r
   VOID\r
   );\r
+\r
 #endif\r