Correct the structure's comments to follow doxygen format.

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h
index 0b7b5dc4675f236fed155b0ce9564d451ae7253f..1719371314df3c92669ef2a877fdc6dfad646cd1 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
   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
   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


@@ -180,19 +180,11 @@ EFI_STATUS
 // Interface structure for the SMM ICHN specific SMI Dispatch Protocol\r
 //\r
 /**\r
 // 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
   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
 **/\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
 };\r
 \r
 extern EFI_GUID gEfiSmmIchnDispatchProtocolGuid;\r