added function header

[mirror_edk2.git] / MdePkg / Library / UefiBootServicesTableLib / UefiBootServicesTableLib.c

diff --git a/MdePkg/Library/UefiBootServicesTableLib/UefiBootServicesTableLib.c b/MdePkg/Library/UefiBootServicesTableLib/UefiBootServicesTableLib.c
index aa990f7fdfd38d4811e79ec0fc297ccd482a2c7e..b45d12debfa0cf0edb189c81d8e64e49a2740ef7 100644 (file)
--- a/MdePkg/Library/UefiBootServicesTableLib/UefiBootServicesTableLib.c
+++ b/MdePkg/Library/UefiBootServicesTableLib/UefiBootServicesTableLib.c
@@ -19,6 +19,18 @@ EFI_SYSTEM_TABLE   *gST;
 EFI_BOOT_SERVICES  *gBS;\r
 \r
 /**\r
+  The constructor function caches the pointer of Boot Services Table.\r
+  \r
+  The constructor function caches the pointer of Boot Services Table through System Table. \r
+  It will ASSERT() if the pointer of System Table is NULL.\r
+  It will ASSERT() if the pointer of Boot Services Table is NULL.\r
+  It will always return EFI_SUCCESS.\r
+\r
+  @param  ImageHandle   The firmware allocated handle for the EFI image.\r
+  @param  SystemTable   A pointer to the EFI System Table.\r
+  \r
+  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
+\r
 **/\r
 EFI_STATUS\r
 UefiBootServicesTableLibConstructor (\r