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

Doc: Use active voice instead of passive voice

Browse Source 
This fixes issues found by vale.

Change-Id: Ic3495633cc3aabd000e53b4a4107b9bccde28005
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
This commit is contained in:
Leena Miettinen
2022-11-02 16:51:20 +01:00
parent c6e08d6940
commit b59ad8b0a9
32 changed files with 303 additions and 319 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -36,12 +36,12 @@
\QC is an integrated development environment (IDE) that you can use to
develop Qt applications. While you can use the Qt Installer to install \QC,
the stand-alone \QC installer never installs Qt or any Qt tools, such as
qmake. To use \QC for Qt development, you also need to have a Qt version
and a compiler installed. If you update the compiler version later, you
qmake. To use \QC for Qt development, you also need to install a Qt version
and a compiler. If you update the compiler version later, you
can register it into \QC.
The Qt Installer attempts to auto-detect the installed compilers and Qt
versions. If it succeeds, the relevant kits will automatically become
The Qt Installer attempts to auto-detect compilers and Qt versions. If it
succeeds, the relevant kits will automatically become
available in \QC. If it does not, you must add the kits yourself to tell
\QC where everything is.
@@ -51,18 +51,17 @@
For more information, see \l{Adding Kits}.
Each kit consists of a set of values that define one environment, such as a
\l{glossary-device}{device}, compiler, and Qt version. If you know you have
installed a Qt version, but it is not listed in \uicontrol Edit >
\uicontrol Preferences > \uicontrol Kits > \uicontrol {Qt Versions}, select
\uicontrol {Link with Qt}.
\l{glossary-device}{device}, compiler, and Qt version. If \uicontrol Edit >
\uicontrol Preferences > \uicontrol Kits > \uicontrol {Qt Versions} does not
show all the installed Qt versions, select \uicontrol {Link with Qt}.
If the Qt version is still not listed under \uicontrol Auto-detected, select
If \uicontrol Auto-detected still does not show the Qt version, select
\uicontrol {Add} to add it manually.
For more information, see \l{Adding Qt Versions}.
Also check that your compiler is listed in \uicontrol Edit >
\uicontrol Preferences > \uicontrol Kits > \uicontrol {Compilers}.
Also check that \uicontrol Edit > \uicontrol Preferences > \uicontrol Kits >
\uicontrol {Compilers} shows your compiler.
For more information, see \l{Adding Compilers}.
@@ -95,8 +94,8 @@
in the \uicontrol Theme field.
You can use the \QC text and code editors with your favorite color scheme
that defines how code elements are highlighted and which background color is
used. You can select one of the predefined color schemes or create custom
that defines how to highlight code elements and which background color to
use. You can select one of the predefined color schemes or create custom
ones. The color schemes apply to highlighting C++ files, QML files, and
generic files.
@@ -105,11 +104,10 @@
For more information, see \l{Defining Color Schemes}.
Generic highlighting is provided by
\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,
and you can download additional files.
{KSyntaxHighlighting} provides 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.
To download and use highlight definition files, select \uicontrol Edit >
\uicontrol Preferences > \uicontrol {Text Editor} > \uicontrol {Generic Highlighter}.
@@ -132,7 +130,7 @@
\QC supports several version control systems. In most cases, you do not need
to configure the version control in any special way to make it work with
\QC. Once it is set up correctly on the development PC, it should just work.
\QC.
However, some configuration options are available and you can set them in
\uicontrol Edit > \uicontrol Preferences > \uicontrol {Version Control} >
@@ -147,9 +145,9 @@
You can enable disabled plugins if you need them and disable plugins you
don't need.
You can also install additional plugins that you downloaded from
\l{https://marketplace.qt.io/}{Qt Marketplace} or some other source,
such as \l{https://github.com/}{GitHub}.
You can download and install additional plugins from
\l{https://marketplace.qt.io/}{Qt Marketplace} or some
other source, such as \l{https://github.com/}{GitHub}.
\section2 Enabling and Disabling Plugins
@@ -174,7 +172,7 @@
browse the available plugins in the \uicontrol Marketplace tab in the
Welcome mode.
\note You can install only plugins that are supported by your \QC version.
\note You can install only plugins that your \QC version supports.
To install plugins:

9
doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc
View File

@@ -43,10 +43,11 @@
\row
\li \b {\l{Building and Running an Example}}
To check that \l{glossary-buildandrun-kit}{kits} for building and running were
successfully installed as part of the \QSDK installation, open
an example application and run it. If you have not done so
before, go to \l{Building and Running an Example}.
To check that the \l{https://www.qt.io/download-qt-installer}
{Qt Online Installer} created \l{glossary-buildandrun-kit}
{build and run kits}, open an example application and run it.
If you have not done so before, go to
\l{Building and Running an Example}.
\li \b {\l{Tutorials}}
Now you are ready to start developing your own applications.

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

@@ -16,8 +16,8 @@
\QC is an integrated development environment (IDE) that provides you with
tools to design and develop applications with the Qt application framework.
Qt is designed for developing applications and user interfaces once and
deploying them to several desktop, embedded, and mobile operating systems or
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
@@ -32,20 +32,20 @@
\li \b {\l{Managing Projects}}
To be able to build and run applications, \QC needs the same
information as a compiler would need. This information is
specified in the project settings.
information as a compiler would need. It stores the information
in the project settings.
Setting up a new project in \QC is aided by a wizard that guides
you step-by-step through the project creation process, creates
the necessary files, and specifies settings depending on the
\QC contains templates for creating new projects. They guide
you step-by-step through the project creation process, create
the necessary files, and specify settings depending on the
choices you make. For more information, see
\l{Managing Projects}.
\li \b {\l{Designing User Interfaces}}
To create intuitive, modern-looking, fluid user interfaces, you
can use \l{Qt Quick} and \l{Qt Design Studio Manual}{\QDS}.
If you need a traditional user interface that is clearly
structured and enforces a platform look and feel, you can use
If you need a traditional user interface that has a clear
structure and enforces a platform look and feel, you can use
the integrated \QD. For more information, see
\l{Designing User Interfaces}.
\li \b {\l{Coding}}
@@ -66,33 +66,33 @@
\row
\li \b {\l{Building and Running}}
\QC is integrated with cross-platform systems for build
\QC integrates cross-platform systems for build
automation: qmake, Qbs, CMake, and Autotools. In addition, you
can import
projects as \e {generic projects} and fully control the steps
and commands used to build the project.
\QC provides support for running and deploying Qt applications
built for the desktop environment or a \l{glossary-device}
{device}. \l{glossary-buildandrun-kit}{Kits}, build,
run, and deployment settings allow you to quickly switch between
different setups and target platforms.
You can build applications for, deploy them to, and run them on
the desktop environment or a \l{glossary-device}{device}.
\l{glossary-buildandrun-kit}{Kits}, build, run, and deployment
settings allow you to quickly switch between different setups and
target platforms.
For more information, see \l{Building and Running}.
\li \b {\l{Testing}}
\QC is integrated to several external native debuggers: GNU
\QC integrates several external native debuggers: GNU
Symbolic Debugger (GDB), Microsoft Console Debugger (CDB), and
internal JavaScript debugger. In the \uicontrol Debug mode, you
can inspect the state of your application while debugging.
The memory and CPU power available on devices are limited and
Devices have limited memory and CPU power, so
you should use them carefully. \QC integrates Valgrind code
analysis tools for detecting memory leaks and profiling function
execution. In addition, the QML Profiler enables you to profile
Qt Quick applications.
\QC is integrated to the \l{Qt Test}, Boost.Test, Catch 2 test,
\QC integrates the \l{Qt Test}, Boost.Test, Catch 2 test,
and Google C++ Testing frameworks for unit testing applications
and libraries. You can use \QC to create, build, and run
autotests.
@@ -100,8 +100,8 @@
For more information, see \l{Testing}.
\li \b {Publishing}
\QC allows you to create installation packages for mobile
devices that are suitable for publishing to application stores
\QC enables you to create installation packages for mobile
devices that you can publish to application stores
and other channels. You must make sure that the package contents
meet the requirements for publishing on the channel.