Committing changes to the comments, to improve code documentation.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8841 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h b/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h
index da44d822d29b5ef79862e39985682ef7593cc033..63387f8aa56ed2b4a94eef069ca509a60e29c5c0 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h
@@ -36,8 +36,8 @@ OemHookStatusCodeInitialize (
   @param  CodeType      Indicates the type of status code being reported.  Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
  \r
   @param  Value         Describes the current status of a hardware or software entity.  \r
   @param  CodeType      Indicates the type of status code being reported.  Type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
  \r
   @param  Value         Describes the current status of a hardware or software entity.  \r

-                        This included information about the class and subclass that is used to classify the entity \r
-                        as well as an operation.  For progress codes, the operation is the current activity. \r
+                        This includes both an operation and classification information about the class and subclass.\r
+                        For progress codes, the operation is the current activity. \r

                         For error codes, it is the exception.  For debug codes, it is not defined at this time. \r
                         Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.  \r
                         Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
                         For error codes, it is the exception.  For debug codes, it is not defined at this time. \r
                         Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.  \r
                         Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r

diff --git a/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h b/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
index 2e4b0d86c80a88570f3adbcebcd8f6653e7dcb5b..030449f11074532227a8db9a1943cbc24f5a5704 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
@@ -1,6 +1,6 @@
 /** @file\r
 /** @file\r

-  Platform BDS library definition. Platform can implement an\r
-  instances to support the platform specific behavior.\r
+  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
 \r
 Copyright (c) 2008 - 2009, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r


@@ -21,7 +21,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/GenericBdsLib.h>\r
 \r
 /**\r
 #include <Library/GenericBdsLib.h>\r
 \r
 /**\r

-  Platform Bds init. Include the platform firmware vendor, revision\r
+  Platform Bds initialization. Includes the platform firmware vendor, revision\r

   and so crc check.\r
 \r
 **/\r
   and so crc check.\r
 \r
 **/\r


@@ -69,9 +69,9 @@ PlatformBdsBootFail (
   Hook point after a boot attempt succeeds. We don't expect a boot option to\r
   return, so the UEFI 2.0 specification defines that you will default to an\r
   interactive mode and stop processing the BootOrder list in this case. This\r
   Hook point after a boot attempt succeeds. We don't expect a boot option to\r
   return, so the UEFI 2.0 specification defines that you will default to an\r
   interactive mode and stop processing the BootOrder list in this case. This\r

-  is alos a platform implementation and can be customized by IBV/OEM.\r
+  is also a platform implementation, and can be customized by an IBV/OEM.\r

 \r
 \r

-  @param  Option                  Pointer to Boot Option that succeeded to boot.\r
+  @param  Option                  Pointer to Boot Option that successfully booted.\r

 \r
 **/\r
 VOID\r
 \r
 **/\r
 VOID\r