Doc: Use defines to hide info not related to Qt Quick projects

Change-Id: I70ee417aebcddd32ef9f6419e3000fdfd02c9707
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
This commit is contained in:
Leena Miettinen
2018-08-30 12:36:23 +02:00
parent aa588449b0
commit fdbcfc6756
12 changed files with 51 additions and 12 deletions

View File

@@ -176,7 +176,11 @@
\li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol Application > \li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol Application >
\uicontrol {Qt Quick Application} > \uicontrol Choose, and \uicontrol {Qt Quick Application} > \uicontrol Choose, and
follow the instructions of the wizard. For more information, see follow the instructions of the wizard. For more information, see
\if defined(qtcreator)
\l{Creating Qt Quick Projects}. \l{Creating Qt Quick Projects}.
\else
\l{Creating UI Prototype Projects}.
\endif
\li To specify settings for deploying applications to Android, select \li To specify settings for deploying applications to Android, select
\uicontrol Projects > \uicontrol Run for the \uicontrol Android kit, and then select \uicontrol Projects > \uicontrol Run for the \uicontrol Android kit, and then select

View File

@@ -49,8 +49,10 @@
To specify settings for application packages, select \uicontrol Projects > To specify settings for application packages, select \uicontrol Projects >
\uicontrol {Build Android APK} > \uicontrol Details. \uicontrol {Build Android APK} > \uicontrol Details.
\if defined(qtcreator)
For more information about options that you have for running applications, For more information about options that you have for running applications,
see \l {Specifying Run Settings for Android Devices}. see \l {Specifying Run Settings for Android Devices}.
\endif
\section1 Using Ministro to Install Qt Libraries \section1 Using Ministro to Install Qt Libraries

View File

@@ -98,9 +98,11 @@
If the files change outside \QC, select \inlineimage reload_gray.png If the files change outside \QC, select \inlineimage reload_gray.png
(\uicontrol {Reload Editor}) to compare them again and to show the results. (\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} 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 {code pasting service}, select \uicontrol {Send Chunk to CodePaster} in the
context menu. context menu.
\endif
\section1 Changing the Colors \section1 Changing the Colors

View File

@@ -46,8 +46,10 @@
\uicontrol Options > \uicontrol{Text Editor}. \uicontrol Options > \uicontrol{Text Editor}.
These settings apply to all projects. To specify editor behavior for an open These settings apply to all projects. To specify editor behavior for an open
project, select \uicontrol Projects > \uicontrol Editor. For more project, select \uicontrol Projects > \uicontrol Editor.
information, see \l{Specifying Editor Settings}. \if defined(qtcreator)
For more information, see \l{Specifying Editor Settings}.
\endif
You can also specify indentation settings separately for C++ and QML files You can also specify indentation settings separately for C++ and QML files
either globally or for the open project. For more information, see 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 \li Set \l{Indenting Text or Code}{tabs, indentation, the handling of
whitespace, and mouse operations} in \uicontrol Behavior. 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} \l{Highlighting and folding blocks}
{highlighting and folding blocks}, text wrapping or {highlighting and folding blocks} or text
\l{Moving to symbol definition or declaration} wrapping in \uicontrol Display.
{moving to symbol definition or declaration} in \uicontrol Display.
\li Add, modify, and remove \l{Editing Code Snippets}{code snippets} in \li Add, modify, and remove \l{Editing Code Snippets}{code snippets} in
\uicontrol Snippets. \uicontrol Snippets.

View File

@@ -156,9 +156,11 @@
Leave the field empty to search through the file Leave the field empty to search through the file
system. system.
\if defined(qtcreator)
\li Select \uicontrol {Silver Searcher} to use the \li Select \uicontrol {Silver Searcher} to use the
experimental Silver Searcher plugin. For more experimental Silver Searcher plugin. For more
information, see \l{Enabling Silver Searcher}. information, see \l{Enabling Silver Searcher}.
\endif
\endlist \endlist
@@ -167,9 +169,11 @@
\li \uicontrol {Open Documents} searches from all open files. \li \uicontrol {Open Documents} searches from all open files.
\if defined(qtcreator)
\li \uicontrol {Clang Query Project} explores the Clang abstract \li \uicontrol {Clang Query Project} explores the Clang abstract
syntax tree (AST) using AST matcher expressions. For more syntax tree (AST) using AST matcher expressions. For more
information, see \l{Exploring Clang AST}. information, see \l{Exploring Clang AST}.
\endif
\endlist \endlist
@@ -213,8 +217,14 @@
(\uicontrol {New Search}) button. (\uicontrol {New Search}) button.
\note You can use \uicontrol {Advanced Find} also to search for symbols. For \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 \section1 Enabling Silver Searcher
You can use Silver Searcher as a search engine in \QC if you install 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 You can view the results of the query as links to code positions in the
\uicontrol {Search Results} output pane. \uicontrol {Search Results} output pane.
\endif
*/ */

View File

@@ -128,8 +128,7 @@
\li To open files that belong to a project, double-click them in the \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 project tree. Files open in the appropriate editor, according to the
file type. For example, code source files open in the code editor file type. For example, code source files open in the code editor.
and image files in the \l{Viewing Images}{image viewer}.
\li To bring up a context menu containing the actions most commonly \li To bring up a context menu containing the actions most commonly
needed, right-click an item in the project tree. For example, needed, right-click an item in the project tree. For example,

View File

@@ -107,6 +107,7 @@
\section1 Qt for Device Creation Deployment Steps \section1 Qt for Device Creation Deployment Steps
\if defined(qtcreator)
The deployment steps depend on the Qt for Device Creation version specified The deployment steps depend on the Qt for Device Creation version specified
in the kit. in the kit.
@@ -136,6 +137,7 @@
When developing with Qt for Device Creation version 5.9 or later, you can 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 specify the deployment steps described in this section in addition to the
generic deployment steps. generic deployment steps.
\endif
To execute custom commands when the application is deployed to the device, To execute custom commands when the application is deployed to the device,
select \uicontrol {Add Deploy Step} > \uicontrol {Run Custom Remote Command} 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} To have your application launch on boot, select \uicontrol {Add Deploy Step}
> \uicontrol {Change Default Application}. > \uicontrol {Change Default Application}.
\if defined(qtcreator)
\include creator-projects-cmake-deploying.qdocinc cmake deploying embedded \include creator-projects-cmake-deploying.qdocinc cmake deploying embedded
\endif
*/ */

View File

@@ -48,8 +48,11 @@
\uicontrol {Application Output} view. \uicontrol {Application Output} view.
Choose \uicontrol {Projects > Embedded Linux > Run} to view the settings for deploying 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}. \l{Specifying Run Settings for Linux-Based Devices}.
\endif
Debugging works transparently if GDB server is installed on the device and Debugging works transparently if GDB server is installed on the device and
it is compatible with the GDB on the host. it is compatible with the GDB on the host.

View File

@@ -31,8 +31,12 @@
/*! /*!
\contentspage index.html \contentspage index.html
\previouspage technical-support.html
\page creator-acknowledgements.html \page creator-acknowledgements.html
\if defined(qtdesignstudio)
\previouspage studio-terms.html
\else
\previouspage technical-support.html
\endif
\title Acknowledgements \title Acknowledgements

View File

@@ -76,8 +76,10 @@
\image qtcreator-application-output.png \image qtcreator-application-output.png
\if defined(qtcreator)
For more information on the options you have, see For more information on the options you have, see
\l{Specifying Run Settings}. \l{Specifying Run Settings}.
\endif
\include linux-mobile/creator-projects-running-generic-linux.qdocinc running on embedded linux \include linux-mobile/creator-projects-running-generic-linux.qdocinc running on embedded linux

View File

@@ -51,9 +51,11 @@
Another typical cause for similar performance problems is creating, Another typical cause for similar performance problems is creating,
painting, or updating invisible items, which takes time in the GUI thread. 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 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 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. the QML Profiler, because it does not profile C++ code.
\endif
To find excessive use of JavaScript, check the frame rate in animations and 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 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 are never visible to the users, because they are located outside the screen
or hidden beneath other, visible elements. or hidden beneath other, visible elements.
\if defined(qtcreator)
If frames get dropped even though JavaScript is not being run, and there are If frames get dropped even though JavaScript is not being run, and there are
large, unexplained gaps in the timeline, check your custom QQuickItem large, unexplained gaps in the timeline, check your custom QQuickItem
implementations. You can use \l{Using Valgrind Code Analysis Tools} implementations. You can use \l{Using Valgrind Code Analysis Tools}
{Valgrind} or other general purpose profilers to analyze C++ code. {Valgrind} or other general purpose profilers to analyze C++ code.
\endif
\section1 Using QML Profiler \section1 Using QML Profiler
@@ -82,8 +86,10 @@
for the project. For more information, see for the project. For more information, see
\l{Setting Up QML Debugging}. \l{Setting Up QML Debugging}.
\if defined(qtcreator)
\li In the \uicontrol Projects mode, select a \l{glossary-buildandrun-kit} \li In the \uicontrol Projects mode, select a \l{glossary-buildandrun-kit}
{kit} with Qt version 4.7.4 or later. {kit} with Qt version 4.7.4 or later.
\endif
\note To profile applications on \l{glossary-device}{devices}, you \note To profile applications on \l{glossary-device}{devices}, you
must install Qt 4.7.4 or later libraries on them. must install Qt 4.7.4 or later libraries on them.

View File

@@ -143,7 +143,9 @@
\endqml \endqml
\endlist \endlist
\if defined(qtcreator)
\include qtquick-states-scxml.qdocinc scxml state machines \include qtquick-states-scxml.qdocinc scxml state machines
\endif
\section1 Animating Transitions Between States \section1 Animating Transitions Between States