summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--src/sql/doc/src/qtsql.qdoc36
-rw-r--r--src/sql/kernel/qsql.qdoc2
-rw-r--r--src/sql/kernel/qsqldatabase.cpp2
3 files changed, 37 insertions, 3 deletions
diff --git a/src/sql/doc/src/qtsql.qdoc b/src/sql/doc/src/qtsql.qdoc
index 594a812bb9..a985c0fdd4 100644
--- a/src/sql/doc/src/qtsql.qdoc
+++ b/src/sql/doc/src/qtsql.qdoc
@@ -24,10 +24,44 @@
** $QT_END_LICENSE$
**
****************************************************************************/
+/*!
+ \page qtsql-index.html
+ \title Qt SQL
+ \brief A module that provides a driver layer, SQL API layer, and a user
+ interface layer for SQL databases.
+ \ingroup modules
+
+ Qt SQL is an essential module which provides support for SQL databases. Qt
+ SQL's APIs are divided into different layers:
+
+ \list
+ \li Driver layer
+ \li SQL API layer
+ \li User interface layer
+ \endlist
+ The \l{SQL Programming} guide contains information about development using
+ Qt SQL.
+
+ \section1 Getting Started
+ To enable Qt SQL in a project, add this directive into the C++ files:
+ \code
+ #include <QtSQL>
+ \endcode
+ To link against the Qt SQL module, add this line to the project file:
+ \code
+ QT += sql
+ \endcode
+
+ \section1 Reference
+ These are links to the API reference materials.
+ \list
+ \li \l{Qt SQL Module - C++ Classes}{C++ classes}
+ \endlist
+*/
/*!
\module QtSql
- \title Qt SQL Module
+ \title Qt SQL Module - C++ Classes
\ingroup modules
To include the definitions of the module's classes, use the
diff --git a/src/sql/kernel/qsql.qdoc b/src/sql/kernel/qsql.qdoc
index 6fbfc0415d..20ebb6d363 100644
--- a/src/sql/kernel/qsql.qdoc
+++ b/src/sql/kernel/qsql.qdoc
@@ -35,7 +35,7 @@
\ingroup database
- \sa {Qt SQL Module}
+ \sa {Qt SQL}
*/
/*!
diff --git a/src/sql/kernel/qsqldatabase.cpp b/src/sql/kernel/qsqldatabase.cpp
index 6dae39b9a2..f0fa5c735e 100644
--- a/src/sql/kernel/qsqldatabase.cpp
+++ b/src/sql/kernel/qsqldatabase.cpp
@@ -440,7 +440,7 @@ void QSqlDatabasePrivate::disable()
If you have created your own custom driver, you must register it
with registerSqlDriver().
- \sa QSqlDriver, QSqlQuery, {Qt SQL Module}, {Threads and the SQL Module}
+ \sa QSqlDriver, QSqlQuery, {Qt SQL}, {Threads and the SQL Module}
*/
/*! \fn QSqlDatabase QSqlDatabase::addDatabase(const QString &type, const QString &connectionName)