Minor code enhancement.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / SmmIchnDispatch.h

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h
index 0b7b5dc4675f236fed155b0ce9564d451ae7253f..165d6a7e38e30655efb52d0ab128ac0b2f995cda 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h
@@ -3,7 +3,7 @@
   The EFI_SMM_ICHN_DISPATCH_PROTOCOL provides the ability to install child handlers for\r
   the given event types.\r
 \r
-  Copyright (c) 2008, Intel Corporation\r
+  Copyright (c) 2008 - 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
@@ -12,8 +12,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:  SmmIchnDispatch.h\r
-\r
   @par Revision Reference:\r
   This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
   Version 0.9.\r
@@ -23,7 +21,6 @@
 #ifndef _EFI_SMM_ICHN_DISPATCH_H_\r
 #define _EFI_SMM_ICHN_DISPATCH_H_\r
 \r
-#include <PiDxe.h>\r
 \r
 //\r
 // Global ID for the ICH SMI Protocol\r
@@ -131,7 +128,7 @@ VOID
   @param  This                  Pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.\r
   @param  DispatchFunction      Function to install.\r
   @param  DispatchContext       Pointer to the dispatch function's context.\r
-                                The caller fills this context in before calling\r
+                                The caller fills in this context before calling\r
                                 the register function to indicate to the register\r
                                 function the ICHN SMI source for which the dispatch\r
                                 function should be invoked.\r
@@ -140,7 +137,7 @@ VOID
 \r
   @retval EFI_SUCCESS           The dispatch function has been successfully\r
                                 registered and the SMI source has been enabled.\r
-  @retval EFI_DEVICE_ERROR      The driver was unable to enable the SMI source.\r
+  @retval EFI_DEVICE_ERROR      The driver could not enable the SMI source.\r
   @retval EFI_OUT_OF_RESOURCES  Not enough memory (system or SMM) to manage this\r
                                 child.\r
   @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The ICHN input value\r
@@ -180,19 +177,11 @@ EFI_STATUS
 // Interface structure for the SMM ICHN specific SMI Dispatch Protocol\r
 //\r
 /**\r
-  @par Protocol Description:\r
   Provides the parent dispatch service for a given SMI source generator.\r
-\r
-  @param Register\r
-  Installs a child service to be dispatched by this protocol.\r
-\r
-  @param UnRegister\r
-  Removes a child service dispatched by this protocol.\r
-\r
 **/\r
 struct _EFI_SMM_ICHN_DISPATCH_PROTOCOL {\r
-  EFI_SMM_ICHN_REGISTER   Register;\r
-  EFI_SMM_ICHN_UNREGISTER UnRegister;\r
+  EFI_SMM_ICHN_REGISTER   Register;     ///< Installs a child service to be dispatched by this protocol.\r
+  EFI_SMM_ICHN_UNREGISTER UnRegister;   ///< Removes a child service dispatched by this protocol.\r
 };\r
 \r
 extern EFI_GUID gEfiSmmIchnDispatchProtocolGuid;\r