feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Replace "provide" with something simpler

Browse Source 
This follows the ComplexWords rule in vale.

Change-Id: I99d8e5dc3ee4736a254064b6ef00166419fccee8
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
This commit is contained in:
Leena Miettinen
2023-02-03 17:25:21 +01:00
parent 33badfa660
commit 738819ec71
52 changed files with 163 additions and 174 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/qtcreator/src/analyze/cpu-usage-analyzer.qdoc
View File

@@ -29,8 +29,8 @@
Profile builds produce optimized binaries with separate debug symbols and
should generally be used for profiling.
To manually set up a build configuration to provide separate debug symbols,
edit the project build settings:
To manually set up a build configuration that generates separate debug
symbols, edit the project build settings:
\list 1
\li To generate debug symbols also for applications compiled in release
@@ -294,7 +294,7 @@
events to move the cursor in the code editor to the part of the code the
event is associated with.
As the Perf tool only provides periodic samples, the Performance Analyzer
As the Perf tool only collects periodic samples, the Performance Analyzer
cannot determine the exact time when a function was called or when it
returned. You can, however, see exactly when a sample was taken in the
second row of each thread. The Performance Analyzer assumes that if the same

8
doc/qtcreator/src/analyze/creator-clang-static-analyzer.qdoc
View File

@@ -20,13 +20,13 @@
\list
\li \l{https://clang.llvm.org/extra/clang-tidy/}{Clang-Tidy}, which
provides diagnostics and fixes for typical programming errors,
has diagnostics and fixes for typical programming errors,
such as style violations or interface misuse.
\li \l{https://github.com/KDE/clazy/blob/master/README.md}{Clazy}, which
helps Clang understand Qt semantics. It displays Qt related compiler
warnings, ranging from unnecessary memory allocation to misuse of
API and provides refactoring actions for fixing some of the issues.
API and has refactoring actions for fixing some of the issues.
\endlist
@@ -191,8 +191,8 @@
\section2 Selecting Clazy Check Levels
The Clazy checks are divided into levels from 0 to 3. The checks at level 0
are very stable and provide hardly any false positives, while the checks at
level 3 can be considered experimental. You can select the checks to perform
are very stable and show hardly any false positives, while the checks at
level 3 are experimental. You can select the checks to perform
at each level. To include the checks from the lower levels automatically,
select the \uicontrol {Enable lower levels automatically} check box.

2
doc/qtcreator/src/analyze/creator-cppcheck.qdoc
View File

@@ -49,7 +49,7 @@
\li In the \uicontrol {Ignored file patterns} field, enter a filter
for ignoring files that match the pattern (wildcard). You can enter
multiple patterns separated by commas. Even though Cppcheck is not
run on files that match the provided patterns, they might be
run on files that match the patterns, they might be
implicitly checked if other files include them.
\li Select the \uicontrol {Inconclusive errors} check box to also
mark possible false positives.

10
doc/qtcreator/src/analyze/creator-ctf-visualizer.qdoc
View File

@@ -18,13 +18,13 @@
JavaScript down to the C++ and all the way to the kernel space. This
enables you to measure the performance of an application and to check
whether it is CPU or I/O bound or influenced by other applications
running on the same system. Tracing provides insight into what a system is
running on the same system. Tracing gives insight into what a system is
doing and why an application is performing in a particular way. It indicates
how the hardware is utilized and what the kernel and application are doing.
Tracing information can also provide you additional insight into the data
collected by \l{Profiling QML Applications}{QML Profiler}. For example, you
could check why a trivial binding evaluation is taking so long. This might
Tracing information can tell you more about the data that
\l{Profiling QML Applications}{QML Profiler} collects. For example, you
can check why a trivial binding evaluation is taking so long. This might
be caused by C++ being executed or the disk I/O being slow.
Several tracing tools (such as \c {chrome://about}) can generate information
@@ -110,7 +110,7 @@
LTTng is a tracing toolkit for Linux that you can apply on embedded Linux
systems to find out how to optimize the startup time of an application.
Since Qt 5.13, Qt provides a set of kernel trace points and a tracing
Since Qt 5.13, Qt has a set of kernel trace points and a tracing
subsystem for custom user space trace points.
\section2 Configuring the Kernel

2
doc/qtcreator/src/analyze/creator-heob.qdoc
View File

@@ -44,7 +44,7 @@
\image qtcreator-heob.png
Heob raises an access violation on buffer overruns and provides stack traces
Heob raises an access violation on buffer overruns and records stack traces
of the offending instruction and buffer allocation. The results are
displayed when Heob exits normally.

6
doc/qtcreator/src/android/androiddev.qdoc
View File

@@ -169,9 +169,9 @@
\section2 Managing Android SDK Packages
Since Android SDK Tools version 25.3.0, only a command-line tool,
\l {sdkmanager}, is provided by Android for SDK package management.
To make SDK management easier, \QC provides an SDK Manager for
Since Android SDK Tools version 25.3.0, Android has only a command-line
tool, \l {sdkmanager}, for SDK package management. To make SDK management
easier, \QC has an SDK Manager for
installing, updating, and removing SDK packages. You can still use
sdkmanager for advanced SDK management.

6
doc/qtcreator/src/android/deploying-android.qdoc
View File

@@ -40,7 +40,7 @@
\section1 Packaging Applications
Because bundling applications as APK packages is not
trivial, Qt 5 provides a deployment tool called \c androiddeployqt.
trivial, Qt 5 has a deployment tool called \c androiddeployqt.
When you deploy an application using a \e {Qt for Android kit}, \QC uses
the \c androiddeployqt tool to create the necessary files and to bundle them
into an APK:
@@ -51,7 +51,7 @@
that automatically load Qt and execute the native code in your
application.
\li AndroidManifest.xml, which provides meta-information about your
\li AndroidManifest.xml, which has meta-information about your
application.
\li Other XML files, which specify the dependencies of your application.
@@ -65,7 +65,7 @@
\li Gradle script that is needed by Java IDEs, such as Android Studio.
It allows the user to extend the Java part without copying our Java
sources. It also allows the IDEs to provide code completion, syntax
sources. It also allows the IDEs to offer code completion, syntax
highlighting, and so on.
\endlist

2
doc/qtcreator/src/cmake/creator-projects-cmake.qdoc
View File

@@ -94,7 +94,7 @@
executable.
\li The \uicontrol {Help file} field displays the path to the
CMake help file (.qch) provided by and installed with CMake.
CMake help file (.qch) that comes with CMake.
\li Deselect the \uicontrol {Autorun CMake} check box if you do not want
to automatically run CMake every time when you save changes to

4
doc/qtcreator/src/conan/creator-projects-conan.qdoc
View File

@@ -28,8 +28,8 @@
sources. Because the client has a local cache for package storage, you can
work offline, as long as no new packages are needed from remote servers.
To use Conan, install it by using the Qt installer or the tools provided by
your operating system. For example, on Windows, you can use the
To use Conan, install it by using the Qt installer or the tools that
your operating system has. For example, on Windows, you can use the
\c {choco install conan} or \c {pip install conan} command.
To enable the experimental Conan plugin, select \uicontrol Help >

19
doc/qtcreator/src/debugger/creator-debugger-common.qdocinc
View File

@@ -368,7 +368,7 @@
\uicontrol {Locals} and \uicontrol {Expressions} view to show
unexpected data.
\row
\li The debug information provided by GCC does not include enough
\li The debug information from GCC does not include enough
information about the time when a variable is initialized.
Therefore, \QC can not tell whether the contents of a local
variable are \e {real data} or \e {initial noise}. If a QObject
@@ -385,21 +385,20 @@
\section1 Inspecting Basic Qt Objects
The \uicontrol {Locals} and \uicontrol {Expressions} views also provide access
to the most powerful feature of the debugger: comprehensive display of data
belonging to Qt's basic objects. For example, in case of QObject, instead of
displaying a pointer to some private data structure, you see a list of
The most powerful feature of the debugger is that the \uicontrol {Locals}
and \uicontrol {Expressions} views show the data that belongs to
Qt's basic objects. For example, in case of QObject, instead of
a pointer to some private data structure, you see a list of
children, signals, and slots.
Similarly, instead of displaying many pointers and integers, \QC's debugger
displays the contents of a QHash or QMap in an orderly manner. Also, the
debugger displays access data for QFileInfo and provides access to the
\e real contents of QVariant.
debugger shows access data for QFileInfo and the \e real contents of QVariant.
Right-click in the \uicontrol {Locals} or the \uicontrol {Expressions} view
to open a context menu that provides additional options for viewing data. The
available options depend on the type of the current items, and are provided
by the \l{Using Debugging Helpers}{Debugging Helpers}. Typically,
to open a context menu that has more options for viewing data. The
available options depend on the type of the current items, and come from
the \l{Using Debugging Helpers}{Debugging Helpers}. Typically,
string-like data, such as \c{QByteArray} and \c{std::string}, offer a
selection of encodings, as well as the possibility to use a full editor
window. Map-like data, such as \c{QMap}, \c{QHash}, and \c{std::map}, offer

7
doc/qtcreator/src/debugger/creator-only/creator-debugger-settings.qdocinc
View File

@@ -170,9 +170,8 @@
source code editor, select the \uicontrol {Correct breakpoint location}
check box. For more information, see \l{Setting Breakpoints}.
To use the abstraction layer provided by Python Dumper
classes to create a description of data items displayed
in the \uicontrol Locals and \uicontrol Expressions
To use the abstraction layer of Python Dumper classes to create a description
of data items in the \uicontrol Locals and \uicontrol Expressions
views, select the \uicontrol {Use Python dumper} check box.
For more information, see \l{Debugging Helper Implementation}.
@@ -183,7 +182,7 @@
\section2 Setting CDB Paths on Windows
To obtain debugging information for the operating system libraries for
debugging Windows applications, add the Symbol Server provided by Microsoft
debugging Windows applications, add the Microsoft Symbol Server
to the symbol search path of the debugger:
\list 1

19
doc/qtcreator/src/debugger/creator-only/creator-debugger-setup.qdoc
View File

@@ -37,14 +37,14 @@
\uicontrol Debuggers > \uicontrol Add to add it.
\note To use the debugging tools for Windows, you must install them and add
the Symbol Server provided by Microsoft to the symbol search path of the
the Microsoft Symbol Server to the symbol search path of the
debugger. For more information, see \l{Setting CDB Paths on Windows}.
\note To use the Free Software Foundation (FSF) version of GDB on \macos, you
must sign it and modify your \l{glossary-buildandrun-kit}{kit} settings.
This section explains the options you have for debugging C++ code and
provides installation notes for the supported native debuggers. It also
This section describes the options you have for debugging C++ code and
installing the supported native debuggers. It also
applies for code in other compiled languages such as C, FORTRAN, Ada.
For more information on the debugger modes, see
@@ -145,8 +145,7 @@
\section1 Installing Native Debuggers
The following sections provide information about installing native
debuggers.
The following sections describe installing native debuggers.
\section2 GDB
@@ -185,12 +184,10 @@
\section3 Symbol Server
It is highly recommended that you add the Symbol Server provided
by Microsoft to the symbol search path of the debugger. The
Symbol Server provides you with debugging information for the
operating system libraries for debugging Windows applications.
For more information, see
\l{Setting CDB Paths on Windows}.
We highly recommend that you add the Microsoft Symbol Server to the
symbol search path of the debugger. The Symbol Server has debugging
information for the operating system libraries for debugging Windows
applications. For more information, see \l{Setting CDB Paths on Windows}.
\section2 Debugging Tools for \macos

21
doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
View File

@@ -14,7 +14,7 @@
\title Debugging
\QC provides a debugger plugin that acts as an interface between the \QC
\QC has a debugger plugin that acts as an interface between the \QC
core and external native debuggers such as the GNU Symbolic Debugger (GDB),
the Microsoft Console Debugger (CDB), a QML/JavaScript debugger, and the
debugger of the low level virtual machine (LLVM) project, LLDB.
@@ -325,8 +325,7 @@
\section1 Remote Debugging
\QC provides very easy access to remote debugging.
\QC makes remote debugging easy.
In general, the remote debugging setup consist of a probe running on the
remote machine and a counterpart running on the host side. The probe is
either integrated into the running process (e.g. for QML debugging) or runs
@@ -533,11 +532,11 @@
\endlist
\QC displays the raw information provided by the native debuggers in a clear
\QC displays the raw information from the native debuggers in a clear
and concise manner with the goal to simplify the debugging process as much
as possible without losing the power of the native debuggers.
In addition to the generic IDE functionality provided by stack view, views
In addition to the generic IDE functionality offered by stack view, views
for locals and expressions, registers, and so on, \QC includes features to
make debugging Qt-based applications easy. The debugger plugin understands
the internal layout of several Qt classes, for example, QString, the Qt
@@ -627,7 +626,7 @@
into one step for less noisy debugging. For more information, see
\l{Specifying GDB Settings}.
The extended GDB settings provide the option to step backwards in code,
The extended GDB settings have the option to step backwards in code,
but this option should be used with care, as it is slow and unstable on the
GDB side. For more information, see \l{Specifying GDB Settings}.
@@ -665,8 +664,8 @@
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
with better ways to handle the task. For example, instead of using the GDB
\note Usually, you do not need this feature because \QC offers 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.
@@ -1093,9 +1092,9 @@
As the format is not guaranteed to be stable, it is strongly recommended
not to generate the wire format directly, but to use the abstraction
layer provided by the Python Dumper classes, specifically the \c{Dumper}
layer of the Python Dumper classes, specifically the \c{Dumper}
class itself, and the \c{Dumper:Value} and \c{Dumper:Type} abstractions.
These provide a complete framework to take care of the \c iname and \c addr
These offer a complete framework to take care of the \c iname and \c addr
fields, to handle children of simple types, references, pointers, enums, and
known and unknown structs, as well as some convenience functions to handle
common situations.
@@ -1287,7 +1286,7 @@
built into or shipped alongside the debugged binary, or created on-the-fly
by the debugging helper.
\QC uses the possibility to provide type information on-the-fly for most Qt
\QC offers type information on-the-fly for most Qt
classes, obliterating the need to use \e Debug builds of Qt for the purpose
of object introspection.

2
doc/qtcreator/src/editors/creator-clangformat.qdocinc
View File

@@ -15,7 +15,7 @@
\uicontrol {Restart Now} to restart \QC and load the plugin.
\note If you enable Clang Format, do not use the \l{Beautifying Source Code}
{Beautifier} because combining them can provide unexpected results.
{Beautifier} because combining them can lead to unexpected results.
You can use Clang Format to enforce a coding style for a project or the
whole organization. Create a \c {.clang-format} file that has the

10
doc/qtcreator/src/editors/creator-code-completion.qdoc
View File

@@ -9,7 +9,7 @@
\title Completing Code
As you write code, \QC suggests properties, IDs, and code snippets to
complete the code. It provides a list of suggestions to
complete the code. It shows a list of suggestions to
the statement currently under your cursor. Press \key Tab
or \key Enter to accept the selected suggestion and complete the code.
@@ -166,7 +166,7 @@
\image qml-snippet-editor.png
\QC provides you with built-in snippets in the following categories:
\QC has built-in snippets in the following categories:
\list
@@ -204,7 +204,7 @@
You can use \l{Using Qt Creator Variables}{predefined variables} in
snippets.
The snippet editor provides you with:
The snippet editor offers:
\list
@@ -271,8 +271,8 @@
\section2 Removing Snippets
Several similar built-in snippets might be provided for different use cases.
To make the list of suggestions shorter when you write code, remove the
The list of suggestions might show several similar built-in snippets for
different use cases. To make it shorter when you write code, remove the
built-in snippets that you do not need. If you need them later, you can
restore them.

4
doc/qtcreator/src/editors/creator-coding-edit-mode.qdoc
View File

@@ -66,8 +66,8 @@
\l{Searching with the Locator}{locator}. Enter the line number and column
number in the locator, separated by a colon (:).
\note Other convenient ways of navigating in \QC are provided
by the \l{Browsing Project Contents}{sidebars}.
\note You can also use the \l{Browsing Project Contents}{sidebars} to
move around in \QC.
\if defined(qtcreator)
\section2 Selecting Parse Context

4
doc/qtcreator/src/editors/creator-coding.qdoc
View File

@@ -70,7 +70,7 @@
\li \l{Using Language Servers}
The language client provides code completion, highlighting of the
The language client offers code completion, highlighting of the
symbol under cursor, and jumping to the symbol definition for other
programming languages besides C++. In addition, it integrates
diagnostics from the language server.
@@ -85,7 +85,7 @@
You can use the model editor to create Universal Modeling Language
(UML) style models with structured and behavioral diagrams that
provide different views of your system and store them in XML format.
show your system in many ways and store them in XML format.
\li \l{Editing State Charts}

4
doc/qtcreator/src/editors/creator-editors-writing-code.qdoc
View File

@@ -91,8 +91,8 @@
\if defined(qtcreator)
\li \l{Parsing C++ Files with the Clang Code Model}
The Clang code model provides some of the services previously
provided by the built-in C/C++ code model, such as code
The Clang code model offers some of the same services as the
built-in C/C++ code model, such as code
completion, syntactic and semantic highlighting, diagnostics,
tooltips, outline of symbols, and renaming of local symbols.
\endif

2
doc/qtcreator/src/editors/creator-finding.qdoc
View File

@@ -33,7 +33,7 @@
\li \l{Searching with the Locator}
The locator provides one of the easiest ways in \QC to browse
Use the locator to browse
through projects, files, classes, functions, documentation and
file systems.

2
doc/qtcreator/src/editors/creator-locator.qdoc
View File

@@ -343,7 +343,7 @@
\section1 Executing JavaScript
The locator provides access to a JavaScript interpreter, that can be used to
The locator has a JavaScript interpreter that you can use to
perform calculations.
Beside simple mathematical operations, like ((1 + 2) * 3), the following

7
doc/qtcreator/src/editors/creator-only/creator-beautifier.qdoc
View File

@@ -134,7 +134,7 @@
then \uicontrol Add to define your own style.
Define code formatting in the
\uicontrol {Add Configuration} dialog. It provides syntax
\uicontrol {Add Configuration} dialog. It offers syntax
highlighting, auto-completion, and context-sensitive help.
For these features, you must have the tool installed.
@@ -152,14 +152,13 @@
\endlist
In addition,
ClangFormat provides the \uicontrol {Format at Cursor} command. If you
In addition, ClangFormat has the \uicontrol {Format at Cursor} command. If you
select it when no text is selected, the syntactic entity under the cursor
is formatted. The \uicontrol {Disable Formatting for Selected Text} command
wraps selected lines within \c {// clang-format off} and
\c {// clang-format on}.
Uncrustify provides the \uicontrol {Format Selected Text} command. If you
Uncrustify has the \uicontrol {Format Selected Text} command. If you
select it when no text is selected, the whole file is formatted by default.
To disable this behavior, deselect the
\uicontrol {Format entire file if no text was selected} check box.

11
doc/qtcreator/src/editors/creator-only/creator-clang-codemodel.qdoc
View File

@@ -16,7 +16,7 @@
The \e {code model} is the part of an IDE that understands the language you
are using to write your application. It is the framework that allows \QC
to provide the following services:
to offer the following services:
\list
@@ -42,12 +42,12 @@
\endlist
\QC comes with a plugin that provides some of these services
The Clang code model plugin offers some of these services
for C++ on top of \l{https://clangd.llvm.org/}{Clangd}.
\section1 About the Clang Code Model
The Clang project provides libraries for parsing
The Clang project has libraries for parsing
C language family source files. The feedback you get through warning and
error markers is the same as a compiler will give you, not an incomplete
set or a close approximation, as when using the built-in \QC code model.
@@ -67,9 +67,8 @@
include several files, processing a single file and all the included files
can take a while.
The Clang code model plugin now provides some of the services that were
previously provided by the built-in C/C++ code model. Currently, the
following services are implemented:
The Clang code model plugin now offers some of the same services as the
built-in C/C++ code model:
\list

2
doc/qtcreator/src/editors/creator-only/creator-compilation-database.qdocinc
View File

@@ -23,7 +23,7 @@
You can use the experimental Compilation Database Project Manager to open
the files in a compilation database with access to all the editing features
provided by the Clang code model.
of the Clang code model.
To switch between header and source files, select \uicontrol Tools >
\uicontrol C++ > \uicontrol {Switch Header/Source}.

2
doc/qtcreator/src/editors/creator-only/creator-fakevim.qdoc
View File

@@ -70,7 +70,7 @@
\list
\li \c :map, \c :unmap, \c :inoremap, and so on
\li \c :source provides very basic line-by-line sourcing of vimrc files
\li \c :source sources vimrc files line-by-line
\li \c :substitute substitutes an expression in a range
\li \c :'<,'>!cmd filters through an external command (for example,
sorts the lines in a file with \c :%!sort)

10
doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc
View File

@@ -8,11 +8,11 @@
\title Using Language Servers
For several programming languages, a \e {language server} is available
that provides information about the code to IDEs as long as they support
For several programming languages, a \e {language server} offers
information about the code to IDEs as long as they support
communication via the \l{Language Server Protocol}
{language server protocol (LSP)}. This enables the
IDE to provide the following services:
IDE to offer the following services:
\list
\li \l{Completing Code}{Code completion}
@@ -145,8 +145,8 @@
\section2 QML Language Server
Qt 6.4 ships with the \c qmlls language server that provides completion and
warnings for QML. To set it up as a \l {Generic StdIO Language Server},
Qt 6.4 ships with the \c qmlls language server that offers completion and
issues warnings for QML. To set it up as a \l {Generic StdIO Language Server},
select \c {text/x-qml} and \c {application/x-qt.ui+qml} as MIME types, and
\c {<Qt Installation>/bin/qmlls} as executable.

13
doc/qtcreator/src/editors/creator-only/creator-modeling.qdoc
View File

@@ -15,10 +15,9 @@
\title Modeling
You can use the model editor to create Universal Modeling Language (UML)
style models with structured and behavioral diagrams that provide different
views of your system. However, the editor uses a variant of UML and only a
subset of properties are provided for specifying the appearance of model
elements.
style models with structured and behavioral diagrams that offer different
views to your system. However, the editor uses a variant of UML and has only
a subset of properties for specifying the appearance of model elements.
Structural diagrams represent the static aspect of the system and are
therefore stable, whereas behavioral diagrams have both static and dynamic
@@ -31,9 +30,9 @@
and visualize how the system is packaged.
\li Class diagrams, which consists of classes, dependencies,
inheritance, associations, aggregation, and composition, and
provide an object-oriented view of a system.
show a system in an object-oriented way.
\li Component diagrams, which represent a set of components and their
relationships, and provide an implementation view of a system.
relationships, and show the implementation of a system.
\li Deployment diagrams, which represent a set of software and hardware
components and their relationships, and visualize the deployment
of a system.
@@ -388,7 +387,7 @@
\section1 Adding Custom Elements
The model editor provides the following built-in element types: package,
The model editor has the following built-in element types: package,
component, class, and item. For package, component, and class elements, you
can specify custom icons. The color, size, and form of the icon are
determined by a stereotype. If you attach the stereotype to an element, the

14
doc/qtcreator/src/editors/creator-only/creator-scxml.qdoc
View File

@@ -14,15 +14,15 @@
\title Editing State Charts
State charts provide a graphical way of modeling how a system reacts to
stimuli. This is done by defining the possible \e states that the system can
State charts are a graphical way of modeling how a system reacts to
stimuli. They define the \e states that the system can
be in, and how the system can move from one state to another (\e transitions
between states). A key characteristic of event-driven systems (such as Qt
applications) is that behavior often depends not only on the last or current
\e event, but also the events that preceded it. With state charts, this
information is easy to express.
between states). The behavior of event-driven systems (such as Qt
applications) often depends not only on the last or current
\e event, but also on earlier events. With state charts, you
can easily share this information.
\QC provides a project wizard for adding \l{https://www.w3.org/TR/scxml/}
\QC has a project wizard for adding \l{https://www.w3.org/TR/scxml/}
{State Chart XML (SCXML)} files with boilerplate code to projects and an
experimental SCXML editor for editing the state charts. You can use the
SCXML editor to add \e states and \e transitions to the files. You can then

4
doc/qtcreator/src/editors/creator-semantic-highlighting.qdoc
View File

@@ -28,7 +28,7 @@
\section1 Generic Highlighting
Generic highlighting is provided by
\QC uses
\l{https://api.kde.org/frameworks/syntax-highlighting/html/index.html}
{KSyntaxHighlighting}, which is the syntax highlighting engine for Kate
syntax definitions. \QC comes with most of the commonly used syntax files,
@@ -62,7 +62,7 @@
\image qtcreator-syntax-highlighter.png "Generic Highlighter preferences"
If you have written your own syntax definition files, you
can provide an additional definition search path in the
can add a definition search path in the
\uicontrol {User Highlight Definition Files} field. To
apply the changes you make to the definition files, select
\uicontrol {Reload Definitions}.

2
doc/qtcreator/src/howto/creator-keyboard-shortcuts.qdoc
View File

@@ -19,7 +19,7 @@
\title Keyboard Shortcuts
\QC provides various keyboard shortcuts to speed up your development
\QC has various keyboard shortcuts that speed up your development
process. You can add more shortcuts if your favorite combination is
missing. In addition, you can specify your own keyboard shortcuts for some
functions that can be easily performed with a mouse, and therefore do not

14
doc/qtcreator/src/howto/creator-only/creator-autotest.qdoc
View File

@@ -9,7 +9,7 @@
\title Running Autotests
\QC supports both \e {code based tests} and \e {build system based tests}.
Code based testing provides special handling for particular testing
Code based testing offers special handling for particular testing
frameworks that is strongly tied to the underlying code models or
specialized parsers. Build system based testing is independent from any
testing frameworks. It retrieves information directly from the underlying
@@ -27,7 +27,7 @@
\li \l{Qt Test} framework
\endlist
Additional build system based support is provided for
\QC offers additional build system based support for
\l{https://cmake.org/cmake/help/latest/manual/ctest.1.html}{CTest}.
You can use \QC to create, build, and run code based tests for your
@@ -44,7 +44,7 @@
The detection of tests is usually much faster for build system based
tests as this normally does not involve scanning or parsing.
The information provided inside the tests tree is usually more detailed
The information in the tests tree is usually more detailed
when using code based tests.
If you have enabled code based and build system based tests together you
@@ -199,8 +199,8 @@
\section2 Creating Catch2 Tests
To build and run Catch2 tests, you either must have Catch2 libraries and
headers installed, or you can use the single include header file provided
by the Catch2 repository.
headers installed, or you can use the single include header file in the
Catch2 repository.
If the Catch2 headers can be found by the used compiler and build system
automatically, you do not need to specify the include directory when
@@ -239,7 +239,7 @@
\section2 Creating CTest Based Tests
CTest provides capabilities to execute tests for CMake based projects
CTest can execute tests for CMake based projects
and is not limited to a special test framework.
You simply configure tests inside the project files, usually CMakeLists.txt.
Basically this is done by enabling testing for the project and registering
@@ -643,7 +643,7 @@
\endtable
Since Qt 5.4, you can provide a BLACKLIST file for tests. It is mainly used
Since Qt 5.4, you can add a BLACKLIST file for tests. It is mainly used
internally by the Qt CI system.
\table

6
doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc
View File

@@ -94,7 +94,7 @@
\section1 View output
The \l{Viewing Output}{taskbar} provides different views to output from
The \l{Viewing Output}{taskbar} shows output from
several sources, such as a list of errors and warnings encountered during
a build, detailed output from the compiler, status of a program when it is
executed, debug output, or search results.
@@ -119,7 +119,7 @@
\section1 Find keyboard shortcuts
\QC provides \l{Keyboard Shortcuts}{many useful keyboard shortcuts}.
\QC has \l{Keyboard Shortcuts}{many useful keyboard shortcuts}.
You can see the keyboard shortcut for a menu command in the menu
or the tooltip for a button.
@@ -227,7 +227,7 @@
\section1 Quickly locate files using the keyboard
The \uicontrol Locator provides one of the easiest ways in \QC to browse
Use the \uicontrol Locator to browse
through projects, files, classes, functions, documentation, and file systems.
To quickly access files not directly mentioned in your project, you can
create your own locator filters. That way you can locate files in a

8
doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc
View File

@@ -196,8 +196,8 @@
following value, where \c{<num>} is the amount of cores in your CPU:
\c{-j <num>}
On Windows, nmake does not support the \c{-j} parameter. Instead, we
provide a drop-in replacement called jom. You can download a precompiled
On Windows, nmake does not support the \c{-j} parameter. Instead, you can use
\e jom. You can download a precompiled
version of jom from \l{https://download.qt.io/official_releases/jom/}{Qt Downloads}.
Put jom.exe in a location in the %PATH%. Go to the \uicontrol {Build Settings}
and set jom.exe as the make command.
@@ -306,7 +306,7 @@
In fact, developers do not want to switch editors, but might have to do so
to accomplish their tasks. We need to figure out what the tasks are to
provide developers with better ways to navigate while performing the tasks.
offer developers better ways to navigate while performing the tasks.
One common factor in many use cases is switching editors while working on a
set of open files. While working on files A and B, users sometimes need to
@@ -316,7 +316,7 @@
Typically, users also work on multiple classes or functions that are
related, even though they are defined or declared in different files.
\QC provides two shortcuts for that: \key F2 to follow the symbol under
\QC offers two shortcuts for that: \key F2 to follow the symbol under
cursor and \key Ctrl+Shift+U to find references to it.
In addition, developers can:

4
doc/qtcreator/src/incredibuild/creator-projects-incredibuild-building.qdoc
View File

@@ -62,8 +62,8 @@
\li \uicontrol {Profile.xml} defines how Automatic Interception
Interface handles processes in a distributed job. It is not
necessary for Visual Studio or Make and Build tools builds, but can
be used to provide configuration options if those builds use
additional processes that are not included in those packages. It is
be used to add configuration options if those builds use
processes that are not included in those packages. It is
required to configure distributable processes in Dev Tools builds.
\li \uicontrol {Avoid local task execution} frees up resources on the
initiator machine. This might be beneficial for distribution if the

12
doc/qtcreator/src/linux-mobile/creator-embedded-platforms.qdoc
View File

@@ -39,12 +39,12 @@
\section1 Boot2Qt
The Boot2Qt stack can be made to run on a variety of hardware. For
license holders, tooling is provided to customize the contents of the stack
as well as to take it into desired production hardware.
The Boot2Qt stack runs on a variety of hardware. License holders can use
tools to customize the contents of the stack and to take it into
production hardware.
Either Windows 10 64-bit or later or Ubuntu Linux 64-bit 20.04 LTS
or later is required to install and use Boot2Qt.
You need either Windows 10 64-bit or later or Ubuntu Linux 64-bit 20.04 LTS
or later to install and use Boot2Qt.
The following topics have more information about developing applications
for Boot2Qt devices:
@@ -95,7 +95,7 @@
\section1 QNX
The QNX Neutrino RTOS should provide a few additional command line tools
The QNX Neutrino RTOS has more command line tools
and services, as described in \l {Qt for QNX}.
\note In Qt 6, \QC support for QNX is considered experimental.

2
doc/qtcreator/src/overview/creator-only/creator-advanced.qdoc
View File

@@ -49,7 +49,7 @@
\li \l{Keyboard Shortcuts}
\QC provides various keyboard shortcuts to speed up your development
\QC has keyboard shortcuts that speed up your development
process. You can change the keyboard shortcuts, as well as import
and export keyboard shortcut mapping schemes.

4
doc/qtcreator/src/overview/creator-only/creator-configuring.qdoc
View File

@@ -105,7 +105,7 @@
For more information, see \l{Defining Color Schemes}.
\l{https://api.kde.org/frameworks/syntax-highlighting/html/index.html}
{KSyntaxHighlighting} provides generic highlighting. It is the syntax
{KSyntaxHighlighting} offers generic highlighting. It is the syntax
highlighting engine for Kate syntax definitions. \QC comes with most of
the commonly used syntax files, and you can download additional files.
@@ -117,7 +117,7 @@
\section1 Adding Your Own Code Snippets
As you write code, \QC suggests properties, IDs, and code snippets to
complete the code. It provides a list of context-sensitive suggestions to
complete the code. It lists context-sensitive suggestions for
the statement currently under your cursor. You can add, modify, and remove
snippets in the snippet editor.

2
doc/qtcreator/src/overview/creator-only/creator-design-overview.qdoc
View File

@@ -16,7 +16,7 @@
\image front-ui.png
\QC provides an integrated visual editor designing widget-based applications
\QC has an integrated visual editor designing widget-based applications
in the \uicontrol Design mode. The integration includes project management
and code completion.

8
doc/qtcreator/src/overview/creator-only/creator-glossary.qdoc
View File

@@ -79,10 +79,10 @@
\row
\li Mode
\target glossary-mode
\li Adapts the \QC user interface to the different application
development tasks at hand. Each mode has its own view that shows
only the information required for performing a particular task,
and provides only the most relevant features and functions
\li Adapts the \QC user interface to the application
development task at hand. Each mode has its own view that shows
only the information you need for performing a particular task,
and has only the most relevant features and functions
related to it. As a result, the majority of the \QC window area
is always dedicated to actual application development tasks.

15
doc/qtcreator/src/overview/creator-only/creator-overview.qdoc
View File

@@ -14,14 +14,13 @@
\title IDE Overview
\QC is an integrated development environment (IDE) that provides you with
tools to design and develop applications with the Qt application framework.
\QC is an integrated development environment (IDE) that has tools for
designing and developing applications with the Qt application framework.
With Qt you can develop applications and user interfaces once and deploy
them to several desktop, embedded, and mobile operating systems or
web browsers (experimental). \QC
provides you with tools for accomplishing your tasks throughout the whole
application development life-cycle, from creating a project to deploying the
application to the target platforms.
web browsers (experimental). \QC has the tools for accomplishing your tasks
throughout the whole application development life-cycle, from creating a
project to deploying the application to the target platforms.
\table
\row
@@ -52,8 +51,8 @@
As an IDE, \QC differs from a text editor in that it knows how
to build and run applications. It understands the C++ and QML
languages as code, not just as plain text. This enables it to
provide you with useful features, such as semantic highlighting,
languages as code, not just as plain text. Therefore, it can
offer useful features, such as semantic highlighting,
checking code syntax, code completion, and refactoring actions.
\QC supports some of these services also for other programming
languages, such as Python, for which a \e {language server} is

6
doc/qtcreator/src/projects/creator-only/creator-files-creating.qdoc
View File

@@ -39,7 +39,7 @@
\li Model
\li Universal Modeling Language (UML) style model with a structured
diagram. However, the model editor uses a variant of UML and
provides only a subset of properties for specifying the
has only a subset of properties for specifying the
appearance of model elements. For more information, see
\l {Modeling}.
\row
@@ -189,7 +189,7 @@
\section1 Creating OpenGL Fragment and Vertex Shaders
Qt provides support for integration with OpenGL implementations on all
Qt supports integration with OpenGL implementations on all
platforms, which allows you to display hardware accelerated 3D graphics
alongside a more conventional user interface. For more information, see
\l{Qt GUI}.
@@ -201,7 +201,7 @@
compiling and linking vertex and fragment shaders.
You can use \QC code editor to write fragment and vertex shaders
in GLSL or GLSL/ES. The code editor provides syntax highlighting and code
in GLSL or GLSL/ES. The code editor offers syntax highlighting and code
completion for the files.
\image qtcreator-new-opengl-file.png "New OpenGL file wizard"

4
doc/qtcreator/src/projects/creator-only/creator-projects-building-running.qdoc
View File

@@ -16,8 +16,8 @@
\image front-preview.png
\QC provides support for running and deploying Qt applications built
for different target platforms, or using different compilers, debuggers, or
\QC supports running and deploying Qt applications that you build
for different target platforms or with different compilers, debuggers, or
Qt versions. \l{glossary-buildandrun-kit}{Kits} define the tools,
\l{glossary-device}{device} type and other settings to use when building and
running your project.

6
doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc
View File

@@ -66,7 +66,7 @@
\endlist
In addition, the \QC Bare Metal Device plugin provides support for the
In addition, the \QC Bare Metal Device plugin supports the
following compilers:
\list
@@ -161,12 +161,12 @@
\image qtcreator-options-qcc-compilers.png "Adding a QCC compiler"
\li In the \uicontrol ABI field, provide an identification for the
\li In the \uicontrol ABI field, enter an identifier for the
target architecture. This is used to warn about ABI mismatches
within the kits.
\li In the \uicontrol {Target triple} field, specify the GCC target
architecture. If services provided by the code model fail because
architecture. If code model services fail because
Clang does not understand the target architecture, select
\uicontrol {Override for code model}.

12
doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards-json.qdocinc
View File

@@ -116,8 +116,8 @@
\li \c supportedProjectTypes is an optional setting that
can be used to filter wizards when adding a new build
target to an existing project. For example, only wizards
that produce qmake projects should be provided when
target to an existing project. For example, show only
wizards that produce qmake projects when
adding a new target to an existing qmake project.
Possible values are the build systems supported by \QC
@@ -457,7 +457,7 @@
\li \c projectFilePath with the path to the project file.
\li \c requiredFeatures with a list of strings or objects that describe
the features that a kit must provide to be listed on the page.
the features that a kit must have to appear on the page.
When a string is found, this feature must be set. When using an
object instead, the following settings are checked:
@@ -574,8 +574,8 @@
\li \c arguments with the arguments to pass to \c command.
\li \c timeOutFactor can be used to provide for longer than
default timeouts for long-running commands.
\li \c timeOutFactor extends default timeouts for long-running
commands.
\li \c enabled which will be evaluated to decide whether or
not to actually execute this job.
@@ -634,7 +634,7 @@
\li \c persistenceKey makes the user choice persistent. The value is
taken to be a settings key. If the user changes the default
value of the widget, the user-provided value is stored and will
value of the widget, the user's value is stored and will
become the new default value the next time the wizard is run.
\li \c visible is set to \c true if the widget is visible, otherwise

2
doc/qtcreator/src/projects/creator-only/creator-projects-generic.qdoc
View File

@@ -131,7 +131,7 @@
If you want to run your application on a remote Linux device,
you first need to deploy your executable and possibly other files.
\QC does that for you automatically if you provide the necessary
\QC does that for you automatically if you enter the necessary
information. This works the same way as explained for CMake in
\l {Deploying to Remote Linux},
except that you also need to include your application binary in the list.

2
doc/qtcreator/src/projects/creator-only/creator-projects-qt-versions.qdoc
View File

@@ -15,7 +15,7 @@
\title Adding Qt Versions
You can install multiple versions of Qt development PC and use them to build
your projects. For example, \l{glossary-device}{device} manufacturers provide
your projects. For example, \l{glossary-device}{device} manufacturers offer
special Qt versions for developing applications for their devices.
\section1 Registering Installed Qt Versions

6
doc/qtcreator/src/python/creator-python-project.qdocinc
View File

@@ -13,7 +13,7 @@
If you have not installed PySide6, \QC prompts you to install it after
you create the project. Further, it prompts you to install the
\l {Python Language Server}{Python language server} that provides services
\l {Python Language Server}{Python language server} that offers services
such as code completion and annotations. Select \uicontrol Install to install
PySide6 and the language server.
@@ -44,7 +44,7 @@
\image qtcreator-python-wizard-app-window.png "Qt for Python wizard for creating a widget-based UI"
The wizard adds the imports to the source file to provide
The wizard adds the imports to the source file for
access to the QApplication, the base class you selected in the Qt
Widgets module, and Qt UI tools:
@@ -152,7 +152,7 @@
\image qtcreator-python-wizard-qml.png "Qt for Python wizard for creating an empty Qt Quick application"
The wizard adds the following imports to the source file to provide access
The wizard adds the following imports to the source file for access
to QGuiApplication and QQmlApplicationEngine:
\badcode

5
doc/qtcreator/src/qnx/creator-developing-qnx.qdoc
View File

@@ -10,9 +10,8 @@
\title Connecting QNX Devices
You can connect QNX devices to the development PC to deploy, run and debug
applications on them from within \QC. The QNX Neutrino RTOS should provide
a few additional command line tools and services, as described in
\l {Qt for QNX}.
applications on them from within \QC. The QNX Neutrino RTOS has additional
command line tools and services, as described in \l {Qt for QNX}.
\note In Qt 6, \QC support for QNX is considered experimental.

4
doc/qtcreator/src/qnx/creator-projects-running-qnx.qdocinc
View File

@@ -28,8 +28,8 @@
\section2 Troubleshooting Errors
To support running, debugging, and stopping applications from \QC, the QNX
Neutrino RTOS should provide a few additional command line tools and
services, as described in \l {Qt for QNX}.
Neutrino RTOS has additional command line tools and services, as described
in \l {Qt for QNX}.
\section3 Debug Output Cannot Be Shown

2
doc/qtcreator/src/qtcreator.qdoc
View File

@@ -13,7 +13,7 @@
\title Qt Creator Manual
\QC provides a cross-platform, complete integrated development environment
\QC is a cross-platform, complete integrated development environment
(IDE) for application developers to create applications for multiple
\l{Desktop Platforms}{desktop}, \l {Embedded Platforms}{embedded}, and
\l{Mobile Platforms}{mobile device} platforms, such as \l Android and

4
doc/qtcreator/src/user-interface/creator-ui.qdoc
View File

@@ -455,7 +455,7 @@
\section1 Issues
\uicontrol{Issues} provides lists of following types of issues:
\uicontrol{Issues} lists the following types of issues:
\list
@@ -580,7 +580,7 @@
\section1 Compile Output
\uicontrol{Compile Output} provides all output from the compiler.
\uicontrol{Compile Output} shows all output from the compiler.
The \uicontrol{Compile Output} is a more detailed version of information
displayed in \l Issues.

2
doc/qtcreator/src/vcs/creator-only/creator-vcs.qdoc
View File

@@ -124,7 +124,7 @@
\section2 Viewing Diff Output
All version control systems provide menu options to \e{diff} the current
All version control systems have menu options to \e{diff} the current
file or project: to compare it with the latest version stored in the
repository and to display the differences. In \QC, a diff is displayed in a
read-only editor. If the file is accessible, you can double-click on a

2
doc/qtcreator/src/vcs/creator-vcs-git.qdoc
View File

@@ -563,7 +563,7 @@
\l{https://curl.haxx.se/}{curl} tool are used for HTTP connections.
Select the \uicontrol HTTPS check box to prepend \c https to the Gerrit URL
if Gerrit does not provide it.
if Gerrit does not add it.
\image qtcreator-gerrit-options.png "Gerrit preferences"