diff options
author | Jerome Pasion <jerome.pasion@digia.com> | 2013-10-02 16:51:05 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-10-08 00:46:27 +0200 |
commit | 4533cc994484a2308297e64e99af005fb4dca065 (patch) | |
tree | bc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/sql/kernel/qsqlresult.cpp | |
parent | 50dd0232b61d8ea3fb9aab18972c6e19678656e6 (diff) |
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 <oswald.buddenhagen@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/sql/kernel/qsqlresult.cpp')
-rw-r--r-- | src/sql/kernel/qsqlresult.cpp | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/src/sql/kernel/qsqlresult.cpp b/src/sql/kernel/qsqlresult.cpp index e3203f983c..953e2ca66e 100644 --- a/src/sql/kernel/qsqlresult.cpp +++ b/src/sql/kernel/qsqlresult.cpp @@ -289,9 +289,9 @@ int QSqlResult::at() const /*! - Returns true if the result is positioned on a valid record (that + Returns \c true if the result is positioned on a valid record (that is, the result is not positioned before the first or after the - last record); otherwise returns false. + last record); otherwise returns \c false. \sa at() */ @@ -305,13 +305,13 @@ bool QSqlResult::isValid() const /*! \fn bool QSqlResult::isNull(int index) - Returns true if the field at position \a index in the current row - is null; otherwise returns false. + Returns \c true if the field at position \a index in the current row + is null; otherwise returns \c false. */ /*! - Returns true if the result has records to be retrieved; otherwise - returns false. + Returns \c true if the result has records to be retrieved; otherwise + returns \c false. */ bool QSqlResult::isActive() const @@ -350,8 +350,8 @@ void QSqlResult::setSelect(bool select) } /*! - Returns true if the current result is from a \c SELECT statement; - otherwise returns false. + Returns \c true if the current result is from a \c SELECT statement; + otherwise returns \c false. \sa setSelect() */ @@ -538,8 +538,8 @@ bool QSqlResult::fetchPrevious() } /*! - Returns true if you can only scroll forward through the result - set; otherwise returns false. + Returns \c true if you can only scroll forward through the result + set; otherwise returns \c false. \sa setForwardOnly() */ @@ -573,8 +573,8 @@ void QSqlResult::setForwardOnly(bool forward) /*! Prepares the given \a query, using the underlying database - functionality where possible. Returns true if the query is - prepared successfully; otherwise returns false. + functionality where possible. Returns \c true if the query is + prepared successfully; otherwise returns \c false. Note: This method should have been called "safePrepare()". @@ -602,7 +602,7 @@ bool QSqlResult::savePrepare(const QString& query) /*! Prepares the given \a query for execution; the query will normally use placeholders so that it can be executed repeatedly. Returns - true if the query is prepared successfully; otherwise returns false. + true if the query is prepared successfully; otherwise returns \c false. \sa exec() */ @@ -860,8 +860,8 @@ QString QSqlResult::boundValueName(int index) const } /*! - Returns true if at least one of the query's bound values is a \c - QSql::Out or a QSql::InOut; otherwise returns false. + Returns \c true if at least one of the query's bound values is a \c + QSql::Out or a QSql::InOut; otherwise returns \c false. \sa bindValueType() */ |