Doc: Improve description of QTextStream::readLine()

Don't recommend a common value for maxlen, because we don't really
know it. Soften a statement about not applying QString::trimmed()
to the result because it may contain surrounding spaces.

Change-Id: Ie90db6f033cfcc0dff0ef6796ba115028bcaaa77
Reviewed-by: David Faure <david.faure@kdab.com>
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com>
This commit is contained in:
Alexander Volkov 2015-01-20 16:21:05 +03:00
parent 473ad206c4
commit 97af289954

View File

@ -1550,11 +1550,10 @@ QString QTextStream::readAll()
the stream contains lines longer than this, then the lines will be the stream contains lines longer than this, then the lines will be
split after \a maxlen characters and returned in parts. split after \a maxlen characters and returned in parts.
If \a maxlen is 0, the lines can be of any length. A common value If \a maxlen is 0, the lines can be of any length.
for \a maxlen is 75.
The returned line has no trailing end-of-line characters ("\\n" The returned line has no trailing end-of-line characters ("\\n"
or "\\r\\n"), so calling QString::trimmed() is unnecessary. or "\\r\\n"), so calling QString::trimmed() can be unnecessary.
If the stream has read to the end of the file, \l {QTextStream::readLine()}{readLine()} If the stream has read to the end of the file, \l {QTextStream::readLine()}{readLine()}
will return a null QString. For strings, or for devices that support it, will return a null QString. For strings, or for devices that support it,