diff options
author | Topi Reinio <topi.reinio@qt.io> | 2018-04-26 12:18:54 +0200 |
---|---|---|
committer | Jani Heikkinen <jani.heikkinen@qt.io> | 2018-04-27 11:23:01 +0000 |
commit | 8a69cec9bbabe57e738d8a92b700352389d7625e (patch) | |
tree | 1ebe7699aad596d8c529f865fdeb98c07cefc1e1 | |
parent | 77cc6211e853ec2b6deb4d07a3ef6e8907318376 (diff) |
Doc: Fix documentation issues
- Add dependency to qtqmltest
- Remove dependencies to obsolete documentation modules
- Fix linking to WorkerScript QML type
- Drop mention of deprecated/removed Active Qt example (Web Browser)
- Fix conflicting page titles for 'Qt for VxWorks'
- Update status of Qt Network Auth, Qt Speech from preview to
add-ons.
Task-number: QTBUG-67980
Change-Id: Iae75cecd5cbac095a699abfa6ceef68337f67e12
Reviewed-by: Martin Smith <martin.smith@qt.io>
-rw-r--r-- | doc/config/qtdoc.qdocconf | 7 | ||||
-rw-r--r-- | doc/src/frameworks-technologies/threads.qdoc | 19 | ||||
-rw-r--r-- | doc/src/getting-started/examples.qdoc | 1 | ||||
-rw-r--r-- | doc/src/platforms/platform-notes-rtos.qdoc | 15 | ||||
-rw-r--r-- | doc/src/platforms/vxworks.qdoc | 2 | ||||
-rw-r--r-- | doc/src/qmlapp/applicationdevelopers.qdoc | 2 | ||||
-rw-r--r-- | doc/src/qtmodules.qdoc | 14 | ||||
-rw-r--r-- | doc/src/testing.qdoc | 2 | ||||
-rw-r--r-- | doc/src/whatsnew/whatsnew510.qdoc | 2 | ||||
-rw-r--r-- | doc/src/whatsnew/whatsnew59.qdoc | 2 |
10 files changed, 28 insertions, 38 deletions
diff --git a/doc/config/qtdoc.qdocconf b/doc/config/qtdoc.qdocconf index 40e327a38..8e3cc1517 100644 --- a/doc/config/qtdoc.qdocconf +++ b/doc/config/qtdoc.qdocconf @@ -20,9 +20,6 @@ depends += \ qtcore \ qtdbus \ qtdesigner \ - qtenginio \ - qtenginiooverview \ - qtenginioqml \ qtgamepad \ qtgraphicaleffects \ qthelp \ @@ -39,11 +36,11 @@ depends += \ qtpositioning \ qtprintsupport \ qtqml \ + qtqmltest \ qtquick \ qtquickcontrols \ qtquickdialogs \ qtquickextras \ - qtquicklayouts \ qtscript \ qtscripttools \ qtscxml \ @@ -59,8 +56,6 @@ depends += \ qtwebsockets \ qtwidgets \ qtwinextras \ - qtwebkit \ - qtwebkitexamples \ qtx11extras \ qtxml \ qtxmlpatterns \ diff --git a/doc/src/frameworks-technologies/threads.qdoc b/doc/src/frameworks-technologies/threads.qdoc index 4b264f52a..2ba3e03c8 100644 --- a/doc/src/frameworks-technologies/threads.qdoc +++ b/doc/src/frameworks-technologies/threads.qdoc @@ -183,10 +183,12 @@ thread. Each WorkerScript instance can have one \c{.js} script attached to it. When - WorkerScript::sendMessage() is called, the script will run in a separate thread - (and a separate \l{QQmlContext}{QML context}). When the script finishes - running, it can send a reply back to the GUI thread which will invoke the - WorkerScript::onMessage() signal handler. + \l {QtQml::WorkerScript::sendMessage()}{WorkerScript.sendMessage}() is + called, the script will run in a separate thread (and a separate + \l{QQmlContext}{QML context}). When the script finishes running, it can + send a reply back to the GUI thread which will invoke the + \l {QtQml::WorkerScript::message()}{WorkerScript.onMessage}() signal + handler. Using a WorkerScript is similar to using a worker QObject that has been moved to another thread. Data is transferred between threads via signals. @@ -306,10 +308,11 @@ \li Perfrom a long computation in a pure QML application, and update the GUI when the results are ready. \li Place the computation code in a \c{.js} script and attach it to a - WorkerScript instance. Call \l{WorkerScript::}{sendMessage()} to start the - computation in a new thread. Let the script call WorkerScript::sendMessage() - too, to pass the result back to the GUI thread. Handle the result in - \c onMessage and update the GUI there. + WorkerScript instance. Call + \l{QtQml::WorkerScript::sendMessage()}{WorkerScript.sendMessage}() + to start the computation in a new thread. Let the script call + sendMessage() too, to pass the result back to the GUI thread. + Handle the result in \c onMessage and update the GUI there. \row \li Permanent \li Have an object living in another thread that can perform different diff --git a/doc/src/getting-started/examples.qdoc b/doc/src/getting-started/examples.qdoc index 6f49d5660..8d81ad5a8 100644 --- a/doc/src/getting-started/examples.qdoc +++ b/doc/src/getting-started/examples.qdoc @@ -313,7 +313,6 @@ \li \l{activeqt/opengl}{OpenGL}\raisedaster \li \l{activeqt/qutlook}{Qutlook}\raisedaster \li \l{activeqt/simple}{Simple}\raisedaster - \li \l{activeqt/webbrowser}{Web Browser}\raisedaster \li \l{activeqt/wrapper}{Wrapper}\raisedaster \endlist */ diff --git a/doc/src/platforms/platform-notes-rtos.qdoc b/doc/src/platforms/platform-notes-rtos.qdoc index 2ca9d651a..c8f366533 100644 --- a/doc/src/platforms/platform-notes-rtos.qdoc +++ b/doc/src/platforms/platform-notes-rtos.qdoc @@ -26,21 +26,6 @@ ****************************************************************************/ /*! - \page platform-notes-vxworks.html - \title Qt for VxWorks - \contentspage Platform and Compiler Notes - \keyword VxWorks - \ingroup supportedplatform - \brief Platform support for VxWorks (under a commercial license). - - \l {ext: Qt for VxWorks}{Qt for VxWorks} is available only under a - commercial license. - - Please contact Qt sales to find out more: - \l http://www.qt.io/contact-us/ -*/ - -/*! \page platform-notes-qnx.html \title Platform and Compiler Notes - QNX \contentspage Platform and Compiler Notes diff --git a/doc/src/platforms/vxworks.qdoc b/doc/src/platforms/vxworks.qdoc index 2cea90e32..e7fc75de5 100644 --- a/doc/src/platforms/vxworks.qdoc +++ b/doc/src/platforms/vxworks.qdoc @@ -28,6 +28,8 @@ /*! \page vxworks.html \title Qt for VxWorks + \keyword VxWorks + \ingroup supportedplatform Qt for VxWorks is available only under a commercial license. diff --git a/doc/src/qmlapp/applicationdevelopers.qdoc b/doc/src/qmlapp/applicationdevelopers.qdoc index 148b68e9c..7a97e5325 100644 --- a/doc/src/qmlapp/applicationdevelopers.qdoc +++ b/doc/src/qmlapp/applicationdevelopers.qdoc @@ -200,7 +200,7 @@ QML code is used in applications. \list \li \l{qtquick-qmlscene.html}{Prototyping with qmlscene} \li \l{qtquick-debugging.html}{Debugging QML Applications} - \li \l{qtquick-qtquicktest.html}{Qt Quick Test: QML Unit Testing Framework} + \li \l{Qt Quick Test}{Qt Quick Test: QML Unit Testing Framework} \endlist \endlist diff --git a/doc/src/qtmodules.qdoc b/doc/src/qtmodules.qdoc index dd54bad23..e230d42f4 100644 --- a/doc/src/qtmodules.qdoc +++ b/doc/src/qtmodules.qdoc @@ -209,6 +209,11 @@ \li \l{Qt for macOS}{\macos} \li Provides platform-specific APIs for \macos. \row + \li \l[QtNetworkAuth]{Qt Network Authorization} + \li All + \li All + \li Provides support for OAuth-based authorization to online services. + \row \li \l[QtNfc]{Qt NFC} \li All \li \l{Qt for Android}{Android} and \l{Qt for Linux/X11}{Linux} @@ -293,6 +298,11 @@ \li \l{Qt for Windows}{Windows}, \l{Qt for Linux/X11}{Linux}, and \l{Qt for macOS}{\macos}. \li Provides access to hardware and virtual serial ports. \row + \li \l[QtSpeech]{Qt Speech} + \li All + \li + \li Provides support for accessibility features such as text-to-speech. + \row \li \l[QtSvg]{Qt SVG} \li All \li @@ -408,10 +418,6 @@ \header \li Module \li Description - \row \li \l{Qt Network Authorization} - \li Provides support for OAuth-based authorization to online services. - \row \li \l{Qt Speech} - \li Provides support for accessibility features such as text-to-speech. \row \li \l{Qt Remote Objects} \li Provides an easy to use mechanism for sharing a QObject's API (Properties/Signals/Slots) between processes or devices. diff --git a/doc/src/testing.qdoc b/doc/src/testing.qdoc index 660e3e7ae..d66725b6c 100644 --- a/doc/src/testing.qdoc +++ b/doc/src/testing.qdoc @@ -41,7 +41,7 @@ functions, or whole libraries. \list \li \l {Qt Test Overview}{Qt Test} (also known as \e testlib) - a framework for unit tests of C++ code -\li \l {Qt Quick Test Reference Documentation}{Qt Quick Test} - a framework for unit tests of QML code +\li \l {Qt Quick Test} - a framework for unit tests of QML code \endlist \section2 Autotests diff --git a/doc/src/whatsnew/whatsnew510.qdoc b/doc/src/whatsnew/whatsnew510.qdoc index 74ce9d000..8cef78dd8 100644 --- a/doc/src/whatsnew/whatsnew510.qdoc +++ b/doc/src/whatsnew/whatsnew510.qdoc @@ -197,7 +197,7 @@ \section1 New Modules \list - \li \l {Qt Network Authentication} - Provides support for OAuth1 and OAuth2. + \li \l {Qt Network Authorization} - Provides support for OAuth1 and OAuth2. \li \l {Qt Speech} - Enables text-to-speech in Qt Applications. \endlist diff --git a/doc/src/whatsnew/whatsnew59.qdoc b/doc/src/whatsnew/whatsnew59.qdoc index 29ccad60f..2c5af3b4d 100644 --- a/doc/src/whatsnew/whatsnew59.qdoc +++ b/doc/src/whatsnew/whatsnew59.qdoc @@ -138,7 +138,7 @@ entity based on distance from the observer or size on the screen. It comes with a convenience loader class that loads different QML files. - \li Made the \l Mesh type plugin based. It comes with plugins for the + \li Made the Mesh type plugin based. It comes with plugins for the Wavefront OBJ, PLY and FBX formats and makes it easy to add other formats. \li Added distance field based 2D textured text that can be freely |