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

[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Library / PlatformBdsLib.h

diff --git a/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h b/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
index d2099f142cc9222ff3bbe72577f1193abcc6eee0..b09f4f53a93179b8722cc4a79a029f7df9b6c563 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
@@ -2,13 +2,13 @@
   Platform BDS library definition. A platform can implement \r
   instances to support platform-specific behavior.\r
 \r
-Copyright (c) 2008 - 2009, 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
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+Copyright (c) 2008 - 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
 **/\r
@@ -25,7 +25,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   @param  Level         The memory test intensive level.\r
 \r
-  @retval EFI_STATUS    Success test all the system memory and update\r
+  @retval EFI_STATUS    Successfully test all the system memory, and update\r
                         the memory resource\r
 \r
 **/\r
@@ -37,7 +37,7 @@ EFI_STATUS
 \r
 /**\r
   This routine is called to see if there are any capsules we need to process.\r
-  If the boot mode is not UPDATE, then we do nothing. Otherwise find the\r
+  If the boot mode is not UPDATE, then we do nothing. Otherwise, find the\r
   capsule HOBS and produce firmware volumes for them via the DXE service.\r
   Then call the dispatcher to dispatch drivers from them. Finally, check\r
   the status of the updates.\r
@@ -48,10 +48,10 @@ EFI_STATUS
   clear the capsule variable so on the next reset PEI does not see it and\r
   think there is a capsule available.\r
 \r
-  @param BootMode                 the current boot mode\r
+  @param BootMode                 The current boot mode\r
 \r
-  @retval EFI_INVALID_PARAMETER   boot mode is not correct for an update\r
-  @retval EFI_SUCCESS             There is no error when processing capsule\r
+  @retval EFI_INVALID_PARAMETER   The boot mode is not correct for an update.\r
+  @retval EFI_SUCCESS             There is no error when processing a capsule.\r
 \r
 **/\r
 typedef \r
@@ -94,10 +94,10 @@ PlatformBdsPolicyBehavior (
 /**\r
   Hook point for a user-provided function, for after a boot attempt fails. \r
 \r
-  @param  Option                  Pointer to Boot Option that failed to boot.\r
-  @param  Status                  Status returned from failed boot.\r
-  @param  ExitData                Exit data returned from failed boot.\r
-  @param  ExitDataSize            Exit data size returned from failed boot.\r
+  @param  Option                  A pointer to Boot Option that failed to boot.\r
+  @param  Status                  The status returned from failed boot.\r
+  @param  ExitData                The exit data returned from failed boot.\r
+  @param  ExitDataSize            The exit data size returned from failed boot.\r
 \r
 **/\r
 VOID\r
@@ -115,7 +115,7 @@ PlatformBdsBootFail (
   interactive mode and stop processing the BootOrder list in this case. This\r
   is also a platform implementation, and can be customized by an IBV/OEM.\r
 \r
-  @param  Option                  Pointer to Boot Option that successfully booted.\r
+  @param  Option                  A pointer to the Boot Option that successfully booted.\r
 \r
 **/\r
 VOID\r
@@ -141,10 +141,10 @@ PlatformBdsLockNonUpdatableFlash (
   presses will be ignored until the Password is typed in. The only way to\r
   disable the password is to type it in to a ConIn device.\r
 \r
-  @param  Password        Password used to lock ConIn device.\r
+  @param  Password        The password used to lock ConIn device.\r
 \r
-  @retval EFI_SUCCESS     lock the Console In Spliter virtual handle successfully.\r
-  @retval EFI_UNSUPPORTED Password not found\r
+  @retval EFI_SUCCESS     Lock the Console In Spliter virtual handle successfully.\r
+  @retval EFI_UNSUPPORTED Password not found.\r
 \r
 **/\r
 EFI_STATUS\r