From 64a80549c8ab874c5b23b376adbb99008e6143b0 Mon Sep 17 00:00:00 2001 From: myronporter Date: Wed, 17 Mar 2010 20:48:52 +0000 Subject: Grammatical and disclaimer changes (does not follow internal C coding stds.) git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10269 6f19259b-4bc3-4df7-8a09-765794883524 --- .../Include/Library/OemHookStatusCodeLib.h | 44 +++++++++++++--------- 1 file changed, 26 insertions(+), 18 deletions(-) (limited to 'MdeModulePkg/Include/Library/OemHookStatusCodeLib.h') diff --git a/MdeModulePkg/Include/Library/OemHookStatusCodeLib.h b/MdeModulePkg/Include/Library/OemHookStatusCodeLib.h index 8b09e78435..2b2d82b5b4 100644 --- a/MdeModulePkg/Include/Library/OemHookStatusCodeLib.h +++ b/MdeModulePkg/Include/Library/OemHookStatusCodeLib.h @@ -2,14 +2,14 @@ OEM hook status code library. Platform can implement an instance to initialize the OEM devices to report status code information. - Copyright (c) 2006 - 2009, Intel Corporation - All rights reserved. This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php +Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved
+This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. +The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php. - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -18,7 +18,7 @@ /** - Initialize OEM status code device . + Initialize OEM status code device. @return Status of initialization of OEM status code device. @@ -36,25 +36,33 @@ OemHookStatusCodeInitialize ( @param CodeType Indicates the type of status code being reported. @param Value Describes the current status of a hardware or software entity. - This includes both an operation and classification information about the class and subclass. + 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. - Specific values are discussed in the Intel Platform Innovation Framework for EFI Status Code Specification. + For error codes, it is the exception. For debug codes, + it is not defined at this time. + Specific values are discussed in the Intel Platform Innovation + Framework for EFI Status Code Specification. @param Instance The enumeration of a hardware or software entity within the system. - A system may contain multiple entities that match a class/subclass pairing. - The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, - not meaningful, or not relevant. Valid instance numbers start with 1. + A system may contain multiple entities that match a class/subclass + pairing. + The instance differentiates between them. An instance of 0 + indicates that instance information is unavailable, + not meaningful, or not relevant. Valid instance numbers + start with 1. @param CallerId This optional parameter may be used to identify the caller. - This parameter allows the status code driver to apply different rules to different callers. - Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0 Specification. + This parameter allows the status code driver to apply + different rules to different callers. + Type EFI_GUID is defined in InstallProtocolInterface() + in the UEFI 2.0 Specification. - @param Data This optional parameter may be used to pass additional data + @param Data This optional parameter may be used to pass additional data. - @return The function always return EFI_SUCCESS. + @return The function always returns EFI_SUCCESS. **/ EFI_STATUS -- cgit v1.2.3