MdeModulePkg/EbcDxe: Add comments for functions

[mirror_edk2.git] / MdeModulePkg / Universal / EbcDxe / EbcDebugger / EdbSupportUI.c

diff --git a/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbSupportUI.c b/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbSupportUI.c
index 21d0dc983802487d2794762381309ed60066c47f..14f8627eb57067d64bfe3512381611222d4a6f6a 100644 (file)
--- a/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbSupportUI.c
+++ b/MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbSupportUI.c
@@ -14,6 +14,19 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include "Edb.h"\r
 \r
+/**\r
+  Set the current coordinates of the cursor position.\r
+\r
+  @param  ConOut        Point to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.\r
+  @param  Column        The position to set the cursor to.\r
+  @param  Row           The position to set the cursor to.\r
+  @param  LineLength    Length of a line.\r
+  @param  TotalRow      Total row of a screen.\r
+  @param  Str           Point to the string.\r
+  @param  StrPos        The position of the string.\r
+  @param  Len           The length of the string.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 SetCursorPosition (\r
@@ -166,6 +179,15 @@ ConMoveCursorForward (
 CHAR16 mBackupSpace[EFI_DEBUG_INPUS_BUFFER_SIZE];\r
 CHAR16 mInputBufferHistory[EFI_DEBUG_INPUS_BUFFER_SIZE];\r
 \r
+/**\r
+\r
+  Get user input.\r
+\r
+  @param  Prompt       The prompt string.\r
+  @param  InStr        Point to the input string.\r
+  @param  StrLength    The max length of string user can input.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 Input (\r
@@ -514,6 +536,19 @@ Input (
   return ;\r
 }\r
 \r
+/**\r
+  Set the current coordinates of the cursor position.\r
+\r
+  @param  ConOut        Point to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.\r
+  @param  Column        The position to set the cursor to.\r
+  @param  Row           The position to set the cursor to.\r
+  @param  LineLength    Length of a line.\r
+  @param  TotalRow      Total row of a screen.\r
+  @param  Str           Point to the string.\r
+  @param  StrPos        The position of the string.\r
+  @param  Len           The length of the string.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 SetCursorPosition (\r
@@ -551,6 +586,11 @@ SetCursorPosition (
   ConOut->SetCursorPosition (ConOut, 0, 0);\r
 }\r
 \r
+/**\r
+\r
+  SetPageBreak.\r
+\r
+**/\r
 BOOLEAN\r
 EFIAPI\r
 SetPageBreak (\r
@@ -620,6 +660,14 @@ SetPageBreak (
   return OmitPrint;\r
 }\r
 \r
+/**\r
+  Print a Unicode string to the output device.\r
+\r
+  @param  Format    A Null-terminated Unicode format string.\r
+  @param  ...       The variable argument list that contains pointers to Null-\r
+                    terminated Unicode strings to be printed\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 EDBPrint (\r
@@ -645,6 +693,17 @@ EDBPrint (
   return Return;\r
 }\r
 \r
+/**\r
+  Print a Unicode string to the output buffer.\r
+\r
+  @param  Buffer          A pointer to the output buffer for the produced Null-terminated\r
+                          Unicode string.\r
+  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+  @param  Format          A Null-terminated Unicode format string.\r
+  @param  ...             The variable argument list that contains pointers to Null-\r
+                          terminated Unicode strings to be printed\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 EDBSPrint (\r
@@ -666,6 +725,18 @@ EDBSPrint (
   return Return;\r
 }\r
 \r
+/**\r
+  Print a Unicode string to the output buffer with specified offset..\r
+\r
+  @param  Buffer          A pointer to the output buffer for the produced Null-terminated\r
+                          Unicode string.\r
+  @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
+  @param  Offset          The offset of the buffer.\r
+  @param  Format          A Null-terminated Unicode format string.\r
+  @param  ...             The variable argument list that contains pointers to Null-\r
+                          terminated Unicode strings to be printed\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 EDBSPrintWithOffset (\r