sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor grammatical work--mostly adding periods. Items with ONLY period added did not have the heading date changed, but Items with content changes had heading copyright dates updated. Sending separately a list of files missing Doxygen @param and @return information. (PENDING)

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10615 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
myronporter
2010-06-30 00:13:25 +00:00
parent 3b33c6d65d
commit 58380e9c61
62 changed files with 1190 additions and 979 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
MdePkg/Library/UefiLib/Console.c
View File

@@ -248,13 +248,13 @@ GetGlyphWidth (
/**
Computes the display length of a Null-terminated Unicode String.
This function computes and returns the display length of the Null-terminated Unicode
string specified by String. If String is NULL then 0 is returned. If any of the widths
of the Unicode characters in String can not be determined, then 0 is returned. The display
width of String can be computed by summing the display widths of each Unicode character
in String. Unicode characters that are narrow glyphs have a width of 1, and Unicode
characters that are width glyphs have a width of 2.
If String is not aligned on a 16-bit boundary, then ASSERT().
This function computes and returns the display length of the Null-terminated
Unicode string specified by String. If String is NULL then 0 is returned. If
any of the widths of the Unicode characters in String can not be determined,
then 0 is returned. The display width of String can be computed by summing the
display widths of each Unicode character in String. Unicode characters that
are narrow glyphs have a width of 1, and Unicode characters that are width glyphs
have a width of 2. If String is not aligned on a 16-bit boundary, then ASSERT().
@param String A pointer to a Null-terminated Unicode string.

8
MdePkg/Library/UefiLib/UefiDriverModel.c
View File

@@ -33,7 +33,7 @@
@param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this
parameter is NULL, then a new handle is created.
@retval EFI_SUCCESS The protocol installation is completed successfully.
@retval EFI_SUCCESS The protocol installation successfully completed.
@retval EFI_OUT_OF_RESOURCES There was not enough system resources to install the protocol.
@retval Others Status from gBS->InstallMultipleProtocolInterfaces().
@@ -93,7 +93,7 @@ EfiLibInstallDriverBinding (
@param DriverConfiguration A Driver Configuration Protocol instance that this driver is producing.
@param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.
@retval EFI_SUCCESS The protocol installation is completed successfully.
@retval EFI_SUCCESS The protocol installation successfully completed.
@retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
**/
@@ -222,7 +222,7 @@ EfiLibInstallAllDriverProtocols (
@param ComponentName A Component Name Protocol instance that this driver is producing.
@param ComponentName2 A Component Name 2 Protocol instance that this driver is producing.
@retval EFI_SUCCESS The protocol installation is completed successfully.
@retval EFI_SUCCESS The protocol installation successfully completed.
@retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
**/
@@ -315,7 +315,7 @@ EfiLibInstallDriverBindingComponentName2 (
@param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.
@param DriverDiagnostics2 A Driver Diagnostics Protocol 2 instance that this driver is producing.
@retval EFI_SUCCESS The protocol installation is completed successfully.
@retval EFI_SUCCESS The protocol installation successfully completed.
@retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
**/

10
MdePkg/Library/UefiLib/UefiLib.c
View File

@@ -5,7 +5,7 @@
EFI Driver Model related protocols, manage Unicode string tables for UEFI Drivers,
and print messages on the console output and standard error devices.
Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -55,7 +55,7 @@ CompareIso639LanguageCode (
If TableGuid is NULL, then ASSERT().
If Table is NULL, then ASSERT().
@param TableGuid The pointer to table's GUID type..
@param TableGuid The pointer to table's GUID type.
@param Table The pointer to the table associated with TableGuid in the EFI System Table.
@retval EFI_SUCCESS A configuration table matching TableGuid was found.
@@ -175,7 +175,7 @@ EfiCreateProtocolNotifyEvent(
If NotifyTpl is not a legal TPL value, then ASSERT().
If NotifyFunction is NULL, then ASSERT().
@param Name Supplies GUID name of the event.
@param Name Supplies the GUID name of the event.
@param NotifyTpl Supplies the task priority level of the event notifications.
@param NotifyFunction Supplies the function to notify when the event is signaled.
@param NotifyContext The context parameter to pass to NotifyFunction.
@@ -246,7 +246,7 @@ EfiNamedEventListen (
created with EfiNamedEventListen().
If Name is NULL, then ASSERT().
@param Name Supplies GUID name of the event.
@param Name Supplies the GUID name of the event.
@retval EFI_SUCCESS A named event was signaled.
@retval EFI_OUT_OF_RESOURCES There are not enough resource to signal the named event.
@@ -320,7 +320,7 @@ EfiGetCurrentTpl (
If Priority is not a valid TPL value, then ASSERT().
@param Lock A pointer to the lock data structure to initialize.
@param Priority EFI TPL associated with the lock.
@param Priority EFI TPL is associated with the lock.
@return The lock.

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

@@ -45,12 +45,12 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_GRAPHICS_OUTPUT_BLT_PIXEL mEfiColors[16] = {
If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT().
@param Format Null-terminated Unicode format string.
@param Format A Null-terminated Unicode format string.
@param Console The output console.
@param Marker VA_LIST marker for the variable argument list.
@param Marker A VA_LIST marker for the variable argument list.
@return The number of Unicode characters in the produced
output buffer not including the Null-terminator.
output buffer, not including the Null-terminator.
**/
UINTN
InternalPrint (
@@ -103,8 +103,8 @@ InternalPrint (
If Format is not aligned on a 16-bit boundary, then ASSERT().
If gST->ConOut is NULL, then ASSERT().
@param Format Null-terminated Unicode format string.
@param ... Variable argument list whose contents are accessed based
@param Format A Null-terminated Unicode format string.
@param ... A Variable argument list whose contents are accessed based
on the format string specified by Format.
@return The number of Unicode characters printed to ConOut.
@@ -142,7 +142,7 @@ Print (
If Format is not aligned on a 16-bit boundary, then ASSERT().
If gST->StdErr is NULL, then ASSERT().
@param Format Null-terminated Unicode format string.
@param Format A Null-terminated Unicode format string.
@param ... Variable argument list whose contents are accessed based
on the format string specified by Format.
@@ -180,7 +180,7 @@ ErrorPrint (
If Format is NULL, then ASSERT().
@param Format Null-terminated ASCII format string.
@param Format A Null-terminated ASCII format string.
@param Console The output console.
@param Marker VA_LIST marker for the variable argument list.
@@ -237,7 +237,7 @@ AsciiInternalPrint (
If Format is NULL, then ASSERT().
If gST->ConOut is NULL, then ASSERT().
@param Format Null-terminated ASCII format string.
@param Format A Null-terminated ASCII format string.
@param ... Variable argument list whose contents are accessed based
on the format string specified by Format.
@@ -276,7 +276,7 @@ AsciiPrint (
If Format is NULL, then ASSERT().
If gST->StdErr is NULL, then ASSERT().
@param Format Null-terminated ASCII format string.
@param Format A Null-terminated ASCII format string.
@param ... Variable argument list whose contents are accessed based
on the format string specified by Format.
@@ -320,8 +320,8 @@ AsciiErrorPrint (
If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no
string is printed, and 0 is returned.
@param PointX X coordinate to print the string.
@param PointY Y coordinate to print the string.
@param PointX An X coordinate to print the string.
@param PointY A Y coordinate to print the string.
@param Foreground The foreground color of the string being printed. This is
an optional parameter that may be NULL. If it is NULL,
then the foreground color of the current ConOut device
@@ -330,7 +330,7 @@ AsciiErrorPrint (
an optional parameter that may be NULL. If it is NULL,
then the background color of the current ConOut device
in the EFI_SYSTEM_TABLE is used.
@param Buffer Null-terminated Unicode formatted string.
@param Buffer A Null-terminated Unicode formatted string.
@param PrintNum The number of Unicode formatted string to be printed.
@return The number of Unicode Characters printed. Zero means no any character
@@ -576,8 +576,8 @@ Error:
If Format is not aligned on a 16-bit boundary, then ASSERT().
If gST->ConsoleOutputHandle is NULL, then ASSERT().
@param PointX X coordinate to print the string.
@param PointY Y coordinate to print the string.
@param PointX An X coordinate to print the string.
@param PointY A Y coordinate to print the string.
@param ForeGround The foreground color of the string being printed. This is
an optional parameter that may be NULL. If it is NULL,
then the foreground color of the current ConOut device
@@ -586,9 +586,9 @@ Error:
an optional parameter that may be NULL. If it is NULL,
then the background color of the current ConOut device
in the EFI_SYSTEM_TABLE is used.
@param Format Null-terminated Unicode format string. See Print Library
@param Format A Null-terminated Unicode format string. See Print Library
for the supported format string syntax.
@param ... Variable argument list whose contents are accessed based on
@param ... A Variable argument list whose contents are accessed based on
the format string specified by Format.
@return The number of Unicode characters printed.
@@ -653,8 +653,8 @@ PrintXY (
If Format is NULL, then ASSERT().
If gST->ConsoleOutputHandle is NULL, then ASSERT().
@param PointX X coordinate to print the string.
@param PointY Y coordinate to print the string.
@param PointX An X coordinate to print the string.
@param PointY A Y coordinate to print the string.
@param ForeGround The foreground color of the string being printed. This is
an optional parameter that may be NULL. If it is NULL,
then the foreground color of the current ConOut device
@@ -663,7 +663,7 @@ PrintXY (
an optional parameter that may be NULL. If it is NULL,
then the background color of the current ConOut device
in the EFI_SYSTEM_TABLE is used.
@param Format Null-terminated ASCII format string. See Print Library
@param Format A Null-terminated ASCII format string. See Print Library
for the supported format string syntax.
@param ... Variable argument list whose contents are accessed based on
the format string specified by Format.

2
MdePkg/Library/UefiLib/UefiNotTiano.c
View File

@@ -138,7 +138,7 @@ EfiCreateEventLegacyBootEx (
change with the version of the specification supported.
If ReadyToBootEvent is NULL, then ASSERT().
@param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
@param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
@retval EFI_SUCCESS Event was created.
@retval Other Event was not created.