added some comments in BaseLib
[mirror_edk2.git] / MdePkg / Include / Library / UefiBootServicesTableLib.h
index 73a2e39a5ddcc858924bd11dd963a0bf9f4f5783..df900a7eceeb4c95b09750fb69b5c741e71cf83b 100644 (file)
@@ -1,14 +1,14 @@
 /** @file\r
   Library that provides a global pointer to the UEFI Boot Services Tables\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
-  are licensed and made available under the terms and conditions of the BSD License         \r
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
+  Copyright (c) 2006, Intel Corporation\r
+  All rights reserved. This program and the accompanying materials\r
+  are licensed and made available under the terms and conditions of the BSD License\r
+  which accompanies this distribution.  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php\r
 \r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
   Module Name:  UefiBootServicesTableLib.h\r
 \r
 #define __UEFI_BOOT_SERVICES_TABLE_LIB_H__\r
 \r
 //\r
-//\r
+// Cache the Image Handle\r
 //\r
 extern EFI_HANDLE         gImageHandle;\r
+\r
+//\r
+// Cache pointer to the EFI System Table\r
+//\r
 extern EFI_SYSTEM_TABLE   *gST;\r
+\r
+//\r
+// Cache pointer to the EFI Boot Services Table\r
+//\r
 extern EFI_BOOT_SERVICES  *gBS;\r
 \r
 #endif\r