diff options
author | Pasi Petäjäjärvi <pasi.petajajarvi@theqtcompany.com> | 2015-06-03 13:42:06 +0300 |
---|---|---|
committer | Pasi Petäjäjärvi <pasi.petajajarvi@theqtcompany.com> | 2015-06-03 13:42:11 +0300 |
commit | 142ee713a4cf9557ff48ee783ed56b3842337629 (patch) | |
tree | fc0a2ff5752bdd5c3c35924bbf69e4769ed74785 | |
parent | 22f56ec593d4953f9b08180b2aa478352850dc1f (diff) | |
parent | 06e55443ddcdcec107599f0a4072f8ce1b528b0b (diff) | |
download | qtdoc-142ee713a4cf9557ff48ee783ed56b3842337629.tar.gz |
Merge branch 'upstream-5.5' into vxworks-5.5
* upstream-5.5:
Prospective fix for cmake docs after -fPIC -> -fPIE changes
Doc: update the moc docs as to what can't be used with class templates
Use make as make sub-src is no longer valid for Qt 5
Update the Android OpenGL notes
Doc: Added \keyword entries for console.xxx
Doc: Link to Qt Visual Studio Add-in documentation
Doc: Update Qt Modules page and related information
Doc: Fix missing/broken links in Intro and What's New pages
Update deployment information for ffmpegsumo.dll on Windows.
Update the QNX platform notes
Update the getting started topic
Bump version
Doc: Removed a few redundant steps based on the latest Qt Creator ver
Change-Id: Ifdd4bf7d14dfbb5b2ab52a4ac058a59e94feb185
-rw-r--r-- | doc/config/qtdoc.qdocconf | 5 | ||||
-rw-r--r-- | doc/src/development/cmake-manual.qdoc | 26 | ||||
-rw-r--r-- | doc/src/development/moc.qdoc | 2 | ||||
-rw-r--r-- | doc/src/external-resources.qdoc | 16 | ||||
-rw-r--r-- | doc/src/graphics.qdoc | 3 | ||||
-rw-r--r-- | doc/src/platforms/android.qdoc | 28 | ||||
-rw-r--r-- | doc/src/platforms/platform-notes-android.qdoc | 23 | ||||
-rw-r--r-- | doc/src/platforms/platform-notes-rtos.qdoc | 6 | ||||
-rw-r--r-- | doc/src/platforms/windows.qdoc | 6 | ||||
-rw-r--r-- | doc/src/qmlapp/debugging.qdoc | 16 | ||||
-rw-r--r-- | doc/src/qt5-intro.qdoc | 1 | ||||
-rw-r--r-- | doc/src/qtmodules.qdoc | 36 | ||||
-rw-r--r-- | doc/src/reference.qdoc | 1 | ||||
-rw-r--r-- | doc/src/snippets/cmake/CMakeLists.pro | 22 | ||||
-rw-r--r-- | doc/src/snippets/code/doc_src_deployment.qdoc | 2 | ||||
-rw-r--r-- | doc/src/whatsnew/whatsnew55.qdoc | 2 |
16 files changed, 93 insertions, 102 deletions
diff --git a/doc/config/qtdoc.qdocconf b/doc/config/qtdoc.qdocconf index 1d1f1bb3..4693fb1c 100644 --- a/doc/config/qtdoc.qdocconf +++ b/doc/config/qtdoc.qdocconf @@ -38,6 +38,7 @@ depends += \ qtquick \ qtquickcontrols \ qtquickdialogs \ + qtquickextras \ qtquicklayouts \ qtscript \ qtscripttools \ @@ -58,7 +59,9 @@ depends += \ qtwebkitexamples \ qtx11extras \ qtxml \ - qtxmlpatterns + qtxmlpatterns \ + qt3dcore \ + qt3drender headerdirs += ../src imagedirs += ../src/images \ diff --git a/doc/src/development/cmake-manual.qdoc b/doc/src/development/cmake-manual.qdoc index fc27c5bf..08e482e0 100644 --- a/doc/src/development/cmake-manual.qdoc +++ b/doc/src/development/cmake-manual.qdoc @@ -96,7 +96,13 @@ associated. They provide a list of plugins in the \c{Qt5}\e{<Module>}\c{_PLUGINS} variable. - \snippet snippets/cmake/CMakeLists.pro 7 + \snippet snippets/cmake/CMakeLists.pro 5 + + \section2 Using Qt 5 with \c{CMake} older than 2.8.12 + + It is also necessary when using an older \c{CMake} to add Qt5<Module>_EXECUTABLE_COMPILE_FLAGS to + the CMAKE_CXX_FLAGS so that the -fPIC flags are added to the compile flags if necessary (as + is the default with Qt 5). \section2 Using Qt 5 with \c{CMake} older than 2.8.11 @@ -124,24 +130,6 @@ \snippet snippets/cmake/CMakeLists.pro 4 - It is also necessary when using an older \c{CMake} to add Qt5<Module>_EXECUTABLE_COMPILE_FLAGS to - the CMAKE_CXX_FLAGS so that the -fPIE flags are added to the compile flags if necessary (as - is the default with Qt 5). - - If not using the \c{qt5_use_modules} macro, and if using CMake 2.8.9 or later, the - \l{CMake POSITION_INDEPENDENT_CODE Documentation}{POSITION_INDEPENDENT_CODE property} can be set on - targets using Qt instead, or it can be set globally for all targets. Note that this is not necessary - with CMake 2.8.11: - - \snippet snippets/cmake/CMakeLists.pro 5 - - Note that it may be necessary to enable POSITION_INDEPENDENT_CODE globally in order to use try_compile - with Qt code, or any wrapper macros around it such as check_cxx_source_compiles etc. - As position independent code is a platform-specific and Qt-configuration-specific concept, the - Qt5_POSITION_INDEPENDENT_CODE property can be used to check whether it is required. - - \snippet snippets/cmake/CMakeLists.pro 6 - \section1 Variable Reference \section2 Module variables diff --git a/doc/src/development/moc.qdoc b/doc/src/development/moc.qdoc index 13f35235..6a609c1a 100644 --- a/doc/src/development/moc.qdoc +++ b/doc/src/development/moc.qdoc @@ -252,7 +252,7 @@ \section1 Limitations \c moc does not handle all of C++. The main problem is that class - templates cannot have signals or slots. Here is an example: + templates cannot have the Q_OBJECT macro. Here is an example: \snippet snippets/code/doc_src_moc.cpp 5 diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc index 7a7256a7..3eff9122 100644 --- a/doc/src/external-resources.qdoc +++ b/doc/src/external-resources.qdoc @@ -178,6 +178,12 @@ \externalpage http://doc.qt.io/qtcreator/creator-configuring.html \title Configuring Qt Creator */ + +/*! + \externalpage http://doc.qt.io/qtcreator/creator-deploying-android.html#specifying-settings-for-packages + \title Android APK +*/ + /*! \externalpage http://doc.qt.io/qtcreator/creator-build-example-application.html \title Building and Running Example @@ -234,11 +240,6 @@ */ /*! - \externalpage http://doc.qt.io/QtQuickEnterpriseControls - \title Qt Quick Enterprise Controls -*/ - -/*! \externalpage http://doc.qt.io/QtVirtualKeyboard \title Qt Virtual Keyboard */ @@ -292,3 +293,8 @@ \externalpage http://www.qt.io/qt-account/ \title Qt Account */ + +/*! + \externalpage http://doc.qt.io/vs-addin + \title Qt Visual Studio Add-in +*/ diff --git a/doc/src/graphics.qdoc b/doc/src/graphics.qdoc index 4a193b9e..ce958b90 100644 --- a/doc/src/graphics.qdoc +++ b/doc/src/graphics.qdoc @@ -121,6 +121,9 @@ OpenGL into their applications. \li \l {http://www.khronos.org/opengl}{www.khronos.org/opengl} - The official OpenGL pages. + \li \l[QtCanvas3D]{Qt Canvas 3D} - An add-on module that provides a way to + make OpenGL-like 3D drawing calls from Qt Quick using JavaScript. + \endlist Prior to Qt 5.0, OpenGL support in Qt was handled by the \l {Qt OpenGL} diff --git a/doc/src/platforms/android.qdoc b/doc/src/platforms/android.qdoc index c78d686c..33a75a40 100644 --- a/doc/src/platforms/android.qdoc +++ b/doc/src/platforms/android.qdoc @@ -253,18 +253,6 @@ application to Android using the qrc approach: \note QML documents can refer to the contents in qrc files using the relative path to the document. Such references do not require the "\c{qrc:}" or "\c{:/}" prefix. - \li Update the "Run" settings for your project as described in the - \l{Qt Creator: Specifying Run Settings} - - \note You can change the default settings for application icons and - identifier. - \li If your application uses imports or plugins which depend on special Qt - modules, these Qt modules should be added to the .pro file. For example, if - your application uses the \l{Qt Multimedia} import in QML, you should add - the following to your .pro file: - \code - QT += multimedia - \endcode \li Save the changes to your project and run the application. \endlist @@ -326,9 +314,9 @@ the APK: \li Run \c{make build_libs} to build the \c libcrypto and \c libssl shared libraries. - \li Open your Qt project using Qt Creator and update the - "Deployment Configuration" under run settings to add \e libcrypto and - \e libssl as additional libraries required for your project. + \li Open your Qt project using Qt Creator and update the "Build Android APK" + settings to add \e libcrypto and \e libssl as additional libraries for + your project. \li Run your application to see it running on the device. \endlist @@ -358,10 +346,9 @@ on Google Play: \li Open your application project using Qt Creator v3.0 or later and change its \uicontrol Build settings to build release version. - \li Open \uicontrol Run settings of your project and select - \uicontrol {Create AndroidManifest.xml}. Qt Creator adds the manifest XML - based on the application's \e .pro file and opens it in \uicontrol General - mode. + \li Select \uicontrol {Create Templates} under \uicontrol Build settings to + create the template files such as \e AndroidManifest.xml and other + resources. \note You can edit the \e AndroidManifest.xml in \uicontrol General or \uicontrol {XML Source} mode. @@ -388,7 +375,8 @@ on Google Play: information on the manifest XML format, see \l{Android: App Manifest}. \li Set up a \uicontrol keystore to sign the \e .apk. You can create a new - keystore if you do not have one. + keystore if you do not have one. For more details, see + \l{Android APK}{QtCreator: Specifying Settings for Packages}. \li Select \uicontrol{Open package location after build} and run your application to build the \e .apk. Qt Creator builds the \e .apk and opens the diff --git a/doc/src/platforms/platform-notes-android.qdoc b/doc/src/platforms/platform-notes-android.qdoc index ba1cf2cd..0b501d0d 100644 --- a/doc/src/platforms/platform-notes-android.qdoc +++ b/doc/src/platforms/platform-notes-android.qdoc @@ -129,16 +129,10 @@ \section1 OpenGL Special Considerations - Qt for Android provides two separate platform plugins: One which is suited for traditional - \l{Qt Widgets}{widget-based} apps that do not require OpenGL support, and one which will be used - when OpenGL is required. When building and deploying your app, Qt Creator will detect whether the - OpenGL-enabled plugin is required by checking if your app depends on either the \l{Qt OpenGL} - module or the \l{Qt Quick} module. - - There are some special considerations to be made when the OpenGL-enabled platform plugin is in - use. The plugin only supports full screen top-level windows. This means that even dialogs and popups - will be shown as full screen. There may also be drawing errors if you try to stack windows that - have animations or otherwise require updating their UI while they are obscured by another window. + There are some special considerations to be made when OpenGL is used. The platform plugin only + supports full screen top-level OpenGL windows. This means that even dialogs and popups will be + shown as full screen. There may also be drawing errors if you try to stack windows that have + animations or otherwise require updating their UI while they are obscured by another window. It is recommended that you try to avoid multiple top-level windows in the case of Android apps, as there is no traditional window system on this platform. @@ -146,6 +140,15 @@ \note Embedding a QGLWidget inside a widget hierarchy is not supported. When QGLWidget is in use, it must be the top-level widget. + \note Avoid using the legacy QGLWidget. For embedding OpenGL or Qt Quick content into a + widget-based user interface, prefer using QOpenGLWidget and QQuickWidget. + + Modern devices often support OpenGL ES 3.0 or 3.1 in addition to 2.0. To get a suitable OpenGL + context, set the requested version via QSurfaceFormat::setVersion(). Note however that the + header files are only available in recent API levels, for example to include gl31.h, you need to + target API level 21. Keep in mind also that using OpenGL ES 3.x features will result in the + application breaking on older devices that only support 2.0. + \section1 Multimedia Special Considerations \l{Qt Multimedia}, like the rest of Qt, supports Android versions 2.3.3 (API level 10) or later. diff --git a/doc/src/platforms/platform-notes-rtos.qdoc b/doc/src/platforms/platform-notes-rtos.qdoc index 1a177c0c..5d81269f 100644 --- a/doc/src/platforms/platform-notes-rtos.qdoc +++ b/doc/src/platforms/platform-notes-rtos.qdoc @@ -31,8 +31,6 @@ \contentspage Platform and Compiler Notes \target QNX - \note QNX Neutrino RTOS is a community supported platform. See the \l{http://wiki.qt.io/Qnx}{related page} on the Qt Project wiki. - \section1 Supported Architectures and QNX Releases From the perspective of an application development platform, Qt runs on top of @@ -54,12 +52,12 @@ For a specific list of available boards, displays and input devices, contact QNX Software Systems (info@qnx.com) or KDAB (qnx-info@kdab.com). Qt on the QNX Neutrino OS is also supported - by Qt Enterprise Embedded, \l {http://qt.digia.com/About-Us/Contact-Us/}{contact Digia Qt} + by Qt Enterprise Embedded, \l {http://www.qt.io/contact-us/}{contact The Qt Company} for more details. \section1 Supported Modules - Almost all Qt Essential \l{All Modules}{modules} and quite some add-ons are supported on + Almost all Qt Essential \l{All Modules}{modules} and some add-ons are supported on the QNX Neutrino RTOS. See the \l{http://wiki.qt.io/Qt_Status_on_QNX} {status page on the Qt Project wiki} for details. diff --git a/doc/src/platforms/windows.qdoc b/doc/src/platforms/windows.qdoc index db382a56..06e189c3 100644 --- a/doc/src/platforms/windows.qdoc +++ b/doc/src/platforms/windows.qdoc @@ -91,7 +91,7 @@ \section2 Visual Studio Add-in - The Qt Visual Studio Add-in allows programmers to create, build, debug + The \l {Qt Visual Studio Add-in} allows programmers to create, build, debug and run Qt applications from within non-Express versions of Microsoft Visual Studio 2008, 2010, and 2012. The add-in contains project wizards, Qt project import/export support, integrated Qt resource manager and automated build setup for @@ -628,8 +628,8 @@ \note To support HTML5 videos, you must additionally deploy \c ffmpegsumo.dll (WebM codec plugin) into the \c qtwebengine directory - under the application install path, and ensure that \c Prefix or - \c PluginsPath variable is set to "." in + under the application install path or under the path that the + \c PluginsPath variable was set to in \c{<Qt install path>/<Qt version>/msvc2013/qt.conf}. Remember that if your application depends on compiler specific diff --git a/doc/src/qmlapp/debugging.qdoc b/doc/src/qmlapp/debugging.qdoc index bd3814e5..6e781e90 100644 --- a/doc/src/qmlapp/debugging.qdoc +++ b/doc/src/qmlapp/debugging.qdoc @@ -34,6 +34,7 @@ \section1 Console API \section2 Log +\keyword console log \c console.log, console.debug, console.info, console.warn and console.error can be used to print debugging information to the console. For example: @@ -48,6 +49,7 @@ The output is generated using the qDebug, qWarning, qCritical methods in C++ (see also \l {Debugging Techniques}). \section2 Assert +\keyword console assert \c console.assert tests that an expression is true. If not, it will write an optional message to the console and print the stack trace. @@ -61,7 +63,8 @@ function f() { \endcode \section2 Timer - +\keyword console time +\keyword console timeEnd \c console.time and console.timeEnd log the time (in milliseconds) that was spent between the calls. Both take a string argument that identifies the measurement. For example: @@ -77,13 +80,14 @@ function f() { \endcode \section2 Trace +\keyword console trace \c console.trace prints the stack trace of the JavaScript execution at the point where it was called. The stack trace info contains the function name, file name, line number and column number. The stack trace is limited to last 10 stack frames. \section2 Count - +\keyword console count \c console.count prints the current number of times a particular piece of code has been executed, along with a message. That is, @@ -96,10 +100,11 @@ function f() { will print \c{f called: 1}, \c{f called: 2} ... whenever \c{f()} is executed. \section2 Profile - +\keyword console profile \c console.profile turns on the QML and JavaScript profilers. Nested calls are not supported and a warning will be printed to the console. +\keyword console profileEnd \c console.profileEnd turns off the QML and JavaScript profilers. Calling this function without a previous call to console.profile will print a warning to the console. A profiling client should have been attached before this call to receive and store the @@ -116,7 +121,7 @@ function f() { \endcode \section2 Exception - +\keyword console exception \c console.exception prints an error message together with the stack trace of JavaScript execution at the point where it is called. @@ -145,7 +150,8 @@ QQmlImportDatabase::resolveType "Rectangle" = "QDeclarativeRectangle" \endcode \section1 QML Debugging Infrastructure - +\keyword declarative_debug +\keyword qml debug The \l{Qt QML} module provides services for debugging, inspecting, and profiling applications via a TCP port. diff --git a/doc/src/qt5-intro.qdoc b/doc/src/qt5-intro.qdoc index dfc3007a..ad5b358a 100644 --- a/doc/src/qt5-intro.qdoc +++ b/doc/src/qt5-intro.qdoc @@ -503,6 +503,7 @@ \section1 Related Topics \list + \li \l{What's New in Qt 5.5} \li \l{What's New in Qt 5.4} \li \l{What's New in Qt 5.3} \li \l{What's New in Qt 5.2} diff --git a/doc/src/qtmodules.qdoc b/doc/src/qtmodules.qdoc index 8055ff22..513e6fbf 100644 --- a/doc/src/qtmodules.qdoc +++ b/doc/src/qtmodules.qdoc @@ -92,11 +92,11 @@ \li \l[QtTestLib]{Qt Test} \li Classes for unit testing Qt applications and libraries. \row - \li \l[QtWebKit]{Qt WebKit} - \li Classes for a WebKit2 based implementation and a new QML API. - See also Qt WebKit Widgets in the add-on modules. + \li \l[QtWebKit]{Qt WebKit} (Deprecated) + \li Classes for a WebKit2 based implementation and a QML API. + Deprecated in favor of \l[QtWebEngine]{Qt WebEngine}. \row - \li \l[QtWebKit]{Qt WebKit Widgets} + \li \l[QtWebKit]{Qt WebKit Widgets} (Deprecated) \li WebKit1 and QWidget-based classes from Qt 4. \row \li \l[QtWidgets]{Qt Widgets} @@ -157,6 +157,12 @@ \l{Qt for iOS}{iOS}, \l{Qt for Linux/X11}{Linux} and \l{Qt for OS X}{OS X} \li Provides access to Bluetooth hardware. \row + \li \l[QtCanvas3D]{Qt Canvas 3D} + \li All + \li + \li Enables OpenGL-like 3D drawing calls from Qt Quick applications + using JavaScript. + \row \li \l[QtConcurrent]{Qt Concurrent} \li \li @@ -212,14 +218,25 @@ \li \li Classes to make printing easier and more portable. \row - \li \l{Qt Quick 1 Reference Documentation}{Qt Declarative} + \li \l{Qt Quick 1 Reference Documentation}{Qt Declarative} (Deprecated) \li All \li \li Qt Declarative is provided for \l{Qt 4.8 Reference Documentation}{Qt 4} compatibility. The documentation is available through the Qt 4.8 \l{Qt Quick 1 Reference Documentation}{Qt Quick} documentation. \row - \li \l[QtScript]{Qt Script} + \li \l[QtQuickExtras]{Qt Quick Extras} + \li All + \li + \li Provides a specialized set of controls that can be used to build + interfaces in Qt Quick. + \row + \li \l{Qt Quick Widgets C++ Classes}{Qt Quick Widgets} + \li All + \li + \li Provides a C++ widget class for displaying a Qt Quick user interface. + \row + \li \l[QtScript]{Qt Script} (Deprecated) \li All \li \li Classes for making Qt applications scriptable. Provided for Qt 4.x @@ -312,8 +329,6 @@ \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} @@ -339,8 +354,9 @@ \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. + \row \li \l[Qt3DCore]{Qt3D Module}{Qt3D} + \li Functionality for near-realtime simulation systems with support + for 2D and 3D rendering. \endtable \section1 Qt Tools diff --git a/doc/src/reference.qdoc b/doc/src/reference.qdoc index d92a0695..f76dbf0c 100644 --- a/doc/src/reference.qdoc +++ b/doc/src/reference.qdoc @@ -58,7 +58,6 @@ \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} diff --git a/doc/src/snippets/cmake/CMakeLists.pro b/doc/src/snippets/cmake/CMakeLists.pro index 5600e870..efdf4226 100644 --- a/doc/src/snippets/cmake/CMakeLists.pro +++ b/doc/src/snippets/cmake/CMakeLists.pro @@ -73,28 +73,8 @@ target_link_libraries(helloworld Qt5::Widgets) #! [4] #! [5] -find_package(Qt5Core) - -add_executable(exe1 ${exe1_SRCS}) -# Set the POSITION_INDEPENDENT_CODE property for the exe1 target... -set_target_properties(exe1 PROPERTIES POSITION_INDEPENDENT_CODE ON) - -# Or set it globally for all targets: -set(CMAKE_POSITION_INDEPENDENT_CODE ON) -add_executable(exe2 ${exe2_SRCS}) - -add_executable(exe3 ${exe3_SRCS}) -#! [5] - -#! [6] -if (Qt5_POSITION_INDEPENDENT_CODE) - set(CMAKE_POSITION_INDEPENDENT_CODE ON) -endif() -#! [6] - -#! [7] foreach(plugin ${Qt5Network_PLUGINS}) get_target_property(_loc ${plugin} LOCATION) message("Plugin ${plugin} is at location ${_loc}") endforeach() -#! [7] +#! [5] diff --git a/doc/src/snippets/code/doc_src_deployment.qdoc b/doc/src/snippets/code/doc_src_deployment.qdoc index 764c0671..3a559436 100644 --- a/doc/src/snippets/code/doc_src_deployment.qdoc +++ b/doc/src/snippets/code/doc_src_deployment.qdoc @@ -41,7 +41,7 @@ //! [0] cd /path/to/Qt ./configure -static -prefix /path/to/Qt <other parameters> -make sub-src +make //! [0] diff --git a/doc/src/whatsnew/whatsnew55.qdoc b/doc/src/whatsnew/whatsnew55.qdoc index b0e34bf4..22510555 100644 --- a/doc/src/whatsnew/whatsnew55.qdoc +++ b/doc/src/whatsnew/whatsnew55.qdoc @@ -33,7 +33,7 @@ \section1 New Modules \list - \li \l[Qt3DCore]{Qt 3D Module}{Qt 3D} + \li \l[Qt3DCore]{Qt3D Module}{Qt 3D} \list \li Included as a technology preview. \li C++ and QML APIs for easy inclusion of 3D graphics into Qt applications. |