Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/9.0'
Browse files Browse the repository at this point in the history 
 Conflicts:
	cmake/QtCreatorIDEBranding.cmake
	qbs/modules/qtc/qtc.qbs
	qtcreator_ide_branding.pri
	src/plugins/clangcodemodel/clangdcompletion.cpp

Change-Id: Iaa92bf057d7696d2da10802ff95e80863f3235d8
  • Loading branch information
@e4z9
e4z9 committed Nov 14, 2022
2 parents 09ee528 + 993815c commit 3f0f9a6
Show file tree
Hide file tree
Showing 50 changed files with 1,629 additions and 1,519 deletions.
Binary file added doc/qtcreator/images/qtcreator-git-blame.webp
View file
Binary file not shown.
22 changes: 11 additions & 11 deletions doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1107,12 +1107,14 @@

\image qtcreator-cdb-options.png "CDB preferences"

The following sections describe some of the widely-used Dumper classes and
members specified in \c qtcreator\share\qtcreator\debugger\dumper.py.


\section3 Dumper Class

The \c Dumper class contains generic bookkeeping, low-level, and convenience
functions.

The member functions of the \c Dumper class are the following:
functions:

\list
\li \c{putItem(self, value)} - The \e {master function} that handles
Expand All @@ -1134,9 +1136,10 @@
self.putType("bool")
\endcode

\li \c{putCallItem(self, name, value, func, *args)} - Uses the native
debugger backend to place the function call \c func on the value
specified by \a {value} and output the resulting item.
\li \c{putCallItem(self, name, rettype, value, func, *args)} - Uses the
native debugger backend to place the function call \c func returning
\c rettype on the value specified by \a {value} and to output the
resulting item.

Native calls are extremely powerful and can leverage existing
debugging or logging facilities in the debugged process, for
Expand Down Expand Up @@ -1289,7 +1292,7 @@
classes, obliterating the need to use \e Debug builds of Qt for the purpose
of object introspection.

The member functions of the \c{Dumper.Type} class are the following:
The \c{Dumper.Type} class has the following widely-used member functions:

\list

Expand Down Expand Up @@ -1332,10 +1335,7 @@
\section3 Dumper.Field Class

The \c{Dumper.Field} class describes a base class or a data member of a type
object.

The member function and properties of the \c{Dumper.Field} class are the
following:
object:

\list

Expand Down
8 changes: 4 additions & 4 deletions doc/qtcreator/src/howto/creator-sessions.qdoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

\title Managing Sessions

When you exit \QC, a snapshot of your current workspace is stored as a
When you exit \QC, it stores a snapshot of your current workspace as a
\e session. To restore the session automatically when you start \QC,
select \uicontrol File > \uicontrol Sessions > \uicontrol Manage >
\uicontrol {Restore last session on startup}.
Expand Down Expand Up @@ -79,8 +79,8 @@
To switch between sessions, select \uicontrol {Open}.

\if defined(qtcreator)
When you launch \QC, a list of existing sessions is displayed in the
\uicontrol Welcome mode. To open a session, select it or press
The \uicontrol Projects tab in the \uicontrol Welcome mode lists existing
sessions. To open a session, select it or press
\key Ctrl+Alt+<number>, where \e <number> is the number of the session to
open (available for the first nine sessions).

Expand All @@ -94,7 +94,7 @@
to clone, rename, and delete sessions.

When you start \QC from the command line, you can give the name of
a session as argument and \QC will start with this session.
a session as an argument and \QC will start with this session.

For more information, see \l{Using Command Line Options}.
\endif
Expand Down
42 changes: 20 additions & 22 deletions doc/qtcreator/src/overview/creator-only/creator-configuring.qdoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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}.

Expand Down Expand Up @@ -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.

Expand All @@ -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}.
Expand All @@ -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} >
Expand All @@ -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

Expand All @@ -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:

Expand Down
9 changes: 5 additions & 4 deletions doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
40 changes: 20 additions & 20 deletions doc/qtcreator/src/overview/creator-only/creator-overview.qdoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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}}
Expand All @@ -66,42 +66,42 @@
\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.

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.

Expand Down
28 changes: 14 additions & 14 deletions doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,26 +36,26 @@

\image qtcreator-gs-build-example-open.png "Selecting an example"

If no examples are listed, check that a \l{Adding Qt Versions}
{Qt version} (2) is installed and configured. If you select a Qt
for Android or iOS, only the examples tested for Android or iOS
are listed.
If you cannot see any examples, check that the list of
\l{Adding Qt Versions}{Qt versions} (2) is not empty. If
you select a Qt for Android or iOS, you can only see the
examples that run on Android or iOS.

\li Select an example in the list of examples.

You can also use tags (3) to filter examples. For instance, enter
the \uicontrol Boot2Qt tag (commercial only) in the search field
(4) to list examples that you can run on Boot2Qt devices.

\li To check that the application code can be compiled and linked for a
\li To check that you can compile and link the application code for a
device, click the \uicontrol {Kit Selector} and select a
\l{glossary-buildandrun-kit}{kit} for the
device.

\image qtcreator-gs-build-example-kit-selector.png "Selecting a kit to build with"

If you installed \QC as part of a Qt installation, it should have
automatically detected the installed kit. If no kits are available,
automatically detected the installed kit. If you cannot see any kits,
see \l{Adding Kits}.

\li Click \inlineimage icons/run_small.png
Expand All @@ -64,15 +64,15 @@
\li To see the compilation progress, press \key{Alt+4} to open
\l {Compile Output}.

If build errors occur, check that a Qt version and
\l{Adding Compilers}{compiler} are installed and
configured and that the necessary kits are configured. If you are
building for an \l{Connecting Android Devices}{Android device} or
\l{Connecting iOS Devices}{iOS device}, check that the development
environment has been set up correctly.
If build errors occur, check that you have a Qt version, a
\l{Adding Compilers}{compiler}, and the necessary kits installed. If
you are building for an \l{Connecting Android Devices}{Android device}
or \l{Connecting iOS Devices}{iOS device}, check that you set up the
development environment correctly.

The \uicontrol Build progress bar on the toolbar turns green when the
project is successfully built. The application opens on the device.
The \uicontrol Build progress bar on the toolbar turns green when
you build the project successfully. The application opens on the
device.

\endlist

Expand Down
22 changes: 9 additions & 13 deletions doc/qtcreator/src/projects/creator-only/creator-projects-build-systems.qdocinc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,23 @@

\section1 Selecting the Build System

Most \QC project wizards enable you to choose the build system to use for
building the project: qmake, CMake, or Qbs. If you are not presented with a
choice, the project is set up to use qmake.
You can use several build systems to build your projects.

\l{qmake Manual}{qmake} is a cross-platform system for build automation
that helps simplify the build process for development projects across
different platforms. qmake automates the generation of build configurations
so that only a few lines of information are needed to create each
configuration. qmake is installed and configured when you install Qt.
so that you need only a few lines of information to create each
configuration. Qt installers install and configure qmake.
To use one of the other supported build systems, you need to set it up.

\l {Build with CMake}{CMake} is an alternative to qmake for automating the
generation of build configurations. For more information, see
\l {Setting Up CMake}.

\l {https://mesonbuild.com/}{Meson} Meson is an open source build system meant
to be both extremely fast, and, even more importantly, as user friendly as
possible. The main design point of Meson is that every second a developer
spends writing or debugging build definitions is a second wasted. So is every
second spent waiting for the build system to actually start compiling code.
For more information, see \l {Setting Up Meson}.
\l {https://mesonbuild.com/}{Meson} Meson is a fast and user-friendly
open-source build system that aims to minimize the time developers spend
writing or debugging build definitions and waiting for the build system
to start compiling code. For more information, see \l {Setting Up Meson}.

\l{Qbs Manual}{Qbs} is an all-in-one build tool that generates a build graph
from a high-level project description (like qmake or CMake do) and executes
Expand All @@ -43,8 +39,8 @@
for building and running projects, select \uicontrol Edit >
\uicontrol Preferences > \uicontrol {Build & Run} > \uicontrol General.

To specify build and run settings for different target platforms,
select \uicontrol Projects. For more information on the options you have,
Specify build and run settings for different target platforms, in the
\uicontrol Projects mode. For more information on the options you have,
see \l{Specifying Build Settings}.

//! [build systems]
Expand Down
Loading

0 comments on commit 3f0f9a6

Please sign in to comment.