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

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11505 6f19259b-4bc3-4df7-8a09-765794883524

ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/Misc.h

@@ -17,80 +17,77 @@
 
 #include "HexEditor.h"
 
-VOID
-HEditorClearLine (
-  UINTN
-  );
-HEFI_EDITOR_LINE  *
-HLineDup (
-  HEFI_EDITOR_LINE *
-  );
-VOID
-HLineFree (
-  HEFI_EDITOR_LINE *
-  );
+/**
+  Advance/Retreat lines.
 
-HEFI_EDITOR_LINE  *
+  @param[in] Count      The line number to advance/retreat.
+                            >0 : advance
+                            <0: retreat  
+
+  @retval NULL An error occured.
+  @return A pointer to the line after move.
+**/
+HEFI_EDITOR_LINE *
 HMoveLine (
-  INTN
+  IN  INTN Count
   );
-HEFI_EDITOR_LINE  *
+
+/**
+  Advance/Retreat lines and set CurrentLine in BufferImage to it.
+
+  @param[in] Count    The line number to advance/retreat.
+                          >0 : advance
+                          <0: retreat
+
+  @retval NULL An error occured.
+  @return A pointer to the line after move.
+**/
+HEFI_EDITOR_LINE *
 HMoveCurrentLine (
-  INTN
+  IN  INTN Count
   );
 
-UINTN
-HLineStrInsert (
-  HEFI_EDITOR_LINE  *,
-  CHAR16,
-  UINTN,
-  UINTN
-  );
+/**
+  Free all the lines in HBufferImage.
+    Fields affected:
+    Lines
+    CurrentLine
+    NumLines
+    ListHead 
 
-VOID
-HLineCat (
-  HEFI_EDITOR_LINE *,
-  HEFI_EDITOR_LINE *
-  );
-
-VOID
-HLineDeleteAt (
-  HEFI_EDITOR_LINE  *,
-  UINTN
-  );
-
-UINTN
-HUnicodeToAscii (
-  CHAR16    *,
-  UINTN,
-  CHAR8     *
-  );
-
-UINTN
-HStrStr (
-  CHAR16    *,
-  CHAR16    *
-  );
+  @param[in] ListHead     The list head.
+  @param[in] Lines        The lines.
 
+  @retval EFI_SUCCESS     The operation was successful.
+**/
 EFI_STATUS
 HFreeLines (
-  LIST_ENTRY   *,
-  HEFI_EDITOR_LINE *
+  IN LIST_ENTRY   *ListHead,
+  IN HEFI_EDITOR_LINE *Lines
   );
 
+/**
+  Get the X information for the mouse.
+
+  @param[in] GuidX      The change.
+
+  @return the new information.
+**/
 INT32
 HGetTextX (
-  INT32
-  ) ;
+  IN INT32 GuidX
+  );
+
+/**
+  Get the Y information for the mouse.
+
+  @param[in] GuidY      The change.
+
+  @return the new information.
+**/
 INT32
 HGetTextY (
-  INT32
-  ) ;
-
-EFI_STATUS
-HXtoi (
-  CHAR16    *,
-  UINTN     *
+  IN INT32 GuidY
   );
 
 #endif