From: pkandel Date: Thu, 9 Jul 2009 12:02:01 +0000 (+0000) Subject: Committing changes to the comments, to improve code documentation. X-Git-Tag: edk2-stable201903~17467 X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=727fed5a449863c51c7fc5f13f907b23cfb3ea6a 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 da44d822d2..63387f8aa5 100644 --- 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. @param Value Describes the current status of a hardware or software entity. - This included information about the class and subclass that is used to classify the entity - as well as an operation. For progress codes, the operation is the current activity. + This includes both an operation and classification information about the class and subclass. + For progress codes, the operation is the current activity. For error codes, it is the exception. For debug codes, it is not defined at this time. Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below. Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification. diff --git a/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h b/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h index 2e4b0d86c8..030449f110 100644 --- a/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h +++ b/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h @@ -1,6 +1,6 @@ /** @file - Platform BDS library definition. Platform can implement an - instances to support the platform specific behavior. + Platform BDS library definition. A platform can implement + instances to support platform-specific behavior. Copyright (c) 2008 - 2009, Intel Corporation.
All rights reserved. This program and the accompanying materials @@ -21,7 +21,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include /** - Platform Bds init. Include the platform firmware vendor, revision + Platform Bds initialization. Includes the platform firmware vendor, revision and so crc check. **/ @@ -69,9 +69,9 @@ PlatformBdsBootFail ( Hook point after a boot attempt succeeds. We don't expect a boot option to return, so the UEFI 2.0 specification defines that you will default to an interactive mode and stop processing the BootOrder list in this case. This - is alos a platform implementation and can be customized by IBV/OEM. + is also a platform implementation, and can be customized by an IBV/OEM. - @param Option Pointer to Boot Option that succeeded to boot. + @param Option Pointer to Boot Option that successfully booted. **/ VOID