Code scrub for the Debug library, PostCode library, Print library, and ExtractGuidedS...

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

diff --git a/MdePkg/Include/Library/PostCodeLib.h b/MdePkg/Include/Library/PostCodeLib.h
index 5a80c561df16e0a083d3b5b7a1d32f161f91ff13..17ece49e4d03ead316b72d56321ee9a312680926 100644 (file)
--- a/MdePkg/Include/Library/PostCodeLib.h
+++ b/MdePkg/Include/Library/PostCodeLib.h
@@ -1,7 +1,7 @@
 /** @file\r
-  Report Status Code Library public .h file\r
+  Post Code Library functions defintion.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
@@ -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 any other 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  Value The 32-bit value to write to the POST card.\r
 \r
 **/\r
 UINT32\r
@@ -55,16 +55,16 @@ 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
-  immediately.\r
+  PostCodeWithDescription() is called while processing another any other \r
+  Post Code Library function, then PostCodeWithDescription() \r
+  must return Value immediately.\r
 \r
   @param  Value        The 32-bit value to write to the POST card.\r
   @param  Description  Pointer to an ASCII string that is a description of the \r
                        POST code value.  This is an optional parameter that may \r
                        be NULL.\r
 \r
-  @return  Value\r
+  @return  Value       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
@@ -122,7 +121,7 @@ PostCodeDescriptionEnabled (
 \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
@@ -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