From 6ca46b63d200fdbc939959d18d31936c1c48b4d9 Mon Sep 17 00:00:00 2001 From: qwang12 Date: Mon, 14 Jul 2008 05:30:21 +0000 Subject: Clean up ExtendedHiiLib, HiiLib, IfrSupportLib, ExtendedIfrSupportLib for Doxygen comments requirement. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5459 6f19259b-4bc3-4df7-8a09-765794883524 --- .../Library/ExtendedHiiLib/ExtendedHiiLib.c | 24 ++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'MdeModulePkg/Library/ExtendedHiiLib') diff --git a/MdeModulePkg/Library/ExtendedHiiLib/ExtendedHiiLib.c b/MdeModulePkg/Library/ExtendedHiiLib/ExtendedHiiLib.c index 1b13da7937..bfaf49e4b1 100644 --- a/MdeModulePkg/Library/ExtendedHiiLib/ExtendedHiiLib.c +++ b/MdeModulePkg/Library/ExtendedHiiLib/ExtendedHiiLib.c @@ -51,7 +51,21 @@ HII_VENDOR_DEVICE_PATH mHiiVendorDevicePathTemplate = { } }; +/** + The HII driver handle passed in for HiiDatabase.NewPackageList() requires + that there should be DevicePath Protocol installed on it. + This routine create a virtual Driver Handle by installing a vendor device + path on it, so as to use it to invoke HiiDatabase.NewPackageList(). + The Device Path created is a Vendor Device Path specific to Intel's implemenation + and it is defined as HII_VENDOR_DEVICE_PATH_NODE. + + @param DriverHandle Handle to be returned + + @retval EFI_SUCCESS Handle destroy success. + @retval EFI_OUT_OF_RESOURCES Not enough memory. + +**/ EFI_STATUS EFIAPI HiiLibCreateHiiDriverHandle ( @@ -85,6 +99,16 @@ HiiLibCreateHiiDriverHandle ( } +/** + Destroy the Driver Handle created by CreateHiiDriverHandle(). + + If no Device Path protocol is installed on the DriverHandle, then ASSERT. + If this Device Path protocol is failed to be uninstalled, then ASSERT. + + @param DriverHandle Handle returned by CreateHiiDriverHandle() + + +**/ VOID EFIAPI HiiLibDestroyHiiDriverHandle ( -- cgit v1.2.3