Correct the structure's comments to follow doxygen format.

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
index 9c3c07743d6a9f4e26f9d426390dcac84dabbe64..9f3e99002b5a89e94c4ba8bbd1013a61fbe6e900 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
@@ -1,7 +1,7 @@
 /** @file\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
@@ -140,19 +140,11 @@ EFI_STATUS
 // 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