Remove "Module Name:" from include file headers.

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
index e7621cdfe6787130cd279d6cc24f2b9a4b8b6a86..938d3725decd6b32f4adca3673ff3bdb15ac7573 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
@@ -1,7 +1,7 @@
 /** @file\r
-  This file declares EFI Smm Sx Smi Child Protocol\r
+  Provides the parent dispatch service for a given Sx-state source generator.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 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,8 +10,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:  SmmSxDispatch.h\r
-\r
   @par Revision Reference:\r
   This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
   Version 0.9.\r
@@ -21,6 +19,7 @@
 #ifndef _EFI_SMM_SX_DISPATCH_H_\r
 #define _EFI_SMM_SX_DISPATCH_H_\r
 \r
+\r
 //\r
 // Global ID for the Sx SMI Protocol\r
 //\r
@@ -68,12 +67,12 @@ typedef struct {
                                 and phases, so the Sx state handler(s) must check the Type and\r
                                 Phase field of EFI_SMM_SX_DISPATCH_CONTEXT and act accordingly.\r
 \r
-  Nothing\r
+  @return None\r
 \r
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_SMM_SX_DISPATCH) (\r
+(EFIAPI *EFI_SMM_SX_DISPATCH)(\r
   IN  EFI_HANDLE                    DispatchHandle,\r
   IN  EFI_SMM_SX_DISPATCH_CONTEXT   *DispatchContext\r
   );\r
@@ -81,9 +80,8 @@ VOID
 /**\r
   Register a child SMI source dispatch function with a parent SMM driver\r
 \r
-  @param  This                  Protocol instance pointer.\r
-  @param  DispatchFunction      Pointer to dispatch function to be invoked for\r
-                                this SMI source\r
+  @param  This                  Pointer to the EFI_SMM_SX_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 register function to indicate to the register\r
@@ -109,50 +107,41 @@ VOID
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_SX_REGISTER) (\r
-  IN EFI_SMM_SX_DISPATCH_PROTOCOL           *This,\r
-  IN  EFI_SMM_SX_DISPATCH                   DispatchFunction,\r
-  IN  EFI_SMM_SX_DISPATCH_CONTEXT           *DispatchContext,\r
-  OUT EFI_HANDLE                            *DispatchHandle\r
+(EFIAPI *EFI_SMM_SX_REGISTER)(\r
+  IN EFI_SMM_SX_DISPATCH_PROTOCOL          *This,\r
+  IN EFI_SMM_SX_DISPATCH                   DispatchFunction,\r
+  IN EFI_SMM_SX_DISPATCH_CONTEXT           *DispatchContext,\r
+  OUT EFI_HANDLE                           *DispatchHandle\r
   );\r
 \r
 /**\r
-  Unregister a child SMI source dispatch function with a parent SMM driver\r
+  Unregisters an Sx-state service\r
 \r
-  @param  This                  Protocol instance pointer.\r
-  @param  DispatchHandle        Handle of dispatch function to deregister.\r
+  @param  This                  Pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.\r
+  @param  DispatchHandle        Handle of the service to remove.\r
 \r
   @retval EFI_SUCCESS           The dispatch function has been successfully unregistered and the\r
                                 SMI source has been disabled if there are no other registered child\r
                                 dispatch functions for this SMI source.\r
   @retval EFI_INVALID_PARAMETER Handle is invalid.\r
-  @retval other                 TBD\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_SX_UNREGISTER) (\r
-  IN EFI_SMM_SX_DISPATCH_PROTOCOL           *This,\r
-  IN  EFI_HANDLE                            DispatchHandle\r
+(EFIAPI *EFI_SMM_SX_UNREGISTER)(\r
+  IN EFI_SMM_SX_DISPATCH_PROTOCOL          *This,\r
+  IN EFI_HANDLE                            DispatchHandle\r
   );\r
 \r
 //\r
 // Interface structure for the SMM Child Dispatch Protocol\r
 //\r
 /**\r
-  @par Protocol Description:\r
   Provides the parent dispatch service for a given Sx-state 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_SX_DISPATCH_PROTOCOL {\r
-  EFI_SMM_SX_REGISTER   Register;\r
-  EFI_SMM_SX_UNREGISTER UnRegister;\r
+  EFI_SMM_SX_REGISTER   Register;     ///< Installs a child service to be dispatched by this protocol.\r
+  EFI_SMM_SX_UNREGISTER UnRegister;   ///< Removes a child service dispatched by this protocol.\r
 };\r
 \r
 extern EFI_GUID gEfiSmmSxDispatchProtocolGuid;\r