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

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

diff --git a/MdePkg/Include/Library/UefiRuntimeLib.h b/MdePkg/Include/Library/UefiRuntimeLib.h
index 02be8ea5e4b28c5d446fd29cafc21bd77ba703cd..3ec56800113ae73eec8fb0101611a5a0113817c2 100644 (file)
--- a/MdePkg/Include/Library/UefiRuntimeLib.h
+++ b/MdePkg/Include/Library/UefiRuntimeLib.h
@@ -2,11 +2,11 @@
   Provides library functions for each of the UEFI Runtime Services.\r
   Only available to DXE and UEFI module types.\r
 \r
-Copyright (c) 2006 - 2008, 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
@@ -120,7 +120,7 @@ EfiSetTime (
   @param  Time     The current alarm setting. Type EFI_TIME is defined in the GetTime()\r
                    function description.\r
 \r
-  @retval  EFI_SUCCESS           The alarm settings were returned.\r
+  @retval  EFI_SUCCESS            The alarm settings were returned.\r
   @retval  EFI_INVALID_PARAMETER  Enabled is NULL.\r
   @retval  EFI_INVALID_PARAMETER  Pending is NULL.\r
   @retval  EFI_INVALID_PARAMETER  Time is NULL.\r
@@ -442,7 +442,7 @@ EfiSetVirtualAddressMap (
   @param  DebugDisposition   Supplies type information for the pointer being converted.\r
   @param  ListHead           Head of linked list to convert.\r
 \r
-  @retval  EFI_SUCCESS  Success to execute the function.\r
+  @retval  EFI_SUCCESS  Successfully executed the function.\r
   @retval  !EFI_SUCCESS Failed to execute the function.\r
 \r
 **/\r
@@ -478,9 +478,10 @@ EfiConvertList (
                                 CapsuleHeaderArray. This parameter is only referenced if\r
                                 the capsules are defined to persist across system reset.\r
 \r
-  @retval EFI_SUCCESS           Valid capsule was passed. If CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set,\r
+  @retval EFI_SUCCESS           A valid capsule was passed. If CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set,\r
                                 the capsule has been successfully processed by the firmware.\r
-  @retval EFI_INVALID_PARAMETER CapsuleSize or HeaderSize is NULL.\r
+  @retval EFI_INVALID_PARAMETER CapsuleSize is NULL, or an incompatible set of flags were\r
+                                set in the capsule header.\r
   @retval EFI_INVALID_PARAMETER CapsuleCount is 0\r
   @retval EFI_DEVICE_ERROR      The capsule update was started, but failed due to a device error.\r
   @retval EFI_UNSUPPORTED       The capsule type is not supported on this platform.\r
@@ -523,7 +524,7 @@ EfiUpdateCapsule (
                                 Undefined on input.\r
   @param  ResetType             Returns the type of reset required for the capsule update.\r
 \r
-  @retval EFI_SUCCESS           Valid answer returned.\r
+  @retval EFI_SUCCESS           A valid answer was returned.\r
   @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.\r
   @retval EFI_UNSUPPORTED       The capsule type is not supported on this platform, and\r
                                 MaximumCapsuleSize and ResetType are undefined.\r
@@ -562,11 +563,11 @@ EfiQueryCapsuleCapabilities (
   @param  RemainingVariableStorageSize\r
                                 Returns the remaining size of the storage space\r
                                 available for the EFI variables associated with the\r
-                                attributes specified..\r
+                                attributes specified.\r
   @param  MaximumVariableSize   Returns the maximum size of the individual EFI\r
                                 variables associated with the attributes specified.\r
 \r
-  @retval EFI_SUCCESS           Valid answer returned.\r
+  @retval EFI_SUCCESS           A valid answer was returned.\r
   @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.\r
   @retval EFI_UNSUPPORTED       EFI_UNSUPPORTED The attribute is not supported on this platform, and the\r
                                 MaximumVariableStorageSize,\r