tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-25 22:54:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6623 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
qwang12 2008-11-19 03:29:46 +00:00
parent dae6a1d3b2
commit 285010e7dc
12 changed files with 52 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
MdePkg/Include/Library/BaseLib.h
View File

@ -3691,7 +3691,10 @@ CpuPause (
function. function.
@param NewStack A pointer to the new stack to use for the EntryPoint @param NewStack A pointer to the new stack to use for the EntryPoint
function. 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.
**/ **/

3
MdePkg/Include/Library/DebugLib.h
View File

@ -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 ErrorLevel The error level of the debug message.
@param Format Format string for the debug message to print. @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 VOID

3
MdePkg/Include/Library/GraphicsLib.h
View File

@ -156,7 +156,8 @@ LockKeyboards (
@param[in] ForeGround Foreground color @param[in] ForeGround Foreground color
@param[in] BackGround background color @param[in] BackGround background color
@param[in] Fmt Print format sting. See definition of Print @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. @return Number of Characters printed.

12
MdePkg/Include/Library/PrintLib.h
View File

@ -111,7 +111,8 @@ UnicodeVSPrint (
Unicode string. Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated Unicode format string. @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 @return The number of Unicode characters in the produced output buffer not including the
Null-terminator. Null-terminator.
@ -195,7 +196,8 @@ UnicodeVSPrintAsciiFormat (
Unicode string. Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated ASCII format string. @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 @return The number of Unicode characters in the produced output buffer not including the
Null-terminator. Null-terminator.
@ -327,7 +329,8 @@ AsciiVSPrint (
ASCII string. ASCII string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated ASCII format string. @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 @return The number of ASCII characters in the produced output buffer not including the
Null-terminator. Null-terminator.
@ -411,7 +414,8 @@ AsciiVSPrintUnicodeFormat (
ASCII string. ASCII string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated Unicode format string. @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 @return The number of ASCII characters in the produced output buffer not including the
Null-terminator. Null-terminator.

12
MdePkg/Include/Library/UefiLib.h
View File

@ -822,7 +822,8 @@ EfiGetNameGuidFromFwVolDevicePathNode (
PcdUefiLibMaxPrintBufferSize characters are sent to ConOut. PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.
@param Format Null-terminated Unicode format string. @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 NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, 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. PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.
@param Format Null-terminated Unicode format string. @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 NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, 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. PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.
@param Format Null-terminated ASCII format string. @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 NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, 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. PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.
@param Format Null-terminated ASCII format string. @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 NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT(). If Format is not aligned on a 16-bit boundary, then ASSERT().

3
MdePkg/Library/BaseDebugLibNull/DebugLib.c
View File

@ -25,7 +25,8 @@
@param ErrorLevel The error level of the debug message. @param ErrorLevel The error level of the debug message.
@param Format Format string for the debug message to print. @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 VOID

3
MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c
View File

@ -39,7 +39,8 @@
@param ErrorLevel The error level of the debug message. @param ErrorLevel The error level of the debug message.
@param Format Format string for the debug message to print. @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 VOID

4
MdePkg/Library/BaseLib/SwitchStack.c
View File

@ -36,6 +36,10 @@
function. function.
@param NewStack A pointer to the new stack to use for the EntryPoint @param NewStack A pointer to the new stack to use for the EntryPoint
function. 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 VOID

12
MdePkg/Library/BasePrintLib/PrintLib.c
View File

@ -91,7 +91,8 @@ UnicodeVSPrint (
Unicode string. Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated Unicode format string. @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 @return The number of Unicode characters in the produced output buffer not including the
Null-terminator. Null-terminator.
@ -184,7 +185,8 @@ UnicodeVSPrintAsciiFormat (
Unicode string. Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated ASCII format string. @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 @return The number of Unicode characters in the produced output buffer not including the
Null-terminator. Null-terminator.
@ -329,7 +331,8 @@ AsciiVSPrint (
ASCII string. ASCII string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated ASCII format string. @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 @return The number of ASCII characters in the produced output buffer not including the
Null-terminator. Null-terminator.
@ -423,7 +426,8 @@ AsciiVSPrintUnicodeFormat (
ASCII string. ASCII string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer. @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param FormatString Null-terminated Unicode format string. @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 @return The number of ASCII characters in the produced output buffer not including the
Null-terminator. Null-terminator.

3
MdePkg/Library/UefiDebugLibConOut/DebugLib.c
View File

@ -42,7 +42,8 @@
@param ErrorLevel The error level of the debug message. @param ErrorLevel The error level of the debug message.
@param Format Format string for the debug message to print. @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 VOID

3
MdePkg/Library/UefiDebugLibStdErr/DebugLib.c
View File

@ -41,7 +41,8 @@
@param ErrorLevel The error level of the debug message. @param ErrorLevel The error level of the debug message.
@param Format Format string for the debug message to print. @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 VOID

12
MdePkg/Library/UefiLib/UefiLibPrint.c
View File

@ -81,7 +81,8 @@ InternalPrint (
If Format is not aligned on a 16-bit boundary, then ASSERT(). If Format is not aligned on a 16-bit boundary, then ASSERT().
@param Format Null-terminated Unicode format string. @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 @return The number of Unicode characters in the produced
output buffer not including the Null-terminator. output buffer not including the Null-terminator.
@ -119,7 +120,8 @@ Print (
If Format is not aligned on a 16-bit boundary, then ASSERT(). If Format is not aligned on a 16-bit boundary, then ASSERT().
@param Format Null-terminated Unicode format string. @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 @return The number of Unicode characters in the produced
output buffer not including the Null-terminator. output buffer not including the Null-terminator.
@ -211,7 +213,8 @@ AsciiInternalPrint (
If Format is NULL, then ASSERT(). If Format is NULL, then ASSERT().
@param Format Null-terminated ASCII format string. @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 @return The number of Ascii characters in the produced
output buffer not including the Null-terminator. output buffer not including the Null-terminator.
@ -249,7 +252,8 @@ AsciiPrint (
If Format is NULL, then ASSERT(). If Format is NULL, then ASSERT().
@param Format Null-terminated ASCII format string. @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 @return The number of Ascii characters in the produced output
buffer not including the Null-terminator. buffer not including the Null-terminator.