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

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h
index 64bba9fac4fc648673a9700f0afe6734144f9445..eab8e8732b665dfb3bf633b52b5104f3647b5f3e 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h
@@ -1,14 +1,14 @@
 /** @file\r
   Provides the parent dispatch service for the power button SMI source generator.\r
 \r
 /** @file\r
   Provides the parent dispatch service for the power button SMI source generator.\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
 \r
   @par Revision Reference:\r
   This Protocol is defined in Framework of EFI SMM Core Interface Spec\r


@@ -53,8 +53,8 @@ typedef struct {
 /**\r
   Dispatch function for a Power Button SMI handler.\r
 \r
 /**\r
   Dispatch function for a Power Button SMI handler.\r
 \r

-  @param[in]  DispatchHandle        Handle of this dispatch function.\r
-  @param[in]  DispatchContext       Pointer to the dispatch function's context.\r
+  @param[in]  DispatchHandle        The handle of this dispatch function.\r
+  @param[in]  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
                                     The DispatchContext fields are filled in\r
                                     by the dispatching driver prior to\r
                                     invoking this dispatch function.\r


@@ -70,13 +70,15 @@ VOID
 /**\r
   Provides the parent dispatch service for a given SMI source generator\r
 \r
 /**\r
   Provides the parent dispatch service for a given SMI source generator\r
 \r

-  @param[in]   This                  Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.\r
-  @param[in]   DispatchFunction      Function to install.\r
-  @param[in]   DispatchContext       Pointer to the dispatch function's context.\r
+  @param[in]   This                  The pointer to the \r
+                                     EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.\r
+  @param[in]   DispatchFunction      The function to install.\r
+  @param[in]   DispatchContext       The pointer to the dispatch function's context.\r

                                      Indicates to the register\r
                                      Indicates to the register\r

-                                     function the Power Button SMI phase for which to invoke the dispatch\r
-                                     function.\r
-  @param[out]  DispatchHandle        Handle generated by the dispatcher to track the function instance.\r
+                                     function the Power Button SMI phase for which \r
+                                     to invoke the dispatch function.\r
+  @param[out]  DispatchHandle        Handle generated by the dispatcher to track \r
+                                     the function instance.\r

 \r
   @retval      EFI_SUCCESS           The dispatch function has been successfully\r
                                      registered and the SMI source has been enabled.\r
 \r
   @retval      EFI_SUCCESS           The dispatch function has been successfully\r
                                      registered and the SMI source has been enabled.\r


@@ -99,15 +101,15 @@ EFI_STATUS
 /**\r
   Unregisters a power-button service.\r
 \r
 /**\r
   Unregisters a power-button service.\r
 \r

-  @param[in]  This                  Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.\r
-  @param[in]  DispatchHandle        Handle of the service to remove.\r
+  @param[in]  This                  The pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.\r
+  @param[in]  DispatchHandle        The handle of the service to remove.\r

 \r
   @retval     EFI_SUCCESS           The dispatch function has been successfully\r
 \r
   @retval     EFI_SUCCESS           The dispatch function has been successfully\r

-                                    unregistered and the SMI source has been\r
-                                   disabled if there are no other registered\r
+                                    unregistered, and the SMI source has been\r
+                                   disabled, if there are no other registered\r

                                    child dispatch functions for this SMI\r
                                    source.\r
                                    child dispatch functions for this SMI\r
                                    source.\r

-  @retval     EFI_INVALID_PARAMETER Handle is invalid.\r
+  @retval     EFI_INVALID_PARAMETER The handle is invalid.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r