Grammatical and disclaimer changes (does not follow internal C coding stds.)

[mirror_edk2.git] / MdePkg / Include / Protocol / Pcd.h

diff --git a/MdePkg/Include/Protocol/Pcd.h b/MdePkg/Include/Protocol/Pcd.h
index ba0ae06676e93e9ebad7a46dcbdb16f080781f4b..31b413301aa774f76f03027d2ca3c1e9511761f3 100644 (file)
--- a/MdePkg/Include/Protocol/Pcd.h
+++ b/MdePkg/Include/Protocol/Pcd.h
@@ -6,14 +6,14 @@
   The interfaces in dynamic type PCD do not require the token space guid as parameter,\r
   but interfaces in dynamic-ex type PCD require token space guid as parameter.\r
   \r
-  Copyright (c) 2006 - 2010, 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
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+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
@@ -364,7 +364,7 @@ UINTN
   @param[in]  TokenNumber The PCD token number. \r
   @param[in]  Value       The value to set for the PCD token.\r
 \r
-  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_SUCCESS  The procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
                                   being set was incompatible with a call to this function.  \r
                                   Use GetSize() to retrieve the size of the target data.\r
@@ -390,7 +390,7 @@ EFI_STATUS
   @param[in]  TokenNumber The PCD token number. \r
   @param[in]  Value       The value to set for the PCD token.\r
 \r
-  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_SUCCESS  The procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
                                   being set was incompatible with a call to this function.  \r
                                   Use GetSize() to retrieve the size of the target data.\r
@@ -416,7 +416,7 @@ EFI_STATUS
   @param[in]  TokenNumber The PCD token number. \r
   @param[in]  Value       The value to set for the PCD token.\r
 \r
-  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_SUCCESS  The procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
                                   being set was incompatible with a call to this function.  \r
                                   Use GetSize() to retrieve the size of the target data.\r
@@ -442,7 +442,7 @@ EFI_STATUS
   @param[in]  TokenNumber The PCD token number. \r
   @param[in]  Value       The value to set for the PCD token.\r
 \r
-  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_SUCCESS  The procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
                                   being set was incompatible with a call to this function.  \r
                                   Use GetSize() to retrieve the size of the target data.\r
@@ -472,7 +472,7 @@ EFI_STATUS
                                the maximum size supported for this TokenNumber.\r
   @param[in]      Buffer       The buffer to set for the PCD token.\r
 \r
-  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_SUCCESS  The procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
                                   being set was incompatible with a call to this function.  \r
                                   Use GetSize() to retrieve the size of the target data.\r
@@ -499,7 +499,7 @@ EFI_STATUS
   @param[in]  TokenNumber The PCD token number. \r
   @param[in]  Value       The value to set for the PCD token.\r
 \r
-  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_SUCCESS  The procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
                                   being set was incompatible with a call to this function.  \r
                                   Use GetSize() to retrieve the size of the target data.\r
@@ -526,7 +526,7 @@ EFI_STATUS
   @param[in]  TokenNumber The PCD token number. \r
   @param[in]  Value       The value to set for the PCD token.\r
 \r
-  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_SUCCESS  The procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
                                   being set was incompatible with a call to this function.  \r
                                   Use GetSize() to retrieve the size of the target data.\r
@@ -554,7 +554,7 @@ EFI_STATUS
   @param[in]  TokenNumber The PCD token number. \r
   @param[in]  Value       The value to set for the PCD token.\r
 \r
-  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_SUCCESS  The procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
                                   being set was incompatible with a call to this function.  \r
                                   Use GetSize() to retrieve the size of the target data.\r
@@ -582,7 +582,7 @@ EFI_STATUS
   @param[in]  TokenNumber The PCD token number. \r
   @param[in]  Value       The value to set for the PCD token.\r
 \r
-  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_SUCCESS  The procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
                                   being set was incompatible with a call to this function.  \r
                                   Use GetSize() to retrieve the size of the target data.\r
@@ -610,7 +610,7 @@ EFI_STATUS
   @param[in]  TokenNumber The PCD token number. \r
   @param[in]  Value       The value to set for the PCD token.\r
 \r
-  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_SUCCESS  The procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
                                   being set was incompatible with a call to this function.  \r
                                   Use GetSize() to retrieve the size of the target data.\r
@@ -642,7 +642,7 @@ EFI_STATUS
                               the maximum size supported for this TokenNumber.\r
   @param[in]  Buffer          The buffer to set for the PCD token.\r
 \r
-  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_SUCCESS  The procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
                                   being set was incompatible with a call to this function.  \r
                                   Use GetSize() to retrieve the size of the target data.\r
@@ -671,7 +671,7 @@ EFI_STATUS
   @param[in]  TokenNumber The PCD token number. \r
   @param[in]  Value       The value to set for the PCD token.\r
 \r
-  @retval EFI_SUCCESS  Procedure returned successfully.\r
+  @retval EFI_SUCCESS  The procedure returned successfully.\r
   @retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
                                   being set was incompatible with a call to this function.  \r
                                   Use GetSize() to retrieve the size of the target data.\r
@@ -766,7 +766,7 @@ EFI_STATUS
   Retrieves the next valid token number in a given namespace.  \r
   \r
   This is useful since the PCD infrastructure contains a sparse list of token numbers, \r
-  and one cannot a priori know what token numbers are valid in the database. \r
+  and one cannot know without examination or by deduction what token numbers are valid in the database. \r
   \r
   If TokenNumber is 0 and Guid is not NULL, then the first token from the token space specified by Guid is returned.  \r
   If TokenNumber is not 0 and Guid is not NULL, then the next token in the token space specified by Guid is returned.  \r
@@ -815,7 +815,7 @@ EFI_STATUS
                         EFI_SUCCESS. \r
 \r
   @retval EFI_SUCCESS  The PCD service retrieved the next valid token space Guid. \r
-                        Or the input token space Guid is already the last valid token space Guid \r
+                        Or, the input token space Guid is already the last valid token space Guid \r
                         in the PCD database. In the later case, *Guid is updated with the value of NULL.\r
   @retval EFI_NOT_FOUND If the input token namespace does not exist on the platform.\r
 \r