Grammatical and disclaimer changes (does not follow internal C coding stds.)

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
index dd3ced55b7b1ab712a99d401e94ad897b41ad469..7d98fcd45c9ffe203b56b5d918a6a64c7be6699a 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
@@ -5,14 +5,14 @@
   the Intel Platform Innovation Framework for EFI SMM Core Interface Specification\r
   (SMM CIS) Version 0.9.\r
 \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
-  http://opensource.org/licenses/bsd-license.php\r
-\r
-  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
+Copyright (c) 2007 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.                                          \r
+    \r
+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
@@ -56,8 +56,8 @@ typedef struct {
 /**\r
   Dispatch function for a Standby Button SMI handler.\r
 \r
-  @param  DispatchHandle        Handle of this dispatch function.\r
-  @param  DispatchContext       Pointer to the dispatch function's context.\r
+  @param  DispatchHandle        The handle of this dispatch function.\r
+  @param  DispatchContext       The pointer to the dispatch function's context.\r
                                 The DispatchContext fields are filled in\r
                                 by the dispatching driver prior to\r
                                 invoking this dispatch function.\r
@@ -73,16 +73,17 @@ VOID
 /**\r
   Provides the parent dispatch service for a given SMI source generator\r
 \r
-  @param  This                  Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.\r
-  @param  DispatchFunction      Function to install.\r
-  @param  DispatchContext       Pointer to the dispatch function's context.\r
-                                Indicates to the register\r
-                                function the Standby Button SMI phase for which to invoke the dispatch\r
+  @param  This                  The pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.\r
+  @param  DispatchFunction      The function to install.\r
+  @param  DispatchContext       The pointer to the dispatch function's context.\r
+                                Indicates to the register function the Standby \r
+                                Button SMI phase for which to invoke the dispatch\r
                                 function.\r
-  @param  DispatchHandle        Handle generated by the dispatcher to track the function instance.\r
+  @param  DispatchHandle        The handle generated by the dispatcher to track the \r
+                                function instance.\r
 \r
   @retval EFI_SUCCESS           The dispatch function has been successfully\r
-                                registered and the SMI source has been enabled.\r
+                                registered, and the SMI source has been enabled.\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
@@ -100,16 +101,16 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Unregister a child SMI source dispatch function with a parent SMM driver\r
+  Unregister a child SMI source dispatch function with a parent SMM driver.\r
 \r
-  @param  This                   Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.\r
-  @param  DispatchHandle         Handle of the service to remove.\r
+  @param  This                   The pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.\r
+  @param  DispatchHandle         The handle of the service to remove.\r
 \r
   @retval EFI_SUCCESS            The dispatch function has been successfully\r
-                                 unregistered and the SMI source has been disabled\r
+                                 unregistered, and the SMI source has been disabled,\r
                                  if there are no other registered child dispatch\r
                                  functions for this SMI source.\r
-  @retval EFI_INVALID_PARAMETER  Handle is invalid.\r
+  @retval EFI_INVALID_PARAMETER  The handle is invalid.\r
 \r
 **/\r
 typedef\r