diff options
| author | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-07-04 08:04:10 +0000 |
|---|---|---|
| committer | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-07-04 08:04:10 +0000 |
| commit | b30312ba2985176709dbcd0aaab9804668720eed (patch) | |
| tree | e2e300e115599be87f99578432846f28e572ab2b /MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.h | |
| parent | 9359e53fcbdf72809f34d5141b642db91e6c9a18 (diff) | |
| download | edk2-platforms-b30312ba2985176709dbcd0aaab9804668720eed.tar.xz | |
Update the function headers to Doxygen format.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5410 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.h')
| -rw-r--r-- | MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.h | 58 |
1 files changed, 44 insertions, 14 deletions
diff --git a/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.h b/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.h index 696f574605..1b32084450 100644 --- a/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.h +++ b/MdeModulePkg/Universal/BdsDxe/BootMaint/BBSsupport.h @@ -19,6 +19,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. //
// Bugbug: Candidate for a PCD entries
//
+/**
+ EDES_TODO: Add function description
+
+ @param CurBBSEntry EDES_TODO: Add parameter description
+ @param Index EDES_TODO: Add parameter description
+ @param BufSize EDES_TODO: Add parameter description
+ @param BootString EDES_TODO: Add parameter description
+
+ @return EDES_TODO: Add description for return value
+
+**/
#define MAX_BBS_ENTRIES 0x100
VOID
@@ -29,38 +40,57 @@ BdsBuildLegacyDevNameString ( OUT CHAR16 *BootString
);
+/**
+ EDES_TODO: Add function description
+
+ @param VOID EDES_TODO: Add parameter description
+
+ @return EDES_TODO: Add description for return value
+
+**/
EFI_STATUS
BdsDeleteAllInvalidLegacyBootOptions (
VOID
);
-EFI_STATUS
-BdsAddNonExistingLegacyBootOptions (
- VOID
- )
-/*++
-
-Routine Description:
+/**
Add the legacy boot options from BBS table if they do not exist.
-Arguments:
-
- None.
-Returns:
+ @param VOID EDES_TODO: Add parameter description
- EFI_SUCCESS - The boot options are added successfully or they are already in boot options.
- others - An error occurred when creating legacy boot options.
+ @retval EFI_SUCCESS The boot options are added successfully or they are already in boot options.
+ @retval others An error occurred when creating legacy boot options.
---*/
+**/
+EFI_STATUS
+BdsAddNonExistingLegacyBootOptions (
+ VOID
+ )
;
+/**
+ EDES_TODO: Add function description
+
+ @param VOID EDES_TODO: Add parameter description
+
+ @return EDES_TODO: Add description for return value
+
+**/
EFI_STATUS
BdsUpdateLegacyDevOrder (
VOID
);
+/**
+ EDES_TODO: Add function description
+
+ @param Entry EDES_TODO: Add parameter description
+
+ @return EDES_TODO: Add description for return value
+
+**/
EFI_STATUS
BdsRefreshBbsTableForBoot (
IN BDS_COMMON_OPTION *Entry
|