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/qsqldatabase.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/qsqldatabase.cpp')
-rw-r--r-- | src/sql/kernel/qsqldatabase.cpp | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/src/sql/kernel/qsqldatabase.cpp b/src/sql/kernel/qsqldatabase.cpp index 0ca79fd39f..b87a1fe1c5 100644 --- a/src/sql/kernel/qsqldatabase.cpp +++ b/src/sql/kernel/qsqldatabase.cpp @@ -454,7 +454,7 @@ void QSqlDatabasePrivate::disable() The database connection is referred to by \a connectionName. The newly added database connection is returned. - If \a type is not available or could not be loaded, isValid() returns false. + If \a type is not available or could not be loaded, isValid() returns \c false. If \a connectionName is not specified, the new connection becomes the default connection for the application, and subsequent calls @@ -620,8 +620,8 @@ void QSqlDatabase::registerSqlDriver(const QString& name, QSqlDriverCreatorBase /*! \threadsafe - Returns true if the list of database connections contains \a - connectionName; otherwise returns false. + Returns \c true if the list of database connections contains \a + connectionName; otherwise returns \c false. \sa connectionNames(), database(), {Threads and the SQL Module} */ @@ -826,7 +826,7 @@ QSqlQuery QSqlDatabase::exec(const QString & query) const /*! Opens the database connection using the current connection - values. Returns true on success; otherwise returns false. Error + values. Returns \c true on success; otherwise returns \c false. Error information can be retrieved using lastError(). \sa lastError(), setDatabaseName(), setUserName(), setPassword(), @@ -843,7 +843,7 @@ bool QSqlDatabase::open() \overload Opens the database connection using the given \a user name and \a - password. Returns true on success; otherwise returns false. Error + password. Returns \c true on success; otherwise returns \c false. Error information can be retrieved using the lastError() function. This function does not store the password it is given. Instead, @@ -876,8 +876,8 @@ void QSqlDatabase::close() } /*! - Returns true if the database connection is currently open; - otherwise returns false. + Returns \c true if the database connection is currently open; + otherwise returns \c false. */ bool QSqlDatabase::isOpen() const @@ -886,8 +886,8 @@ bool QSqlDatabase::isOpen() const } /*! - Returns true if there was an error opening the database - connection; otherwise returns false. Error information can be + Returns \c true if there was an error opening the database + connection; otherwise returns \c false. Error information can be retrieved using the lastError() function. */ @@ -1302,8 +1302,8 @@ QString QSqlDatabase::connectOptions() const } /*! - Returns true if a driver called \a name is available; otherwise - returns false. + Returns \c true if a driver called \a name is available; otherwise + returns \c false. \sa drivers() */ @@ -1418,7 +1418,7 @@ QSqlDatabase QSqlDatabase::addDatabase(QSqlDriver* driver, const QString& connec } /*! - Returns true if the QSqlDatabase has a valid driver. + Returns \c true if the QSqlDatabase has a valid driver. Example: \snippet code/src_sql_kernel_qsqldatabase.cpp 8 |