Code have been checked with spec

[mirror_edk2.git] / MdePkg / Include / Library / DxeServicesTableLib.h

diff --git a/MdePkg/Include/Library/DxeServicesTableLib.h b/MdePkg/Include/Library/DxeServicesTableLib.h
index f473a1721c94c62df2d296845d9681e36d4cf5e1..60b7da2936852c826adcd0aea8ab9724918b7edc 100644 (file)
--- a/MdePkg/Include/Library/DxeServicesTableLib.h
+++ b/MdePkg/Include/Library/DxeServicesTableLib.h
@@ -1,25 +1,33 @@
 /** @file\r
-       Library that provides a global pointer to the DXE Services Table\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
-\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:    DxeServicesTableLib.h\r
+  Provides a service to retrieve a pointer to the DXE Services Table.\r
+  Only available to DXE module types.\r
+  \r
+  This library does not contain any functions or macros.  It simply exports a global \r
+  pointer to the DXE Services Table as defined in the Platform Initialization Driver \r
+  Execution Environment Core Interface Specification.  The library constructor must \r
+  initialize this global pointer to the DX Services Table, so it is available at the\r
+  module's entry point.  Since there is overhead in looking up the pointer to the DXE \r
+  Services Table, only those modules that actually require access to the DXE Services \r
+  Table should use this library.  This will typically be DXE Drivers that require GCD \r
+  or Dispatcher services.\r
+   \r
+Copyright (c) 2006 - 2008, Intel Corporation<BR>\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
 \r
 **/\r
 \r
 #ifndef __DXE_SERVICES_TABLE_LIB_H__\r
 #define __DXE_SERVICES_TABLE_LIB_H__\r
 \r
-//\r
-//\r
-//\r
+///\r
+/// Cache copy of the DXE Services Table\r
+///\r
 extern EFI_DXE_SERVICES  *gDS;\r
 \r
 #endif\r