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

Doc: Use active voice instead of passive voice

Browse Source 
This fixes issues found by vale.

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

12
doc/qtcreator/src/user-interface/creator-file-system-view.qdoc
View File

@@ -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}).
*/

4
doc/qtcreator/src/user-interface/creator-open-documents-view.qdoc
View File

@@ -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

43
doc/qtcreator/src/user-interface/creator-projects-view.qdoc
View File

@@ -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
*/

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

@@ -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

17
doc/qtcreator/src/user-interface/creator-views.qdoc
View File

@@ -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}).
*/