Grammatical and disclaimer changes (does not follow internal C coding stds.)

[mirror_edk2.git] / MdePkg / Include / Library / UefiLib.h

diff --git a/MdePkg/Include/Library/UefiLib.h b/MdePkg/Include/Library/UefiLib.h
index 60ba7ff1e77ff0e6d5f89700feb1c9033dca3ce7..41cf1376f62ce6d7dd1e4a8eceb037d8be7ffbcf 100644 (file)
--- a/MdePkg/Include/Library/UefiLib.h
+++ b/MdePkg/Include/Library/UefiLib.h
@@ -12,11 +12,11 @@
   of size reduction when compiler optimization is disabled. If MDEPKG_NDEBUG is\r
   defined, then debug and assert related macros wrapped by it are the NULL implementations.\r
 \r
   of size reduction when compiler optimization is disabled. If MDEPKG_NDEBUG is\r
   defined, then debug and assert related macros wrapped by it are the NULL implementations.\r
 \r

-Copyright (c) 2006 - 2010, Intel Corporation<BR>\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution.  The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.\r

 \r
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r


@@ -64,9 +64,9 @@ typedef struct {
 \r
 /**\r
   Macro that returns the number of 100 ns units for a specified number of microseconds.\r
 \r
 /**\r
   Macro that returns the number of 100 ns units for a specified number of microseconds.\r

-  Useful for managing EFI timer events.\r
+  This is useful for managing EFI timer events.\r

 \r
 \r

-  @param  Microseconds           Number of microseconds.\r
+  @param  Microseconds           The number of microseconds.\r

 \r
   @return The number of 100 ns units equivalent to the number of microseconds specified\r
           by Microseconds.\r
 \r
   @return The number of 100 ns units equivalent to the number of microseconds specified\r
           by Microseconds.\r


@@ -76,9 +76,9 @@ typedef struct {
 \r
 /**\r
   Macro that returns the number of 100 ns units for a specified number of milliseconds.\r
 \r
 /**\r
   Macro that returns the number of 100 ns units for a specified number of milliseconds.\r

-  Useful for managing EFI timer events.\r
+  This is useful for managing EFI timer events.\r

 \r
 \r

-  @param  Milliseconds           Number of milliseconds.\r
+  @param  Milliseconds           The number of milliseconds.\r

 \r
   @return The number of 100 ns units equivalent to the number of milliseconds specified\r
           by Milliseconds.\r
 \r
   @return The number of 100 ns units equivalent to the number of milliseconds specified\r
           by Milliseconds.\r


@@ -88,9 +88,9 @@ typedef struct {
 \r
 /**\r
   Macro that returns the number of 100 ns units for a specified number of seconds.\r
 \r
 /**\r
   Macro that returns the number of 100 ns units for a specified number of seconds.\r

-  Useful for managing EFI timer events.\r
+  This is useful for managing EFI timer events.\r

 \r
 \r

-  @param  Seconds                Number of seconds.\r
+  @param  Seconds                The number of seconds.\r

 \r
   @return The number of 100 ns units equivalent to the number of seconds specified\r
           by Seconds.\r
 \r
   @return The number of 100 ns units equivalent to the number of seconds specified\r
           by Seconds.\r


@@ -123,8 +123,8 @@ typedef struct {
   If TableGuid is NULL, then ASSERT().\r
   If Table is NULL, then ASSERT().\r
 \r
   If TableGuid is NULL, then ASSERT().\r
   If Table is NULL, then ASSERT().\r
 \r

-  @param  TableGuid       Pointer to table's GUID type..\r
-  @param  Table           Pointer to the table associated with TableGuid in the EFI System Table.\r
+  @param  TableGuid       The pointer to table's GUID type..\r
+  @param  Table           The pointer to the table associated with TableGuid in the EFI System Table.\r

 \r
   @retval EFI_SUCCESS     A configuration table matching TableGuid was found.\r
   @retval EFI_NOT_FOUND   A configuration table matching TableGuid could not be found.\r
 \r
   @retval EFI_SUCCESS     A configuration table matching TableGuid was found.\r
   @retval EFI_NOT_FOUND   A configuration table matching TableGuid could not be found.\r


@@ -191,7 +191,7 @@ EfiCreateProtocolNotifyEvent(
   @param  Registration          A pointer to a memory location to receive the registration value.\r
 \r
   @retval EFI_SUCCESS           A named event was created.\r
   @param  Registration          A pointer to a memory location to receive the registration value.\r
 \r
   @retval EFI_SUCCESS           A named event was created.\r

-  @retval EFI_OUT_OF_RESOURCES  There are not enough resource to create the named event.\r
+  @retval EFI_OUT_OF_RESOURCES  There are not enough resources to create the named event.\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -211,10 +211,10 @@ EfiNamedEventListen (
   created with EfiNamedEventListen().\r
   If Name is NULL, then ASSERT().\r
 \r
   created with EfiNamedEventListen().\r
   If Name is NULL, then ASSERT().\r
 \r

-  @param  Name                  Supplies GUID name of the event.\r
+  @param  Name                  Supplies the GUID name of the event.\r

 \r
   @retval EFI_SUCCESS           A named event was signaled.\r
 \r
   @retval EFI_SUCCESS           A named event was signaled.\r

-  @retval EFI_OUT_OF_RESOURCES  There are not enough resource to signal the named event.\r
+  @retval EFI_OUT_OF_RESOURCES  There are not enough resources to signal the named event.\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -252,7 +252,7 @@ EfiGetCurrentTpl (
   If Priority is not a valid TPL value, then ASSERT().\r
 \r
   @param  Lock       A pointer to the lock data structure to initialize.\r
   If Priority is not a valid TPL value, then ASSERT().\r
 \r
   @param  Lock       A pointer to the lock data structure to initialize.\r

-  @param  Priority   EFI TPL associated with the lock.\r
+  @param  Priority   The EFI TPL associated with the lock.\r

 \r
   @return The lock.\r
 \r
 \r
   @return The lock.\r
 \r


@@ -493,7 +493,7 @@ LookupUnicodeString (
                                that matches the language specified by Language.\r
   @param  Iso639Language       Specifies the supported language code format. If it is TRUE, then\r
                                Language and SupportedLanguages follow ISO 639-2 language code format.\r
                                that matches the language specified by Language.\r
   @param  Iso639Language       Specifies the supported language code format. If it is TRUE, then\r
                                Language and SupportedLanguages follow ISO 639-2 language code format.\r

-                               Otherwise, they follow RFC 4646 language code format.\r
+                               Otherwise, they follow the RFC 4646 language code format.\r

 \r
 \r
   @retval  EFI_SUCCESS            The Unicode string that matches the language specified by Language\r
 \r
 \r
   @retval  EFI_SUCCESS            The Unicode string that matches the language specified by Language\r


@@ -639,8 +639,8 @@ FreeUnicodeStringTable (
   If Name is NULL, then ASSERT().\r
   If Guid is NULL, then ASSERT().\r
 \r
   If Name is NULL, then ASSERT().\r
   If Guid is NULL, then ASSERT().\r
 \r

-  @param[in]  Name  Pointer to a Null-terminated Unicode string.\r
-  @param[in]  Guid  Pointer to an EFI_GUID structure\r
+  @param[in]  Name  The pointer to a Null-terminated Unicode string.\r
+  @param[in]  Guid  The pointer to an EFI_GUID structure.\r

 \r
   @retval NULL   The variable could not be retrieved.\r
   @retval NULL   There are not enough resources available for the variable contents.\r
 \r
   @retval NULL   The variable could not be retrieved.\r
   @retval NULL   There are not enough resources available for the variable contents.\r


@@ -663,7 +663,7 @@ GetVariable (
 \r
   If Name is NULL, then ASSERT().\r
 \r
 \r
   If Name is NULL, then ASSERT().\r
 \r

-  @param[in]  Name  Pointer to a Null-terminated Unicode string.\r
+  @param[in]  Name  The pointer to a Null-terminated Unicode string.\r

 \r
   @retval NULL   The variable could not be retrieved.\r
   @retval NULL   There are not enough resources available for the variable contents.\r
 \r
   @retval NULL   The variable could not be retrieved.\r
   @retval NULL   There are not enough resources available for the variable contents.\r


@@ -839,8 +839,8 @@ EfiSignalEventLegacyBoot (
 \r
   @param  LegacyBootEvent   Returns the EFI event returned from gBS->CreateEvent(Ex).\r
 \r
 \r
   @param  LegacyBootEvent   Returns the EFI event returned from gBS->CreateEvent(Ex).\r
 \r

-  @retval EFI_SUCCESS       Event was created.\r
-  @retval Other             Event was not created.\r
+  @retval EFI_SUCCESS       The event was created.\r
+  @retval Other             The event was not created.\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -864,8 +864,8 @@ EfiCreateEventLegacyBoot (
   @param  NotifyContext     The content to pass to NotifyFunction when the event is signaled.\r
   @param  LegacyBootEvent   Returns the EFI event returned from gBS->CreateEvent(Ex).\r
 \r
   @param  NotifyContext     The content to pass to NotifyFunction when the event is signaled.\r
   @param  LegacyBootEvent   Returns the EFI event returned from gBS->CreateEvent(Ex).\r
 \r

-  @retval EFI_SUCCESS       Event was created.\r
-  @retval Other             Event was not created.\r
+  @retval EFI_SUCCESS       The event was created.\r
+  @retval Other             The event was not created.\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -890,8 +890,8 @@ EfiCreateEventLegacyBootEx (
 \r
   @param  ReadyToBootEvent   Returns the EFI event returned from gBS->CreateEvent(Ex).\r
 \r
 \r
   @param  ReadyToBootEvent   Returns the EFI event returned from gBS->CreateEvent(Ex).\r
 \r

-  @retval EFI_SUCCESS       Event was created.\r
-  @retval Other             Event was not created.\r
+  @retval EFI_SUCCESS       The event was created.\r
+  @retval Other             The event was not created.\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -915,8 +915,8 @@ EfiCreateEventReadyToBoot (
   @param  NotifyContext     The content to pass to NotifyFunction when the event is signaled.\r
   @param  ReadyToBootEvent  Returns the EFI event returned from gBS->CreateEvent(Ex).\r
 \r
   @param  NotifyContext     The content to pass to NotifyFunction when the event is signaled.\r
   @param  ReadyToBootEvent  Returns the EFI event returned from gBS->CreateEvent(Ex).\r
 \r

-  @retval EFI_SUCCESS       Event was created.\r
-  @retval Other             Event was not created.\r
+  @retval EFI_SUCCESS       The event was created.\r
+  @retval Other             The event was not created.\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -940,7 +940,7 @@ EfiCreateEventReadyToBootEx (
   If FvDevicePathNode is NULL, then ASSERT().\r
   If NameGuid is NULL, then ASSERT().\r
   \r
   If FvDevicePathNode is NULL, then ASSERT().\r
   If NameGuid is NULL, then ASSERT().\r
   \r

-  @param  FvDevicePathNode  Pointer to a FV device path node to initialize\r
+  @param  FvDevicePathNode  The pointer to a FV device path node to initialize\r

   @param  NameGuid          FV file name to use in FvDevicePathNode\r
 \r
 **/\r
   @param  NameGuid          FV file name to use in FvDevicePathNode\r
 \r
 **/\r


@@ -963,7 +963,7 @@ EfiInitializeFwVolDevicepathNode (
   the differences from the caller.\r
   If FvDevicePathNode is NULL, then ASSERT().\r
 \r
   the differences from the caller.\r
   If FvDevicePathNode is NULL, then ASSERT().\r
 \r

-  @param  FvDevicePathNode  Pointer to FV device path to check.\r
+  @param  FvDevicePathNode  The pointer to FV device path to check.\r

 \r
   @retval NULL              FvDevicePathNode is not valid.\r
   @retval Other             FvDevicePathNode is valid and pointer to NameGuid was returned.\r
 \r
   @retval NULL              FvDevicePathNode is not valid.\r
   @retval Other             FvDevicePathNode is valid and pointer to NameGuid was returned.\r


@@ -987,8 +987,8 @@ EfiGetNameGuidFromFwVolDevicePathNode (
   If Format is NULL, then ASSERT().\r
   If Format is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   If Format is NULL, then ASSERT().\r
   If Format is not aligned on a 16-bit boundary, then ASSERT().\r
 \r

-  @param Format   Null-terminated Unicode format string.\r
-  @param ...      Variable argument list whose contents are accessed based \r
+  @param Format   A null-terminated Unicode format string.\r
+  @param ...      The variable argument list whose contents are accessed based \r

                   on the format string specified by Format.\r
   \r
   @return Number of Unicode characters printed to ConOut.\r
                   on the format string specified by Format.\r
   \r
   @return Number of Unicode characters printed to ConOut.\r


@@ -1013,8 +1013,8 @@ Print (
   If Format is NULL, then ASSERT().\r
   If Format is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   If Format is NULL, then ASSERT().\r
   If Format is not aligned on a 16-bit boundary, then ASSERT().\r
 \r

-  @param Format   Null-terminated Unicode format string.\r
-  @param ...      Variable argument list whose contents are accessed based \r
+  @param Format   A null-terminated Unicode format string.\r
+  @param ...      The variable argument list whose contents are accessed based \r

                   on the format string specified by Format.\r
   \r
   @return Number of Unicode characters printed to StdErr.\r
                   on the format string specified by Format.\r
   \r
   @return Number of Unicode characters printed to StdErr.\r


@@ -1038,8 +1038,8 @@ ErrorPrint (
   PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.\r
   If Format is NULL, then ASSERT().\r
 \r
   PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.\r
   If Format is NULL, then ASSERT().\r
 \r

-  @param Format   Null-terminated ASCII format string.\r
-  @param ...      Variable argument list whose contents are accessed based \r
+  @param Format   A null-terminated ASCII format string.\r
+  @param ...      The variable argument list whose contents are accessed based \r

                   on the format string specified by Format.\r
   \r
   @return Number of ASCII characters printed to ConOut.\r
                   on the format string specified by Format.\r
   \r
   @return Number of ASCII characters printed to ConOut.\r


@@ -1063,8 +1063,8 @@ AsciiPrint (
   PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.\r
   If Format is NULL, then ASSERT().\r
 \r
   PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.\r
   If Format is NULL, then ASSERT().\r
 \r

-  @param Format   Null-terminated ASCII format string.\r
-  @param ...      Variable argument list whose contents are accessed based \r
+  @param Format   A null-terminated ASCII format string.\r
+  @param ...      The variable argument list whose contents are accessed based \r

                   on the format string specified by Format.\r
   \r
   @return Number of ASCII characters printed to ConErr.\r
                   on the format string specified by Format.\r
   \r
   @return Number of ASCII characters printed to ConErr.\r


@@ -1109,7 +1109,7 @@ AsciiErrorPrint (
                        an optional parameter that may be NULL.  If it is NULL, \r
                        then the background color of the current ConOut device\r
                        in the EFI_SYSTEM_TABLE is used.\r
                        an optional parameter that may be NULL.  If it is NULL, \r
                        then the background color of the current ConOut device\r
                        in the EFI_SYSTEM_TABLE is used.\r

-  @param  Format       Null-terminated Unicode format string.  See Print Library \r
+  @param  Format       A null-terminated Unicode format string.  See Print Library \r

                        for the supported format string syntax.\r
   @param  ...          Variable argument list whose contents are accessed based on \r
                        the format string specified by Format.         \r
                        for the supported format string syntax.\r
   @param  ...          Variable argument list whose contents are accessed based on \r
                        the format string specified by Format.         \r


@@ -1158,9 +1158,9 @@ PrintXY (
                        an optional parameter that may be NULL.  If it is NULL, \r
                        then the background color of the current ConOut device\r
                        in the EFI_SYSTEM_TABLE is used.\r
                        an optional parameter that may be NULL.  If it is NULL, \r
                        then the background color of the current ConOut device\r
                        in the EFI_SYSTEM_TABLE is used.\r

-  @param  Format       Null-terminated ASCII format string.  See Print Library \r
+  @param  Format       A null-terminated ASCII format string.  See Print Library \r

                        for the supported format string syntax.\r
                        for the supported format string syntax.\r

-  @param  ...          Variable argument list whose contents are accessed based on \r
+  @param  ...          The variable argument list whose contents are accessed based on \r

                        the format string specified by Format.         \r
 \r
   @return  The number of ASCII characters printed.\r
                        the format string specified by Format.         \r
 \r
   @return  The number of ASCII characters printed.\r


@@ -1194,7 +1194,7 @@ AsciiPrintXY (
   @param  DriverBindingHandle  The handle that DriverBinding is to be installed onto.  If this\r
                                parameter is NULL, then a new handle is created.\r
 \r
   @param  DriverBindingHandle  The handle that DriverBinding is to be installed onto.  If this\r
                                parameter is NULL, then a new handle is created.\r
 \r

-  @retval EFI_SUCCESS           The protocol installation is completed successfully.\r
+  @retval EFI_SUCCESS           The protocol installation completed successfully.\r

   @retval EFI_OUT_OF_RESOURCES  There was not enough system resources to install the protocol.\r
   @retval Others                Status from gBS->InstallMultipleProtocolInterfaces().\r
 \r
   @retval EFI_OUT_OF_RESOURCES  There was not enough system resources to install the protocol.\r
   @retval Others                Status from gBS->InstallMultipleProtocolInterfaces().\r
 \r


@@ -1231,8 +1231,8 @@ EfiLibInstallDriverBinding (
   @param  DriverConfiguration  A Driver Configuration Protocol instance that this driver is producing.\r
   @param  DriverDiagnostics    A Driver Diagnostics Protocol instance that this driver is producing.\r
 \r
   @param  DriverConfiguration  A Driver Configuration Protocol instance that this driver is producing.\r
   @param  DriverDiagnostics    A Driver Diagnostics Protocol instance that this driver is producing.\r
 \r

-  @retval EFI_SUCCESS           The protocol installation is completed successfully.\r
-  @retval EFI_OUT_OF_RESOURCES  There was not enough memory in pool to install all the protocols.\r
+  @retval EFI_SUCCESS           The protocol installation completed successfully.\r
+  @retval EFI_OUT_OF_RESOURCES  There was not enough memory in the pool to install all the protocols.\r

 \r
 **/\r
 EFI_STATUS\r
 \r
 **/\r
 EFI_STATUS\r


@@ -1268,7 +1268,7 @@ EfiLibInstallAllDriverProtocols (
   @param  ComponentName        A Component Name Protocol instance that this driver is producing.\r
   @param  ComponentName2       A Component Name 2 Protocol instance that this driver is producing.\r
 \r
   @param  ComponentName        A Component Name Protocol instance that this driver is producing.\r
   @param  ComponentName2       A Component Name 2 Protocol instance that this driver is producing.\r
 \r

-  @retval EFI_SUCCESS           The protocol installation is completed successfully.\r
+  @retval EFI_SUCCESS           The protocol installation completed successfully.\r

   @retval EFI_OUT_OF_RESOURCES  There was not enough memory in pool to install all the protocols.\r
 \r
 **/\r
   @retval EFI_OUT_OF_RESOURCES  There was not enough memory in pool to install all the protocols.\r
 \r
 **/\r


@@ -1309,7 +1309,7 @@ EfiLibInstallDriverBindingComponentName2 (
   @param  DriverDiagnostics     A Driver Diagnostics Protocol instance that this driver is producing.\r
   @param  DriverDiagnostics2    A Driver Diagnostics Protocol 2 instance that this driver is producing.\r
 \r
   @param  DriverDiagnostics     A Driver Diagnostics Protocol instance that this driver is producing.\r
   @param  DriverDiagnostics2    A Driver Diagnostics Protocol 2 instance that this driver is producing.\r
 \r

-  @retval EFI_SUCCESS           The protocol installation is completed successfully.\r
+  @retval EFI_SUCCESS           The protocol installation completed successfully.\r

   @retval EFI_OUT_OF_RESOURCES  There was not enough memory in pool to install all the protocols.\r
 \r
 **/\r
   @retval EFI_OUT_OF_RESOURCES  There was not enough memory in pool to install all the protocols.\r
 \r
 **/\r