diff options
Diffstat (limited to 'src/sql/doc/src/qtsql.qdoc')
| -rw-r--r-- | src/sql/doc/src/qtsql.qdoc | 103 |
1 files changed, 41 insertions, 62 deletions
diff --git a/src/sql/doc/src/qtsql.qdoc b/src/sql/doc/src/qtsql.qdoc index 39c0e44187..78acaf1fd0 100644 --- a/src/sql/doc/src/qtsql.qdoc +++ b/src/sql/doc/src/qtsql.qdoc @@ -1,37 +1,13 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \page qtsql-index.html \title Qt SQL \brief Provides a driver layer, SQL API layer, and a user interface layer for SQL databases - Qt SQL is an essential module which provides support for SQL databases. Qt - SQL's APIs are divided into different layers: + The Qt SQL module provides support for SQL databases. Qt SQL's APIs are + divided into different layers: \list \li Driver layer @@ -41,22 +17,45 @@ 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 Using the Module + + \include {module-use.qdocinc} {using the c++ api} + + \section2 Building with CMake + + \include {module-use.qdocinc} {building with cmake} {Sql} + + \section2 Building with qmake + + \include {module-use.qdocinc} {building_with_qmake} {sql} + + \section1 Articles and Guides + + \list + \li \l {SQL Programming} {Qt SQL Programming Guide} + \endlist + + \section1 Examples + + \list + \li \l {SQL Examples} + \endlist + + \section1 Reference + + \list + \li \l {Qt SQL C++ Classes} {C++ Classes} + \endlist + + \section1 Module Evolution + \l{Changes to Qt SQL} lists important changes in the module API + and functionality that were done for the Qt 6 series of Qt. \section1 Licenses and Attributions Qt SQL is available under commercial licenses from \l{The Qt Company}. - In addition, it is available under free software licenses. Since Qt 5.4, - these free software licenses are - \l{GNU Lesser General Public License, version 3}, or + In addition, it is available under free software licenses: + The \l{GNU Lesser General Public License, version 3}, or the \l{GNU General Public License, version 2}. See \l{Qt Licensing} for further details. @@ -64,36 +63,16 @@ modules under following permissive licenses: \generatelist{groupsbymodule attributions-qtsql} - - \section1 Related Information - - These are links to the API reference materials and related pages. - \list - \li \l{Qt SQL C++ Classes}{C++ Classes} - \li \l{SQL Examples} - \endlist */ /*! \module QtSql \title Qt SQL C++ Classes \ingroup modules + \qtcmakepackage Sql \qtvariable sql \brief Provides a driver layer, SQL API layer, and a user interface layer for SQL databases. - To include the definitions of the module's classes, use the - following directive: - - \snippet code/doc_src_qtsql.cpp 0 - - \if !defined(qtforpython) - To link against the module, add this line to your \l qmake \c - .pro file: - - \snippet code/doc_src_qtsql.pro 1 - \endif - - See the \l{SQL Programming} guide for information about using this - module in your applications. + The \l{Qt SQL} page contains information about how to use the module. */ |