From 4533cc994484a2308297e64e99af005fb4dca065 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 2 Oct 2013 16:51:05 +0200 Subject: Doc: Adding mark-up to boolean default values. Default values should have mark-up to denote that they are code. This commit changes: -"property is true" to "property is \c true". -"Returns true" to "Returns \c true". -"property is false" to "property is \c false". -"returns true" to "returns \c true". -"returns false" to "returns \c false". src/3rdparty and non-documentation instances were ignored. Task-number: QTBUG-33360 Change-Id: Ie87eaa57af947caa1230602b61c5c46292a4cf4e Reviewed-by: Oswald Buddenhagen Reviewed-by: Jerome Pasion --- src/corelib/io/qtextstream.cpp | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'src/corelib/io/qtextstream.cpp') diff --git a/src/corelib/io/qtextstream.cpp b/src/corelib/io/qtextstream.cpp index 8459cdd158..8188628f57 100644 --- a/src/corelib/io/qtextstream.cpp +++ b/src/corelib/io/qtextstream.cpp @@ -1085,8 +1085,8 @@ void QTextStream::flush() } /*! - Seeks to the position \a pos in the device. Returns true on - success; otherwise returns false. + Seeks to the position \a pos in the device. Returns \c true on + success; otherwise returns \c false. */ bool QTextStream::seek(qint64 pos) { @@ -1185,7 +1185,7 @@ qint64 QTextStream::pos() const character. Whitespace characters are all characters for which - QChar::isSpace() returns true. + QChar::isSpace() returns \c true. \sa operator>>() */ @@ -1517,8 +1517,8 @@ void QTextStream::setStatus(Status status) } /*! - Returns true if there is no more data to be read from the - QTextStream; otherwise returns false. This is similar to, but not + Returns \c true if there is no more data to be read from the + QTextStream; otherwise returns \c false. This is similar to, but not the same as calling QIODevice::atEnd(), as QTextStream also takes into account its internal Unicode buffer. */ @@ -2091,7 +2091,7 @@ QTextStream &QTextStream::operator>>(double &f) /*! Reads a word from the stream and stores it in \a str, then returns a reference to the stream. Words are separated by whitespace - (i.e., all characters for which QChar::isSpace() returns true). + (i.e., all characters for which QChar::isSpace() returns \c true). Leading whitespace is skipped. */ @@ -2943,8 +2943,8 @@ void QTextStream::setAutoDetectUnicode(bool enabled) } /*! - Returns true if automatic Unicode detection is enabled, otherwise - returns false. Automatic Unicode detection is enabled by default. + Returns \c true if automatic Unicode detection is enabled, otherwise + returns \c false. Automatic Unicode detection is enabled by default. \sa setAutoDetectUnicode(), setCodec() */ @@ -2974,8 +2974,8 @@ void QTextStream::setGenerateByteOrderMark(bool generate) } /*! - Returns true if QTextStream is set to generate the UTF BOM (Byte Order - Mark) when using a UTF codec; otherwise returns false. UTF BOM generation is + Returns \c true if QTextStream is set to generate the UTF BOM (Byte Order + Mark) when using a UTF codec; otherwise returns \c false. UTF BOM generation is set to false by default. \sa setGenerateByteOrderMark() -- cgit v1.2.3