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

7 files changed, 28 insertions, 12 deletions

diff --git a/MdePkg/Library/BaseDebugLibNull/DebugLib.c b/MdePkg/Library/BaseDebugLibNull/DebugLib.c
index c9916165a0..6fdf6f97a5 100644
--- a/MdePkg/Library/BaseDebugLibNull/DebugLib.c
+++ b/MdePkg/Library/BaseDebugLibNull/DebugLib.c
@@ -25,7 +25,8 @@
 

   @param  ErrorLevel  The error level of the debug message.

   @param  Format      Format string for the debug message to print.

-  @param  ...         The variable argument list.

+  @param  ...         Variable argument list whose contents are accessed 

+                      based on the format string specified by Format.

 

 **/

 VOID

diff --git a/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c b/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c
index 39640119aa..4abdf9cd69 100644
--- a/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c
+++ b/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c
@@ -39,7 +39,8 @@
 

   @param  ErrorLevel  The error level of the debug message.

   @param  Format      Format string for the debug message to print.

-  @param  ...         The variable argument list.

+  @param  ...         Variable argument list whose contents are accessed 

+                      based on the format string specified by Format.

 

 **/

 VOID

diff --git a/MdePkg/Library/BaseLib/SwitchStack.c b/MdePkg/Library/BaseLib/SwitchStack.c
index 4454856607..a6e33aec6e 100644
--- a/MdePkg/Library/BaseLib/SwitchStack.c
+++ b/MdePkg/Library/BaseLib/SwitchStack.c
@@ -36,6 +36,10 @@
                       function.

   @param  NewStack    A pointer to the new stack to use for the EntryPoint

                       function.

+  @param  ...         This variable argument list is ignored for IA32, x64, and EBC.  

+                      For IPF, this variable argument list is expected to contain 

+                      a single parameter of type VOID * that specifies the new backing 

+                      store pointer.

 

 **/

 VOID

diff --git a/MdePkg/Library/BasePrintLib/PrintLib.c b/MdePkg/Library/BasePrintLib/PrintLib.c
index 8fe7c06adf..92deb5f5db 100644
--- a/MdePkg/Library/BasePrintLib/PrintLib.c
+++ b/MdePkg/Library/BasePrintLib/PrintLib.c
@@ -91,7 +91,8 @@ UnicodeVSPrint (
                           Unicode string.

   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

   @param  FormatString    Null-terminated Unicode format string.

-  @param  ...             The variable argument list.

+  @param  ...             Variable argument list whose contents are accessed based on the 

+                          format string specified by FormatString.

   @return The number of Unicode characters in the produced output buffer not including the

           Null-terminator.

 

@@ -184,7 +185,8 @@ UnicodeVSPrintAsciiFormat (
                           Unicode string.

   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

   @param  FormatString    Null-terminated ASCII format string.

-  @param  ...             The variable argument list.

+  @param  ...             Variable argument list whose contents are accessed based on the 

+                          format string specified by FormatString.

   

   @return The number of Unicode characters in the produced output buffer not including the

           Null-terminator.

@@ -329,7 +331,8 @@ AsciiVSPrint (
                           ASCII string.

   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

   @param  FormatString    Null-terminated ASCII format string.

-  @param  ...             The variable argument list.

+  @param  ...             Variable argument list whose contents are accessed based on the 

+                          format string specified by FormatString.

   

   @return The number of ASCII characters in the produced output buffer not including the

           Null-terminator.

@@ -423,7 +426,8 @@ AsciiVSPrintUnicodeFormat (
                           ASCII string.

   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.

   @param  FormatString    Null-terminated Unicode format string.

-  @param  ...             The variable argument list.

+  @param  ...             Variable argument list whose contents are accessed based on the 

+                          format string specified by FormatString.

   

   @return The number of ASCII characters in the produced output buffer not including the

           Null-terminator.

diff --git a/MdePkg/Library/UefiDebugLibConOut/DebugLib.c b/MdePkg/Library/UefiDebugLibConOut/DebugLib.c
index 16a8faa684..7f93509b2d 100644
--- a/MdePkg/Library/UefiDebugLibConOut/DebugLib.c
+++ b/MdePkg/Library/UefiDebugLibConOut/DebugLib.c
@@ -42,7 +42,8 @@
 

   @param  ErrorLevel  The error level of the debug message.

   @param  Format      Format string for the debug message to print.

-  @param  ...         The variable argument list.

+  @param  ...         Variable argument list whose contents are accessed 

+                      based on the format string specified by Format.

 

 **/

 VOID

diff --git a/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c b/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c
index 82fd78ab4f..608ed26929 100644
--- a/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c
+++ b/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c
@@ -41,7 +41,8 @@
 

   @param  ErrorLevel  The error level of the debug message.

   @param  Format      Format string for the debug message to print.

-  @param  ...         The variable argument list.

+  @param  ...         Variable argument list whose contents are accessed 

+                      based on the format string specified by Format.

 

 **/

 VOID

diff --git a/MdePkg/Library/UefiLib/UefiLibPrint.c b/MdePkg/Library/UefiLib/UefiLibPrint.c
index 312c22673e..630d1b3123 100644
--- 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().

 

   @param Format   Null-terminated Unicode format string.

-  @param ...      VARARG list consumed to process Format.

+  @param ...      Variable argument list whose contents are accessed based 

+                  on the format string specified by Format.

   

   @return The number of Unicode characters in the produced

           output buffer not including the Null-terminator.

@@ -119,7 +120,8 @@ Print (
   If Format is not aligned on a 16-bit boundary, then ASSERT().

 

   @param Format   Null-terminated Unicode format string.

-  @param ...      VARARG list consumed to process Format.

+  @param ...      Variable argument list whose contents are accessed based 

+                  on the format string specified by Format.

 

   @return The number of Unicode characters in the produced

           output buffer not including the Null-terminator.

@@ -211,7 +213,8 @@ AsciiInternalPrint (
   If Format is NULL, then ASSERT().

 

   @param Format   Null-terminated ASCII format string.

-  @param ...      VARARG list consumed to process Format.

+  @param ...      Variable argument list whose contents are accessed based 

+                  on the format string specified by Format.

   

   @return The number of Ascii characters in the produced

           output buffer not including the Null-terminator.

@@ -249,7 +252,8 @@ AsciiPrint (
   If Format is NULL, then ASSERT().

 

   @param Format   Null-terminated ASCII format string.

-  @param ...      VARARG list consumed to process Format.

+  @param ...      Variable argument list whose contents are accessed based 

+                  on the format string specified by Format.

   

   @return The number of Ascii characters in the produced output

           buffer not including the Null-terminator.