added function header

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

diff --git a/MdePkg/Library/UefiRuntimeServicesTableLib/UefiRuntimeServicesTableLib.c b/MdePkg/Library/UefiRuntimeServicesTableLib/UefiRuntimeServicesTableLib.c
index ac4b3ebfbfdb22c37bd66d3bcd4adf136f53c3b0..bd996ba8b565e5a7fbb76afbd521633dd4573ed8 100644 (file)
--- a/MdePkg/Library/UefiRuntimeServicesTableLib/UefiRuntimeServicesTableLib.c
+++ b/MdePkg/Library/UefiRuntimeServicesTableLib/UefiRuntimeServicesTableLib.c
@@ -20,6 +20,17 @@
 EFI_RUNTIME_SERVICES  *gRT = NULL;\r
 \r
 /**\r
+  The constructor function caches the pointer of Runtime Services Table.\r
+  \r
+  The constructor function caches the pointer of Runtime Services Table. \r
+  It will ASSERT() if the pointer of Runtime 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
 UefiRuntimeServicesTableLibConstructor (\r