summaryrefslogtreecommitdiffstats
path: root/src/sql/doc
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@nokia.com>2012-08-06 12:21:48 +0200
committerQt by Nokia <qt-info@nokia.com>2012-08-06 16:04:25 +0200
commit195663260cd00aa8b5a907cd802d9be343d6f34a (patch)
tree8f8c18eead6fc25ca2a91748f293e6835d447b86 /src/sql/doc
parentefdc35b680f2700b0326f10708337ff52ddcc143 (diff)
Doc: Adding a landing page for Qt SQL.
-Simple landing page which contains a link to the SQL guide and API. -Gave a new title to C++ API page. Change-Id: I54eca4f6933bafa0affd5825e7fe2e1a2522dad0 Reviewed-by: Geir Vattekar <geir.vattekar@nokia.com>
Diffstat (limited to 'src/sql/doc')
-rw-r--r--src/sql/doc/src/qtsql.qdoc36
1 files changed, 35 insertions, 1 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