Update the copyright notice format

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

diff --git a/MdePkg/Include/Library/PostCodeLib.h b/MdePkg/Include/Library/PostCodeLib.h
index 5a80c561df16e0a083d3b5b7a1d32f161f91ff13..9a7a9e6a9967962dad9c3d81b63662f1aac1ea87 100644 (file)
--- a/MdePkg/Include/Library/PostCodeLib.h
+++ b/MdePkg/Include/Library/PostCodeLib.h
@@ -1,14 +1,14 @@
 /** @file\r
-  Report Status Code Library public .h file\r
+  Provides services to send progress/error codes to a POST card.\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 - 2008, 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
 \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
 **/\r
 \r
@@ -19,7 +19,7 @@
 #define POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED  0x00000010\r
 \r
 /**\r
-  Sends an 32-bit value to a POST card.\r
+  Sends a 32-bit value to a POST card.\r
 \r
   Sends the 32-bit value specified by Value to a POST card, and returns Value.  \r
   Some implementations of this library function may perform I/O operations \r
@@ -28,12 +28,12 @@
   display the 32-bit value on the status reporting device.\r
   \r
   PostCode() must actively prevent recursion.  If PostCode() is called while \r
-  processing another any other Report Status Code Library function, then \r
+  processing another Post Code Library function, then \r
   PostCode() must return Value immediately.\r
 \r
   @param  Value  The 32-bit value to write to the POST card.\r
 \r
-  @return  Value\r
+  @return The 32-bit value to write to the POST card.\r
 \r
 **/\r
 UINT32\r
@@ -44,7 +44,7 @@ PostCode (
 \r
 \r
 /**\r
-  Sends an 32-bit value to a POST and associated ASCII string.\r
+  Sends a 32-bit value to a POST and associated ASCII string.\r
 \r
   Sends the 32-bit value specified by Value to a POST card, and returns Value.\r
   If Description is not NULL, then the ASCII string specified by Description is \r
@@ -55,8 +55,8 @@ PostCode (
   value on the status reporting device.  \r
 \r
   PostCodeWithDescription()must actively prevent recursion.  If \r
-  PostCodeWithDescription() is called while processing another any other Report \r
-  Status Code Library function, then PostCodeWithDescription() must return Value \r
+  PostCodeWithDescription() is called while processing another any other Post \r
+  Code Library function, then PostCodeWithDescription() must return Value \r
   immediately.\r
 \r
   @param  Value        The 32-bit value to write to the POST card.\r
@@ -64,7 +64,7 @@ PostCode (
                        POST code value.  This is an optional parameter that may \r
                        be NULL.\r
 \r
-  @return  Value\r
+  @return The 32-bit value to write to the POST card.\r
 \r
 **/\r
 UINT32\r
@@ -97,14 +97,13 @@ PostCodeEnabled (
 /**\r
   Returns TRUE if POST code descriptions are enabled.\r
 \r
-  This function returns TRUE if the \r
-  POST_CODE_PROPERTY_POST_CODE_ENABLED bit of \r
-  PcdPostCodePropertyMask is set.  Otherwise FALSE is returned.\r
+  This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED\r
+  bit of PcdPostCodePropertyMask is set.  Otherwise FALSE is returned.\r
 \r
-  @retval  TRUE   The POST_CODE_PROPERTY_POST_CODE_ENABLED \r
-                  bit of PcdPostCodeProperyMask is set.\r
-  @retval  FALSE  The POST_CODE_PROPERTY_POST_CODE_ENABLED \r
-                  bit of PcdPostCodeProperyMask is clear.\r
+  @retval  TRUE   The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of\r
+                  PcdPostCodeProperyMask is set.\r
+  @retval  FALSE  The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of\r
+                  PcdPostCodeProperyMask is clear.\r
 \r
 **/\r
 BOOLEAN\r
@@ -115,20 +114,20 @@ PostCodeDescriptionEnabled (
 \r
 \r
 /**\r
-  Sends an 32-bit value to a POST card.\r
+  Sends a 32-bit value to a POST card.\r
 \r
   If POST codes are enabled in PcdPostCodeProperyMask, then call PostCode() \r
   passing in Value.  Value is returned.\r
 \r
   @param  Value  The 32-bit value to write to the POST card.\r
 \r
-  @return  Value\r
+  @return  Value The 32-bit value to write to the POST card.\r
 \r
 **/\r
 #define POST_CODE(Value)  PostCodeEnabled() ? PostCode(Value) : Value\r
 \r
 /**\r
-  Sends an 32-bit value to a POST and associated ASCII string.\r
+  Sends a 32-bit value to a POST and associated ASCII string.\r
 \r
   If POST codes and POST code descriptions are enabled in \r
   PcdPostCodeProperyMask, then call PostCodeWithDescription() passing in \r
@@ -139,6 +138,7 @@ PostCodeDescriptionEnabled (
   @param  Description  Pointer to an ASCII string that is a description of the \r
                        POST code value.\r
 \r
+  @return Value        The 32-bit value to write to the POST card.\r
 **/\r
 #define POST_CODE_WITH_DESCRIPTION(Value,Description)  \\r
   PostCodeEnabled()                              ?     \\r