Add limitation clarification for usage of AsmPrepareThunk16(), AsmThunk16(), AsmPrepa...

[mirror_edk2.git] / MdePkg / Library / BaseLib / Ia32 / ReadGs.c

diff --git a/MdePkg/Library/BaseLib/Ia32/ReadGs.c b/MdePkg/Library/BaseLib/Ia32/ReadGs.c
index df495a0ff9b54806191c59d462b524a7cb5e3e0a..9995bcb16e03794e34d81784eec93c88b720aa70 100644 (file)
--- a/MdePkg/Library/BaseLib/Ia32/ReadGs.c
+++ b/MdePkg/Library/BaseLib/Ia32/ReadGs.c
@@ -1,7 +1,7 @@
 /** @file\r
   AsmReadGs function\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation<BR>\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
@@ -12,11 +12,18 @@
 \r
 **/\r
 \r
-//\r
-// Include common header file for this module.\r
-//\r
 \r
 \r
+\r
+/**\r
+  Reads the current value of GS Data Segment Register (GS).\r
+\r
+  Reads and returns the current value of GS. This function is only available on\r
+  IA-32 and x64.\r
+\r
+  @return The current value of GS.\r
+\r
+**/\r
 UINT16\r
 EFIAPI\r
 AsmReadGs (\r