From f18f55b4397cf4890339e29822b67e3df07ae6e4 Mon Sep 17 00:00:00 2001 From: Friedemann Kleint Date: Thu, 8 Jan 2015 12:31:03 +0100 Subject: Update documentation on ANGLE. Task-number: QTBUG-43263 Change-Id: I10ca5c565406b3ba7fefabc03542c98f8f6693fb Reviewed-by: Leena Miettinen Reviewed-by: Laszlo Agocs --- doc/src/platforms/windows.qdoc | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/doc/src/platforms/windows.qdoc b/doc/src/platforms/windows.qdoc index f844022b..0b998b80 100644 --- a/doc/src/platforms/windows.qdoc +++ b/doc/src/platforms/windows.qdoc @@ -123,10 +123,10 @@ application folder or by adding the \e bin folder of the ICU installation to the \c PATH environment variable. - \li \l{ANGLE}: This library converts - OpenGL ES 2.0 API calls to DirectX 9, removing the need to install - graphics drivers on the target machines. Building - the library requires the installation of the \l{Direct X SDK}. + \li \l{ANGLE}: This library converts OpenGL ES 2.0 API calls to DirectX 11 or DirectX 9 + calls (depending on availability), removing the need to install graphics drivers on + the target machines. + Building the library requires the installation of the \l{Direct X SDK}. More information is available at \l{http://code.google.com/p/angleproject/wiki/DevSetup} \note When building for 64-bit environments, de-activate the @@ -170,8 +170,14 @@ higher is required. The default driver from Windows is OpenGL 1.1. Qt includes a version of the \l{ANGLE} project which is included from the Windows Qt installers. ANGLE implements the - OpenGL ES 2.0 API on top of DirectX 9. ANGLE requires that the DirectX SDK - is installed when building Qt. + OpenGL ES 2.0 API on top of DirectX 11 or DirectX 9. + ANGLE requires that the DirectX SDK is installed when building Qt. + + ANGLE chooses the render backend depending on availability. DirectX 11 + is usually preferable. However, some graphics cards may not fully + support it. For these cases, the environment variable \c QT_ANGLE_PLATFORM + (introduced in Qt 5.4) can be used to control the render backend. Possible + values are \c d3d11, \c d3d9 and \c warp. To use a custom version of ANGLE, set the \c ANGLE_DIR environment variable to point to the ANGLE source tree before building Qt. -- cgit v1.2.1 From 32e5c8ab9e887b579a64d0d57863b1f33719ec96 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Mon, 5 Jan 2015 09:56:12 +0100 Subject: Doc: Fix incorrect link to container classes on 'Core Internals' page Use the module name for the link command to link to the list of container classes under Qt Core. Task-number: QTBUG-43622 Change-Id: I1f55f1a19a36a5250a9d8c6d08116685c07d6e36 Reviewed-by: Martin Smith Reviewed-by: Nico Vertriest --- doc/src/core.qdoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/src/core.qdoc b/doc/src/core.qdoc index c1fb708a..d712a0a2 100644 --- a/doc/src/core.qdoc +++ b/doc/src/core.qdoc @@ -70,7 +70,8 @@ objects. Some examples of containers are: dynamic arrays, queues, linked lists, and associative arrays. Qt provides a set of general purpose, template-based container classes for structuring data in memory. -See the full list of \l {Container Classes} for more details. +See the full list of \l [QtCore]{The Container Classes}{Container Classes} for +more details. \section1 Internationalization -- cgit v1.2.1 From 6429da6efd2b5d95ea2c993251e1180e93d618e4 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Mon, 8 Dec 2014 18:16:05 +0100 Subject: Doc: Mention Value-Add and Tech Preview modules Discuss and link to the modules that are not part of the Qt release in - All Qt Modules page - Qt Reference Pages listing Change-Id: I88b40aadca92c0df6a60e51550f280f9189031a6 Reviewed-by: Leena Miettinen --- doc/src/external-resources.qdoc | 50 +++++++++++++++++++++++++++++++++++++++++ doc/src/qtmodules.qdoc | 50 +++++++++++++++++++++++++++++++++++++++++ doc/src/reference.qdoc | 13 +++++++++++ 3 files changed, 113 insertions(+) diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc index e9263745..19878927 100644 --- a/doc/src/external-resources.qdoc +++ b/doc/src/external-resources.qdoc @@ -222,3 +222,53 @@ \externalpage https://codereview.qt-project.org/#/admin/projects/qt/qtftp \title Qt FTP */ + +/*! + \externalpage http://doc.qt.io/QtDataVisualization + \title Qt Data Visualization +*/ + +/*! + \externalpage http://doc.qt.io/QtQuickEnterpriseControls + \title Qt Quick Enterprise Controls +*/ + +/*! + \externalpage http://doc.qt.io/QtVirtualKeyboard + \title Qt Virtual Keyboard +*/ + +/*! + \externalpage http://doc.qt.io/QtCharts + \title Qt Charts +*/ + +/*! + \externalpage http://doc.qt.io/QtQuickCompiler + \title Qt Quick Compiler +*/ + +/*! + \externalpage http://doc.qt.io/QtForDeviceCreation + \title Qt for Device Creation +*/ + +/*! + \externalpage http://doc.qt.io/QtQuick2DRenderer + \title Qt Quick 2D Renderer +*/ + +/*! + \externalpage http://doc.qt.io/QtPurchasing + \title Qt Purchasing +*/ + +/*! + \externalpage http://doc.qt.io/qt-5/qtwebview-index.html + \title Qt WebView +*/ + +/*! + \externalpage http://doc.qt.io/qt-5/qtcanvas3d-index.html + \title Qt Canvas 3D +*/ diff --git a/doc/src/qtmodules.qdoc b/doc/src/qtmodules.qdoc index 9de4576a..aa4701e0 100644 --- a/doc/src/qtmodules.qdoc +++ b/doc/src/qtmodules.qdoc @@ -290,6 +290,56 @@ \li Support for XPath, XQuery, XSLT and XML schema validation. \endtable + \section1 Value-Add Modules + + In addition to the modules released as part of Qt 5, the following modules + and tooling build on top of the Qt libraries to provide additional value. They + have their own release schedule, and are available under different Qt licenses. + See the \l {Downloads} page for more information. + + \table 80% + \header + \li Feature + \li Description + + \row \li \l{Qt for Device Creation} + \li Tools for fast, easy, and fully-integrated embedded device application development. + Includes most other Value-Add features. + \row \li \l{Qt Charts} + \li UI Components for displaying visually pleasing charts, driven by static or dynamic + data models. + \row \li \l{Qt Quick Compiler} + \li Enables compiling .qml source files into application binaries, improving load times + and security for code assets. + \row \li \l{Qt Quick Enterprise Controls} + \li A set of advanced UI controls with an industry-specific look-and-feel. + \row \li \l{Qt Data Visualization} + \li UI Components for creating stunning 3D data visualizations. + \row \li \l{Qt Purchasing} + \li Enables in-app purchase of products in Qt applications on mobile platforms. + \row \li \l{Qt Virtual Keyboard} + \li A framework for implementing different input methods as well as a QML virtual keyboard. + Supports localized keyboard layouts and custom visual themes. + \row \li \l{Qt Quick 2D Renderer} + \li Enables the use of Qt Quick UI on devices without OpenGL capability. + \endtable + + \section1 Technology Preview Modules + + The following modules are still in development but are available as technology previews. + + \table 80% + \header + \li Module + \li Description + + \row \li \l{Qt WebView} + \li Displays web content in a QML application by using APIs native to the platform, + without the need to include a full web browser stack. + \row \li \l{Qt Canvas 3D} + \li Enables OpenGL-like 3D drawing calls from Qt Quick applications using JavaScript. + \endtable + \section1 Qt Tools \e{Qt Tools} run on all the supported development platforms and facilitate diff --git a/doc/src/reference.qdoc b/doc/src/reference.qdoc index f96dfbde..9671a86b 100644 --- a/doc/src/reference.qdoc +++ b/doc/src/reference.qdoc @@ -52,6 +52,19 @@ \li \l{qmake Manual}{qmake} \endlist + \section2 Value-Add Features + + \list + \li \l{Qt for Device Creation} + \li \l{Qt Charts} + \li \l{Qt Quick Compiler} + \li \l{Qt Quick Enterprise Controls} + \li \l{Qt Data Visualization} + \li \l{Qt Purchasing} + \li \l{Qt Virtual Keyboard} + \li \l{Qt Quick 2D Renderer} + \endlist + \section2 Platform Reference \annotatedlist supportedplatform -- cgit v1.2.1 From f2b0ed69b0ee1debd2d21164e235ffb881c479de Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Tue, 23 Dec 2014 14:43:55 +0100 Subject: Doc: corrected link errors qtdoc Change-Id: I557a2f7c71f98457f0c8a1a6c2a6e3a46f975e74 Task-number: QTBUG-43537 Reviewed-by: Martin Smith --- doc/snippets/qmlapp/usecases/styling.qml | 3 ++- doc/src/external-resources.qdoc | 2 +- doc/src/internationalization/i18n.qdoc | 7 +++---- doc/src/legal/3rdparty.qdoc | 2 +- doc/src/platforms/android.qdoc | 2 +- doc/src/platforms/platform-notes-android.qdoc | 2 +- doc/src/qmlapp/glossary.qdoc | 10 ++++------ doc/src/qmlapp/usecases/layouts.qdoc | 2 +- doc/src/qt5-intro.qdoc | 2 +- doc/src/scripting.qdoc | 2 +- doc/src/source-breaks.qdoc | 4 ++-- 11 files changed, 18 insertions(+), 20 deletions(-) diff --git a/doc/snippets/qmlapp/usecases/styling.qml b/doc/snippets/qmlapp/usecases/styling.qml index 45ce780a..848c8df8 100644 --- a/doc/snippets/qmlapp/usecases/styling.qml +++ b/doc/snippets/qmlapp/usecases/styling.qml @@ -60,6 +60,7 @@ ApplicationWindow { GradientStop { position: 1 ; color: control.pressed ? "#000" : "#fff" } } } - } + } //![0] + } } diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc index 19878927..f0c832e4 100644 --- a/doc/src/external-resources.qdoc +++ b/doc/src/external-resources.qdoc @@ -57,7 +57,7 @@ /*! \externalpage http://www.gnu.org/licenses/gpl.html - \title GNU General Public License + \title GNU General Public License (GPL) */ /*! diff --git a/doc/src/internationalization/i18n.qdoc b/doc/src/internationalization/i18n.qdoc index 6ab8185f..71a444d0 100644 --- a/doc/src/internationalization/i18n.qdoc +++ b/doc/src/internationalization/i18n.qdoc @@ -151,10 +151,9 @@ and Qt Quick's Text item). Support for these writing systems is transparent to the - programmer and completely encapsulated in \l{rich text - processing}{Qt's text engine}. This means that you don't need to - have any knowledge about the writing system used in a particular - language, except for the following small points: + programmer and completely encapsulated in \l{Rich Text Processing}{Qt's text engine}. + This means that you don't need to have any knowledge about the writing + system used in a particular language, except for the following small points: \list diff --git a/doc/src/legal/3rdparty.qdoc b/doc/src/legal/3rdparty.qdoc index b86d8556..78f8142a 100644 --- a/doc/src/legal/3rdparty.qdoc +++ b/doc/src/legal/3rdparty.qdoc @@ -468,7 +468,7 @@ and related or neighboring rights to the source code. http://creativecommons.org/publicdomain/zero/1.0/ - \section1 SQLite (sqlite) version 3.7.17.0 + \section1 SQLite (sqlite) version 3.8.5.0 \e{SQLite is a small C library that implements a self-contained, embeddable, zero-configuration SQL database engine.} diff --git a/doc/src/platforms/android.qdoc b/doc/src/platforms/android.qdoc index de85d027..ac0f0510 100644 --- a/doc/src/platforms/android.qdoc +++ b/doc/src/platforms/android.qdoc @@ -320,7 +320,7 @@ the APK: \note You must consider enabling/disabling the SSL features based on the legal restrictions in the region where your application is available. - See the \l{SSL Configure Options}{SSL configure options} for details about + See the \l{OpenSSL Configure Options}{SSL configure options} for details about the configurable features. \li Run \c{make build_libs} to build the \c libcrypto and \c libssl shared diff --git a/doc/src/platforms/platform-notes-android.qdoc b/doc/src/platforms/platform-notes-android.qdoc index 2a9a23d6..c6c6ce2b 100644 --- a/doc/src/platforms/platform-notes-android.qdoc +++ b/doc/src/platforms/platform-notes-android.qdoc @@ -164,7 +164,7 @@ you can use \c QPixmap("assets:/images/logo.png"). If using the assets mechanism is not required for your app, the recommended way of distributing - resources with your Qt app is to use \l{the Qt Resource System}, which is a cross-platform mechanism + resources with your Qt app is to use \l{The Qt Resource System}, which is a cross-platform mechanism for distributing resources with your app. \section1 Supported Architectures diff --git a/doc/src/qmlapp/glossary.qdoc b/doc/src/qmlapp/glossary.qdoc index 460493de..db82da19 100644 --- a/doc/src/qmlapp/glossary.qdoc +++ b/doc/src/qmlapp/glossary.qdoc @@ -56,12 +56,10 @@ The QML language provides a number of built in (\l{qtqml-typesystem-basictypes.html}{basic types}), and the - Qt Quick module provides various \l{qtquick-qmltypereference.html} - {Qt Quick types} for building QML applications. Types can also be - provided by third-party developers through - (\l{qtqml-modules-topic.html}{modules}) or by the application - developer in the application itself through - \l{qtqml-documents-definetypes.html}{QML Documents}. + Qt Quick module provides various \l {Qt Quick QML Types}{Qt Quick types} + for building QML applications. Types can also be provided by + third-party developers through (\l{qtqml-modules-topic.html}{modules}) or by the application + developer in the application itself through \l{qtqml-documents-definetypes.html}{QML Documents}. See \l{qtqml-typesystem-topic.html}{The QML Type System} for more details. diff --git a/doc/src/qmlapp/usecases/layouts.qdoc b/doc/src/qmlapp/usecases/layouts.qdoc index cd51b86f..dd50f87f 100644 --- a/doc/src/qmlapp/usecases/layouts.qdoc +++ b/doc/src/qmlapp/usecases/layouts.qdoc @@ -69,7 +69,7 @@ For the common case of wanting to \e position a set of types in a regular patter types. Items placed in a positioner are automatically positioned in some way; for example, a \l Row positions items to be horizontally adjacent (forming a row). -For full details see \l {Item Positioners} and the documentation for \l{qtquick-qmltypereference.html#positioning}{the positioner types}. +For full details see \l {Item Positioners} and the documentation for \l{Qt Positioning QML Types}{the positioner types}. \snippet qmlapp/usecases/layouts.qml import \snippet qmlapp/usecases/layouts.qml positioners diff --git a/doc/src/qt5-intro.qdoc b/doc/src/qt5-intro.qdoc index ceb6d399..de8d9009 100644 --- a/doc/src/qt5-intro.qdoc +++ b/doc/src/qt5-intro.qdoc @@ -283,7 +283,7 @@ module interact with the Qt Cloud servers from Digia. \list - \li \l{Enginio Data Storage}{Qt Cloud Services} by Digia + \li \l{Qt Cloud Services} by Digia \li \l{Enginio Manual}{Enginio} - API for developers \endlist diff --git a/doc/src/scripting.qdoc b/doc/src/scripting.qdoc index c6f5a915..26e1fb60 100644 --- a/doc/src/scripting.qdoc +++ b/doc/src/scripting.qdoc @@ -53,5 +53,5 @@ This is a simple API, very similar to \l{Qt Script}, but limited to basic functi (\l{Use Case - Integrating JavaScript in QML}). All of these three scripting solutions seamlessly inter-operate with \l{The Meta-Object System}{the Meta-Object System}, which means that all \l{Signals & Slots}{signals and slots} and -\l{The property system}{properties} of a QObject instance are accessible in an \l{ECMAScript Reference}{ECMAScript} environment. +\l{The Property System}{properties} of a QObject instance are accessible in an \l{ECMAScript Reference}{ECMAScript} environment. */ diff --git a/doc/src/source-breaks.qdoc b/doc/src/source-breaks.qdoc index c366cfc5..9fbd079d 100644 --- a/doc/src/source-breaks.qdoc +++ b/doc/src/source-breaks.qdoc @@ -721,7 +721,7 @@ recommendations for handling those changes. \li \c{QTest::qt_snprintf()} is removed. This was an internal test library function that was exposed in the public API due to its use in a public macro. Any calls to this function must be replaced with - \l{QByteArray::qsnprintf()}. + \l{qbytearray-qsnprintf()}{QByteArray::qsnprintf()}. \li c{QTest::pixmapsAreEqual()} is removed. Comparison of \l{QPixmap} objects must be done using the \c{QCOMPARE} macro, which provides more informative output in the event of a failure. \li The \c{"mode"} parameter in \c{QSKIP} macro is removed. This parameter caused problems @@ -791,7 +791,7 @@ recommendations for handling those changes. \li Configure no longer calls \c{qmake -recursive} by default, because the subsequent build invokes qmake as needed. Use \c{-fully-process} to restore the old behavior. - \li The \l lupdate \c CODECFORTR variable is deprecated, because source + \li The \l {Using lupdate}{lupdate} \c CODECFORTR variable is deprecated, because source code written with Qt 5 is expected to use UTF-8 encoding. \endlist -- cgit v1.2.1