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/qsqlfield.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/qsqlfield.cpp')
| -rw-r--r-- | src/sql/kernel/qsqlfield.cpp | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/src/sql/kernel/qsqlfield.cpp b/src/sql/kernel/qsqlfield.cpp index a0ce4068fc5..c3c80cad610 100644 --- a/src/sql/kernel/qsqlfield.cpp +++ b/src/sql/kernel/qsqlfield.cpp @@ -190,12 +190,12 @@ QSqlField& QSqlField::operator=(const QSqlField& other) /*! \fn bool QSqlField::operator!=(const QSqlField &other) const - Returns true if the field is unequal to \a other; otherwise returns + Returns \c true if the field is unequal to \a other; otherwise returns false. */ /*! - Returns true if the field is equal to \a other; otherwise returns + Returns \c true if the field is equal to \a other; otherwise returns false. */ bool QSqlField::operator==(const QSqlField& other) const @@ -299,7 +299,7 @@ void QSqlField::setGenerated(bool gen) /*! Sets the value of the field to \a value. If the field is read-only - (isReadOnly() returns true), nothing happens. + (isReadOnly() returns \c true), nothing happens. If the data type of \a value differs from the field's current data type, an attempt is made to cast it to the proper type. This @@ -403,7 +403,7 @@ void QSqlField::setType(QVariant::Type type) /*! - Returns true if the field's value is read-only; otherwise returns + Returns \c true if the field's value is read-only; otherwise returns false. \sa setReadOnly(), type(), requiredStatus(), length(), precision(), @@ -413,7 +413,7 @@ bool QSqlField::isReadOnly() const { return d->ro; } /*! - Returns true if the field's value is NULL; otherwise returns + Returns \c true if the field's value is NULL; otherwise returns false. \sa value() @@ -429,7 +429,7 @@ void QSqlField::detach() } /*! - Returns true if this is a required field; otherwise returns false. + Returns \c true if this is a required field; otherwise returns \c false. An \c INSERT will fail if a required field does not have a value. \sa setRequiredStatus(), type(), length(), precision(), defaultValue(), @@ -494,7 +494,7 @@ int QSqlField::typeID() const } /*! - Returns true if the field is generated; otherwise returns + Returns \c true if the field is generated; otherwise returns false. \sa setGenerated(), type(), requiredStatus(), length(), precision(), @@ -506,8 +506,8 @@ bool QSqlField::isGenerated() const } /*! - Returns true if the field's variant type is valid; otherwise - returns false. + Returns \c true if the field's variant type is valid; otherwise + returns \c false. */ bool QSqlField::isValid() const { @@ -536,7 +536,7 @@ QDebug operator<<(QDebug dbg, const QSqlField &f) #endif /*! - Returns true if the value is auto-generated by the database, + Returns \c true if the value is auto-generated by the database, for example auto-increment primary key values. \sa setAutoValue() |