Committing changes to the comments, to improve code documentation.

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

diff --git a/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h b/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h
index 533df317ff7cef1729012f0181e58edec1a41de9..63387f8aa56ed2b4a94eef069ca509a60e29c5c0 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h
@@ -1,8 +1,8 @@
-\r
 /** @file\r
-  OEM hook status code library functions with no library constructor/destructor\r
+  OEM hook status code library. Platform can implement an instance to \r
+  initialize the OEM devices to report status code information.\r
 \r
-  Copyright (c) 2006, Intel Corporation\r
+  Copyright (c) 2006 - 2009, Intel Corporation\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
@@ -11,8 +11,6 @@
   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
-  Module Name:  OemHookStatusCodeLib.h\r
-\r
 **/\r
 \r
 #ifndef __OEM_HOOK_STATUSCODE_LIB__\r
@@ -38,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
-                        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
@@ -52,7 +50,7 @@ OemHookStatusCodeInitialize (
 \r
   @param  CallerId      This optional parameter may be used to identify the caller. \r
                         This parameter allows the status code driver to apply different rules to different callers. \r
-                        Type EFI_GUID is defined in InstallProtocolInterface() in the EFI 1.10 Specification.\r
+                        Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0 Specification.\r
 \r
 \r
   @param  Data          This optional parameter may be used to pass additional data\r
@@ -70,4 +68,5 @@ OemHookStatusCodeReport (
   IN EFI_STATUS_CODE_DATA     *Data      OPTIONAL\r
   );\r
 \r
-#endif\r
+#endif // __OEM_HOOK_STATUSCODE_LIB__\r
+\r