Per code review, Update Doxygen comments - restore reference to framework spec in...

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8703 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
index 188e950f9f1ab6ecf61e8e2ee527890683bd7829..78c6ff844faddcd5ba98de91da2e5614a7ac152c 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
@@ -5,7 +5,7 @@
   the Intel Platform Innovation Framework for EFI SMM Core Interface Specification\r
   (SMM CIS) Version 0.9.\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
@@ -14,6 +14,10 @@
   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
+  @par Revision Reference:\r
+  This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
+  Version 0.9.\r
+\r
 **/\r
 \r
 #ifndef _EFI_SMM_STANDBY_BUTTON_DISPATCH_H_\r
@@ -35,22 +39,20 @@ typedef struct _EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL  EFI_SMM_STANDBY_BUTTON
 // Related Definitions\r
 //\r
 \r
-//\r
-// Standby Button. Example, Use for changing LEDs before ACPI OS is on.\r
-//    - DXE/BDS Phase\r
-//    - OS Install Phase\r
-//\r
+///\r
+/// Standby Button. Example, Use for changing LEDs before ACPI OS is on.\r
+///    - DXE/BDS Phase\r
+///    - OS Install Phase\r
+///\r
 typedef enum {\r
   EfiStandbyButtonEntry,\r
   EfiStandbyButtonExit\r
 } EFI_STANDBY_BUTTON_PHASE;\r
 \r
 typedef struct {\r
-  //\r
-  // Describes whether the child handler should be invoked upon the entry to the button\r
-  // activation or upon exit (i.e., upon receipt of the button press event or upon release of\r
-  // the event).\r
-  //\r
+  ///  Describes whether the child handler should be invoked upon the entry to the button\r
+  ///  activation or upon exit (i.e., upon receipt of the button press event or upon release of\r
+  ///  the event).\r
   EFI_STANDBY_BUTTON_PHASE  Phase;\r
 } EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT;\r
 \r
@@ -128,9 +130,18 @@ EFI_STATUS
 //\r
 // Interface structure for the SMM Standby Button SMI Dispatch Protocol\r
 //\r
-\r
+/**\r
+       This protocol  provices the parent dispatch service for the standby button SMI source generator.\r
+       Provides the ability to install child handlers for the given event types.\r
+ **/\r
 struct _EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL {\r
-  EFI_SMM_STANDBY_BUTTON_REGISTER   Register;\r
+       /// \r
+  /// Installs a child service to be dispatched by this protocol.\r
+  ///\r
+  EFI_SMM_STANDBY_BUTTON_REGISTER   Register;\\r
+       ///\r
+       /// Removes a child service dispatched by this protocol.\r
+       ///\r
   EFI_SMM_STANDBY_BUTTON_UNREGISTER UnRegister;\r
 };\r
 \r