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 a81a0ad26fc5a53b9e2419fea18deb5361b49f2d..eb0c2925c1c83eb4a2322d46b2ad0b77ddb7d20a 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/BootScriptSave.h
+++ b/IntelFrameworkPkg/Include/Protocol/BootScriptSave.h
@@ -19,14 +19,9 @@
 #ifndef _BOOT_SCRIPT_SAVE_PROTOCOL_H_\r
 #define _BOOT_SCRIPT_SAVE_PROTOCOL_H_\r
 \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
@@ -34,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
@@ -80,19 +72,15 @@ EFI_STATUS
   OUT EFI_PHYSICAL_ADDRESS                    *Address\r
   );\r
 \r
-//\r
-// S3 Save Protocol data structure\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
+///\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;      ///< Writes various boot scripts to a boot script table.\r
-  EFI_BOOT_SCRIPT_CLOSE_TABLE CloseTable; ///< Retrieves and closes a script table.\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