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

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

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/Clipboard.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/Clipboard.h
index 9165d98f3060efa8a8962baa0ba3fcee0829033c..8066c292479cc79098811e690791d9dc4aec2384 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/Clipboard.h
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/Clipboard.h
@@ -18,23 +18,52 @@
 \r
 #include "HexEditor.h"\r
 \r
+/**\r
+  Initialization function for HDiskImage\r
+\r
+  @param[in] EFI_SUCCESS      The operation was successful.\r
+  @param[in] EFI_LOAD_ERROR   A load error occured.\r
+**/\r
 EFI_STATUS\r
 HClipBoardInit (\r
   VOID\r
   );\r
+\r
+/**\r
+  Initialization function for HDiskImage.\r
+\r
+  @param[in] EFI_SUCCESS      The operation was successful.\r
+  @param[in] EFI_LOAD_ERROR   A load error occured.\r
+**/\r
 EFI_STATUS\r
 HClipBoardCleanup (\r
   VOID\r
   );\r
 \r
+/**\r
+  Set a buffer into the clipboard.\r
+\r
+  @param[in] Buffer   The buffer to add to the clipboard.\r
+  @param[in] Size     The size of Buffer in bytes.\r
+\r
+  @retval EFI_SUCCESS   The operation was successful.\r
+**/\r
 EFI_STATUS\r
 HClipBoardSet (\r
-  UINT8   *,\r
-  UINTN\r
+  IN UINT8 *Buffer,\r
+  IN UINTN Size\r
   );\r
+\r
+/**\r
+  Get a buffer from the clipboard.\r
+\r
+  @param[out] Buffer   The pointer to the buffer to add to the clipboard.\r
+\r
+  @return the size of the buffer.\r
+**/\r
 UINTN\r
 HClipBoardGet (\r
-  UINT8 **\r
+  OUT UINT8  **Buffer\r
   );\r
 \r
 #endif\r