forked from qt-creator/qt-creator
Doc: Do not use comma before "because"
Change-Id: I375342fa10b95e26a3de2524610905c4d5503d3e Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
@@ -94,7 +94,7 @@
|
||||
\inlineimage icons/online.png
|
||||
to open the JDK download web page in the default browser.
|
||||
|
||||
\note We recommended using a 64-bit JDK, because the 32-bit one
|
||||
\note We recommended using a 64-bit JDK because the 32-bit one
|
||||
might cause issues with \c cmdline-tools, and some packages might
|
||||
not be listed.
|
||||
\li In the \uicontrol {Android SDK location} field, set the path to the
|
||||
@@ -130,7 +130,7 @@
|
||||
\section2 Manual Setup
|
||||
|
||||
\note We recommend that you use the latest Android SDK Command-Line Tools.
|
||||
Using Android SDK Tools version 25.2.5 or earlier is not supported, because
|
||||
Using Android SDK Tools version 25.2.5 or earlier is not supported because
|
||||
they cannot be fully integrated with \QC.
|
||||
|
||||
However, if the automatic setup does not meet your needs, you can download
|
||||
|
||||
@@ -161,7 +161,7 @@
|
||||
|
||||
\section3 Building AABs
|
||||
|
||||
For testing the application locally, use the APK format, because
|
||||
For testing the application locally, use the APK format because
|
||||
the package can be uploaded directly to the device and run. For
|
||||
distribution to the Google Play store, create an AAB by selecting
|
||||
the \uicontrol {Build Android App Bundle (*.aab)} check box.
|
||||
@@ -185,7 +185,7 @@
|
||||
verify that the future versions of your application are actually created by
|
||||
you.
|
||||
|
||||
\warning Keep the key pair in a safe place and take back up copies, because
|
||||
\warning Keep the key pair in a safe place and take back up copies because
|
||||
you cannot update the application if you lose the key pair.
|
||||
|
||||
You can use \QC to generate a keystore and a \e {self-signed} certificate.
|
||||
|
||||
@@ -42,7 +42,7 @@
|
||||
specify the debugger and compiler to use for each kit, select
|
||||
\uicontrol Edit > \uicontrol Preferences > \uicontrol Kits.
|
||||
|
||||
You need to set up the debugger only if the automatic setup fails, because
|
||||
You need to set up the debugger only if the automatic setup fails because
|
||||
the native debugger is missing (as is usually the case for the CDB debugger
|
||||
on Windows, which you always must install yourself) or because the installed
|
||||
version is not supported (for example, when your system contains no, or an
|
||||
|
||||
@@ -675,7 +675,7 @@
|
||||
the bottom of the view. Output is displayed in the right pane of the
|
||||
\uicontrol {Debugger Log} view.
|
||||
|
||||
\note Usually, you do not need this feature, because \QC provides you
|
||||
\note Usually, you do not need this feature because \QC provides you
|
||||
with better ways to handle the task. For example, instead of using the GDB
|
||||
\c print command from the command line, you can evaluate an expression in
|
||||
the \uicontrol {Expressions} view.
|
||||
@@ -1565,7 +1565,7 @@
|
||||
\l{http://wiki.ubuntu.com/SecurityTeam/Roadmap/KernelHardening#ptrace%20Protection}
|
||||
{KernelHardening}.
|
||||
|
||||
However, the usefulness of this security measure seems dubious, because this
|
||||
However, the usefulness of this security measure seems dubious because this
|
||||
feature can be easily disabled. With root permissions, you can disable the
|
||||
feature temporarily by writing \c{0} into
|
||||
\c{/proc/sys/kernel/yama/ptrace_scope} or permanently by changing the value
|
||||
|
||||
@@ -257,7 +257,7 @@
|
||||
project containing the file that is currently open in the editor:
|
||||
\c {%{CurrentDocument:Project:Name}}.
|
||||
|
||||
Use unique variable names within a snippet, because all instances of a
|
||||
Use unique variable names within a snippet because all instances of a
|
||||
variable are renamed when you specify a value for it.
|
||||
|
||||
To determine the case of values you enter in snippets, use the following
|
||||
|
||||
@@ -99,7 +99,7 @@
|
||||
numerical types, whereas masks for strings must be in base 16, and
|
||||
start with 0x.
|
||||
|
||||
\note You are recommended not to change the range and priority,
|
||||
\note You are recommended not to change the range and priority
|
||||
because it might cause problems when opening files in \QC.
|
||||
|
||||
\li Click \uicontrol OK to return to the \uicontrol {MIME Types} tab.
|
||||
|
||||
@@ -235,7 +235,7 @@
|
||||
> \uicontrol {On help start} field.
|
||||
To display the page and help views that were open when you exited the mode,
|
||||
select the \uicontrol {Show My Tabs from Last Session} option. However, Web pages
|
||||
are not opened, because loading them would slow down opening the \uicontrol Help
|
||||
are not opened because loading them would slow down opening the \uicontrol Help
|
||||
mode.
|
||||
|
||||
To display a particular page, select \uicontrol {Show My Home Page}, and specify
|
||||
|
||||
@@ -319,7 +319,7 @@
|
||||
\li The common solution is to give the user the ability to reorder
|
||||
tabs. Now user has to manage tabs instead of writing code.
|
||||
|
||||
\li Tabs force you to limit the amount of open editors, because
|
||||
\li Tabs force you to limit the amount of open editors because
|
||||
otherwise you get confused.
|
||||
|
||||
\endlist
|
||||
|
||||
@@ -113,7 +113,7 @@
|
||||
|
||||
\endlist
|
||||
|
||||
\note If you cannot deploy applications, because a provisioning profile is
|
||||
\note If you cannot deploy applications because a provisioning profile is
|
||||
missing, check that provisioning profiles are listed in Xcode by selecting
|
||||
\uicontrol Xcode > \uicontrol Preferences > \uicontrol Accounts. For more
|
||||
information about how to acquire and install a provisioning profile, see
|
||||
|
||||
@@ -166,7 +166,7 @@
|
||||
with a single QML file that contains the main view. You can
|
||||
preview Qt Quick 2 UI projects in the
|
||||
\l{Validating with Target Hardware}{QML Scene preview tool}.
|
||||
You do not need to build them, because they do not contain any
|
||||
You do not need to build them because they do not contain any
|
||||
C++ code.
|
||||
|
||||
Use this template only if you are prototyping. You cannot create
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
actually copied from the \QC source directory into the \QC build directory
|
||||
as part of the next \QC build.
|
||||
|
||||
If you do not run CMake or qmake, your new wizard will not show up, because
|
||||
If you do not run CMake or qmake, your new wizard will not show up because
|
||||
it does not exist in the build directory you run your newly built \QC from.
|
||||
It never got copied there because CMake or qmake did not inform the
|
||||
build tool, such as make or ninja, about the new files in the source tree.
|
||||
|
||||
@@ -104,7 +104,7 @@
|
||||
default.
|
||||
|
||||
\note On Windows, the build will fail if the application
|
||||
is running, because the executable file cannot be
|
||||
is running because the executable file cannot be
|
||||
overwritten. To avoid this issue, you can deselect this
|
||||
check box and add a \uicontrol {Qbs Install} deployment step
|
||||
in the run settings that will be performed just before
|
||||
|
||||
@@ -80,7 +80,7 @@
|
||||
\l {Application Output} displays the status of the
|
||||
application while it is running. You can select the \uicontrol Run button
|
||||
to re-run applications without building them first. This is
|
||||
useful when developing Qt Quick applications, because the QML files are
|
||||
useful when developing Qt Quick applications because the QML files are
|
||||
interpreted at runtime. Therefore, the application does not need to be
|
||||
built again if you edited only QML files. This saves time especially if
|
||||
the application contains large image files that would need to be bundled
|
||||
|
||||
@@ -43,7 +43,7 @@
|
||||
asks you whether you would like to open the file in \QDS instead. Select
|
||||
\uicontrol {Open in \QDS} to open the file in \QDS. To continue editing
|
||||
the file in \QC, close the info bar. However, we do not recommend editing
|
||||
\l{UI Files}{UI files} in the \uicontrol Edit mode, because it is easy to
|
||||
\l{UI Files}{UI files} in the \uicontrol Edit mode because it is easy to
|
||||
add code that is not supported by \QDS. To hide the question, select
|
||||
\uicontrol {Do Not Show Again}.
|
||||
|
||||
|
||||
@@ -62,7 +62,7 @@
|
||||
\li Qt Quick UI Prototype
|
||||
\li Creates a Qt Quick UI project with a single QML file that
|
||||
contains the main view. You can preview Qt Quick 2 UI projects
|
||||
in the QML Scene preview tool. You do not need to build them,
|
||||
in the QML Scene preview tool. You do not need to build them
|
||||
because they do not contain any C++ code.
|
||||
|
||||
This project type is compatible with \QDS. However, use this
|
||||
@@ -168,7 +168,7 @@
|
||||
Qt Quick UI Prototype projects are useful for testing or prototyping user
|
||||
interfaces,
|
||||
or for setting up a separate project just for QML editing, for example. You
|
||||
cannot use them for application development, because they do not contain:
|
||||
cannot use them for application development because they do not contain:
|
||||
|
||||
\list
|
||||
\li C++ code
|
||||
|
||||
@@ -76,7 +76,7 @@
|
||||
|
||||
The first time you preview a UI on devices, the preview utility
|
||||
is copied to them. This might take some time. Thereafter, previewing will
|
||||
get faster, because only the UI files need to be copied to the
|
||||
get faster because only the UI files need to be copied to the
|
||||
device.
|
||||
|
||||
\section2 Previewing on Boot2Qt Devices
|
||||
|
||||
@@ -53,7 +53,7 @@
|
||||
\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.
|
||||
the QML Profiler because it does not profile C++ code.
|
||||
\endif
|
||||
|
||||
To find excessive use of JavaScript, check the frame rate in animations and
|
||||
@@ -65,7 +65,7 @@
|
||||
frames and check that you are not using too many short bindings or signal
|
||||
handlers that are updated per frame. You can also \l{Visualizing Overdraw}
|
||||
{visualize Scene Graph overdraw} to check scene layout and find items that
|
||||
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.
|
||||
|
||||
\if defined(qtcreator)
|
||||
@@ -127,7 +127,7 @@
|
||||
takes time, and therefore, there might be a delay
|
||||
before the data is displayed.
|
||||
|
||||
Do not use application commands to exit the application, because data is
|
||||
Do not use application commands to exit the application because data is
|
||||
sent to the QML Profiler when you select the \uicontrol {Enable Profiling} button.
|
||||
The application continues to run for some seconds, after which it is stopped
|
||||
automatically. If you exit the application, the data is not sent.
|
||||
|
||||
@@ -183,7 +183,7 @@
|
||||
\li On Windows, if no \l{High DPI}{scaling environment variables} are
|
||||
set, \QC instructs Qt to detect the scaling factor and use it for
|
||||
\QC.
|
||||
\li On Linux, \QC leaves it to the user to enable high DPI scaling,
|
||||
\li On Linux, \QC leaves it to the user to enable high DPI scaling
|
||||
because the process varies so much on different distributions
|
||||
and windowing systems that it cannot be reliably done automatically.
|
||||
\endlist
|
||||
|
||||
@@ -179,7 +179,7 @@
|
||||
|
||||
The \c {\else} command is sometimes used to replace some \QC specific text
|
||||
with text that applies to \QDS. For example, the following \c if-else
|
||||
statement is needed in the \QC Manual sources, because the project wizards
|
||||
statement is needed in the \QC Manual sources because the project wizards
|
||||
in \QDS are different from those in \QC, and are therefore described in
|
||||
a new topic that is located in the \QDS Manual sources:
|
||||
|
||||
@@ -251,7 +251,7 @@
|
||||
It is mostly used in the \QC Manual sources to specify values for the
|
||||
\c {\previouspage} and \c {\nextpage} commands depending on whether
|
||||
the \QDS Manual or \QC Manual is being built. For example, the
|
||||
following \c if-else statement is needed, because only the Git
|
||||
following \c if-else statement is needed because only the Git
|
||||
version control system is integrated to \QDS, and information about
|
||||
the other systems integrated to \QC is hidden:
|
||||
|
||||
@@ -349,7 +349,7 @@
|
||||
topic in the Qt reference documentation.
|
||||
|
||||
This improves the consistency of the look and feel of Qt documentation,
|
||||
and eliminates the need to describe parts of the UI in the text, because
|
||||
and eliminates the need to describe parts of the UI in the text because
|
||||
you can just insert the number of the element you are referring to in
|
||||
brackets.
|
||||
|
||||
|
||||
@@ -259,7 +259,7 @@
|
||||
Use \c{QDir::toNativeSeparators()} for file and directory names that you
|
||||
pass to \c{tr().arg()}.
|
||||
|
||||
Do not use markup that spans the whole string, because that can be confusing
|
||||
Do not use markup that spans the whole string because that can be confusing
|
||||
for translators. For example, instead of:
|
||||
|
||||
\code
|
||||
|
||||
@@ -168,7 +168,7 @@
|
||||
\image coffee-machine-timeline-settings.png
|
||||
|
||||
We set the start frame for the \c {"selection"} state to 400 and
|
||||
the end frame to 200, because we are moving back on the timeline to display
|
||||
the end frame to 200 because we are moving back on the timeline to display
|
||||
the selection sidebar.
|
||||
|
||||
In the \uicontrol {Transition to state} field, we select the state to
|
||||
|
||||
@@ -90,7 +90,7 @@
|
||||
\l {basic-image}{Image}, \l Text, and \l {Mouse Area} components. For the
|
||||
screen background, we use the \l {basic-rectangle}{Rectangle} component.
|
||||
|
||||
The text might look different on the desktop and MCUs, because on the
|
||||
The text might look different on the desktop and MCUs because on the
|
||||
desktop we use dynamic font loading, whereas on MCUs fonts are compiled
|
||||
into application sources. Therefore, the text will always be Maven Pro
|
||||
on MCUs, whereas on the desktop you'd need to have Maven Pro installed
|
||||
@@ -227,7 +227,7 @@
|
||||
\skipto Item {
|
||||
\printuntil }
|
||||
|
||||
We have to do it this way, because we are developing for MCUs. We have to
|
||||
We have to do it this way because we are developing for MCUs. We have to
|
||||
use either \c when conditions or set the state directly through code,
|
||||
which overrides \c when conditions. Otherwise, we could just select the
|
||||
action to change to the state that we want in the \uicontrol Action field.
|
||||
|
||||
@@ -198,7 +198,7 @@
|
||||
\inlineimage icons/anchor-fill.png
|
||||
(\uicontrol {Fill to Parent}) button to always make the
|
||||
image the same size as its parent. This makes the button
|
||||
component scalable, because the image size is bound to the
|
||||
component scalable because the image size is bound to the
|
||||
component size.
|
||||
\endlist
|
||||
\li Select the other border image to edit the values of its properties
|
||||
|
||||
@@ -70,7 +70,7 @@
|
||||
components, unless it has been explicitly set for them.
|
||||
|
||||
\note Take care when enabling wheel events for controls within scrollable
|
||||
components, such as \l Flickable, because the control will consume the
|
||||
components, such as \l Flickable because the control will consume the
|
||||
events, and therefore interrupt scrolling of the flickable.
|
||||
|
||||
\uicontrol Spacing is useful for controls that have multiple or repetitive
|
||||
@@ -130,7 +130,7 @@
|
||||
The button text should be a verb describing the action, or a noun matching
|
||||
the title of the popup that will be opened.
|
||||
|
||||
Don't use a button to set state, because a \l Switch is more suitable for
|
||||
Don't use a button to set state because a \l Switch is more suitable for
|
||||
that purpose.
|
||||
|
||||
\section3 Highlighted Buttons
|
||||
|
||||
@@ -118,7 +118,7 @@
|
||||
|
||||
If the source is an intrinsically scalable image (such as SVG), source size
|
||||
determines the size of the loaded image regardless of intrinsic size.
|
||||
Avoid changing the source size property dynamically, because rendering an
|
||||
Avoid changing the source size property dynamically because rendering an
|
||||
SVG is slow compared with rendering other image formats.
|
||||
|
||||
If the source is a non-scalable image (such as JPEG), the loaded image will
|
||||
|
||||
@@ -98,7 +98,7 @@
|
||||
\endqml
|
||||
|
||||
This works nicely for applications but \uicontrol {Form Editor} displays a
|
||||
zero-sized component. A parent for the opened file does not exist, because
|
||||
zero-sized component. A parent for the opened file does not exist because
|
||||
the context is missing. To get around the missing context, the idea of a
|
||||
\e {dummy context} is introduced. If you place a file with the same name as
|
||||
the application (here, example.qml) in the \c {dummydata/context} directory,
|
||||
|
||||
@@ -54,7 +54,7 @@
|
||||
\list 1
|
||||
\li In the File Explorer, create a new folder for the mock data
|
||||
inside the \e imports folder in your project folder (for example, \e Data).
|
||||
\note Make sure to capitalize the \e Data folder name, because you
|
||||
\note Make sure to capitalize the \e Data folder name because you
|
||||
will need to import it as a component later, and component names must
|
||||
be capitalized.
|
||||
\note If you place this folder somewhere else in the project, you will
|
||||
@@ -73,7 +73,7 @@
|
||||
\li Follow the instructions of the wizard to create the Qt Quick file
|
||||
in the data folder. In these instructions, the file is called
|
||||
\e Values.qml.
|
||||
\note Make sure to capitalize the filename, because it will become
|
||||
\note Make sure to capitalize the filename because it will become
|
||||
a custom component.
|
||||
\li Select \uicontrol File > \uicontrol {New File} >
|
||||
\uicontrol {JavaScript} >
|
||||
|
||||
@@ -67,7 +67,7 @@
|
||||
The \uicontrol Cached property allows the effect output pixels to be cached
|
||||
in order to improve the rendering performance. Every time the source or
|
||||
effect properties are changed, the pixels in the cache must be updated.
|
||||
Memory consumption is increased, because an extra buffer of memory is
|
||||
Memory consumption is increased because an extra buffer of memory is
|
||||
required for storing the effect output. We recommend that you disable the
|
||||
cache when the source or the effect properties are animated.
|
||||
|
||||
|
||||
@@ -439,7 +439,7 @@
|
||||
The value of the \uicontrol Format field specifies the internal OpenGL
|
||||
format of the texture. Depending on the OpenGL implementation, it might
|
||||
allow you to save some texture memory. However, use the \uicontrol RGB
|
||||
and \uicontrol Alpha values with caution, because the underlying hardware
|
||||
and \uicontrol Alpha values with caution because the underlying hardware
|
||||
and driver might not support them.
|
||||
|
||||
In the \uicontrol {Texture mirroring} field, specify whether the generated
|
||||
|
||||
Reference in New Issue
Block a user