Correct the structure's comments to follow doxygen format.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / BootScriptExecuter.h

diff --git a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
index a622381274e2a9bb48c748c8cacd329241e4e35c..bb6120b59d9d4dcb877ac8d3bd398d01e2d352d4 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
+++ b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
@@ -1,7 +1,14 @@
 /** @file\r
   This file declares Boot Script Executer PPI.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  This PPI is published by a PEIM upon dispatch and provides an execution engine for the\r
+  Framework boot script. This PEIM should be platform neutral and have no specific knowledge of\r
+  platform instructions and other information. The ability to interpret the boot script depends on the\r
+  abundance of other PPIs that are available. For example, if the script requests an SMBus command\r
+  execution, the PEIM looks for a relevant PPI that is available to execute it, rather than executing it\r
+  by issuing the native IA-32 instruction.\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
@@ -18,8 +25,10 @@
 \r
 **/\r
 \r
-#ifndef _PEI_BOOT_SCRIPT_EXECUTER_PPI_H\r
-#define _PEI_BOOT_SCRIPT_EXECUTER_PPI_H\r
+#ifndef _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_\r
+#define _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_\r
+\r
+#include <PiPei.h>\r
 \r
 #define EFI_ACPI_S3_RESUME_SCRIPT_TABLE               0x00\r
 \r
@@ -94,23 +103,18 @@ typedef struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI EFI_PEI_BOOT_SCRIPT_EXECUTER_PP
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_BOOT_SCRIPT_EXECUTE) (\r
+(EFIAPI *EFI_PEI_BOOT_SCRIPT_EXECUTE)(\r
   IN     EFI_PEI_SERVICES                        **PeiServices,\r
   IN     EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI        *This,\r
   IN     EFI_PHYSICAL_ADDRESS                    Address,\r
   IN     EFI_GUID                                *FvFile OPTIONAL\r
   );\r
 \r
-/**\r
-  @par Ppi Description:\r
-  This PPI produces functions to interpret and execute the Framework boot script table.\r
-\r
-  @param Execute\r
-  Executes a boot script table.\r
-\r
-**/\r
+///\r
+/// This PPI produces functions to interpret and execute the Framework boot script table.\r
+///\r
 struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI {\r
-  EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;\r
+  EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;  ///< Executes a boot script table.\r
 };\r
 \r
 extern EFI_GUID gEfiPeiBootScriptExecuterPpiGuid;\r