added function header

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

diff --git a/MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.c b/MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.c
index f130b207e5ebaf8238ebb720e9d13b2521c898a9..40d4f641a4cf449cb80fba15632e872da01df100 100644 (file)
--- a/MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.c
+++ b/MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.c
@@ -19,6 +19,18 @@
 EFI_DXE_SERVICES  *gDS      = NULL;\r
 \r
 /**\r
+  The constructor function caches the pointer of System Configuration Table.\r
+  \r
+  The constructor function caches the pointer of System Configuration Table. \r
+  It will ASSERT() if that operation fails.\r
+  It will ASSERT() if the pointer of System Configuration 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
 DxeServicesTableLibConstructor (\r