diff options
author | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-11-19 03:29:46 +0000 |
---|---|---|
committer | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-11-19 03:29:46 +0000 |
commit | 285010e7dc951798fcc1e77eda2027c72bedbacf (patch) | |
tree | 78d43a9485395416a4fb0dd28e8d8b133f3d62e0 /MdePkg/Include/Library | |
parent | dae6a1d3b288a888376d2efa737bcc45faf825f3 (diff) | |
download | edk2-platforms-285010e7dc951798fcc1e77eda2027c72bedbacf.tar.xz |
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
Diffstat (limited to 'MdePkg/Include/Library')
-rw-r--r-- | MdePkg/Include/Library/BaseLib.h | 5 | ||||
-rw-r--r-- | MdePkg/Include/Library/DebugLib.h | 3 | ||||
-rw-r--r-- | MdePkg/Include/Library/GraphicsLib.h | 3 | ||||
-rw-r--r-- | MdePkg/Include/Library/PrintLib.h | 12 | ||||
-rw-r--r-- | MdePkg/Include/Library/UefiLib.h | 12 |
5 files changed, 24 insertions, 11 deletions
diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h index 8f490e6d86..45e5bb2228 100644 --- a/MdePkg/Include/Library/BaseLib.h +++ b/MdePkg/Include/Library/BaseLib.h @@ -3691,7 +3691,10 @@ CpuPause ( function.
@param NewStack A pointer to the new stack to use for the EntryPoint
function.
- @param ... Extended parameters.
+ @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.
**/
diff --git a/MdePkg/Include/Library/DebugLib.h b/MdePkg/Include/Library/DebugLib.h index b489bf3034..7465abb24d 100644 --- 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. @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/Include/Library/GraphicsLib.h b/MdePkg/Include/Library/GraphicsLib.h index 50cb421370..2009febdaf 100644 --- a/MdePkg/Include/Library/GraphicsLib.h +++ b/MdePkg/Include/Library/GraphicsLib.h @@ -156,7 +156,8 @@ LockKeyboards ( @param[in] ForeGround Foreground color
@param[in] BackGround background color
@param[in] Fmt Print format sting. See definition of Print
- @param[in] ... Argumnet stream defined by Fmt string
+ @param ... Variable argument list whose contents are accessed based on
+ the format string specified by Format.
@return Number of Characters printed.
diff --git a/MdePkg/Include/Library/PrintLib.h b/MdePkg/Include/Library/PrintLib.h index b7c114e0cc..e47dbae5e0 100644 --- a/MdePkg/Include/Library/PrintLib.h +++ b/MdePkg/Include/Library/PrintLib.h @@ -111,7 +111,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.
@@ -195,7 +196,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.
@@ -327,7 +329,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.
@@ -411,7 +414,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/Include/Library/UefiLib.h b/MdePkg/Include/Library/UefiLib.h index 8c5b628aa9..c9da13316c 100644 --- a/MdePkg/Include/Library/UefiLib.h +++ b/MdePkg/Include/Library/UefiLib.h @@ -822,7 +822,8 @@ EfiGetNameGuidFromFwVolDevicePathNode ( PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.
@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.
If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT().
@@ -847,7 +848,8 @@ Print ( PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.
@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.
If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT().
@@ -872,7 +874,8 @@ ErrorPrint ( PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.
@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.
If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT().
@@ -897,7 +900,8 @@ AsciiPrint ( PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.
@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.
If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT().
|