diff options
Diffstat (limited to 'src/compositor/doc/src/qtwaylandcompositor-cpp.qdoc')
| -rw-r--r-- | src/compositor/doc/src/qtwaylandcompositor-cpp.qdoc | 45 |
1 files changed, 11 insertions, 34 deletions
diff --git a/src/compositor/doc/src/qtwaylandcompositor-cpp.qdoc b/src/compositor/doc/src/qtwaylandcompositor-cpp.qdoc index c406b81e1..a61278d73 100644 --- a/src/compositor/doc/src/qtwaylandcompositor-cpp.qdoc +++ b/src/compositor/doc/src/qtwaylandcompositor-cpp.qdoc @@ -1,49 +1,26 @@ -/**************************************************************************** -** -** Copyright (C) 2017 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) 2017 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \module QtWaylandCompositor \title Qt Wayland Compositor C++ Classes \ingroup modules + \qtcmakepackage WaylandCompositor \qtvariable waylandcompositor \brief Provides C++ classes for writing custom Wayland display servers. - To include the definitions of the module's classes, use the following directive: + \section1 Using the Module - \code - #include <QtWaylandCompositor> - \endcode + \include {module-use.qdocinc} {using the c++ api} {WaylandCompositor} - To link against the module, add this line to your \l qmake \c .pro file: + \section2 Building with CMake - \code - QT += waylandcompositor - \endcode + \include {module-use.qdocinc} {building with cmake} {WaylandCompositor} + + \section2 Building with qmake + + \include {module-use.qdocinc} {building_with_qmake} {waylandcompositor} For more information about using these classes in your application, see the \l{Qt Wayland Compositor} documentation. |