ShellPkg: Clean up source files

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

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/Misc.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/Misc.h
index a9b59ff514eab01e475596f48aed1329d9787f75..f95de3d95f9eb6e870aa951f2045fd2d4cbe6c16 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/Misc.h
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/Misc.h
@@ -1,7 +1,7 @@
 /** @file\r
     Definitions for various line and string routines\r
 \r
-  Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved. <BR>\r
+  Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved. <BR>\r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -17,80 +17,77 @@
 \r
 #include "HexEditor.h"\r
 \r
-VOID\r
-HEditorClearLine (\r
-  UINTN\r
-  );\r
-HEFI_EDITOR_LINE  *\r
-HLineDup (\r
-  HEFI_EDITOR_LINE *\r
-  );\r
-VOID\r
-HLineFree (\r
-  HEFI_EDITOR_LINE *\r
-  );\r
+/**\r
+  Advance/Retreat lines.\r
 \r
-HEFI_EDITOR_LINE  *\r
+  @param[in] Count      The line number to advance/retreat.\r
+                            >0 : advance\r
+                            <0: retreat\r
+\r
+  @retval NULL An error occured.\r
+  @return A pointer to the line after move.\r
+**/\r
+HEFI_EDITOR_LINE *\r
 HMoveLine (\r
-  INTN\r
-  );\r
-HEFI_EDITOR_LINE  *\r
-HMoveCurrentLine (\r
-  INTN\r
+  IN  INTN Count\r
   );\r
 \r
-UINTN\r
-HLineStrInsert (\r
-  HEFI_EDITOR_LINE  *,\r
-  CHAR16,\r
-  UINTN,\r
-  UINTN\r
-  );\r
+/**\r
+  Advance/Retreat lines and set CurrentLine in BufferImage to it.\r
 \r
-VOID\r
-HLineCat (\r
-  HEFI_EDITOR_LINE *,\r
-  HEFI_EDITOR_LINE *\r
-  );\r
+  @param[in] Count    The line number to advance/retreat.\r
+                          >0 : advance\r
+                          <0: retreat\r
 \r
-VOID\r
-HLineDeleteAt (\r
-  HEFI_EDITOR_LINE  *,\r
-  UINTN\r
+  @retval NULL An error occured.\r
+  @return A pointer to the line after move.\r
+**/\r
+HEFI_EDITOR_LINE *\r
+HMoveCurrentLine (\r
+  IN  INTN Count\r
   );\r
 \r
-UINTN\r
-HUnicodeToAscii (\r
-  CHAR16    *,\r
-  UINTN,\r
-  CHAR8     *\r
-  );\r
+/**\r
+  Free all the lines in HBufferImage.\r
+    Fields affected:\r
+    Lines\r
+    CurrentLine\r
+    NumLines\r
+    ListHead\r
 \r
-UINTN\r
-HStrStr (\r
-  CHAR16    *,\r
-  CHAR16    *\r
-  );\r
+  @param[in] ListHead     The list head.\r
+  @param[in] Lines        The lines.\r
 \r
+  @retval EFI_SUCCESS     The operation was successful.\r
+**/\r
 EFI_STATUS\r
 HFreeLines (\r
-  LIST_ENTRY   *,\r
-  HEFI_EDITOR_LINE *\r
+  IN LIST_ENTRY   *ListHead,\r
+  IN HEFI_EDITOR_LINE *Lines\r
   );\r
 \r
+/**\r
+  Get the X information for the mouse.\r
+\r
+  @param[in] GuidX      The change.\r
+\r
+  @return the new information.\r
+**/\r
 INT32\r
 HGetTextX (\r
-  INT32\r
-  ) ;\r
+  IN INT32 GuidX\r
+  );\r
+\r
+/**\r
+  Get the Y information for the mouse.\r
+\r
+  @param[in] GuidY      The change.\r
+\r
+  @return the new information.\r
+**/\r
 INT32\r
 HGetTextY (\r
-  INT32\r
-  ) ;\r
-\r
-EFI_STATUS\r
-HXtoi (\r
-  CHAR16    *,\r
-  UINTN     *\r
+  IN INT32 GuidY\r
   );\r
 \r
 #endif\r