Doc: Clarified the use of qUncompress().

Task-number: QTBUG-16671

1 files changed, 5 insertions, 5 deletions

diff --git a/src/corelib/tools/qbytearray.cpp b/src/corelib/tools/qbytearray.cpp
index b1bac9d..568293d 100644
--- a/src/corelib/tools/qbytearray.cpp
+++ b/src/corelib/tools/qbytearray.cpp
@@ -492,7 +492,7 @@ QByteArray qCompress(const uchar* data, int nbytes, int compressionLevel)
 #endif
 
 /*!
-    \fn QByteArray qUncompress(const QByteArray& data)
+    \fn QByteArray qUncompress(const QByteArray &data)
 
     \relates QByteArray
 
@@ -506,10 +506,10 @@ QByteArray qCompress(const uchar* data, int nbytes, int compressionLevel)
     feature was added.
 
     \bold{Note:} If you want to use this function to uncompress external
-    data compressed using zlib, you first need to prepend four bytes to the
-    byte array that contain the expected length (as an unsigned integer)
-    of the uncompressed data encoded in big-endian order (most significant
-    byte first).
+    data that was compressed using zlib, you first need to prepend a four
+    byte header to the byte array containing the data. The header must
+    contain the expected length (in bytes) of the uncompressed data,
+    expressed as an unsigned, big-endian, 32-bit integer.
 
     \sa qCompress()
 */