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

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

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/FileImage.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/FileImage.c
index 5397071b3b197b5defa279ed72efc56e0bd9e95d..85626626386511a59eb2ea55e22a980aba5ad015 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/FileImage.c
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/FileImage.c
@@ -35,26 +35,15 @@ HEFI_EDITOR_BUFFER_IMAGE          HFileImageConst = {
   FALSE\r
 };\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
-Routine Description: \r
-\r
-  Initialization function for HFileImage\r
-\r
-Arguments:  \r
-\r
-  None\r
-\r
-Returns:  \r
-\r
-  EFI_SUCCESS\r
-  EFI_LOAD_ERROR\r
-\r
---*/\r
 {\r
   //\r
   // basically initialize the HFileImage\r
@@ -70,29 +59,17 @@ Returns:
   return EFI_SUCCESS;\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
-\r
-Routine Description: \r
-\r
-  Backup function for HFileImage\r
-  Only a few fields need to be backup. \r
-  This is for making the file buffer refresh \r
-  as few as possible.\r
-\r
-Arguments:  \r
-\r
-  None\r
-\r
-Returns:  \r
-\r
-  EFI_SUCCESS\r
-  EFI_OUT_OF_RESOURCES\r
-\r
---*/\r
 {\r
   SHELL_FREE_NON_NULL (HFileImageBackupVar.FileName);\r
   HFileImageBackupVar.FileName = CatSPrint(NULL, L"%s", HFileImage.FileName);\r
@@ -103,25 +80,15 @@ Returns:
   return EFI_SUCCESS;\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
-Routine Description: \r
-\r
-  Cleanup function for HFileImage\r
-\r
-Arguments:  \r
-\r
-  None\r
-\r
-Returns:  \r
-\r
-  EFI_SUCCESS\r
-\r
---*/\r
 {\r
 \r
   SHELL_FREE_NON_NULL (HFileImage.FileName);\r
@@ -130,26 +97,18 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  Set FileName field in HFileImage\r
+\r
+  @param[in] Str  File name to set.\r
+\r
+  @retval EFI_SUCCESS           The operation was successful.\r
+  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
+**/\r
 EFI_STATUS\r
 HFileImageSetFileName (\r
   IN CONST CHAR16 *Str\r
   )\r
-/*++\r
-\r
-Routine Description: \r
-\r
-  Set FileName field in HFileImage\r
-\r
-Arguments:  \r
-\r
-  Str -- File name to set\r
-\r
-Returns:  \r
-\r
-  EFI_SUCCESS\r
-  EFI_OUT_OF_RESOURCES\r
-\r
---*/\r
 {\r
   UINTN Size;\r
   UINTN Index;\r
@@ -175,79 +134,21 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
-EFI_STATUS\r
-HFileImageGetFileInfo (\r
-  IN  EFI_FILE_HANDLE Handle,\r
-  IN  CHAR16          *FileName,\r
-  OUT EFI_FILE_INFO   **InfoOut\r
-  )\r
-/*++\r
-\r
-Routine Description: \r
-\r
-  Get this file's information\r
-\r
-Arguments:  \r
-\r
-  Handle   - in NT32 mode Directory handle, in other mode File Handle\r
-  FileName - The file name\r
-  InfoOut  - parameter to pass file information out\r
-\r
-Returns:  \r
-\r
-  EFI_SUCCESS\r
-  EFI_OUT_OF_RESOURCES\r
-  EFI_LOAD_ERROR\r
-\r
---*/\r
-{\r
-\r
-  VOID        *Info;\r
-  UINTN       Size;\r
-  EFI_STATUS  Status;\r
-\r
-  Size  = SIZE_OF_EFI_FILE_INFO + 1024;\r
-  Info  = AllocateZeroPool (Size);\r
-  if (!Info) {\r
-    return EFI_OUT_OF_RESOURCES;\r
-  }\r
-  //\r
-  // get file information\r
-  //\r
-  Status = Handle->GetInfo (Handle, &gEfiFileInfoGuid, &Size, Info);\r
-  if (EFI_ERROR (Status)) {\r
-    return EFI_LOAD_ERROR;\r
-  }\r
-\r
-  *InfoOut = (EFI_FILE_INFO *) Info;\r
+/**\r
+  Read a file from disk into HBufferImage.\r
 \r
-  return EFI_SUCCESS;\r
-\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  *FileName,\r
   IN BOOLEAN Recover\r
   )\r
-/*++\r
-\r
-Routine Description: \r
-\r
-  Read a file from disk into HBufferImage\r
-\r
-Arguments:  \r
-\r
-  FileName -- filename to read\r
-  Recover -- if is for recover, no information print\r
-\r
-Returns:  \r
-\r
-  EFI_SUCCESS\r
-  EFI_LOAD_ERROR\r
-  EFI_OUT_OF_RESOURCES\r
-  \r
---*/\r
 {\r
   HEFI_EDITOR_LINE                *Line;\r
   UINT8                           *Buffer;\r
@@ -343,27 +244,19 @@ Returns:
   return EFI_SUCCESS;\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 *FileName\r
   )\r
-/*++\r
-\r
-Routine Description: \r
-\r
-  Save lines in HBufferImage to disk\r
-\r
-Arguments:  \r
-\r
-  FileName - The file name\r
-\r
-Returns:  \r
-\r
-  EFI_SUCCESS\r
-  EFI_LOAD_ERROR\r
-  EFI_OUT_OF_RESOURCES\r
-\r
---*/\r
 {\r
 \r
   LIST_ENTRY                      *Link;\r