diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2018-08-30 12:36:23 +0200 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2018-09-07 08:59:48 +0000 |
commit | fdbcfc6756035331a3b038d7406e761860e641eb (patch) | |
tree | d66bf41c359fbfb0fda9c296f9655173f1201a0b /doc | |
parent | aa588449b0a4f639459bb2a0933656145f0d5dd6 (diff) |
Doc: Use defines to hide info not related to Qt Quick projects
Change-Id: I70ee417aebcddd32ef9f6419e3000fdfd02c9707
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/src/android/androiddev.qdoc | 4 | ||||
-rw-r--r-- | doc/src/android/deploying-android.qdoc | 2 | ||||
-rw-r--r-- | doc/src/editors/creator-diff-editor.qdoc | 2 | ||||
-rw-r--r-- | doc/src/editors/creator-editors-options.qdoc | 13 | ||||
-rw-r--r-- | doc/src/editors/creator-search.qdoc | 15 | ||||
-rw-r--r-- | doc/src/howto/creator-sidebar-views.qdocinc | 3 | ||||
-rw-r--r-- | doc/src/linux-mobile/creator-deployment-embedded-linux.qdoc | 5 | ||||
-rw-r--r-- | doc/src/linux-mobile/creator-projects-running-generic-linux.qdocinc | 5 | ||||
-rw-r--r-- | doc/src/overview/creator-acknowledgements.qdoc | 6 | ||||
-rw-r--r-- | doc/src/projects/creator-projects-running.qdoc | 2 | ||||
-rw-r--r-- | doc/src/qtquick/qtquick-profiler.qdoc | 6 | ||||
-rw-r--r-- | doc/src/qtquick/qtquick-states.qdoc | 2 |
12 files changed, 52 insertions, 13 deletions
diff --git a/doc/src/android/androiddev.qdoc b/doc/src/android/androiddev.qdoc index e2317d7617..31a698dab1 100644 --- a/doc/src/android/androiddev.qdoc +++ b/doc/src/android/androiddev.qdoc @@ -176,7 +176,11 @@ \li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol Application > \uicontrol {Qt Quick Application} > \uicontrol Choose, and follow the instructions of the wizard. For more information, see + \if defined(qtcreator) \l{Creating Qt Quick Projects}. + \else + \l{Creating UI Prototype Projects}. + \endif \li To specify settings for deploying applications to Android, select \uicontrol Projects > \uicontrol Run for the \uicontrol Android kit, and then select diff --git a/doc/src/android/deploying-android.qdoc b/doc/src/android/deploying-android.qdoc index 86a58f3b93..998cc7f210 100644 --- a/doc/src/android/deploying-android.qdoc +++ b/doc/src/android/deploying-android.qdoc @@ -49,8 +49,10 @@ To specify settings for application packages, select \uicontrol Projects > \uicontrol {Build Android APK} > \uicontrol Details. + \if defined(qtcreator) For more information about options that you have for running applications, see \l {Specifying Run Settings for Android Devices}. + \endif \section1 Using Ministro to Install Qt Libraries diff --git a/doc/src/editors/creator-diff-editor.qdoc b/doc/src/editors/creator-diff-editor.qdoc index 80494a36e7..d20ed8f9f5 100644 --- a/doc/src/editors/creator-diff-editor.qdoc +++ b/doc/src/editors/creator-diff-editor.qdoc @@ -98,9 +98,11 @@ If the files change outside \QC, select \inlineimage reload_gray.png (\uicontrol {Reload Editor}) to compare them again and to show the results. + \if defined(qtcreator) To send a chunk of changes to a \l{Pasting and Fetching Code Snippets} {code pasting service}, select \uicontrol {Send Chunk to CodePaster} in the context menu. + \endif \section1 Changing the Colors diff --git a/doc/src/editors/creator-editors-options.qdoc b/doc/src/editors/creator-editors-options.qdoc index b7084c4adc..c5d8bf534f 100644 --- a/doc/src/editors/creator-editors-options.qdoc +++ b/doc/src/editors/creator-editors-options.qdoc @@ -46,8 +46,10 @@ \uicontrol Options > \uicontrol{Text Editor}. These settings apply to all projects. To specify editor behavior for an open - project, select \uicontrol Projects > \uicontrol Editor. For more - information, see \l{Specifying Editor Settings}. + project, select \uicontrol Projects > \uicontrol Editor. + \if defined(qtcreator) + For more information, see \l{Specifying Editor Settings}. + \endif You can also specify indentation settings separately for C++ and QML files either globally or for the open project. For more information, see @@ -68,11 +70,10 @@ \li Set \l{Indenting Text or Code}{tabs, indentation, the handling of whitespace, and mouse operations} in \uicontrol Behavior. - \li Set various display properties, for example, + \li Set various display properties, such as \l{Highlighting and folding blocks} - {highlighting and folding blocks}, text wrapping or - \l{Moving to symbol definition or declaration} - {moving to symbol definition or declaration} in \uicontrol Display. + {highlighting and folding blocks} or text + wrapping in \uicontrol Display. \li Add, modify, and remove \l{Editing Code Snippets}{code snippets} in \uicontrol Snippets. diff --git a/doc/src/editors/creator-search.qdoc b/doc/src/editors/creator-search.qdoc index 33ca79fc65..877d3b7492 100644 --- a/doc/src/editors/creator-search.qdoc +++ b/doc/src/editors/creator-search.qdoc @@ -156,9 +156,11 @@ Leave the field empty to search through the file system. + \if defined(qtcreator) \li Select \uicontrol {Silver Searcher} to use the experimental Silver Searcher plugin. For more information, see \l{Enabling Silver Searcher}. + \endif \endlist @@ -167,9 +169,11 @@ \li \uicontrol {Open Documents} searches from all open files. + \if defined(qtcreator) \li \uicontrol {Clang Query Project} explores the Clang abstract syntax tree (AST) using AST matcher expressions. For more information, see \l{Exploring Clang AST}. + \endif \endlist @@ -213,8 +217,14 @@ (\uicontrol {New Search}) button. \note You can use \uicontrol {Advanced Find} also to search for symbols. For - more information, see \l{Finding Symbols}. - + more information, see + \if defined(qtcreator) + \l{Finding Symbols}. + \else + \l{Finding QML Types}. + \endif + + \if defined(qtcreator) \section1 Enabling Silver Searcher You can use Silver Searcher as a search engine in \QC if you install @@ -269,4 +279,5 @@ You can view the results of the query as links to code positions in the \uicontrol {Search Results} output pane. + \endif */ diff --git a/doc/src/howto/creator-sidebar-views.qdocinc b/doc/src/howto/creator-sidebar-views.qdocinc index 43f6239f4c..a08b04de63 100644 --- a/doc/src/howto/creator-sidebar-views.qdocinc +++ b/doc/src/howto/creator-sidebar-views.qdocinc @@ -128,8 +128,7 @@ \li To open files that belong to a project, double-click them in the project tree. Files open in the appropriate editor, according to the - file type. For example, code source files open in the code editor - and image files in the \l{Viewing Images}{image viewer}. + file type. For example, code source files open in the code editor. \li To bring up a context menu containing the actions most commonly needed, right-click an item in the project tree. For example, diff --git a/doc/src/linux-mobile/creator-deployment-embedded-linux.qdoc b/doc/src/linux-mobile/creator-deployment-embedded-linux.qdoc index 7733fa62c0..625666a191 100644 --- a/doc/src/linux-mobile/creator-deployment-embedded-linux.qdoc +++ b/doc/src/linux-mobile/creator-deployment-embedded-linux.qdoc @@ -107,6 +107,7 @@ \section1 Qt for Device Creation Deployment Steps + \if defined(qtcreator) The deployment steps depend on the Qt for Device Creation version specified in the kit. @@ -136,6 +137,7 @@ When developing with Qt for Device Creation version 5.9 or later, you can specify the deployment steps described in this section in addition to the generic deployment steps. + \endif To execute custom commands when the application is deployed to the device, select \uicontrol {Add Deploy Step} > \uicontrol {Run Custom Remote Command} @@ -144,6 +146,7 @@ To have your application launch on boot, select \uicontrol {Add Deploy Step} > \uicontrol {Change Default Application}. + \if defined(qtcreator) \include creator-projects-cmake-deploying.qdocinc cmake deploying embedded - + \endif */ diff --git a/doc/src/linux-mobile/creator-projects-running-generic-linux.qdocinc b/doc/src/linux-mobile/creator-projects-running-generic-linux.qdocinc index 5b7045703c..f573a0de79 100644 --- a/doc/src/linux-mobile/creator-projects-running-generic-linux.qdocinc +++ b/doc/src/linux-mobile/creator-projects-running-generic-linux.qdocinc @@ -48,8 +48,11 @@ \uicontrol {Application Output} view. Choose \uicontrol {Projects > Embedded Linux > Run} to view the settings for deploying - the application to the connected device. For more information, see + the application to the connected device. + \if defined(qtcreator) + For more information, see \l{Specifying Run Settings for Linux-Based Devices}. + \endif Debugging works transparently if GDB server is installed on the device and it is compatible with the GDB on the host. diff --git a/doc/src/overview/creator-acknowledgements.qdoc b/doc/src/overview/creator-acknowledgements.qdoc index b87f3be11d..c49275bb50 100644 --- a/doc/src/overview/creator-acknowledgements.qdoc +++ b/doc/src/overview/creator-acknowledgements.qdoc @@ -31,8 +31,12 @@ /*! \contentspage index.html - \previouspage technical-support.html \page creator-acknowledgements.html + \if defined(qtdesignstudio) + \previouspage studio-terms.html + \else + \previouspage technical-support.html + \endif \title Acknowledgements diff --git a/doc/src/projects/creator-projects-running.qdoc b/doc/src/projects/creator-projects-running.qdoc index 57f3a1419f..caca6bb636 100644 --- a/doc/src/projects/creator-projects-running.qdoc +++ b/doc/src/projects/creator-projects-running.qdoc @@ -76,8 +76,10 @@ \image qtcreator-application-output.png + \if defined(qtcreator) For more information on the options you have, see \l{Specifying Run Settings}. + \endif \include linux-mobile/creator-projects-running-generic-linux.qdocinc running on embedded linux diff --git a/doc/src/qtquick/qtquick-profiler.qdoc b/doc/src/qtquick/qtquick-profiler.qdoc index 939c0b5081..cd934eb55d 100644 --- a/doc/src/qtquick/qtquick-profiler.qdoc +++ b/doc/src/qtquick/qtquick-profiler.qdoc @@ -51,9 +51,11 @@ Another typical cause for similar performance problems is creating, painting, or updating invisible items, which takes time in the GUI thread. + \if defined(qtcreator) Triggering long-running C++ functions, such as paint methods and signal handlers, also takes time in the GUI thread, but is more difficult to see in the QML Profiler, because it does not profile C++ code. + \endif To find excessive use of JavaScript, check the frame rate in animations and Scene Graph events, look for gaps, and check whether the application behaves @@ -67,10 +69,12 @@ are never visible to the users, because they are located outside the screen or hidden beneath other, visible elements. + \if defined(qtcreator) If frames get dropped even though JavaScript is not being run, and there are large, unexplained gaps in the timeline, check your custom QQuickItem implementations. You can use \l{Using Valgrind Code Analysis Tools} {Valgrind} or other general purpose profilers to analyze C++ code. + \endif \section1 Using QML Profiler @@ -82,8 +86,10 @@ for the project. For more information, see \l{Setting Up QML Debugging}. + \if defined(qtcreator) \li In the \uicontrol Projects mode, select a \l{glossary-buildandrun-kit} {kit} with Qt version 4.7.4 or later. + \endif \note To profile applications on \l{glossary-device}{devices}, you must install Qt 4.7.4 or later libraries on them. diff --git a/doc/src/qtquick/qtquick-states.qdoc b/doc/src/qtquick/qtquick-states.qdoc index e03355a0a5..f476026d55 100644 --- a/doc/src/qtquick/qtquick-states.qdoc +++ b/doc/src/qtquick/qtquick-states.qdoc @@ -143,7 +143,9 @@ \endqml \endlist + \if defined(qtcreator) \include qtquick-states-scxml.qdocinc scxml state machines + \endif \section1 Animating Transitions Between States |