Update doxygen comment for VarArg list parameter. "..."'s description is added.

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

diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h
index 8f490e6d86a78ca30fa1037bc96e612f1c427bfa..45e5bb2228aca1d18aae0a056e76da0dc6caa63d 100644 (file)
--- a/MdePkg/Include/Library/BaseLib.h
+++ b/MdePkg/Include/Library/BaseLib.h
@@ -3691,7 +3691,10 @@ CpuPause (
                       function.\r
   @param  NewStack    A pointer to the new stack to use for the EntryPoint\r
                       function.\r
-  @param  ...         Extended parameters.\r
+  @param  ...         This variable argument list is ignored for IA32, x64, and EBC.  \r
+                      For IPF, this variable argument list is expected to contain \r
+                      a single parameter of type VOID * that specifies the new backing \r
+                      store pointer.\r
 \r
 \r
 **/\r

diff --git a/MdePkg/Include/Library/DebugLib.h b/MdePkg/Include/Library/DebugLib.h
index b489bf3034472865e169885faeea510982aea5cf..7465abb24d6edca91061913f30dbf9e224470956 100644 (file)
--- a/MdePkg/Include/Library/DebugLib.h
+++ b/MdePkg/Include/Library/DebugLib.h
@@ -77,7 +77,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   @param  ErrorLevel  The error level of the debug message.\r
   @param  Format      Format string for the debug message to print.\r
-  @param  ...         The variable argument list.\r
+  @param  ...         Variable argument list whose contents are accessed \r
+                      based on the format string specified by Format.\r
 \r
 **/\r
 VOID\r

diff --git a/MdePkg/Include/Library/GraphicsLib.h b/MdePkg/Include/Library/GraphicsLib.h
index 50cb42137081478a45221e1155dee8da64804766..2009febdaf73c8c0ec67cec16bc115e7bb5fd65f 100644 (file)
--- a/MdePkg/Include/Library/GraphicsLib.h
+++ b/MdePkg/Include/Library/GraphicsLib.h
@@ -156,7 +156,8 @@ LockKeyboards (
   @param[in]  ForeGround   Foreground color\r
   @param[in]  BackGround   background color\r
   @param[in]  Fmt          Print format sting. See definition of Print\r
-  @param[in]  ...          Argumnet stream defined by Fmt string\r
+  @param ...               Variable argument list whose contents are accessed based on \r
+                           the format string specified by Format.\r
 \r
   @return  Number of Characters printed.\r
 \r

diff --git a/MdePkg/Include/Library/PrintLib.h b/MdePkg/Include/Library/PrintLib.h
index b7c114e0cc40a684747d2eb4a9a9e1bb9eaede6d..e47dbae5e0f035f25ee4d7f00c30c2ac1c50075d 100644 (file)
--- a/MdePkg/Include/Library/PrintLib.h
+++ b/MdePkg/Include/Library/PrintLib.h
@@ -111,7 +111,8 @@ UnicodeVSPrint (
                           Unicode string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
   @param  FormatString    Null-terminated Unicode format string.\r
-  @param  ...             The variable argument list.\r
+  @param  ...             Variable argument list whose contents are accessed based on the \r
+                          format string specified by FormatString.\r
   \r
   @return The number of Unicode characters in the produced output buffer not including the\r
           Null-terminator.\r
@@ -195,7 +196,8 @@ UnicodeVSPrintAsciiFormat (
                           Unicode string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
   @param  FormatString    Null-terminated ASCII format string.\r
-  @param  ...             The variable argument list.\r
+  @param  ...             Variable argument list whose contents are accessed based on the \r
+                          format string specified by FormatString.\r
   \r
   @return The number of Unicode characters in the produced output buffer not including the\r
           Null-terminator.\r
@@ -327,7 +329,8 @@ AsciiVSPrint (
                           ASCII string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
   @param  FormatString    Null-terminated ASCII format string.\r
-  @param  ...             The variable argument list. \r
+  @param  ...             Variable argument list whose contents are accessed based on the \r
+                          format string specified by FormatString.\r
    \r
   @return The number of ASCII characters in the produced output buffer not including the\r
           Null-terminator.\r
@@ -411,7 +414,8 @@ AsciiVSPrintUnicodeFormat (
                           ASCII string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
   @param  FormatString    Null-terminated Unicode format string.\r
-  @param  ...             The variable argument list.\r
+  @param  ...             Variable argument list whose contents are accessed based on the \r
+                          format string specified by FormatString.\r
   \r
   @return The number of ASCII characters in the produced output buffer not including the\r
           Null-terminator.\r

diff --git a/MdePkg/Include/Library/UefiLib.h b/MdePkg/Include/Library/UefiLib.h
index 8c5b628aa94ea04bb6bcb444e1a49310d9140cd6..c9da13316cc31a4fdd0ad4e520b2055287c3ca83 100644 (file)
--- a/MdePkg/Include/Library/UefiLib.h
+++ b/MdePkg/Include/Library/UefiLib.h
@@ -822,7 +822,8 @@ EfiGetNameGuidFromFwVolDevicePathNode (
   PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.\r
 \r
   @param Format   Null-terminated Unicode format string.\r
-  @param ...      VARARG list consumed to process Format.\r
+  @param ...      Variable argument list whose contents are accessed based \r
+                  on the format string specified by Format.\r
   If Format is NULL, then ASSERT().\r
   If Format is not aligned on a 16-bit boundary, then ASSERT().\r
   \r
@@ -847,7 +848,8 @@ Print (
   PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.\r
 \r
   @param Format   Null-terminated Unicode format string.\r
-  @param ...      VARARG list consumed to process Format.\r
+  @param ...      Variable argument list whose contents are accessed based \r
+                  on the format string specified by Format.\r
   If Format is NULL, then ASSERT().\r
   If Format is not aligned on a 16-bit boundary, then ASSERT().\r
   \r
@@ -872,7 +874,8 @@ ErrorPrint (
   PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.\r
 \r
   @param Format   Null-terminated ASCII format string.\r
-  @param ...      VARARG list consumed to process Format.\r
+  @param ...      Variable argument list whose contents are accessed based \r
+                  on the format string specified by Format.\r
   If Format is NULL, then ASSERT().\r
   If Format is not aligned on a 16-bit boundary, then ASSERT().\r
   \r
@@ -897,7 +900,8 @@ AsciiPrint (
   PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.\r
 \r
   @param Format   Null-terminated ASCII format string.\r
-  @param ...      VARARG list consumed to process Format.\r
+  @param ...      Variable argument list whose contents are accessed based \r
+                  on the format string specified by Format.\r
   If Format is NULL, then ASSERT().\r
   If Format is not aligned on a 16-bit boundary, then ASSERT().\r
   \r

diff --git a/MdePkg/Library/BaseDebugLibNull/DebugLib.c b/MdePkg/Library/BaseDebugLibNull/DebugLib.c
index c9916165a04c3c196337897ff8ccf9237a60f5e7..6fdf6f97a5b618587d58305d674cd4918523826e 100644 (file)
--- a/MdePkg/Library/BaseDebugLibNull/DebugLib.c
+++ b/MdePkg/Library/BaseDebugLibNull/DebugLib.c
@@ -25,7 +25,8 @@
 \r
   @param  ErrorLevel  The error level of the debug message.\r
   @param  Format      Format string for the debug message to print.\r
-  @param  ...         The variable argument list.\r
+  @param  ...         Variable argument list whose contents are accessed \r
+                      based on the format string specified by Format.\r
 \r
 **/\r
 VOID\r

diff --git a/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c b/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c
index 39640119aa59766b9d85a1123def34c54e7ea2d6..4abdf9cd699545580da4cf9cf4464e17221c9c3d 100644 (file)
--- a/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c
+++ b/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c
@@ -39,7 +39,8 @@
 \r
   @param  ErrorLevel  The error level of the debug message.\r
   @param  Format      Format string for the debug message to print.\r
-  @param  ...         The variable argument list.\r
+  @param  ...         Variable argument list whose contents are accessed \r
+                      based on the format string specified by Format.\r
 \r
 **/\r
 VOID\r

diff --git a/MdePkg/Library/BaseLib/SwitchStack.c b/MdePkg/Library/BaseLib/SwitchStack.c
index 445485660719a3ddb3c0c168bae90d8a321a4fca..a6e33aec6eb2362ee4b9382f3e14b0093881e0bf 100644 (file)
--- a/MdePkg/Library/BaseLib/SwitchStack.c
+++ b/MdePkg/Library/BaseLib/SwitchStack.c
@@ -36,6 +36,10 @@
                       function.\r
   @param  NewStack    A pointer to the new stack to use for the EntryPoint\r
                       function.\r
+  @param  ...         This variable argument list is ignored for IA32, x64, and EBC.  \r
+                      For IPF, this variable argument list is expected to contain \r
+                      a single parameter of type VOID * that specifies the new backing \r
+                      store pointer.\r
 \r
 **/\r
 VOID\r

diff --git a/MdePkg/Library/BasePrintLib/PrintLib.c b/MdePkg/Library/BasePrintLib/PrintLib.c
index 8fe7c06adfb13c90c48aa39c21c2f7e7cb84a5da..92deb5f5dbb8b9e7d8a6d77c7c4e73fd9cf987c1 100644 (file)
--- a/MdePkg/Library/BasePrintLib/PrintLib.c
+++ b/MdePkg/Library/BasePrintLib/PrintLib.c
@@ -91,7 +91,8 @@ UnicodeVSPrint (
                           Unicode string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
   @param  FormatString    Null-terminated Unicode format string.\r
-  @param  ...             The variable argument list.\r
+  @param  ...             Variable argument list whose contents are accessed based on the \r
+                          format string specified by FormatString.\r
   @return The number of Unicode characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r
@@ -184,7 +185,8 @@ UnicodeVSPrintAsciiFormat (
                           Unicode string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
   @param  FormatString    Null-terminated ASCII format string.\r
-  @param  ...             The variable argument list.\r
+  @param  ...             Variable argument list whose contents are accessed based on the \r
+                          format string specified by FormatString.\r
   \r
   @return The number of Unicode characters in the produced output buffer not including the\r
           Null-terminator.\r
@@ -329,7 +331,8 @@ AsciiVSPrint (
                           ASCII string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
   @param  FormatString    Null-terminated ASCII format string.\r
-  @param  ...             The variable argument list.\r
+  @param  ...             Variable argument list whose contents are accessed based on the \r
+                          format string specified by FormatString.\r
   \r
   @return The number of ASCII characters in the produced output buffer not including the\r
           Null-terminator.\r
@@ -423,7 +426,8 @@ AsciiVSPrintUnicodeFormat (
                           ASCII string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
   @param  FormatString    Null-terminated Unicode format string.\r
-  @param  ...             The variable argument list.\r
+  @param  ...             Variable argument list whose contents are accessed based on the \r
+                          format string specified by FormatString.\r
   \r
   @return The number of ASCII characters in the produced output buffer not including the\r
           Null-terminator.\r

diff --git a/MdePkg/Library/UefiDebugLibConOut/DebugLib.c b/MdePkg/Library/UefiDebugLibConOut/DebugLib.c
index 16a8faa684233b3bb35ee676363f37d687f7ff68..7f93509b2d4071e217f5c8b606cae07b7e696700 100644 (file)
--- a/MdePkg/Library/UefiDebugLibConOut/DebugLib.c
+++ b/MdePkg/Library/UefiDebugLibConOut/DebugLib.c
@@ -42,7 +42,8 @@
 \r
   @param  ErrorLevel  The error level of the debug message.\r
   @param  Format      Format string for the debug message to print.\r
-  @param  ...         The variable argument list.\r
+  @param  ...         Variable argument list whose contents are accessed \r
+                      based on the format string specified by Format.\r
 \r
 **/\r
 VOID\r

diff --git a/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c b/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c
index 82fd78ab4f56640d1ad658f647f417af3f02f87a..608ed2692971713769ac67efb7abfd1318156a35 100644 (file)
--- a/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c
+++ b/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c
@@ -41,7 +41,8 @@
 \r
   @param  ErrorLevel  The error level of the debug message.\r
   @param  Format      Format string for the debug message to print.\r
-  @param  ...         The variable argument list.\r
+  @param  ...         Variable argument list whose contents are accessed \r
+                      based on the format string specified by Format.\r
 \r
 **/\r
 VOID\r

diff --git a/MdePkg/Library/UefiLib/UefiLibPrint.c b/MdePkg/Library/UefiLib/UefiLibPrint.c
index 312c22673ec1bb9810b55303f2aa375016fa6c40..630d1b3123f0d3eebd086303aa5b5fc4498cfc36 100644 (file)
--- a/MdePkg/Library/UefiLib/UefiLibPrint.c
+++ b/MdePkg/Library/UefiLib/UefiLibPrint.c
@@ -81,7 +81,8 @@ InternalPrint (
   If Format is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param Format   Null-terminated Unicode format string.\r
-  @param ...      VARARG list consumed to process Format.\r
+  @param ...      Variable argument list whose contents are accessed based \r
+                  on the format string specified by Format.\r
   \r
   @return The number of Unicode characters in the produced\r
           output buffer not including the Null-terminator.\r
@@ -119,7 +120,8 @@ Print (
   If Format is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param Format   Null-terminated Unicode format string.\r
-  @param ...      VARARG list consumed to process Format.\r
+  @param ...      Variable argument list whose contents are accessed based \r
+                  on the format string specified by Format.\r
 \r
   @return The number of Unicode characters in the produced\r
           output buffer not including the Null-terminator.\r
@@ -211,7 +213,8 @@ AsciiInternalPrint (
   If Format is NULL, then ASSERT().\r
 \r
   @param Format   Null-terminated ASCII format string.\r
-  @param ...      VARARG list consumed to process Format.\r
+  @param ...      Variable argument list whose contents are accessed based \r
+                  on the format string specified by Format.\r
   \r
   @return The number of Ascii characters in the produced\r
           output buffer not including the Null-terminator.\r
@@ -249,7 +252,8 @@ AsciiPrint (
   If Format is NULL, then ASSERT().\r
 \r
   @param Format   Null-terminated ASCII format string.\r
-  @param ...      VARARG list consumed to process Format.\r
+  @param ...      Variable argument list whose contents are accessed based \r
+                  on the format string specified by Format.\r
   \r
   @return The number of Ascii characters in the produced output\r
           buffer not including the Null-terminator.\r