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

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h
index 3c742dc070f24cf9a9fac7d4b50f219992f94cb9..1d113315652b487148b702a698b15dfe1092136f 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h
@@ -1,19 +1,19 @@
 /** @file\r
-  This file declares Smm Gpi Smi Child Protocol.\r
+  This file declares the Smm Gpi Smi Child Protocol.\r
   \r
   The EFI_SMM_GPI_DISPATCH_PROTOCOL is defined in Framework of EFI SMM Core Interface Spec\r
   Version 0.9. It provides the ability to install child handlers for the given event types.\r
   Several inputs can be enabled. This purpose of this interface is to generate an\r
   SMI in response to any of these inputs having a true value provided.\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
 **/\r
 \r
@@ -54,10 +54,11 @@ typedef struct {
 /**\r
   Dispatch function for a GPI SMI handler.\r
 \r
-  @param  DispatchHandle        Handle of this dispatch function.\r
-  @param  DispatchContext       Pointer to the dispatch function's context.\r
-                                The DispatchContext fields are filled in by the dispatching driver prior to\r
-                                invoking this dispatch function.\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 by the \r
+                                dispatching driver prior to invoking this dispatch \r
+                                function.\r
 **/\r
 typedef\r
 VOID\r
@@ -69,17 +70,17 @@ VOID
 /**\r
   Register a child SMI source dispatch function with a parent SMM driver\r
 \r
-  @param  This                  Pointer to the EFI_SMM_GPI_DISPATCH_PROTOCOL instance.\r
+  @param  This                  The pointer to the EFI_SMM_GPI_DISPATCH_PROTOCOL instance.\r
   @param  DispatchFunction      Function to install.\r
-  @param  DispatchContext       Pointer to the dispatch function's context.\r
+  @param  DispatchContext       The pointer to the dispatch function's context.\r
                                 Indicates to the register\r
                                 function the GPI(s) for which the dispatch function\r
                                 should be invoked.\r
-  @param  DispatchHandle        Handle generated by the dispatcher to track the \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 was unable to enable the SMI source.\r
   @retval EFI_OUT_OF_RESOURCES  Not enough memory (system or SMM) to manage this\r
                                 child.\r
@@ -99,11 +100,11 @@ EFI_STATUS
 /**\r
   Unregisters a General Purpose Input (GPI) service.\r
 \r
-  @param  This                  Pointer to the EFI_SMM_GPI_DISPATCH_PROTOCOL instance.\r
-  @param  DispatchHandle        Handle of the service to remove.\r
+  @param  This                  The pointer to the EFI_SMM_GPI_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 DispatchHandle is invalid.\r