Update comments.

[mirror_edk2.git] / IntelFrameworkModulePkg / Library / OemHookStatusCodeLibNull / OemHookStatusCodeLibNull.c

diff --git a/IntelFrameworkModulePkg/Library/OemHookStatusCodeLibNull/OemHookStatusCodeLibNull.c b/IntelFrameworkModulePkg/Library/OemHookStatusCodeLibNull/OemHookStatusCodeLibNull.c
index deaccfac4eaa1191a3b6aaca5aad407808ec3448..dceaaa641dc486a93445b81a225e4e49a9406d49 100644 (file)
--- a/IntelFrameworkModulePkg/Library/OemHookStatusCodeLibNull/OemHookStatusCodeLibNull.c
+++ b/IntelFrameworkModulePkg/Library/OemHookStatusCodeLibNull/OemHookStatusCodeLibNull.c
@@ -1,7 +1,7 @@
 /** @file\r
-  OEM hook status code library functions with no library constructor/destructor\r
+  Null instance of OEM Hook Status Code Library with empty functions.\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
@@ -10,17 +10,13 @@
   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:  OemHookStatusCodeLibNull.c\r
-\r
 **/\r
 \r
-#include <PiPei.h>\r
 \r
 /**\r
-\r
   Initialize OEM status code device .\r
 \r
-  @return     Always return EFI_SUCCESS.\r
+  @retval  EFI_SUCCESS   Always return EFI_SUCCESS.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -35,29 +31,20 @@ OemHookStatusCodeInitialize (
 /**\r
   Report status code to OEM device.\r
  \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  CodeType      Indicates the type of status code being reported.\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
                         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
- \r
   @param  Instance      The enumeration of a hardware or software entity within the system.  \r
                         A system may contain multiple entities that match a class/subclass pairing. \r
                         The instance differentiates between them.  An instance of 0 indicates that instance information is unavailable, \r
                         not meaningful, or not relevant.  Valid instance numbers start with 1.\r
-\r
-\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
-\r
-\r
   @param  Data          This optional parameter may be used to pass additional data\r
  \r
-  @return               The function always return EFI_UNSUPPORTED.\r
+  @retval EFI_SUCCESS   Always return EFI_SUCCESS.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -70,6 +57,6 @@ OemHookStatusCodeReport (
   IN EFI_STATUS_CODE_DATA     *Data      OPTIONAL\r
   )\r
 {\r
-  return EFI_UNSUPPORTED;\r
+  return EFI_SUCCESS;\r
 }\r
 \r