diff options
| author | Eike Ziller <eike.ziller@qt.io> | 2017-08-15 10:07:51 +0200 |
|---|---|---|
| committer | Eike Ziller <eike.ziller@qt.io> | 2017-08-15 10:07:51 +0200 |
| commit | d8fd5292f17bd07d390500f5daa10b46d5573a49 (patch) | |
| tree | 24a004a722d7947bd6a354e20a5ad6b651c73073 /doc | |
| parent | e6a50fd44a68ccb61a852c4576817162a465c2ce (diff) | |
| parent | 885f8b53858b5c6158a0c6f2208c24cc042b9f38 (diff) | |
Merge remote-tracking branch 'origin/4.4'
Conflicts:
src/tools/clangbackend/ipcsource/clangiasyncjob.cpp
src/tools/clangbackend/ipcsource/clangjobrequest.cpp
src/tools/clangbackend/ipcsource/clangjobrequest.h
Change-Id: Ib8602530663813ade418f995dfd2a736908cfe75
Diffstat (limited to 'doc')
33 files changed, 198 insertions, 216 deletions
diff --git a/doc/images/qmldesigner-new-project.png b/doc/images/qmldesigner-new-project.png Binary files differindex 59e17f2449..10480502f9 100644 --- a/doc/images/qmldesigner-new-project.png +++ b/doc/images/qmldesigner-new-project.png diff --git a/doc/images/qtcreator-add-resource-wizard.png b/doc/images/qtcreator-add-resource-wizard.png Binary files differindex e9f8d7bfd1..921ef724bb 100644 --- a/doc/images/qtcreator-add-resource-wizard.png +++ b/doc/images/qtcreator-add-resource-wizard.png diff --git a/doc/images/qtcreator-android-run-settings.png b/doc/images/qtcreator-android-run-settings.png Binary files differnew file mode 100644 index 0000000000..2ed8b065c5 --- /dev/null +++ b/doc/images/qtcreator-android-run-settings.png diff --git a/doc/images/qtcreator-build-dependencies.png b/doc/images/qtcreator-build-dependencies.png Binary files differindex 62db9b21ac..b67341f94f 100644 --- a/doc/images/qtcreator-build-dependencies.png +++ b/doc/images/qtcreator-build-dependencies.png diff --git a/doc/images/qtcreator-custom-project-wizards.png b/doc/images/qtcreator-custom-project-wizards.png Binary files differindex 581322b37a..43a0d0b6be 100644 --- a/doc/images/qtcreator-custom-project-wizards.png +++ b/doc/images/qtcreator-custom-project-wizards.png diff --git a/doc/images/qtcreator-custom-wizard.png b/doc/images/qtcreator-custom-wizard.png Binary files differindex 9155866e41..3f03954511 100644 --- a/doc/images/qtcreator-custom-wizard.png +++ b/doc/images/qtcreator-custom-wizard.png diff --git a/doc/images/qtcreator-editor-settings.png b/doc/images/qtcreator-editor-settings.png Binary files differindex 583af66502..81b4af6a39 100644 --- a/doc/images/qtcreator-editor-settings.png +++ b/doc/images/qtcreator-editor-settings.png diff --git a/doc/images/qtcreator-ios-preferences.png b/doc/images/qtcreator-ios-preferences.png Binary files differnew file mode 100644 index 0000000000..b6ad26f268 --- /dev/null +++ b/doc/images/qtcreator-ios-preferences.png diff --git a/doc/images/qtcreator-ios-simulator-deploy.png b/doc/images/qtcreator-ios-simulator-deploy.png Binary files differnew file mode 100644 index 0000000000..e2fc146a39 --- /dev/null +++ b/doc/images/qtcreator-ios-simulator-deploy.png diff --git a/doc/images/qtcreator-kits.png b/doc/images/qtcreator-kits.png Binary files differindex 0eaf814d07..2d9a312364 100644 --- a/doc/images/qtcreator-kits.png +++ b/doc/images/qtcreator-kits.png diff --git a/doc/images/qtcreator-new-opengl-file.png b/doc/images/qtcreator-new-opengl-file.png Binary files differindex 3e64d1fff5..0e35bf7e14 100644 --- a/doc/images/qtcreator-new-opengl-file.png +++ b/doc/images/qtcreator-new-opengl-file.png diff --git a/doc/images/qtcreator-new-qt-gui-application.png b/doc/images/qtcreator-new-qt-gui-application.png Binary files differindex 54c807bb9f..62895ef9d1 100644 --- a/doc/images/qtcreator-new-qt-gui-application.png +++ b/doc/images/qtcreator-new-qt-gui-application.png diff --git a/doc/images/qtcreator-new-qt-quick-project-wizard.png b/doc/images/qtcreator-new-qt-quick-project-wizard.png Binary files differindex 35aebe6a16..5b518dc225 100644 --- a/doc/images/qtcreator-new-qt-quick-project-wizard.png +++ b/doc/images/qtcreator-new-qt-quick-project-wizard.png diff --git a/doc/images/qtcreator-options-code-style-qml.png b/doc/images/qtcreator-options-code-style-qml.png Binary files differindex 538155eb7b..7755be5581 100644 --- a/doc/images/qtcreator-options-code-style-qml.png +++ b/doc/images/qtcreator-options-code-style-qml.png diff --git a/doc/src/android/androiddev.qdoc b/doc/src/android/androiddev.qdoc index 5d57ce1beb..34cf3f7d6a 100644 --- a/doc/src/android/androiddev.qdoc +++ b/doc/src/android/androiddev.qdoc @@ -57,16 +57,14 @@ \li \l{http://www.oracle.com/technetwork/java/javase/downloads/index.html} {Java SE Development Kit (JDK)} version 6, or later - \li A build tool for building application packages for Android devices: + \li \l{http://www.gradle.org}{Gradle} for building application packages + for Android devices (APK). Gradle is delivered with Qt 5.9, and + later. - \list - - \li \l{http://ant.apache.org/bindownload.cgi}{Apache Ant} 1.8.0, - or later - - \li \l{http://www.gradle.org}{Gradle} - - \endlist + \note Using Ant to build APKs is still possible when developing with + Qt 5.8 or earlier together with Android SDK tools versions 25.2.5 or + earlier, but Ant support has been deprecated since \QC 4.3 and will + be removed in a future version. \li A tool chain for building applications for Android devices provided by the \l{http://developer.android.com/tools/sdk/ndk/index.html} @@ -74,20 +72,10 @@ \li \l{http://developer.android.com/sdk/index.html}{Android SDK Tools} - After installing the Tools, update the Android SDK to get the API - and tools packages required for development. You can use the - \l{http://developer.android.com/tools/help/android.html}{android} - tool that comes with the SDK Tools package. For example, on Ubuntu - the following command starts the SDK update: - - \code - ./android update sdk - \endcode - - \note The android tool is deprecated since SDK tools version 25.3.0. - Consider using + After installing the Tools, you can use the \l{https://developer.android.com/studio/command-line/sdkmanager.html} - {sdkmanager} instead. + {sdkmanager} to get the API and tools packages required for + development. \li On Windows, you also need the following: @@ -108,33 +96,17 @@ \endlist - \section1 Selecting the APK Build Tool - - On Android, applications are distributed in specially structured type of ZIP - packages called APK. You can use either Ant or Gradle to build APKs. Using - Gradle has the following benefits: - - \list - - \li It is 25 to 50 percent faster than Ant when rebuilding packages. - - \li It is delivered with Qt 5.9. - - \li It supports easily adding Android Extras libraries, such as - Google Play services or Android extension files (.obb) to your - project. - - \endlist - - \note Android SDK tools version 25.3.0 onwards do not contain Ant scripts - anymore. Therefore, Gradle builds are forced and you must use Qt 5.9 or - later when using these tools versions. - \section1 Setting Up the Development Environment You must download and install the latest Android NDK and SDK, and update the - SDK to get the API and tools packages needed for development. In addition, - you must install Qt for Android as part of Qt 5.2, or later. + SDK to get the build and platform tools needed for development. Since + SDK tools version 25.3.0, \QC, you must use the + \l{https://developer.android.com/studio/command-line/sdkmanager.html} + {sdkmanager} command line tool for SDK package management and the + \l{https://developer.android.com/studio/command-line/avdmanager.html} + {avdmanager} tool for Android Virtual Device (AVD) management. + + In addition, you must install Qt for Android as part of Qt 5.2, or later. For more information, see \l{Qt for Android}. @@ -165,6 +137,9 @@ \li To use Ant, add the path to the Ant executable in the \uicontrol {Ant executable} field. + \note Ant support has been deprecated since \QC 4.3. We + recommend that you use Gradle instead. + \endlist \li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol Application > @@ -213,7 +188,7 @@ \image qtcreator-android-select-devices.png "Select Android Devices dialog" - Android Virtual Devices (AVD) are also listed. To create new AVDs, select + AVDs are also listed. To create new AVDs, select \uicontrol {Create Android Virtual Device}. To set a device as the default device for a particular Android architecture, diff --git a/doc/src/android/creator-projects-settings-run-android.qdocinc b/doc/src/android/creator-projects-settings-run-android.qdocinc new file mode 100644 index 0000000000..fa3deeb907 --- /dev/null +++ b/doc/src/android/creator-projects-settings-run-android.qdocinc @@ -0,0 +1,64 @@ +/**************************************************************************** +** +** Copyright (C) 2017 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Qt Creator documentation. +** +** 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. +** +****************************************************************************/ + +/*! +//! [run settings android] + + \section1 Specifying Run Settings for Android Devices + + To run and debug an application on an Android device, you must create + connections from the development host to the device, as instructed in + \l {Connecting Android Devices}. + + A default set of Android Activity manager (am) start options is applied when + starting applications. You can specify additional start options in the + \uicontrol {Activity manager start options} field. However, if the default + options conflict with the added options, the application might not start. + + For example, to run the application as a particular user, enter the start + option \c {--user 10}, where \c 10 is the user ID of the user account. + + \image qtcreator-android-run-settings.png + + You can specify shell commands to run before the application is started and + after it is quit. For example, enter the following commands to unlock the + screen and to switch to the user account \c 10 on the device before running + the application: + + \code + input keyevent 82 + am switch-user 10 + \endcode + + Enter the following commands to switch back to the default user, \c 0, and + to unlock the screen after the application is quit: + + \code + am switch-user 0 + input keyevent 82 + \endcode + +//! [run settings android] +*/ diff --git a/doc/src/android/deploying-android.qdoc b/doc/src/android/deploying-android.qdoc index 0bbd71f379..cf9018ce31 100644 --- a/doc/src/android/deploying-android.qdoc +++ b/doc/src/android/deploying-android.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 The Qt Company Ltd. +** Copyright (C) 2017 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -55,6 +55,9 @@ To specify settings for application packages, select \uicontrol Projects > \uicontrol {Build Android APK} > \uicontrol Details. + For more information about options that you have for running applications, + see \l {Specifying Run Settings for Android Devices}. + \section1 Creating Distributable APK Packages To copy Qt libraries and files to the project directory and to bundle them @@ -128,8 +131,9 @@ \endlist - The Gradle wrappers and scripts are bundled only if you use - \l{Selecting the APK Build Tool}{Gradle} to build the application packages. + The Gradle wrappers and scripts are bundled only if you use Gradle to build + the application packages. For more information, see + \l{Connecting Android Devices}. To view the packages that the \c androiddeployqt tool created, select the \uicontrol {Open package location after build} check box. diff --git a/doc/src/debugger/qtquick-debugging.qdoc b/doc/src/debugger/qtquick-debugging.qdoc index 003429dc5b..53578482d8 100644 --- a/doc/src/debugger/qtquick-debugging.qdoc +++ b/doc/src/debugger/qtquick-debugging.qdoc @@ -37,7 +37,7 @@ \title Debugging Qt Quick Projects - \note You need Qt 4.8 or later to debug Qt Quick projects. + \note You need Qt 5.0 or later to debug Qt Quick projects. For an example of how to debug Qt Quick Projects, see \l{Debugging a Qt Quick Example Application}. @@ -55,17 +55,14 @@ \list 1 - \li Debugging is enabled by default for Qt 4.8, or later. For Qt 4.7, - select \uicontrol Projects, and then select the - \uicontrol {Enable QML debugging and profiling} check box in the \uicontrol qmake - section in \uicontrol {Build Steps}. + \li Debugging is enabled by default for Qt 5.0, or later. You might have to compile the library first, by selecting the \uicontrol Compile link. \image qml-link-debugging-library.png "Build Steps" - \note Debugging requires opening a socket at a well-known port, + \note Debugging requires opening a socket at a TCP port, which presents a security risk. Anyone on the Internet could connect to the application that you are debugging and execute any JavaScript functions. Therefore, you must make sure that the port is properly @@ -78,7 +75,7 @@ \li Select \uicontrol {Build > Rebuild Project} to clean and rebuild the project. - \li To debug applications on devices, check that Qt 4.7.4, or later, + \li To debug applications on devices, check that Qt 5.0, or later, libraries are installed on the device and \l{Running on Multiple Platforms}{select the corresponding kit for the device} before you start debugging. @@ -107,9 +104,8 @@ \li Execute JavaScript expressions to get information about the state of the application - \li Change QML code and immediately see the changes at runtime - - \li Inspect QML code and change it temporarily at runtime + \li Inspect QML properties and JavaScript variables and change them + temporarily at runtime \endlist @@ -121,13 +117,8 @@ parameters (if you build the application with \QC, it automatically uses the correct configuration): - \list - - \li Qt Quick 1: \c {CONFIG+=declarative_debug} - - \li Qt Quick 2: \c {CONFIG+=qml_debug} + \c {CONFIG+=qml_debug} - \endlist \li Start the application with the following arguments: @@ -210,7 +201,7 @@ \section1 Inspecting User Interfaces When you debug complex applications, you can jump to the position in code - where an item is defined or you can zoom into the user interface. + where an item is defined. In the selection mode, you can click items in the running application to jump to their definitions in the code. The properties of the @@ -222,18 +213,8 @@ You can also view the item hierarchy in the running application: - \list - - \li When debugging Qt Quick 1 applications, right-click an item in the - running application to view the item hierarchy as a context menu. - - \image qml-observer-context-menu.png "QML item hierarchy" - - \li When debugging Qt Quick 2 applications, double-click an item in the - running application to cycle through the item stack at the cursor - position. - - \endlist + Double-click an item in the running application to cycle through the item + stack at the cursor position. To switch out of the selection mode, toggle the \uicontrol Select menu item. diff --git a/doc/src/editors/creator-editors.qdoc b/doc/src/editors/creator-editors.qdoc index 1c040afe5a..8e49e9665a 100644 --- a/doc/src/editors/creator-editors.qdoc +++ b/doc/src/editors/creator-editors.qdoc @@ -233,7 +233,7 @@ in Windows. To check JSON data structure, copy the JSON schema file to the above folder. - \section1 Checking JavaScript and QML Syntax + \section2 Checking JavaScript and QML Syntax To run the checks, select \uicontrol Tools > \uicontrol {QML/JS} > \uicontrol {Run Checks} or press \key {Ctrl+Shift+C}. The results are shown @@ -241,7 +241,7 @@ pane. - \section1 List of JavaScript and QML Checks + \section2 List of JavaScript and QML Checks Many of the JavaScript checks are similar to the ones in Douglas Crockford's \l{http://www.jslint.com}{JSLint} tool. @@ -811,6 +811,12 @@ To inspect QML and JavaScript properties, methods, and enums, move the cursor over them and select \uicontrol Tools > \uicontrol {QML/JS} > \uicontrol {Inspect API for Element Under Cursor}. + + \section1 Automatically Formatting QML/JS Files + + To automatically format QML/JS files upon saving, select \uicontrol Tools > + \uicontrol Options > \uicontrol {Qt Quick} > \uicontrol {QML/JS Editing} > + \uicontrol {Enable auto format on file save}. */ diff --git a/doc/src/ios/creator-ios-dev.qdoc b/doc/src/ios/creator-ios-dev.qdoc index 4f97e3d804..d3678c0d1c 100644 --- a/doc/src/ios/creator-ios-dev.qdoc +++ b/doc/src/ios/creator-ios-dev.qdoc @@ -148,20 +148,62 @@ For more information, see \l{Expressing Supported iOS Versions}. - \section1 Testing on iOS Simulator + \section1 Testing on Simulator If you do not have an iOS device or you do not want to create an account, you can test applications on \l{http://developer.apple.com/library/ios/documentation/IDEs/Conceptual/iOS_Simulator_Guide/Introduction/Introduction.html} - {iOS Simulator}, which is installed as part of Xcode. Each Xcode version + {Simulator}, which is installed as part of Xcode. Each Xcode version simulates a predefined set of hardware devices and software versions. You can change the simulated hardware and software version in the run settings for the project. Select \uicontrol Projects > \uicontrol Run, and then select the device to simulate in the \uicontrol {Device type} field. - \QC uses the Xcode version set as current on the Mac computer. - To check the version, enter the following command: + \image qtcreator-ios-simulator-deploy.png + + The simulator is started automatically when you run the application. + To start the simulator manually, select \uicontrol Preferences > + \uicontrol Devices > \uicontrol iOS > \uicontrol Start. + + To take screenshots of the simulator, select \uicontrol Preferences > + \uicontrol Devices > \uicontrol iOS > \uicontrol Screenshot. The screenshots + are stored in the directory specified in the + \uicontrol {Screenshot directory} field. + + \section2 Managing Simulators + + The available simulators are listed in \uicontrol Preferences > + \uicontrol Devices > \uicontrol iOS. + + \image qtcreator-ios-preferences.png + + To create a new simulator instance: + + \list + + \li Select \uicontrol Create. + + \li In the \uicontrol {Device type} field, select the device type from + a list of devices supported by the Xcode version set as current on + the Mac computer. + + \li In the \uicontrol {OS version} field, select an OS version from a + list of OS versions supported by the selected device and the current + Xcode version. + + \endlist + + To rename the selected simulator, select \uicontrol Rename. + + To reset the contents and settings of the selected simulators, select + \uicontrol Reset. + + To delete the selected simulator, select \uicontrol Delete. + + \section2 Checking Current Xcode Version + + To check the current Xcode version, enter the following command: \c {xcode-select --print-path} diff --git a/doc/src/linux-mobile/creator-projects-settings-run-b2qt.qdocinc b/doc/src/linux-mobile/creator-projects-settings-run-b2qt.qdocinc index bbbe220a1d..ea34ff83de 100644 --- a/doc/src/linux-mobile/creator-projects-settings-run-b2qt.qdocinc +++ b/doc/src/linux-mobile/creator-projects-settings-run-b2qt.qdocinc @@ -26,7 +26,7 @@ /*! //! [run settings embedded] - \section2 Specifying Run Settings for Embedded Devices + \section1 Specifying Run Settings for Embedded Devices To run and debug an application on an embedded device (commercial only), you must create connections from the development host to the device and add the diff --git a/doc/src/linux-mobile/creator-projects-settings-run-linux.qdocinc b/doc/src/linux-mobile/creator-projects-settings-run-linux.qdocinc index 968cb881ee..5ae14681fb 100644 --- a/doc/src/linux-mobile/creator-projects-settings-run-linux.qdocinc +++ b/doc/src/linux-mobile/creator-projects-settings-run-linux.qdocinc @@ -26,7 +26,7 @@ /*! //! [run settings linux] - \section2 Specifying Run Settings for Linux-Based Devices + \section1 Specifying Run Settings for Linux-Based Devices To run and debug an application on a Linux-based device, you must create connections from the development diff --git a/doc/src/projects/creator-projects-custom-wizards-xml.qdoc b/doc/src/projects/creator-projects-custom-wizards-xml.qdoc index 787a90fd32..2cb3244e74 100644 --- a/doc/src/projects/creator-projects-custom-wizards-xml.qdoc +++ b/doc/src/projects/creator-projects-custom-wizards-xml.qdoc @@ -41,29 +41,16 @@ {JSON-Based wizards} instead. XML wizards are deprecated and support for them will be removed in future versions of \QC. - To display the XML-based example wizards in \QC, rename - \c {wizard_sample.xml} as \c {wizard.xml} in the - \c {\share\qtcreator\templates\wizards\helloworld} and - \c {\share\qtcreator\templates\wizards\listmodel} folders. After - you restart \QC, the \uicontrol {Custom Classes} - and \uicontrol {Custom Projects} categories (1) appear in the \uicontrol New - dialog. For each category, an icon (2), a display name (3), and a - description (4) are displayed. - - \image qtcreator-custom-project-wizards.png "The New dialog with custom projects and classes" - - Files can be generated by using either \l{Processing Template Files} - {templates} or \l{Using Generator Scripts}{generator scripts}, where a - script is called to create the files. - - \note The generator option mainly exists to accommodate existing generator - scripts or cases where complicated algorithmic logic is required when - generating files. Writing cross-platform scripts is inherently difficult, - and therefore, it is not recommended for new wizards. + To see examples of XML-based wizards, select \uicontrol File > + \uicontrol {New File or Project} > \uicontrol Library. For each wizard, an + icon (1), a display name (2), and a description (3) are displayed. + + \image qtcreator-custom-project-wizards.png "The New dialog" + + Files can be generated by using \l{Processing Template Files}{templates}. XML-based wizard template directories contain an XML configuration file - called wizard.xml, the template source files, and optionally, the generator - script. + called wizard.xml and the template source files. \section1 Creating XML-Based Project Wizards @@ -71,10 +58,11 @@ \list 1 - \li Make a copy of the \c {share/qtcreator/templates/wizards/helloworld} - or \c {share/qtcreator/templates/wizards/listmodel} folder. + \li Make a copy of a folder in the \c share/qtcreator/templates/wizards/ + folder that contains an XML-based wizard (\c codesnippet, + \c qtcreatorplugin, or \c qtquick2-extension). - \li Modify the wizard_example.xml file. + \li Modify the wizard.xml file. \li The following code determines the type of the wizard and its place in the \uicontrol New dialog: @@ -89,8 +77,7 @@ \list - \li \c version is the version of the file contents. Do not modify - this value. + \li \c version is the version of the file contents. \li \c kind specifies the type of the wizard: \c project or \c class. @@ -146,12 +133,7 @@ \endlist - \li Files to be added to the project: - - \list - - \li Template-based: The following code specifies the files to add to - the project: + \li The following code specifies the files to add to the project: \code <files> <file source="main.cpp" openeditor="true" /> @@ -183,41 +165,6 @@ See also \l{Processing Template Files}. - \li Generator-script: The following code specifies that the script - \c generate.pl is to be used to create the files: - - \code - <generatorscript binary="generate.pl"> - <argument value="--class-name=%ClassName%"/> - <argument value="--project-name=%ProjectName%"/> - <argument value="--header-suffix=%CppHeaderSuffix%" omit-empty="true"/> - <argument value="--source-suffix=%CppSourceSuffix%" omit-empty="true"/> - <argument value="--description=%Description%" omit-empty="true" write-file="true"/> - </generatorscript> - \endcode - - In each argument, the field placeholders are replaced by the - field values. There are additional boolean attributes which give - fine-grained control: - - \list - - \li \c omit-empty specifies that complete argument is to be - omitted when all placeholders expand to empty values. In - the above example, the option \c --source-suffix will - not be passed to the script if the value is empty. - - \li \c write-file indicates that instead of the expanded - value, the value will be written to a temporary file and - its file name will be passed to the script instead. This - is useful for multi-line text fields. - - \endlist - - See also \l{Using Generator Scripts}. - - \endlist - \li The following code creates a page that specifies settings for the project: \code @@ -600,50 +547,4 @@ of the base class. If the validation fails, a red label displaying the message appears at the bottom of the wizard page. - \section1 Using Generator Scripts - - The values entered in the wizard page are passed to the script - as command line arguments as defined by the wizard configuration file. - - In addition, the script must implement a \c{--dry-run} command line option. - - \QC needs to know the file names before the files are created to check - whether files with identical names already exist, for example. Therefore, - script file generation is a two-step process: - - \list 1 - - \li Determine file names and attributes: The script is called with the - command line \c{--dry-run} option and the field values. It then prints - the relative path names of the files it intends to create, followed by - comma-separated attributes matching those of the \c{<file>} element, for - example: - - \code - myclass.cpp,openeditor - myclass.h,openeditor - myproject.pro,openproject - \endcode - - \li Create files: The script is called with the parameters only in the - working directory. It then actually creates the files. If directories - are needed, the script should create them, too. - - \endlist - - The \c{scriptgeneratedproject} sample wizard illustrates the usage. - A typical script invocation for this example (obtained by running \QC with - \c{--customwizard-verbose}) looks as follows: - - \code - generate.pl --class-name=TestClass --project-name=TestProject --header-suffix=h --source-suffix=cpp --description=/tmp/qtcreatorj26629.txt - \endcode - - By default, the scripts are run in the directory corresponding to - \c %TargetPath%. This can be overridden by specifying the attribute - \c workingdirectory on the element \c generatorscript. For example, if the - script creates the project directory by itself, %Path% can be specified. In - that case, \c --dry-run should output the correct relative paths or absolute - paths constructed using the value of \c %Path%. - */ diff --git a/doc/src/projects/creator-projects-settings-code-style.qdoc b/doc/src/projects/creator-projects-settings-code-style.qdoc index e2665f8540..8479124a00 100644 --- a/doc/src/projects/creator-projects-settings-code-style.qdoc +++ b/doc/src/projects/creator-projects-settings-code-style.qdoc @@ -58,9 +58,11 @@ \list 1 - \li Select \uicontrol Projects > \uicontrol {Code Style}. + \li Select \uicontrol Projects > \uicontrol {Project Settings} > + \uicontrol {Code Style}. - \li In the \uicontrol Language field, select \uicontrol C++ or \uicontrol {Qt Quick}. + \li In the \uicontrol Language field, select \uicontrol C++, + \uicontrol {Qt Quick}, or \uicontrol Nim. \li In the \uicontrol {Current settings} field, select the settings to modify and click \uicontrol Copy. diff --git a/doc/src/projects/creator-projects-settings-dependencies.qdoc b/doc/src/projects/creator-projects-settings-dependencies.qdoc index d1c9b20b50..51c2c7f0a4 100644 --- a/doc/src/projects/creator-projects-settings-dependencies.qdoc +++ b/doc/src/projects/creator-projects-settings-dependencies.qdoc @@ -51,9 +51,8 @@ \list 1 - \li In \uicontrol Projects, select a project. - - \li Click \uicontrol Dependencies. + \li Select \uicontrol Projects > \uicontrol {Project Settings} > + \uicontrol Dependencies. \li Select projects that must be built before the current project is built. diff --git a/doc/src/projects/creator-projects-settings-editor.qdoc b/doc/src/projects/creator-projects-settings-editor.qdoc index c2b8a108bd..c3ea91b00d 100644 --- a/doc/src/projects/creator-projects-settings-editor.qdoc +++ b/doc/src/projects/creator-projects-settings-editor.qdoc @@ -50,7 +50,8 @@ \list 1 - \li Select \uicontrol Projects > \uicontrol Editor. + \li Select \uicontrol Projects > \uicontrol {Project Settings} > + \uicontrol Editor. \li In the \uicontrol {Editor settings} field, select \uicontrol {Custom}. diff --git a/doc/src/projects/creator-projects-settings-run-analyze.qdocinc b/doc/src/projects/creator-projects-settings-run-analyze.qdocinc index 00cd86828b..f802f89f0d 100644 --- a/doc/src/projects/creator-projects-settings-run-analyze.qdocinc +++ b/doc/src/projects/creator-projects-settings-run-analyze.qdocinc @@ -26,7 +26,7 @@ /*! //! [settings valgrind] - \section2 Specifying Valgrind Settings + \section1 Specifying Valgrind Settings \QC integrates \l{Analyzing Code}{Valgrind code analysis tools} for detecting memory leaks and profiling function execution. You can configure diff --git a/doc/src/projects/creator-projects-settings-run-debug.qdocinc b/doc/src/projects/creator-projects-settings-run-debug.qdocinc index 191cdf0b48..ef3389e27d 100644 --- a/doc/src/projects/creator-projects-settings-run-debug.qdocinc +++ b/doc/src/projects/creator-projects-settings-run-debug.qdocinc @@ -26,7 +26,7 @@ /*! //! [run settings debugger] - \section2 Specifying Debugger Settings + \section1 Specifying Debugger Settings \image qtquick-debugging-settings.png "Debugger Settings" diff --git a/doc/src/projects/creator-projects-settings-run-desktop.qdocinc b/doc/src/projects/creator-projects-settings-run-desktop.qdocinc index b1c9a00d77..c9c2ef06db 100644 --- a/doc/src/projects/creator-projects-settings-run-desktop.qdocinc +++ b/doc/src/projects/creator-projects-settings-run-desktop.qdocinc @@ -26,7 +26,7 @@ /*! //! [run settings desktop] - \section2 Specifying Run Settings for Desktop Device Types + \section1 Specifying Run Settings for Desktop Device Types You can specify command line arguments to be passed to the executable and the working directory to use. The working directory defaults to diff --git a/doc/src/projects/creator-projects-settings-run.qdoc b/doc/src/projects/creator-projects-settings-run.qdoc index 3641596107..36a2f4307d 100644 --- a/doc/src/projects/creator-projects-settings-run.qdoc +++ b/doc/src/projects/creator-projects-settings-run.qdoc @@ -53,7 +53,7 @@ \QC automatically adds run configurations for all targets specified in the CMake project file, \c {CMakeLists.txt}. - \section2 Creating Run Configurations for Subprojects + \section1 Creating Run Configurations for Subprojects To prevent \QC from automatically creating run configurations for SUBDIRS projects, specify the following variable in the .pro file of the SUBDIRS @@ -65,6 +65,7 @@ \include projects/creator-projects-settings-run-desktop.qdocinc run settings desktop \include projects/creator-projects-settings-run-analyze.qdocinc settings valgrind \include projects/creator-projects-settings-run-debug.qdocinc run settings debugger + \include android/creator-projects-settings-run-android.qdocinc run settings android \include linux-mobile/creator-projects-settings-run-linux.qdocinc run settings linux \include qnx/creator-projects-settings-run-qnx.qdocinc run settings qnx \include linux-mobile/creator-projects-settings-run-b2qt.qdocinc run settings embedded diff --git a/doc/src/projects/creator-projects-targets.qdoc b/doc/src/projects/creator-projects-targets.qdoc index e3366e8489..dace3e18a4 100644 --- a/doc/src/projects/creator-projects-targets.qdoc +++ b/doc/src/projects/creator-projects-targets.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 The Qt Company Ltd. +** Copyright (C) 2017 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -107,6 +107,9 @@ add debuggers to the list. For more information, see \l{Adding Debuggers}. + For Android kits, the \uicontrol {Android GDB server} field will + display the path to GDB server executable. + \li In the \uicontrol {Qt version} field, select the Qt version to use for building the project. You can add Qt versions to the list if they are installed on the development PC, but were not detected @@ -137,6 +140,10 @@ \uicontrol Change to edit the variables of the CMake configuration for the kit. + \li In the \uicontrol {Additional Qbs profile settings} field, select + \uicontrol Change to add settings to Qbs build profiles. For more + information, see \l {Editing Build Profiles}. + \endlist \QC uses the \e {default kit} if it does not have enough information to diff --git a/doc/src/qnx/creator-projects-settings-run-qnx.qdocinc b/doc/src/qnx/creator-projects-settings-run-qnx.qdocinc index ea832dbc6e..b86eed55f8 100644 --- a/doc/src/qnx/creator-projects-settings-run-qnx.qdocinc +++ b/doc/src/qnx/creator-projects-settings-run-qnx.qdocinc @@ -26,7 +26,7 @@ /*! //! [run settings qnx] - \section2 Specifying Run Settings for QNX Devices + \section1 Specifying Run Settings for QNX Devices To run and debug an application on a QNX device, you must create connections from the development PC to the device. Click diff --git a/doc/src/qtquick/qtquick-toolbars.qdoc b/doc/src/qtquick/qtquick-toolbars.qdoc index 54fd768646..d4943517c7 100644 --- a/doc/src/qtquick/qtquick-toolbars.qdoc +++ b/doc/src/qtquick/qtquick-toolbars.qdoc @@ -42,14 +42,13 @@ . Select the icon to open the toolbar. To open toolbars immediately when you select a QML type, select - \uicontrol{Tools > Options > Qt Quick > Qt Quick Toolbar > Always show Qt Quick - Toolbar}. + \uicontrol Tools > \uicontrol Options > \uicontrol {Qt Quick} > + \uicontrol {QML/JS Editing} > \uicontrol {Always show Qt Quick Toolbar}. Drag the toolbar to pin it to another location. Select \inlineimage qml-toolbar-pin.png to unpin the toolbar and move it to its default location. To pin toolbars - by default, select \uicontrol{Tools > Options > Qt Quick > Qt Quick Toolbar - > Pin Quick Toolbar}. + by default, select \uicontrol {Pin Quick Toolbar}. \section1 Previewing Images |
