MdePkg/BasePrintLib: Refine the comment for AsciiValueToStringS API

The commit refines the comment description for PrintLib API
AsciiValueToStringS.

This API will not ASSERT when the input/output parameter 'Buffer' is not
aligned on a 16-bit boundary.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Hao Wu <hao.a.wu@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

diff --git a/MdePkg/Include/Library/PrintLib.h b/MdePkg/Include/Library/PrintLib.h
index 9fe36099808bdc9d256634e4b980c599eb859b76..80a4fd21d3b6d1ba1f2a5d9f5bfeef0bbab3d045 100644 (file)
--- a/MdePkg/Include/Library/PrintLib.h
+++ b/MdePkg/Include/Library/PrintLib.h
@@ -967,8 +967,7 @@ AsciiValueToString (
   sign character, '0' characters, digit characters for Value, and the\r
   Null-terminator add up to Width characters.\r
 \r
-  If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
-  If an error would be returned, then the function will also ASSERT().\r
+  If an error would be returned, then the function will ASSERT().\r
 \r
   @param  Buffer      The pointer to the output buffer for the produced\r
                       Null-terminated Ascii string.\r

diff --git a/MdePkg/Library/BasePrintLib/PrintLib.c b/MdePkg/Library/BasePrintLib/PrintLib.c
index 7453e952a76309f8426591bb4ab1f27f4d19facc..34793919f67a06520c00aedfce0ff67df3737c08 100644 (file)
--- a/MdePkg/Library/BasePrintLib/PrintLib.c
+++ b/MdePkg/Library/BasePrintLib/PrintLib.c
@@ -869,8 +869,7 @@ AsciiValueToString (
   sign character, '0' characters, digit characters for Value, and the\r
   Null-terminator add up to Width characters.\r
 \r
-  If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
-  If an error would be returned, then the function will also ASSERT().\r
+  If an error would be returned, then the function will ASSERT().\r
 \r
   @param  Buffer      The pointer to the output buffer for the produced\r
                       Null-terminated Ascii string.\r