From b59ad8b0a96bcb7f249a9ea0b2835a8521c53cea Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Wed, 2 Nov 2022 16:51:20 +0100 Subject: [PATCH] Doc: Use active voice instead of passive voice This fixes issues found by vale. Change-Id: Ic3495633cc3aabd000e53b4a4107b9bccde28005 Reviewed-by: Andreas Eliasson --- doc/qtcreator/src/howto/creator-sessions.qdoc | 8 ++-- .../creator-only/creator-configuring.qdoc | 42 ++++++++--------- .../creator-only/creator-getting-started.qdoc | 9 ++-- .../creator-only/creator-overview.qdoc | 40 ++++++++-------- .../creator-projects-build-run-tutorial.qdoc | 28 +++++------ .../creator-projects-build-systems.qdocinc | 22 ++++----- .../creator-projects-compilers.qdoc | 10 ++-- .../creator-projects-creating.qdoc | 45 +++++++++--------- ...eator-projects-custom-wizards-json.qdocinc | 22 ++++----- .../creator-projects-custom-wizards.qdoc | 27 ++++++----- .../creator-projects-debuggers.qdoc | 6 +-- .../creator-projects-libraries.qdoc | 12 ++--- .../creator-projects-opening.qdoc | 14 +++--- .../creator-projects-overview.qdoc | 6 +-- .../creator-projects-qt-versions.qdoc | 39 ++++++++------- .../creator-projects-settings-overview.qdoc | 29 +++++------- ...ator-projects-settings-run-desktop.qdocinc | 2 +- .../creator-projects-targets.qdoc | 15 +++--- .../src/python/creator-python-project.qdocinc | 8 ++-- .../creator-mobile-app-tutorial.qdoc | 6 +-- .../creator-only/qtquick-app-tutorial.qdoc | 4 +- ...uick-tutorial-create-empty-project.qdocinc | 2 +- .../creator-file-system-view.qdoc | 12 ++--- .../creator-open-documents-view.qdoc | 4 +- .../user-interface/creator-projects-view.qdoc | 43 +++++++++-------- .../src/user-interface/creator-ui.qdoc | 47 +++++++++---------- .../src/user-interface/creator-views.qdoc | 17 ++++--- .../creator-only/creator-vcs-perforce.qdoc | 21 +++++---- .../creator-only/creator-vcs-subversion.qdoc | 4 +- .../src/vcs/creator-only/creator-vcs.qdoc | 2 +- doc/qtcreator/src/vcs/creator-vcs-git.qdoc | 47 +++++++++---------- .../src/widgets/qtdesigner-app-tutorial.qdoc | 29 +++++------- 32 files changed, 303 insertions(+), 319 deletions(-) diff --git a/doc/qtcreator/src/howto/creator-sessions.qdoc b/doc/qtcreator/src/howto/creator-sessions.qdoc index d7e45fcd411..203df259f28 100644 --- a/doc/qtcreator/src/howto/creator-sessions.qdoc +++ b/doc/qtcreator/src/howto/creator-sessions.qdoc @@ -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}. @@ -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+, where \e is the number of the session to open (available for the first nine sessions). @@ -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 diff --git a/doc/qtcreator/src/overview/creator-only/creator-configuring.qdoc b/doc/qtcreator/src/overview/creator-only/creator-configuring.qdoc index 504769064a6..4429f3283b8 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-configuring.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-configuring.qdoc @@ -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: diff --git a/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc b/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc index 0b045bea831..218442555c2 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc @@ -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. diff --git a/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc b/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc index c3567e75b4a..3bd6c9e5c4a 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc @@ -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. diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc index a9fdff6e061..66bd2ce2b73 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc @@ -36,10 +36,10 @@ \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. @@ -47,7 +47,7 @@ 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. @@ -55,7 +55,7 @@ \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 @@ -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 diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-build-systems.qdocinc b/doc/qtcreator/src/projects/creator-only/creator-projects-build-systems.qdocinc index 6604121d606..a12e010d68e 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-build-systems.qdocinc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-build-systems.qdocinc @@ -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 @@ -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] diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc index cac8caf3a80..99acca06fa3 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc @@ -20,9 +20,9 @@ specifies the compiler and other necessary tools for building an application for and running it on a particular platform. - \QC automatically detects the compilers that are registered by your - system or by the Qt Installer and lists them in \uicontrol Edit > - \uicontrol Preferences > \uicontrol Kits > \uicontrol Compilers. + \QC automatically detects the compilers that your system or the Qt Installer + registers and lists them in \uicontrol Edit > \uicontrol Preferences > + \uicontrol Kits > \uicontrol Compilers. \image qtcreator-toolchains.png @@ -113,7 +113,7 @@ To enable Microsoft Visual C++ Compilers (MSVC) and clang-cl to find system headers, libraries, and the linker, \QC executes them inside a command - prompt where the environment has been set up using \c {vcvarsall.bat}. For + prompt where you set up the environment using \c {vcvarsall.bat}. For these compilers, you also specify the path to the script that sets up the command prompt in the \uicontrol Initialization field. @@ -245,7 +245,7 @@ To keep working with the third-party tool chain, create a new shell link that adds the required paths (as Visual Studio and Qt do). The shell link - must point to cmd.exe, as illustrated by the following example: + must point to cmd.exe: \c {C:\Windows\System32\cmd.exe /K C:\path_to\myenv.bat} diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc index 418b4083b6f..8cfb298d219 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc @@ -28,15 +28,15 @@ \endlist - Setting up a new project in \QC is aided by a wizard that guides you - step-by-step through the project creation process. The wizards prompt you - to enter the settings needed for that particular type of project and create + When you set up a new project in \QC, a wizard guides you step-by-step + through the process. The wizard templates prompt you to enter the settings + that you need for that particular type of project and create the necessary files for you. You can add your own custom wizards to - standardize the way subprojects and classes are added to a project. + standardize the way of adding subprojects and classes to a project. 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. + building the project: qmake, CMake, or Qbs. If you do not get to choose, + the project uses qmake as the build system. You can use wizards also to create plain C or C++ projects that use qmake, Qbs, or CMake, but do not use the Qt library. @@ -46,8 +46,8 @@ to fully control the steps and commands used to build the project. You can install tools for \l{glossary-device}{devices} as part of Qt distributions. - The \l{glossary-buildandrun-kit}{kits} and build and run settings for the - installed device types are set up automatically. However, you might need to + The installers create \l{glossary-buildandrun-kit}{kits} and specify build + and run settings for the installed device types. However, you might need to install and configure some additional software on the devices to be able to connect to them from the development PC. @@ -129,8 +129,8 @@ \row \li Qt Quick 2 Extension Plugin \li Creates a C++ plugin that makes it possible to offer extensions - that can be loaded dynamically into Qt Quick 2 applications - by using the QQmlEngine class. + that the QQmlEngine class can load dynamically into Qt Quick 2 + applications. \row \li \QC Plugin \li Creates a \QC plugin. @@ -150,7 +150,7 @@ Use this template only if you are prototyping. You cannot create a full application by using this template. - Qt Quick UI projects cannot be deployed to embedded or mobile + You cannot deploy Qt Quick UI projects to embedded or mobile target platforms. For those platforms, create a Qt Quick application instead. \row @@ -163,8 +163,8 @@ projects as a tree hierarchy. \row \li Empty qmake Project - \li Creates an empty qmake project that is based on qmake but does - not use any default classes. + \li Creates an empty qmake project that uses qmake as the build + system but does not use any default classes. \row \li Code Snippet \li Creates a qmake project from a code snippet. When working on @@ -192,9 +192,9 @@ \li {1,3} Import Project \li Project from version control \li Imports a project from a supported version control system, such - as Bazaar, CVS, Git, Mercurial, or Subversion. For - more information on how version control systems are integrated - in \QC, see \l{Using Version Control Systems}. + as Bazaar, CVS, Git, Mercurial, or Subversion. For more + information about how \QC integrates version control systems, + see \l{Using Version Control Systems}. \row \li Import as qmake or CMake Project (Limited Functionality) \li Imports an existing project that does not use any of the @@ -241,8 +241,8 @@ to \QC \endlist - \QC displays all files that are declared to be part of the project by the - project files in the \l Projects view. The files are sorted into categories + \QC displays all files that you declare to be part of the project by the + project files in the \l Projects view. It sorts the files into categories by file type (.cpp, .h, .qrc, and so on). To display additional files, edit the project file. Alternatively, you can see all the files in a project directory in the \l {File System} view. @@ -307,7 +307,7 @@ You can add CMakeLists.txt files to any project by using the \l{https://cmake.org/cmake/help/latest/command/add_subdirectory.html} {add_subdirectory} command. The files can define complete projects that - are included into the top-level project or any other CMake commands. + you include into the top-level project or any other CMake commands. \section2 qmake Projects @@ -348,10 +348,11 @@ \section1 Binding Keyboard Shortcuts to Wizards If you use a wizard regularly, you can bind a custom keyboard shortcut to - it. Triggering this keyboard shortcut will directly open the wizard without - the need to navigate to \uicontrol File > \uicontrol {New File} or \uicontrol {New Project}. + it. Triggering this keyboard shortcut directly opens the wizard, so you do + not need to navigate to \uicontrol File > \uicontrol {New File} or + \uicontrol {New Project}. - Keyboard shortcuts for wizards can be set in \uicontrol Edit > + Set keyboard shortcuts for wizards in \uicontrol Edit > \uicontrol Preferences > \uicontrol Environment > \uicontrol Keyboard > \uicontrol Wizard. All wizard actions start with \uicontrol Impl there. diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards-json.qdocinc b/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards-json.qdocinc index f1066d49173..ced787d2d95 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards-json.qdocinc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards-json.qdocinc @@ -28,7 +28,7 @@ You can use variables (\c {%\{\}}) in strings in the JSON configuration file and in template source files. A set of variables is predefined by the wizards and their pages. - You can introduce new variables as shortcuts to be used later by + You can introduce new variables as shortcuts for later use by defining the variable key names and values in the \c options section in the \c {wizard.json} file. @@ -225,8 +225,8 @@ \li The \c options section contains an array of objects with \e key and \e value attributes. You can define your own variables to use in the configuration and template source files, in addition - to the predefined variables. For example, the following - variables are used in the C++ class creation wizard: + to the predefined variables. For example, the C++ class creation + wizard uses the following variables: \code "options": @@ -372,7 +372,7 @@ may be empty. \endlist - The following information is only available when the wizard was triggered + The following information is only available when users trigger the wizard via the context menu of a node in the \uicontrol Projects view: \list @@ -563,12 +563,12 @@ settings: \list - \li \c skipIfEmpty will cause empty arguments to be silently - removed from the command to be run if set to \c true. + \li \c skipIfEmpty silently removes empty arguments from the + command to run if you set it to \c true. Defaults to \c true. \li \c directory with the working directory of the command to - be run. This defaults to the value of \c baseDirectory. + run. This defaults to the value of \c baseDirectory. \li \c command with the command to be run. @@ -605,8 +605,8 @@ \li Text Edit \endlist - \note Only the the settings documented in the following sections are - supported in wizards. + \note Wizards support only the the settings documented in the following + sections. Specify the following settings for each widget: @@ -629,8 +629,8 @@ must have their \c isComplete evaluate to \c true for this to happen. This setting defaults to \c true. - \li \c trIncompleteMessage is shown when the field's \c isComplete was - evaluated to \c false. + \li \c trIncompleteMessage is shown when the field's \c isComplete + evaluates to \c false. \li \c persistenceKey makes the user choice persistent. The value is taken to be a settings key. If the user changes the default diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards.qdoc index e6e9d293f3e..b6f786f1ad1 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards.qdoc @@ -29,17 +29,17 @@ change the wizard id in the \c {wizard.json} file. You can create a subdirectory for the templates in the settings directory. - The standard wizards are organized into subdirectories by type, but you can + \QC organizes the standard wizards into subdirectories by type, but you can add your wizard directory to any directory you like. The folder hierarchy - does not affect the order in which the wizards are displayed. + does not affect the order in which \QC displays wizards. To share the wizard with other users, you can create an archive of the wizard directory and instruct the recipients to extract it into one of the directories \QC searches wizards from. \QC displays the wizards that it finds in the \uicontrol {New Project} - and \uicontrol {New File} dialogs. For each wizard, an icon (1), a - display name (2), and a description (3) are displayed. + and \uicontrol {New File} dialogs. For each wizard, it shows an icon (1), a + display name (2), and a description (3). \image qtcreator-custom-wizard.png @@ -79,9 +79,9 @@ \section2 Mapping Actions to Keyboard Shortcuts - \QC has some actions that can improve the wizard development process. These - are by default not bound to any keyboard shortcuts and can thus not be - triggered. To enable them, assign keyboard shortcuts in \uicontrol Edit > + \QC has some actions that can improve the wizard development process. They + don't have keyboard shortcuts by default, so you cannot trigger them. To + enable them, assign keyboard shortcuts in \uicontrol Edit > \uicontrol Preferences > \uicontrol Environment > \uicontrol Keyboard > \uicontrol Wizard. @@ -112,8 +112,8 @@ \section2 Verbose Output For wizard development, we recommend that you start \QC with the - \c {-customwizard-verbose} argument to receive confirmation that \QC was - able to find and parse the \c {wizard.json} file. The verbose mode displays + \c {-customwizard-verbose} argument to receive confirmation that \QC + finds and parses the \c {wizard.json} file. The verbose mode displays information about syntax errors, which are the most typical errors you might run into while editing wizards. @@ -126,11 +126,12 @@ * Configuration found and parsed. \endcode - The output includes the name of the directory that was checked for a - \c wizard.json file. If the file is not found, the message is not displayed. + The output includes the name of the directory that \QC checks for a + \c wizard.json file. If it does not find the file, it does not show + the message. - If the file contains errors, such as an invalid icon path, the following - types of messages are displayed: + If the file contains errors, such as an invalid icon path, you receive the + following types of messages: \code Checking "/home/jsmith/.config/QtProject/qtcreator/templates/wizards/mywizard" diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-debuggers.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-debuggers.qdoc index 15ee1ac0770..a7d0aeb7b5e 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-debuggers.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-debuggers.qdoc @@ -66,14 +66,14 @@ devices in the \uicontrol ABIs field. \li In the \uicontrol {Working directory} field, specify the working - directory of the application process. If the application is run + directory of the application process. If the application runs locally, the working directory defaults to the build directory. If - the application is run remotely on a device, the value depends on + the application runs remotely on a device, the value depends on the shell or the device. Usually, you can leave this field empty. \endlist To remove the selected manually added debugger, select \uicontrol Remove. - The debugger is removed from the list when you select \uicontrol Apply. + The debugger disappears from the list when you select \uicontrol Apply. Until then, you can cancel the deletion by clicking \uicontrol Restore. */ diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-libraries.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-libraries.qdoc index 89a61c7d44c..f48b8fe649f 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-libraries.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-libraries.qdoc @@ -15,7 +15,7 @@ \title Adding Libraries to Projects In addition to Qt libraries, you can add other libraries to your projects. - The way the library is added depends on the type and location of the + The process depends on the type and location of the library. You can add a system library, your own library, or a 3rd party library. The library can be located either in the build tree of the current project or in another build tree. @@ -40,11 +40,11 @@ (\l{CMake: target_link_libraries command}{target_link_libraries} when using CMake or \l PRE_TARGETDEPS when using qmake) in the project file. - Depending on the development platform, some options might be detected - automatically. For example, on \macos, the library type (\uicontrol Library or - \uicontrol Framework) is detected automatically and the option is hidden. However, - if you develop on another platform than \macos and want to build your - project for \macos, you must specify the library type. + Depending on the development platform, \QC might detect some options + automatically. For example, on \macos, it detects the library type + (\uicontrol Library or \uicontrol Framework) automatically and hides the + option. However, if you develop on another platform than \macos and want + to build your project for \macos, you must specify the library type. The default convention on Windows is that the debug and release versions of a library have the same name, but are placed in different subdirectories, diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc index 30b41c1e458..6563358d778 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc @@ -17,15 +17,15 @@ \QC stores information that it needs to build projects in a .user file. If \QC cannot find the file when you open an existing project, it prompts you - to enter the information. If you created the project by using another \QC - instance, \QC asks whether you want to use the old settings. The settings - are specific to the development environment, and should not be copied from + to enter the information. If you used another \QC instance to create the + project, \QC asks whether you want to use the old settings. The settings + are specific to the development environment, and you should not copy them from one environment to another. Therefore, we recommend that you select \uicontrol No and enter the information again in the \uicontrol {Configure Project} tab. The \uicontrol {Configure Project} tab displays a list of \l{glossary-buildandrun-kit}{kits} - for building and running projects, that are installed on the development PC and - configured in \uicontrol Edit > \uicontrol Preferences > \uicontrol Kits. + for building and running projects, that you install on the development PC and + configure in \uicontrol Edit > \uicontrol Preferences > \uicontrol Kits. Select the kits that you want to build and run the project with. \image qtcreator-open-project-kits.png "Configure Project tab" @@ -46,8 +46,8 @@ and location for the directory that you can change. If you have built the project before, \QC can use the existing build - configuration to make the exact same build as found in the directory - available to \QC. To import a build, specify a directory in the + configuration to make the exact same build available to you. To import a + build, specify a directory in the \uicontrol {Import Build From} section and select \uicontrol {Import}. You can edit the build configuration later. For more information, see diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-overview.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-overview.qdoc index ab24e97fac5..7be0b1ba4d9 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-overview.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-overview.qdoc @@ -44,9 +44,9 @@ \li \l{Managing Sessions} - Items such as open files, breakpoints, and evaluated expressions - are stored in sessions. They are not considered to be part of - the information shared across platforms. + Sessions store items such as open files, breakpoints, and evaluated + expressions, which you do not typically want to share across + platforms. \endlist diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-qt-versions.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-qt-versions.qdoc index 9f00483330d..bddad912d27 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-qt-versions.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-qt-versions.qdoc @@ -14,25 +14,23 @@ \title Adding Qt Versions - \QC allows you to have multiple versions of Qt installed on your development - PC and use different versions to build your projects. For example, - \l{glossary-device}{device} manufacturers provide special Qt versions for - developing applications for their devices. + You can install multiple versions of Qt development PC and use them to build + your projects. For example, \l{glossary-device}{device} manufacturers provide + special Qt versions for developing applications for their devices. \section1 Registering Installed Qt Versions - \QC automatically detects the Qt versions that are registered by your - system or by the Qt Installer. To view detailed information for each Qt - version, select it in the list and select \uicontrol Details in the - \uicontrol {Qt version for} section. + The \uicontrol {Qt Versions} tab lists the installed Qt versions. To view + detailed information about each Qt version, select it in the list and select + \uicontrol Details in the \uicontrol {Qt version for} section. \image qtcreator-qt-versions.png "Qt Versions tab in Kit preferences" To remove invalid Qt versions, select \uicontrol {Clean Up}. - You can link to a Qt that you installed using the Qt Maintenance Tool to - automatically register the installed Qt versions. However, you cannot link - to Qt versions that were installed by the system using some other package + You can link to a Qt that the Qt Installer installed to + automatically detect the installed Qt versions. However, you cannot link + to a Qt that the system installed with some other package manager, such as your Linux distribution, brew on \macos, or Chocolatey on Windows, nor a self-built Qt. In those cases, select \uicontrol {Add} in the \uicontrol {Qt Versions} tab to add the Qt version manually, as @@ -56,8 +54,8 @@ To remove the automatically detected Qt versions from the list, select \uicontrol {Remove Link}. - If a Qt version is still not listed in the \uicontrol {Qt Versions} tab - under \uicontrol Auto-detected, you have to set it up manually, as described + If the \uicontrol {Qt Versions} tab does not show a Qt version + under \uicontrol Auto-detected, set it up manually, as described in the following section. You specify the Qt version to use for each \l{glossary-buildandrun-kit} @@ -74,8 +72,7 @@ \li Select \uicontrol Edit > \uicontrol Preferences > \uicontrol Kits > \uicontrol {Qt Versions} > \uicontrol Add. - \li Select the qmake executable for the Qt version that you want to - add. + \li Select the qmake executable for the Qt version to add. \li Select the Qt version to view and edit it. @@ -85,7 +82,7 @@ \li In the \uicontrol{qmake path} field, you can change the qmake location. - \li If the Qt version is for QNX, enter the path to your installed QNX SDK in the + \li If the Qt version is for QNX, enter the path to the QNX SDK in the \uicontrol{QNX SDK} field. \endlist @@ -110,7 +107,7 @@ the Qt version to see more information about the issue and suggestions for fixing it. - To determine whether a particular Qt version is installed correctly, \QC + To verify the installation of a particular Qt version, \QC calls \c {qmake -query} and checks that the directories referenced in the output exist. When \QC complains about the installation of a self-built Qt version, try running \c {make install} in the build directory to actually @@ -119,8 +116,10 @@ the Qt version. \section1 Minimum Requirements - If your build of Qt is incomplete but you still want to use QMake as build - system, you need to ensure the following minimum requirements to be able to use that setup with \QC. + If your build of Qt is incomplete but you still want to use qmake as build + system, you need to ensure the following minimum requirements to use that + setup with \QC. + \list 1 \li qmake is an executable that understands the \c -query command line argument. @@ -130,7 +129,7 @@ files. \endlist - If your Qt version has no \c libQtCore.so, \QC is unable to detect the ABI. + If your Qt version has no \c libQtCore.so, \QC cannot detect the ABI. */ diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc index a680f956958..5ee2b302375 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc @@ -15,32 +15,27 @@ \title Configuring Projects When you install Qt for a target platform, such as Android or QNX, the - build and run settings for the development targets might be set up - automatically in \QC. - - When you open a project for the first time, the - \uicontrol {Configure Projects} view is displayed to let you select a set of - \l{glossary-buildandrun-kit}{kits} that you want to use to build and run - your project. At least one kit must be active for you to be able to build - and run the project. For more information about selecting the initial kit, - see \l{Opening Projects}. + \l{https://www.qt.io/download-qt-installer}{Qt Online Installer} + creates \l{glossary-buildandrun-kit}{kits} for the development + targets. Select the kits to use in the \uicontrol {Configure Projects} + view when you open a project for the first time. At least one kit must be + active. For more information about selecting the initial kit, see + \l{Opening Projects}. To maintain the list of active kits for a currently open project, switch to the \uicontrol Projects mode by pressing \key Ctrl+5. \section1 Activating Kits for a Project - All kits compatible with your project are listed in the - \uicontrol {Build & Run} section of the sidebar. To activate one or more - disabled kits, click them. + The \uicontrol {Build & Run} section of the sidebar lists the kits that are + compatible with your project. To activate one or more kits, click them. \image qtcreator-project-kits.png - The list displays kits that are configured in \uicontrol Edit > - \uicontrol Preferences > \uicontrol Kits. If the kit configuration is not - suitable for the project type, warning and error icons are displayed. - To view the warning and error messages, move the mouse pointer over - the kit name. + The list displays kits from \uicontrol Edit > \uicontrol Preferences > + \uicontrol Kits. Warning and error icons indicate that the kit configuration + is not suitable for the project type. To view the warning and error messages, + move the mouse pointer over the kit name. In the list of kits, you may see entries described as \e {Replacement for }. \QC generates them to save your project-specific settings, diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdocinc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdocinc index 150b491ea5c..f39a31fb0a7 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdocinc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdocinc @@ -43,7 +43,7 @@ application with root user permissions. You can also create custom executable run configurations where you - can set the executable to be run. For more information, see + can set the executable to run. For more information, see \l{Specifying a Custom Executable to Run}. //! [run settings desktop] diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-targets.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-targets.qdoc index 91ce4b81c34..a242e94e154 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-targets.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-targets.qdoc @@ -152,18 +152,17 @@ \row \li \uicontrol {Qt version} \li Qt version to use for building the project. You can add Qt versions - to the list if they are installed on the development PC, but were not - detected automatically. For more information, see \l{Adding Qt Versions}. + that \QC did not detect automatically. For more information, see + \l{Adding Qt Versions}. \QC checks the directories listed in the \c{PATH} environment - variable for the qmake executable. If a qmake executable is found, - it is referred to as \b{Qt in PATH} and selected as the Qt - version to use for the \uicontrol Desktop kit that is created by default. + variable for the qmake executable. It refers to the qmake executable + it finds as \b{Qt in PATH} and selects it as the Qt version + to use for the \uicontrol Desktop kit that is created by default. \row \li \uicontrol {Qt mkspec} - \li Name of the mkspec configuration that should be used by qmake. If - you leave this field empty, the default mkspec of the selected Qt - version is used. + \li Name of the mkspec configuration that qmake uses. If you leave this + field empty, it uses the default mkspec of the selected Qt version. \row \li \uicontrol {Additional Qbs profile settings} \li Select \uicontrol Change to add settings to Qbs build profiles. diff --git a/doc/qtcreator/src/python/creator-python-project.qdocinc b/doc/qtcreator/src/python/creator-python-project.qdocinc index dabf001d17a..4d32d5abff7 100644 --- a/doc/qtcreator/src/python/creator-python-project.qdocinc +++ b/doc/qtcreator/src/python/creator-python-project.qdocinc @@ -12,7 +12,7 @@ and \l {Qt Widgets}. If you have not installed PySide6, \QC prompts you to install it after - the project is created. Further, it prompts you to install the + you create the project. Further, it prompts you to install the \l {Python Language Server}{Python language server} that provides services such as code completion and annotations. Select \uicontrol Install to install PySide6 and the language server. @@ -23,12 +23,12 @@ \image qtcreator-python-interpreters.png "Python Interpreters in Preferences" You can add and remove interpreters and clean up references to interpreters - that have been uninstalled, but still appear in the list. In addition, you + that you uninstalled, but that still appear in the list. In addition, you can set the interpreter to use by default. The Qt for Python Application wizards generate a \c {.pyproject} file that lists the files in the Python project and a \c {.py} file that contains - some boilerplate code. In addition, the widget based UI wizard creates a + some boilerplate code. In addition, the widget-based UI wizard creates a \c {.ui} file that contains a \QD form, and the Qt Quick Application wizard creates a \c {.qml} file that contains Qt Quick controls. @@ -84,7 +84,7 @@ self.ui.setupUi(self) \endcode - \note UI elements of the new class can be accessed as member variables. + \note You can access the UI elements of the new class as member variables. For example, if you have a button called \e{button1}, you can interact with it using \c{self.ui.button1}. diff --git a/doc/qtcreator/src/qtquick/creator-only/creator-mobile-app-tutorial.qdoc b/doc/qtcreator/src/qtquick/creator-only/creator-mobile-app-tutorial.qdoc index d5a88c88a7b..23e5cfb68de 100644 --- a/doc/qtcreator/src/qtquick/creator-only/creator-mobile-app-tutorial.qdoc +++ b/doc/qtcreator/src/qtquick/creator-only/creator-mobile-app-tutorial.qdoc @@ -189,7 +189,7 @@ \section1 Running the Application - The application is complete and ready to be deployed to a device: + You can now deploy the application to a device: \list 1 @@ -199,8 +199,8 @@ \li Connect the device to the development PC. If you are using a device running Android v4.2.2, it should prompt you to - verify the connection to allow USB debugging from the PC it is connected - to. To avoid such prompts every time you connect the device, select the + verify the connection to allow USB debugging from the PC. To avoid such + prompts every time you connect the device, select the \uicontrol {Always allow from this computer} check box, and then select \uicontrol OK. diff --git a/doc/qtcreator/src/qtquick/creator-only/qtquick-app-tutorial.qdoc b/doc/qtcreator/src/qtquick/creator-only/qtquick-app-tutorial.qdoc index 7f307d803bd..bda9e678757 100644 --- a/doc/qtcreator/src/qtquick/creator-only/qtquick-app-tutorial.qdoc +++ b/doc/qtcreator/src/qtquick/creator-only/qtquick-app-tutorial.qdoc @@ -48,7 +48,7 @@ \section1 Creating Custom QML Types - Because the \l Window QML type requires states to be added into child + Because the \l Window QML type requires that you add states into child components, we use the wizard to create a custom QML type called \e Page that we will refer to from \e main.qml. @@ -126,7 +126,7 @@ To make the image move between the rectangles when users click them, we add states to the Page component, where we change the values of the \c x and \c y properties of \e icon to match those of the middle right and top left - rectangles. To make sure that the image is displayed within the rectangle + rectangles. To make sure that the image stays within the rectangle when the view is scaled on different sizes of screens, we \e bind the values of the \c x and \c y properties of \e icon to those of the rectangles: diff --git a/doc/qtcreator/src/qtquick/creator-only/qtquick-tutorial-create-empty-project.qdocinc b/doc/qtcreator/src/qtquick/creator-only/qtquick-tutorial-create-empty-project.qdocinc index 357e71db37a..e1f5e5491de 100644 --- a/doc/qtcreator/src/qtquick/creator-only/qtquick-tutorial-create-empty-project.qdocinc +++ b/doc/qtcreator/src/qtquick/creator-only/qtquick-tutorial-create-empty-project.qdocinc @@ -48,7 +48,7 @@ applications for mobile devices, select kits also for Android and iOS. - \note Kits are listed if they have been specified in \uicontrol Edit + \note The list shows kits that you specify in \uicontrol Edit > \uicontrol Preferences > \uicontrol Kits (on Windows and Linux) or in \uicontrol {\QC} > \uicontrol Preferences > \uicontrol Kits (on \macos). diff --git a/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc b/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc index 5567f14c1c5..7a191cc414c 100644 --- a/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc +++ b/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc @@ -28,7 +28,7 @@ \uicontrol Preferences > \uicontrol {Build & Run} > \uicontrol General. The file that is currently active in the editor determines which folder - is displayed in the \uicontrol {File System} view: + to display in the \uicontrol {File System} view: \list \li \uicontrol Projects if the file is located in a subdirectory of the @@ -41,8 +41,8 @@ \uicontrol {File System} view, delesect the \inlineimage icons/linkicon.png (\uicontrol {Synchronize Root Directory with Editor}) button. - The path to the active file is displayed as bread crumbs. You can move to - any directory along the path by clicking it. + The view displays the path to the active file as bread crumbs. You can move + to any directory along the path by clicking it. \section1 File System Context Menu @@ -94,13 +94,13 @@ \list \li To hide the bread crumbs, deselect the \uicontrol {Show Bread Crumbs} check box. - \li By default, folders are separated from files and listed first in - the view. To list all items in alphabetic order, deselect the + \li By default, the view separates folders from files and lists them + first. To list all items in alphabetic order, deselect the \uicontrol {Show Folders on Top} check box. \li To also show hidden files, select \uicontrol {Show Hidden Files}. \endlist - To stop the synchronization with the file currently opened in the + To stop the synchronization with the file currently open in the editor, deselect \inlineimage icons/linkicon.png (\uicontrol {Synchronize with Editor}). */ diff --git a/doc/qtcreator/src/user-interface/creator-open-documents-view.qdoc b/doc/qtcreator/src/user-interface/creator-open-documents-view.qdoc index a1ce4badba7..5250f79af3c 100644 --- a/doc/qtcreator/src/user-interface/creator-open-documents-view.qdoc +++ b/doc/qtcreator/src/user-interface/creator-open-documents-view.qdoc @@ -14,7 +14,7 @@ You can use the context menu to apply some of the functions also available in the \uicontrol File menu and in the \l {File System Context Menu} - {File System} view to the file that is selected in the view. + {File System} view to the file that you select in the view. In addition, you can: @@ -22,7 +22,7 @@ \li Copy the full path of the file or just the filename to the clipboard. \li Pin files to ensure they stay at the top of the list and are not - closed when \uicontrol {Close All} is used. + closed when you select \uicontrol {Close All}. \endlist \section1 Specifying Settings for Opening Files diff --git a/doc/qtcreator/src/user-interface/creator-projects-view.qdoc b/doc/qtcreator/src/user-interface/creator-projects-view.qdoc index cda8226e0fa..0f5010ae600 100644 --- a/doc/qtcreator/src/user-interface/creator-projects-view.qdoc +++ b/doc/qtcreator/src/user-interface/creator-projects-view.qdoc @@ -50,8 +50,8 @@ \section1 Projects View Context Menu The \uicontrol Projects view contains context menus for managing projects, - subprojects, folders, and files. The following functions are available for - managing projects and subprojects: + subprojects, folders, and files. Use the following functions to manage + projects and subprojects: \list \li Set a project as the active project. @@ -77,28 +77,28 @@ \li Open a terminal window in the project directory. To specify the terminal to use on Linux and \macos, select \uicontrol Edit > \uicontrol Preferences > \uicontrol Environment > \uicontrol System. - \li Open a terminal window in the project directory that is configured + \li Open a terminal window in the project directory that you configured for building or running the project. \li Expand or collapse the tree view to show or hide all files and folders. \li Close all files in a project. \li Close the selected project or all projects except the selected - one. By default, all files in the projects are also - closed. To keep them open, deselect the \uicontrol Edit > + one. By default, this closes all files in the projects. To keep + them open, deselect the \uicontrol Edit > \uicontrol Preferences > \uicontrol {Build & Run} > \uicontrol General > \uicontrol {Close source files along with project} check box. \endlist - For managing files and directories, the same functions are available as in + For managing files and directories, use the same functions as in the \l {File System} view. To view a project in it, select \uicontrol {Show in File System View}. \section1 Projects View Toolbar \if defined(qtdesignstudio) - In the \uicontrol Edit and \uicontrol Debug mode, the \uicontrol Projects - view is displayed in the \l{Working with Sidebars}{sidebar}. It has a - toolbar with additional options. + In the \uicontrol Edit and \uicontrol Debug mode, the + \l{Working with Sidebars}{sidebar} contains the \uicontrol Projects + view. It has a toolbar with additional options. \image qtcreator-projects-view-edit.png "Projects view in the sidebar" \else @@ -112,10 +112,10 @@ \list \li \uicontrol {Simplify Tree} hides the categories and sorts project files alphabetically. - \li \uicontrol {Hide Generated Files} hides the source files that are - automatically generated by the build system. - \li \uicontrol {Hide Disabled Files} hides the source files that are - not enabled for the current target, + \li \uicontrol {Hide Generated Files} hides the source files that the + build system automatically generates. + \li \uicontrol {Hide Disabled Files} hides the source files that you + have not enabled for the current target, \li \uicontrol {Hide Empty Directories} hides directories that do not contain any files. \li \uicontrol {Show Source and Header Groups} shows source and header @@ -130,18 +130,17 @@ \if defined(qtcreator) Some build systems support adding and removing files to a project in \QC (currently qmake and Qbs). The faithful display of the project structure - allows to specify exactly where a new file should be placed in the build - system. + enables you to specify exactly where to place a new file in the build system. - If you cannot see some files, they might not be declared as part of the + If you cannot see some files, you might have to declare them as part of the project. For more information, see \l{Specifying Project Contents}. - If the project is under version control, information from the version - control system might be displayed in brackets after the project name. - This is currently implemented for Git (the branch name or a tag is - displayed) and ClearCase (the view name is displayed). + If the project is under version control, you might see information + from the version control system in brackets after the project name. + \QC currently implements this for Git (the view displays the branch name + or a tag) and ClearCase (the view displays the branch name). \else - If the project is under Git version control, the currently checked out - branch or tag is displayed in brackets after the project name. + If the project is under Git version control, you can see the currently + checked out branch or tag in brackets after the project name. \endif */ diff --git a/doc/qtcreator/src/user-interface/creator-ui.qdoc b/doc/qtcreator/src/user-interface/creator-ui.qdoc index bbf9b13b376..7e34962e952 100644 --- a/doc/qtcreator/src/user-interface/creator-ui.qdoc +++ b/doc/qtcreator/src/user-interface/creator-ui.qdoc @@ -50,17 +50,14 @@ \endif \if defined(qtcreator) - You can use the \l{Selecting Modes}{mode selector} (1) to change to another - \QC mode. + Use the \l{Selecting Modes}{mode selector} (1) to change to another \QC mode. - You can use the kit selector (2) to select the - \l{glossary-buildandrun-kit}{kit} for running (3), debugging (4), or - building (5) the application. Output from these actions is displayed on - the task bar (7). + Use the kit selector (2) to select the \l{glossary-buildandrun-kit}{kit} for + running (3), debugging (4), or building (5) the application. The task bar (7) + displays output from these actions. - You can use the \l{Searching with the Locator}{locator} (6) to browse - through projects, files, classes, functions, documentation, and file - systems. + Use the \l{Searching with the Locator}{locator} (6) to browse through + projects, files, classes, functions, documentation, and file systems. For a quick tour of the user interface that takes you to the locations of these controls, select \uicontrol Help > \uicontrol {UI Tour}. @@ -147,8 +144,8 @@ \section1 Changing Languages - \QC has been localized into several languages. If the system language - is one of the supported languages, it is automatically selected. To + \QC has several language versions. If the system language + is one of the supported languages, \QC selects it automatically. To change the language, select \uicontrol Edit > \uicontrol Preferences > \uicontrol Environment and select a language in the \uicontrol Language field. Select \uicontrol {Restart Now} to restart \QC and have the change @@ -156,16 +153,16 @@ \section1 High DPI Scaling - The operating systems supported by \QC implement high dots-per-inch (DPI) + The operating systems that \QC supports implement high dots-per-inch (DPI) scaling at varying levels. Therefore, \QC handles high DPI scaling differently on different operating systems: \list - \li On \macos, high DPI scaling is forced, which means that \QC allows + \li On \macos, \QC forces high DPI scaling, which means that it allows Qt to use the system scaling factor as the \QC scaling factor. - \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 Windows, if you do not set \l{High DPI} + {scaling environment variables}, \QC instructs Qt to detect the + scaling factor and use it as the \QC scaling factor. \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. @@ -257,14 +254,14 @@ \list - \li On Linux and other Unix platforms, the files are located in + \li On Linux and other Unix platforms, look in \c {~/.config/QtProject} and \c {~/.local/share/data/QtProject/qtcreator}. - \li On \macos, the files are located in \c {~/.config/QtProject} and + \li On \macos, look in \c {~/.config/QtProject} and \c {~/Library/Application Support/QtProject/Qt Creator}. - \li On Windows, the files are located in + \li On Windows, look in \c {%appdata%\QtProject} and \c {%localappdata%\QtProject}. \endlist @@ -288,8 +285,8 @@ \if defined(qtcreator) The mode selector allows you to quickly switch between tasks such as editing - project and source files, designing application UIs, configuring how - projects are built and executed, and debugging your applications. To change + project and source files, designing application UIs, configuring projects for + building and running, and debugging your applications. To change modes, click the icons, or use the \l{keyboard-shortcuts} {corresponding keyboard shortcut}. @@ -533,7 +530,7 @@ To jump from one issue to the next or previous one, press \key F6 and \key Shift+F6. - By default, the \uicontrol Issues view is cleared on a new build. To keep + By default, a new build clears the \uicontrol Issues view. To keep the issues from the previous build rounds, deselect \uicontrol Edit > \uicontrol Preferences > \uicontrol {Build & Run} > \uicontrol General > \uicontrol {Clear issues list on new build}. @@ -545,8 +542,8 @@ \image qtcreator-search-results.png "Search Results" - The search results are stored in the search history (1) from which you can - select earlier searches. + The search history (1) stores the search results. You can select earlier + searches from the history. The figure below shows an example search result for all occurrences of the search string in the specified directory. @@ -559,7 +556,7 @@ \section1 Application Output \uicontrol{Application Output} displays the status of a program when - it is executed, and the debug output. + you execute it, and the debug output. \image qtcreator-application-output.png diff --git a/doc/qtcreator/src/user-interface/creator-views.qdoc b/doc/qtcreator/src/user-interface/creator-views.qdoc index f683788713d..5b709cd7687 100644 --- a/doc/qtcreator/src/user-interface/creator-views.qdoc +++ b/doc/qtcreator/src/user-interface/creator-views.qdoc @@ -22,7 +22,7 @@ {mode} you are working in. Only views that are relevant to a mode are available in it. - The following views are related to managing projects and files: + Manage projects and files in the following views: \list \li \l Projects shows a list of projects open in the current @@ -49,8 +49,8 @@ tests in the project. \li \l{Viewing Type Hierarchy}{Type Hierarchy} shows the base classes of a class. - \li \l{Viewing Include Hierarchy}{Include Hierarchy} shows which - files are included in the current file and which files include + \li \l{Viewing Include Hierarchy}{Include Hierarchy} shows the + files that the current file includes and those that include the current file. \endlist \else @@ -58,8 +58,7 @@ files in the \uicontrol Design mode, see \l{Design Views}. \endif - The additional options in a particular view are described in the following - sections. + The following sections describe the additional options in a particular view. In some views, right-clicking opens a context menu that contains functions for managing the objects listed in the view. @@ -109,21 +108,21 @@ To navigate in the type hierarchy, double-click a class or select it, and then select \uicontrol {Open Type Hierarchy} in the context menu. - The previous class is highlighted in the view. + The view highlights the previous class. - The definition of the selected class is opened in the code editor. You + The definition of the selected class opens in the code editor. You can also select \uicontrol {Open in Editor} in the context menu to open it. \section1 Viewing Include Hierarchy - To view which files are included in the current file and which files include + To view the files that the current file includes and those that include the current file, right-click in the editor and select \uicontrol {Open Include Hierarchy} or press \key {Ctrl+Shift+I}. \image qtcreator-include-hierarchy-view.png "Include Hierarchy view" - To keep the view synchronized with the file currently opened in the editor, + To keep the view synchronized with the file currently open in the editor, select \inlineimage icons/linkicon.png (\uicontrol {Synchronize with Editor}). */ diff --git a/doc/qtcreator/src/vcs/creator-only/creator-vcs-perforce.qdoc b/doc/qtcreator/src/vcs/creator-only/creator-vcs-perforce.qdoc index a7f24e0484f..23df8528b30 100644 --- a/doc/qtcreator/src/vcs/creator-only/creator-vcs-perforce.qdoc +++ b/doc/qtcreator/src/vcs/creator-only/creator-vcs-perforce.qdoc @@ -17,10 +17,15 @@ Perforce is a fast software configuration management system developed by Perforce Software. - Since \QC 4.9, the Perforce plugin is disabled by default. To enable - it, select \uicontrol Help > \uicontrol {About Plugins} > - \uicontrol {Version Control} > \uicontrol Perforce. Then select - \uicontrol {Restart Now} to restart \QC and load the plugin. + \section1 Enabling the Perforce Plugin + + To enable the Perforce plugin: + + \list 1 + \li Select \uicontrol Help > \uicontrol {About Plugins} > + \uicontrol {Version Control} > \uicontrol Perforce. + \li Select \uicontrol {Restart Now} to restart \QC and load the plugin. + \endlist \section1 Configuring Perforce @@ -29,8 +34,8 @@ specify the details individually for several projects, use configuration files instead. Create a \c {p4config.txt} configuration file for each project in the top level project directory, and run - \c{p4 set P4CONFIG=p4config.txt} once. Note that - \uicontrol {Environment Variables} must be unchecked. + \c{p4 set P4CONFIG=p4config.txt} once. You must deselect the + \uicontrol {Environment Variables} check box. \section1 Editing Files @@ -52,8 +57,8 @@ To view information about changelists and the files in them, select \uicontrol Tools > \uicontrol Perforce > \uicontrol Describe. - By default, you are prompted to confirm that you want to submit changes. - To suppress the prompt, select \uicontrol Edit > \uicontrol Preferences > + By default, you must confirm that you want to submit changes. To suppress + the confirmation prompt, select \uicontrol Edit > \uicontrol Preferences > \uicontrol {Version Control} > \uicontrol Perforce, and then deselect the \uicontrol {Prompt on submit} check box. */ diff --git a/doc/qtcreator/src/vcs/creator-only/creator-vcs-subversion.qdoc b/doc/qtcreator/src/vcs/creator-only/creator-vcs-subversion.qdoc index e817b483c24..320666cb3a3 100644 --- a/doc/qtcreator/src/vcs/creator-only/creator-vcs-subversion.qdoc +++ b/doc/qtcreator/src/vcs/creator-only/creator-vcs-subversion.qdoc @@ -21,8 +21,8 @@ \uicontrol Subversion > \uicontrol Describe to display commit log messages for a revision. - By default, you are prompted to confirm that you want to submit changes. - To suppress the prompt, select \uicontrol Edit > \uicontrol Preferences > + By default, you must confirm that you want to submit changes. To suppress the + confirmation prompt, select \uicontrol Edit > \uicontrol Preferences > \uicontrol {Version Control} > \uicontrol Subversion, and then deselect the \uicontrol {Prompt on submit} check box. diff --git a/doc/qtcreator/src/vcs/creator-only/creator-vcs.qdoc b/doc/qtcreator/src/vcs/creator-only/creator-vcs.qdoc index 7f59ee1b28a..c935dfbc2d0 100644 --- a/doc/qtcreator/src/vcs/creator-only/creator-vcs.qdoc +++ b/doc/qtcreator/src/vcs/creator-only/creator-vcs.qdoc @@ -173,7 +173,7 @@ Once you have finished making changes, submit them to the version control system by choosing \uicontrol{Commit} or \uicontrol{Submit}. \QC displays a commit page containing a text editor where you can enter your commit - message and a checkable list of modified files to be included. + message and a checkable list of modified files to include. \section2 Reverting Changes diff --git a/doc/qtcreator/src/vcs/creator-vcs-git.qdoc b/doc/qtcreator/src/vcs/creator-vcs-git.qdoc index 46b2629f6e8..8267c8e0422 100644 --- a/doc/qtcreator/src/vcs/creator-vcs-git.qdoc +++ b/doc/qtcreator/src/vcs/creator-vcs-git.qdoc @@ -62,8 +62,8 @@ \image qtcreator-vcs-diff.png - The diff is displayed side-by-side in a \l{Comparing Files}{diff editor} - by default. To use the unified diff view instead, select the + The \l{Comparing Files}{diff editor} displays the diff side-by-side. To use + the unified diff view instead, select the \uicontrol {Switch to Unified Diff Editor} (1) option from the toolbar. In both views, you can use context menu commands to apply, revert, stage, and unstage chunks or selected lines, as well as send chunks to a code @@ -125,7 +125,7 @@ The other actions in the context-menu enable you to apply actions to the commit, such as cherry-pick, checkout, or revert it. - To rescan the files, click \inlineimage icons/reload_gray.png + To rescan the files, select \inlineimage icons/reload_gray.png (\uicontrol Reload). \section2 Staging Changes @@ -136,7 +136,7 @@ \section2 Resetting Changes - Git has an index that is used to stage changes. The index is committed on + Git uses an index to stage changes. The index is committed on the next commit. Git allows you to revert back to the state of the last commit as well as to the state staged in the index. @@ -158,9 +158,8 @@ To clean the working directory, select \uicontrol {Build Project} > \uicontrol {Clean}. All files that are not under version control are displayed in - the \uicontrol {Clean Repository} dialog. Ignored files are - deselected by default. Select the files to delete and click - \uicontrol Delete. + the \uicontrol {Clean Repository} dialog. Ignored files are deselected by + default. Select the files to delete, and then select \uicontrol Delete. \section1 Working with Local Repositories @@ -185,7 +184,7 @@ To submit your changes to Git, select \uicontrol Commit. \QC displays a commit page containing a text editor where you can enter your commit - message and a checkable list of modified files to be included. + message and a checkable list of modified files to include. \image qtcreator-vcs-commit.png "Committing changes with Git" @@ -194,7 +193,7 @@ In \uicontrol {Commit Information}, you can edit information about the author of the commit. To bypass re-commit and commit message hooks, - select \uicontrol {Bypass hooks}. If signoffs are used for your project, + select \uicontrol {Bypass hooks}. If your project uses signoffs, select \uicontrol {Sign off} to add a \e signed-off-by trailer by the author at the end of the commit log message. @@ -202,7 +201,7 @@ In \uicontrol Files, select the files to include in the commit. - When you have finished filling out the commit page information, click on + When you have finished filling out the commit page information, select \uicontrol Commit to start committing. The \uicontrol {Diff Selected Files} button opens a \l{Viewing Git Diff} @@ -236,7 +235,7 @@ To amend an earlier comment in a series of related commits, select \uicontrol Tools > \uicontrol Git > \uicontrol {Local Repository} > - \uicontrol {Fixup Previous Commit}. This operation is done using interactive + \uicontrol {Fixup Previous Commit}. This operation uses interactive rebase. In case of conflicts, a merge tool is suggested. \section2 Resetting Local Repository @@ -265,9 +264,9 @@ \section2 Working with Branches - To work with Git branches, select \uicontrol {Branches}. The checked out - branch is shown in bold and underlined in the list of branches in the - \uicontrol {Git Branches} sidebar view. + To work with Git branches, select \uicontrol {Branches}. The + \uicontrol {Git Branches} sidebar view shows the checked out + branch in bold and underlined in the list of branches. \image qtcreator-vcs-gitbranch.png "Git Branches sidebar view" @@ -283,13 +282,13 @@ If you checked out a specific commit, the list of branches displays a \e {Detached HEAD} entry. - For local and remote branches, the changes log can be shown by double - clicking on the branch name. + For local and remote branches, double-click the branch name to view the + change log. - To refresh the list of branches, click \inlineimage icons/reload_gray.png + To refresh the list of branches, select \inlineimage icons/reload_gray.png (\uicontrol Refresh). - The following operations are supported in the context-menu for a branch: + The context menu for a branch contains the following functions: \table \header @@ -347,9 +346,9 @@ \li Push the committed changes to the selected remote branch. \endtable - The following additional context-menu operations are available for - \uicontrol{Remote Branches}. The context-menu can be opened on - \uicontrol{Remote Branches} or on a specific remote repository. + The context menu for a remote branch contains the following additional + functions. To open it, select \uicontrol{Remote Branches} or a remote + repository. \table \header @@ -378,7 +377,7 @@ \section2 Applying Patches - Patches are rewriting instructions that can be applied to a set of files. + Patches are rewriting instructions that Git can apply to a set of files. To apply a patch file that is open in \QC, select \uicontrol Patch > \uicontrol {Apply from Editor}. @@ -444,8 +443,8 @@ To start controlling a project directory that is currently not under version control, select \uicontrol Tools > \uicontrol Git > \uicontrol {Create Repository}. \QC creates a new subdirectory named .git - that contains all the necessary repository files. However, nothing in the - project is tracked yet, so you will need to create an initial commit to + that contains all the necessary repository files. However, Git does not track + anyhing in the project yet, so you will need to create an initial commit to start tracking the project files. \section1 Working with Remote Repositories diff --git a/doc/qtcreator/src/widgets/qtdesigner-app-tutorial.qdoc b/doc/qtcreator/src/widgets/qtdesigner-app-tutorial.qdoc index 1d76b5f5e17..56b0cea0bfb 100644 --- a/doc/qtcreator/src/widgets/qtdesigner-app-tutorial.qdoc +++ b/doc/qtcreator/src/widgets/qtdesigner-app-tutorial.qdoc @@ -16,8 +16,8 @@ This tutorial describes how to use \QC to create a small Qt application, Text Finder. It is a simplified version of the Qt UI Tools \l{Text Finder - Example}. The application user interface is constructed from Qt widgets by - using \QD. The application logic is written in C++ by using the code editor. + Example}. We use \QD to construct the application user interface from + Qt widgets and the code editor to write the application logic in C++. \image qtcreator-textfinder-screenshot.png @@ -91,8 +91,8 @@ \endlist - \note The project opens in the \uicontrol Edit mode, and these instructions are - hidden. To return to these instructions, open the \uicontrol Help mode. + \note The project opens in the \uicontrol Edit mode, which hides these + instructions. To return to these instructions, open the \uicontrol Help mode. The TextFinder project now contains the following files: @@ -187,9 +187,9 @@ \li Select \uicontrol {Go to Slot} > \uicontrol {clicked()}, and then select \uicontrol OK. - A private slot, \c{on_findButton_clicked()}, is added to the + This adds a private slot, \c{on_findButton_clicked()}, to the header file, textfinder.h and a private function, - \c{TextFinder::on_findButton_clicked()}, is added to the + \c{TextFinder::on_findButton_clicked()}, to the source file, textfinder.cpp. \endlist @@ -214,8 +214,7 @@ \c{textfinder.h} file to open it for editing. \li Add a private function to the \c{private} section, after the - \c{Ui::TextFinder} pointer, as illustrated by the following code - snippet: + \c{Ui::TextFinder} pointer: \snippet textfinder/textfinder.h 0 @@ -233,8 +232,7 @@ \li Add code to load a text file using QFile, read it with QTextStream, and then display it on \c{textEdit} with - \l{QTextEdit::setPlainText()}. - This is illustrated by the following code snippet: + \l{QTextEdit::setPlainText()}: \snippet textfinder/textfinder.cpp 0 @@ -245,21 +243,18 @@ \li For the \c{on_findButton_clicked()} slot, add code to extract the search string and use the \l{QTextEdit::find()} function - to look for the search string within the text file. This is - illustrated by the following code snippet: + to look for the search string within the text file: \snippet textfinder/textfinder.cpp 2 - \li Once both of these functions are complete, add a line to call - \c{loadTextFile()} in the constructor, as illustrated by the - following code snippet: + \li Add a line to call \c{loadTextFile()} in the constructor: \snippet textfinder/textfinder.cpp 3 \endlist - The \c{on_findButton_clicked()} slot is called automatically in - the uic generated ui_textfinder.h file by this line of code: + The following line of code automatically calls the \c{on_findButton_clicked()} + slot in the uic generated ui_textfinder.h file: \code QMetaObject::connectSlotsByName(TextFinder);