diff options
Diffstat (limited to 'src/core/doc/src/qt_webengine_add_convert_dictionary.qdoc')
| -rw-r--r-- | src/core/doc/src/qt_webengine_add_convert_dictionary.qdoc | 47 |
1 files changed, 13 insertions, 34 deletions
diff --git a/src/core/doc/src/qt_webengine_add_convert_dictionary.qdoc b/src/core/doc/src/qt_webengine_add_convert_dictionary.qdoc index cbb4a41fd..6af681cc5 100644 --- a/src/core/doc/src/qt_webengine_add_convert_dictionary.qdoc +++ b/src/core/doc/src/qt_webengine_add_convert_dictionary.qdoc @@ -1,39 +1,17 @@ -/**************************************************************************** -** -** Copyright (C) 2021 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) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page qt_add_webengine_dictionary.html -\ingroup cmake-commands +\page qt-add-webengine-dictionary.html +\ingroup cmake-commands-qtwebenginecore \title qt_add_webengine_dictionary -\target qt6_add_webengine_dictionary +\keyword qt6_add_webengine_dictionary \brief Converts the hunspell dictionary format into \e bdict binary format. +\cmakecommandsince 6.3 + \section1 Synopsis \badcode @@ -51,7 +29,7 @@ qt_add_webengine_dictionary( A spell checker in Qt Web Engine needs dictionaries in a specific binary format. This CMake command converts dictionaries from the \l{Hunspell project}. into the \c bdict - binary format. It creates a \c webengine_dictionaries target, which your project can + binary format. It creates a \c qtwebengine_dictionaries target, which your project can use as a dependency. This way your project can easily add dictionaries for the spell checker. Refer to the \l{WebEngine Widgets Spellchecker Example}{spell checker example} for more details. @@ -59,7 +37,7 @@ qt_add_webengine_dictionary( \section1 Arguments \c TARGET is an optinal argument and specifies the name of the application target that should - depend on \c webengine_dictionaries target. In other words it is used to define a build + depend on \c qtwebengine_dictionaries target. In other words it is used to define a build dependency to create the binary format of dictionaries before building \c TARGET. \c SOURCE is the absolute path to the \l{Hunspell project} dictionary for which @@ -69,7 +47,8 @@ qt_add_webengine_dictionary( of the dictionary will be created. If not specified, \c CMAKE_CURRENT_BINARY_DIR will be used as \c OUTPUT_DIRECTORY. - \note The \c webengine_dictionaries directory or \c <CONFIG>/webengine_dictionaries directories - in the case of the multi-config generator is appended to OUTPUT_DIRECTORY. This helps to - utilize dictionaries, as the \c webengine_dictionaries directory is the default search location. + \note The \c qtwebengine_dictionaries directory or \c <CONFIG>/qtwebengine_dictionaries + directories in the case of the multi-config generator is appended to OUTPUT_DIRECTORY. This + helps to utilize dictionaries, as the \c webengine_dictionaries directory is the default + search location. */ |