From 6d95a228d85c5a805899f9cf8216f435c5e38442 Mon Sep 17 00:00:00 2001 From: Ulf Hermann Date: Mon, 16 Sep 2019 13:40:31 +0200 Subject: Re-add documentation for QtQml.WorkerScript It was lost when moving the classes and the import URI was wrong. Change-Id: Ic01f5c327ac53e58874f54399dc0434a23bed7b8 Reviewed-by: Simon Hausmann --- src/qmlworkerscript/doc/qtqmlworkerscript.qdocconf | 37 ++++++++++++++++++++++ src/qmlworkerscript/qmlworkerscript.pro | 2 ++ src/qmlworkerscript/qquickworkerscript.cpp | 2 +- 3 files changed, 40 insertions(+), 1 deletion(-) create mode 100644 src/qmlworkerscript/doc/qtqmlworkerscript.qdocconf diff --git a/src/qmlworkerscript/doc/qtqmlworkerscript.qdocconf b/src/qmlworkerscript/doc/qtqmlworkerscript.qdocconf new file mode 100644 index 0000000000..bb883cf39f --- /dev/null +++ b/src/qmlworkerscript/doc/qtqmlworkerscript.qdocconf @@ -0,0 +1,37 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) +include($QT_INSTALL_DOCS/config/exampleurl-qtdeclarative.qdocconf) + +project = QtQmlWorkerScript +description = Qt Qml WorkerScript Reference Documentation +version = $QT_VERSION +moduleheader = QtQmlWorkerScript +qhp.projects = QtQmlWorkerScript + +qhp.QtQmlWorkerScript.file = qtqmlworkerscript.qhp +qhp.QtQmlWorkerScript.namespace = org.qt-project.qtqmlworkerscript.$QT_VERSION_TAG +qhp.QtQmlWorkerScript.virtualFolder = qtqmlworkerscript +qhp.QtQmlWorkerScript.indexRoot = + +qhp.QtQmlWorkerScript.filterAttributes = qtqmlworkerscript $QT_VERSION qtrefdoc +qhp.QtQmlWorkerScript.customFilters.Qt.name = QtQmlWorkerScript $QT_VERSION +qhp.QtQmlWorkerScript.customFilters.Qt.filterAttributes = qtqmlworkerscript $QT_VERSION + +qhp.QtQmlWorkerScript.title = QML Types +qhp.QtQmlWorkerScript.indexTitle = Qt QML WorkerScript QML Types +qhp.QtQmlWorkerScript.selectors = qmlclass +qhp.QtQmlWorkerScript.sortPages = true + +tagfile = qtqmlworkerscript.tags + +depends += qtcore qtqml qtdoc + +headerdirs += .. + +sourcedirs += .. \ + ../../imports/workerscript + +exampledirs += ../../../examples/qml \ + ../ \ + snippets + +navigation.qmltypespage = "Qt Qml WorkerScript QML Types" diff --git a/src/qmlworkerscript/qmlworkerscript.pro b/src/qmlworkerscript/qmlworkerscript.pro index 908caa4ed4..9f5e0e809a 100644 --- a/src/qmlworkerscript/qmlworkerscript.pro +++ b/src/qmlworkerscript/qmlworkerscript.pro @@ -1,6 +1,8 @@ TARGET = QtQmlWorkerScript QT = core-private qml-private +QMAKE_DOCS = $$PWD/doc/qtqmlworkerscript.qdocconf + DEFINES += QT_NO_URL_CAST_FROM_STRING QT_NO_INTEGER_EVENT_COORDINATES QT_NO_FOREACH HEADERS += \ diff --git a/src/qmlworkerscript/qquickworkerscript.cpp b/src/qmlworkerscript/qquickworkerscript.cpp index 4da1def5f5..b93e297b61 100644 --- a/src/qmlworkerscript/qquickworkerscript.cpp +++ b/src/qmlworkerscript/qquickworkerscript.cpp @@ -441,7 +441,7 @@ void QQuickWorkerScriptEngine::run() \qmltype WorkerScript \instantiates QQuickWorkerScript \ingroup qtquick-threading - \inqmlmodule QtQml + \inqmlmodule QtQml.WorkerScript \brief Enables the use of threads in a Qt Quick application. Use WorkerScript to run operations in a new thread. -- cgit v1.2.3