summaryrefslogtreecommitdiff
path: root/IntelFrameworkPkg/Include/Protocol/BootScriptSave.h
diff options
context:
space:
mode:
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2009-07-02 07:40:24 +0000
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2009-07-02 07:40:24 +0000
commit2bbaeb0d624f1d7758edd0a8d61322af209a1b1a (patch)
tree4e6161f7b624d87883fe7be6b53f4ff20203bb36 /IntelFrameworkPkg/Include/Protocol/BootScriptSave.h
parentd97286f4b36691776d0affe525387a9b56b6ba4f (diff)
downloadedk2-platforms-2bbaeb0d624f1d7758edd0a8d61322af209a1b1a.tar.xz
Correct the structure's comments to follow doxygen format.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8721 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'IntelFrameworkPkg/Include/Protocol/BootScriptSave.h')
-rw-r--r--IntelFrameworkPkg/Include/Protocol/BootScriptSave.h14
1 files changed, 3 insertions, 11 deletions
diff --git a/IntelFrameworkPkg/Include/Protocol/BootScriptSave.h b/IntelFrameworkPkg/Include/Protocol/BootScriptSave.h
index 7dd847022f..ebe2e1ea21 100644
--- 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
script tables.
- Copyright (c) 2007, Intel Corporation
+ Copyright (c) 2007 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -85,20 +85,12 @@ EFI_STATUS
// S3 Save Protocol data structure
//
/**
- @par Protocol Description:
The EFI_BOOT_SCRIPT_SAVE_PROTOCOL publishes the Framework boot script abstractions
to store or record various boot scripts into boot script tables.
-
- @param Write
- Writes various boot scripts to a boot script table.
-
- @param CloseTable
- Retrieves and closes a script table.
-
**/
struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL {
- EFI_BOOT_SCRIPT_WRITE Write;
- EFI_BOOT_SCRIPT_CLOSE_TABLE CloseTable;
+ EFI_BOOT_SCRIPT_WRITE Write; ///< Writes various boot scripts to a boot script table.
+ EFI_BOOT_SCRIPT_CLOSE_TABLE CloseTable; ///< Retrieves and closes a script table.
};
extern EFI_GUID gEfiBootScriptSaveProtocolGuid;