Move generic IA32_SEGMENT_DESCRIPTOR definition to BaseLib.h.

[mirror_edk2.git] / MdePkg / Library / BasePcdLibNull / PcdLib.c

diff --git a/MdePkg/Library/BasePcdLibNull/PcdLib.c b/MdePkg/Library/BasePcdLibNull/PcdLib.c
index 6ad91b8cdbae327005ade294e77cc45c21762529..4823f5ad6716da6fe006632e76e2b27f490ffd01 100644 (file)
--- a/MdePkg/Library/BasePcdLibNull/PcdLib.c
+++ b/MdePkg/Library/BasePcdLibNull/PcdLib.c
@@ -1,11 +1,11 @@
 /** @file\r
   A emptry template implementation of PCD Library.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  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
+  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
@@ -209,7 +209,7 @@ LibPcdGetSize (
   \r
   If Guid is NULL, then ASSERT(). \r
 \r
-  @param[in]  Guid Pointer to a 128-bit unique value that designates \r
+  @param[in]  Guid The pointer to a 128-bit unique value that designates \r
               which namespace to retrieve a value from.\r
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
 \r
@@ -237,7 +237,7 @@ LibPcdGetEx8 (
   \r
   If Guid is NULL, then ASSERT(). \r
 \r
-  @param[in]  Guid Pointer to a 128-bit unique value that designates \r
+  @param[in]  Guid The pointer to a 128-bit unique value that designates \r
               which namespace to retrieve a value from.\r
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
 \r
@@ -262,7 +262,7 @@ LibPcdGetEx16 (
   Returns the 32-bit value for the token specified by TokenNumber and Guid.\r
   If Guid is NULL, then ASSERT(). \r
 \r
-  @param[in]  Guid Pointer to a 128-bit unique value that designates \r
+  @param[in]  Guid The pointer to a 128-bit unique value that designates \r
               which namespace to retrieve a value from.\r
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
 \r
@@ -290,7 +290,7 @@ LibPcdGetEx32 (
   \r
   If Guid is NULL, then ASSERT(). \r
 \r
-  @param[in]  Guid          Pointer to a 128-bit unique value that designates \r
+  @param[in]  Guid          The pointer to a 128-bit unique value that designates \r
                             which namespace to retrieve a value from.\r
   @param[in]  TokenNumber   The PCD token number to retrieve a current value for.\r
 \r
@@ -318,7 +318,7 @@ LibPcdGetEx64 (
   \r
   If Guid is NULL, then ASSERT(). \r
 \r
-  @param[in]  Guid          Pointer to a 128-bit unique value that designates \r
+  @param[in]  Guid          The pointer to a 128-bit unique value that designates \r
                             which namespace to retrieve a value from.\r
   @param[in]  TokenNumber   The PCD token number to retrieve a current value for.\r
 \r
@@ -346,7 +346,7 @@ LibPcdGetExPtr (
   \r
   If Guid is NULL, then ASSERT(). \r
 \r
-  @param[in]  Guid          Pointer to a 128-bit unique value that designates \r
+  @param[in]  Guid          The pointer to a 128-bit unique value that designates \r
                             which namespace to retrieve a value from.\r
   @param[in]  TokenNumber   The PCD token number to retrieve a current value for.\r
 \r
@@ -374,7 +374,7 @@ LibPcdGetExBool (
   \r
   If Guid is NULL, then ASSERT(). \r
 \r
-  @param[in]  Guid          Pointer to a 128-bit unique value that designates \r
+  @param[in]  Guid          The pointer to a 128-bit unique value that designates \r
                             which namespace to retrieve a value from.\r
   @param[in]  TokenNumber   The PCD token number to retrieve a current value for.\r
 \r
@@ -404,7 +404,7 @@ LibPcdGetExSize (
   @param[in]  TokenNumber   The PCD token number to set a current value for.\r
   @param[in]  Value         The 8-bit value to set.\r
 \r
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT8\r
@@ -430,7 +430,7 @@ LibPcdSet8 (
   @param[in]  TokenNumber   The PCD token number to set a current value for.\r
   @param[in]  Value         The 16-bit value to set.\r
 \r
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT16\r
@@ -456,7 +456,7 @@ LibPcdSet16 (
   @param[in]  TokenNumber   The PCD token number to set a current value for.\r
   @param[in]  Value         The 32-bit value to set.\r
 \r
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT32\r
@@ -482,7 +482,7 @@ LibPcdSet32 (
   @param[in]  TokenNumber   The PCD token number to set a current value for.\r
   @param[in]  Value         The 64-bit value to set.\r
 \r
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT64\r
@@ -545,7 +545,7 @@ LibPcdSetPtr (
   @param[in]  TokenNumber   The PCD token number to set a current value for.\r
   @param[in]  Value         The boolean value to set.\r
 \r
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 BOOLEAN\r
@@ -570,12 +570,12 @@ LibPcdSetBool (
   \r
   If Guid is NULL, then ASSERT().\r
   \r
-  @param[in]  Guid          Pointer to a 128-bit unique value that \r
+  @param[in]  Guid          The pointer to a 128-bit unique value that \r
                             designates which namespace to set a value from.\r
   @param[in]  TokenNumber   The PCD token number to set a current value for.\r
   @param[in]  Value         The 8-bit value to set.\r
 \r
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT8\r
@@ -601,12 +601,12 @@ LibPcdSetEx8 (
   \r
   If Guid is NULL, then ASSERT().\r
   \r
-  @param[in]  Guid          Pointer to a 128-bit unique value that \r
+  @param[in]  Guid          The pointer to a 128-bit unique value that \r
                             designates which namespace to set a value from.\r
   @param[in]  TokenNumber   The PCD token number to set a current value for.\r
   @param[in]  Value         The 16-bit value to set.\r
 \r
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT16\r
@@ -632,12 +632,12 @@ LibPcdSetEx16 (
   \r
   If Guid is NULL, then ASSERT().\r
   \r
-  @param[in]  Guid          Pointer to a 128-bit unique value that \r
+  @param[in]  Guid          The pointer to a 128-bit unique value that \r
                             designates which namespace to set a value from.\r
   @param[in]  TokenNumber   The PCD token number to set a current value for.\r
   @param[in]  Value         The 32-bit value to set.\r
 \r
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT32\r
@@ -662,12 +662,12 @@ LibPcdSetEx32 (
   Guid to the value specified by Value. Value is returned.\r
   If Guid is NULL, then ASSERT().\r
   \r
-  @param[in]  Guid          Pointer to a 128-bit unique value that \r
+  @param[in]  Guid          The pointer to a 128-bit unique value that \r
                             designates which namespace to set a value from.\r
   @param[in]  TokenNumber   The PCD token number to set a current value for.\r
   @param[in]  Value         The 64-bit value to set.\r
 \r
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT64\r
@@ -698,7 +698,7 @@ LibPcdSetEx64 (
   If SizeOfBuffer is NULL, then ASSERT().\r
   If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
   \r
-  @param[in]  Guid              Pointer to a 128-bit unique value that \r
+  @param[in]  Guid              The pointer to a 128-bit unique value that \r
                                 designates which namespace to set a value from.\r
   @param[in]  TokenNumber       The PCD token number to set a current value for.\r
   @param[in, out] SizeOfBuffer  The size, in bytes, of Buffer.\r
@@ -731,12 +731,12 @@ LibPcdSetExPtr (
   \r
   If Guid is NULL, then ASSERT().\r
   \r
-  @param[in]  Guid          Pointer to a 128-bit unique value that \r
+  @param[in]  Guid          The pointer to a 128-bit unique value that \r
                             designates which namespace to set a value from.\r
   @param[in]  TokenNumber   The PCD token number to set a current value for.\r
   @param[in]  Value         The Boolean value to set.\r
 \r
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 BOOLEAN\r
@@ -763,7 +763,7 @@ LibPcdSetExBool (
   \r
   If NotificationFunction is NULL, then ASSERT().\r
 \r
-  @param[in]  Guid      Pointer to a 128-bit unique value that designates which \r
+  @param[in]  Guid      The pointer to a 128-bit unique value that designates which \r
                         namespace to set a value from.  If NULL, then the default \r
                         token space is used.\r
   @param[in]  TokenNumber   The PCD token number to monitor.\r
@@ -822,7 +822,7 @@ LibPcdCancelCallback (
   \r
   If TokenNumber is not 0 and is not in the token space specified by Guid, then ASSERT().\r
 \r
-  @param[in]  Guid        Pointer to a 128-bit unique value that designates which namespace \r
+  @param[in]  Guid        The pointer to a 128-bit unique value that designates which namespace \r
                           to set a value from.  If NULL, then the default token space is used.\r
   @param[in]  TokenNumber The previous PCD token number.  If 0, then retrieves the first PCD \r
                           token number.\r
@@ -847,18 +847,12 @@ LibPcdGetNextToken (
 /**\r
   Used to retrieve the list of available PCD token space GUIDs.\r
   \r
-  Retrieves the next PCD token space from a token space specified by Guid.\r
-  Guid of NULL is reserved to mark the default local token namespace on the current\r
-  platform. If Guid is NULL, then the GUID of the first non-local token space of the \r
-  current platform is returned. If Guid is the last non-local token space, \r
-  then NULL is returned. \r
-\r
-  If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().\r
-\r
-\r
+  Returns the PCD token space GUID that follows TokenSpaceGuid in the list of token spaces\r
+  in the platform.\r
+  If TokenSpaceGuid is NULL, then a pointer to the first PCD token spaces returned.\r
+  If TokenSpaceGuid is the last PCD token space GUID in the list, then NULL is returned.\r
   \r
-  @param[in]  Guid  Pointer to a 128-bit unique value that designates from which namespace \r
-                    to start the search.\r
+  @param  TokenSpaceGuid  The pointer to a PCD token space GUID.\r
 \r
   @return The next valid token namespace.\r
 \r
@@ -895,7 +889,7 @@ LibPcdGetNextTokenSpace (
   @param[in, out] SizeOfBuffer  A pointer to the size, in bytes, of Buffer.\r
   @param[in] Buffer             A pointer to the buffer to used to set the target variable.\r
   \r
-  @return Return the pointer to the buffer been set.\r
+  @return Return the pointer to the buffer that was set.\r
 \r
 **/\r
 VOID *\r