Committing changes to the comments, after review with engineers.

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

diff --git a/IntelFrameworkPkg/Include/Protocol/BootScriptSave.h b/IntelFrameworkPkg/Include/Protocol/BootScriptSave.h
index 828cb8c46e8c6dc7cb89b9443b628b455d51572d..eb0c2925c1c83eb4a2322d46b2ad0b77ddb7d20a 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/BootScriptSave.h
+++ b/IntelFrameworkPkg/Include/Protocol/BootScriptSave.h
@@ -2,7 +2,7 @@
   This protocol is used to store or record various boot scripts into boot \r
   script tables.\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
@@ -16,18 +16,12 @@
 \r
 **/\r
 \r
-#ifndef _BOOT_SCRIPT_SAVE_PROTOCOL_H\r
-#define _BOOT_SCRIPT_SAVE_PROTOCOL_H\r
+#ifndef _BOOT_SCRIPT_SAVE_PROTOCOL_H_\r
+#define _BOOT_SCRIPT_SAVE_PROTOCOL_H_\r
 \r
-#include <PiDxe.h>\r
-//\r
-// To get the multiple phase definitions defined in Boot Script Specification\r
-//\r
-#include <Ppi/BootScriptExecuter.h>\r
-\r
-//\r
-// S3 Save Protocol GUID\r
-//\r
+///\r
+/// S3 Save Protocol GUID\r
+///\r
 #define EFI_BOOT_SCRIPT_SAVE_PROTOCOL_GUID \\r
   { \\r
     0x470e1529, 0xb79e, 0x4e32, {0xa0, 0xfe, 0x6a, 0x15, 0x6d, 0x29, 0xf9, 0xb2 } \\r
@@ -35,14 +29,11 @@
 \r
 typedef struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL EFI_BOOT_SCRIPT_SAVE_PROTOCOL;\r
 \r
-//\r
-// Protocol Member_Function\r
-//\r
 /**\r
   Adds a record into a specified Framework boot script table.\r
 \r
   @param  This                  A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.\r
-  @param  TableName             Name of the script table.Currently, the only meaningful\r
+  @param  TableName             Name of the script table. Currently, the only meaningful\r
                                 value is EFI_ACPI_S3_RESUME_SCRIPT_TABLE.\r
   @param  OpCode                The operation code (opcode) number.\r
   @param  ...                   Argument list that is specific to each opcode.\r
@@ -54,7 +45,7 @@ typedef struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL EFI_BOOT_SCRIPT_SAVE_PROTOCOL;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_BOOT_SCRIPT_WRITE) (\r
+(EFIAPI *EFI_BOOT_SCRIPT_WRITE)(\r
   IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL            *This,\r
   IN UINT16                                   TableName,\r
   IN UINT16                                   OpCode,\r
@@ -75,33 +66,21 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_BOOT_SCRIPT_CLOSE_TABLE) (\r
+(EFIAPI *EFI_BOOT_SCRIPT_CLOSE_TABLE)(\r
   IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL            *This,\r
   IN UINT16                                   TableName,\r
   OUT EFI_PHYSICAL_ADDRESS                    *Address\r
   );\r
 \r
-//\r
-// S3 Save Protocol data structure\r
-//\r
-/**\r
-  @par Protocol Description:\r
-  The EFI_BOOT_SCRIPT_SAVE_PROTOCOL publishes the Framework boot script abstractions\r
-  to store or record various boot scripts into boot script tables.\r
-\r
-  @param Write\r
-  Writes various boot scripts to a boot script table.\r
-\r
-  @param CloseTable\r
-  Retrieves and closes a script table.\r
-\r
-**/\r
+///\r
+/// The EFI_BOOT_SCRIPT_SAVE_PROTOCOL publishes the Framework boot script abstractions\r
+/// to store or record various boot scripts into boot script tables.\r
+///\r
 struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL {\r
-  EFI_BOOT_SCRIPT_WRITE       Write;\r
-  EFI_BOOT_SCRIPT_CLOSE_TABLE CloseTable;\r
+  EFI_BOOT_SCRIPT_WRITE        Write;      ///< Writes various boot scripts to a boot script table.\r
+  EFI_BOOT_SCRIPT_CLOSE_TABLE  CloseTable; ///< Retrieves and closes a script table.\r
 };\r
 \r
 extern EFI_GUID gEfiBootScriptSaveProtocolGuid;\r
 \r
 #endif\r
-\r