Refine include file for Device Recovery Module PPI.

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

diff --git a/IntelFrameworkPkg/Include/Protocol/BootScriptSave.h b/IntelFrameworkPkg/Include/Protocol/BootScriptSave.h
index 828cb8c46e8c6dc7cb89b9443b628b455d51572d..ebe2e1ea213c68f15109ff31373fda671e08da4f 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,8 +16,8 @@
 \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
@@ -54,7 +54,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,7 +75,7 @@ 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
@@ -85,20 +85,12 @@ EFI_STATUS
 // 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
 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