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

Doc: Fix style for menu hierarchies

Browse Source 
Use \uicontrol for the individual components individually

Change-Id: Idf62db7c37e94a55a988792f13aaa8c49cb1ac07
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
Eike Ziller
2020-04-02 11:46:41 +02:00
parent 7f958700a0
commit 708f84cce8
26 changed files with 100 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/qtcreator/src/analyze/creator-analyze.qdoc
View File

@@ -45,8 +45,9 @@
You can drag and drop the views in the \uicontrol Debug mode to new
positions on the screen. The size and position of views are saved for future
sessions. Select \uicontrol {Window > Views > Reset to Default Layout} to
reset the views to their original sizes and positions.
sessions. Select \uicontrol Window > \uicontrol Views >
\uicontrol {Reset to Default Layout} to reset the views to their original
sizes and positions.
You can use the following code analysis tools in the \uicontrol Debug
mode:

7
doc/qtcreator/src/analyze/creator-valgrind-overview.qdoc
View File

@@ -59,9 +59,9 @@
For more information about analyzing applications for which you do not have
a project, see \l{Running Valgrind Tools on External Applications}.
To select options for the Valgrind tools, select \uicontrol {Tools > Options >
Analyzer}. You can override the general settings for each project in the
\uicontrol {Run Settings} for the project.
To select options for the Valgrind tools, select \uicontrol Tools >
\uicontrol Options > \uicontrol Analyzer. You can override the general
settings for each project in the \uicontrol {Run Settings} for the project.
The following sections describe how to use the Valgrind tools:
@@ -74,4 +74,3 @@
\endlist
*/

12
doc/qtcreator/src/analyze/creator-valgrind.qdoc
View File

@@ -93,8 +93,9 @@
Stack traces can get quite large and confusing, and therefore, reading them
from the bottom up can help. If the stack trace is not big enough or it is
too big, select \uicontrol {Tools > Options > Analyzer} and define the
length of the stack trace in the \uicontrol {Backtrace frame count} field.
too big, select \uicontrol Tools > \uicontrol Options > \uicontrol Analyzer
and define the length of the stack trace in the
\uicontrol {Backtrace frame count} field.
\image qtcreator-valgrind-memcheck-options.png "Memory Analysis options"
@@ -138,7 +139,6 @@
*/
/*!
\contentspage index.html
\previouspage creator-analyzer.html
@@ -221,8 +221,9 @@
separately for each project in the \l{Specifying Run Settings}{run settings}
of the project.
To specify settings for Valgrind, select \uicontrol {Tools > Options >
Analyzer}. The \uicontrol {Profiling Options} group contains Callgrind options.
To specify settings for Valgrind, select \uicontrol Tools >
\uicontrol Options > \uicontrol Analyzer. The \uicontrol {Profiling Options}
group contains Callgrind options.
\image qtcreator-valgrind-callgrind-options.png "Valgrind options"
@@ -269,7 +270,6 @@
*/
/*!
\contentspage index.html
\previouspage creator-cache-profiler.html

7
doc/qtcreator/src/debugger/qtquick-debugging.qdoc
View File

@@ -79,8 +79,8 @@
the \uicontrol {Enable QML} check box to enable
QML debugging.
\li Select \uicontrol {Build > Rebuild Project} to clean and rebuild the
project.
\li Select \uicontrol Build > \uicontrol {Rebuild Project} to clean and
rebuild the project.
\li To debug applications on \l{glossary-device}{devices}, check that
Qt 5.0, or later, libraries are installed on the device and
@@ -144,7 +144,8 @@
the application from running until the debug client connects to the
server. This enables debugging from the start.
\li Select \uicontrol {Debug > Start Debugging > Attach to QML Port}.
\li Select \uicontrol Debug > \uicontrol {Start Debugging} >
\uicontrol {Attach to QML Port}.
Choose the kit configured for the device where the application to
be debugged is running. The port number to use is displayed in the

3
doc/qtcreator/src/editors/creator-editors-options-text.qdoc
View File

@@ -42,7 +42,8 @@
\title Specifying Text Editor Settings
Set the font preferences and apply color schemes for syntax highlighting in
\uicontrol {Tools > Options > Text Editor > Font & Colors}.
\uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor} >
\uicontrol {Font & Colors}.
\image qtcreator-font-colors.png "Text editor options"

3
doc/qtcreator/src/editors/creator-only/creator-mime-types.qdoc
View File

@@ -69,7 +69,8 @@
\list 1
\li Select \uicontrol {Tools > Options > Environment > MIME Types}.
\li Select \uicontrol Tools > \uicontrol Options >
\uicontrol Environment > \uicontrol {MIME Types}.
\image qtcreator-mime-types.png "MIME Types"

12
doc/qtcreator/src/howto/creator-external-tools.qdoc
View File

@@ -70,8 +70,8 @@
\uicontrol Linguist > \uicontrol {Release Translations (lrelease)}.
By default, the project .pro file is passed to the tools as an argument. To
specify other command line arguments for the tools, select \uicontrol {Tools >
External > Configure}.
specify other command line arguments for the tools, select \uicontrol Tools >
\uicontrol External > \uicontrol Configure}.
To open TS files in Qt Linguist, right-click a TS file in the
\uicontrol Projects or \uicontrol {File System} view and select
@@ -111,9 +111,10 @@
\list 1
\li Select \uicontrol {Tools > External > Configure}.
\li Select \uicontrol Tools > \uicontrol External >
\uicontrol Configure.
\li Select \uicontrol {Add > Add Tool}
\li Select \uicontrol Add > \uicontrol {Add Tool}
to add a new tool. You can also select \uicontrol {Add Category} to add a
new category.
@@ -163,7 +164,8 @@
\endlist
The category and tool are added to the \uicontrol {Tools > External} menu.
The category and tool are added to the \uicontrol Tools >
\uicontrol External menu.
If you change the configuration of preconfigured tools, you can later
revert the changes by selecting the \uicontrol Reset button.

13
doc/qtcreator/src/howto/creator-help.qdoc
View File

@@ -78,11 +78,11 @@
\section1 Viewing Function Tooltips
To hide function tooltips by default, select \uicontrol {Tools > Options >
Text Editor > Behavior > Show help tooltips using the mouse >
On Shift+Mouseover}. You
can still view the tooltips by pressing and holding down the \key Shift
key.
To hide function tooltips by default, select \uicontrol Tools >
\uicontrol Options > \uicontrol {Text Editor} > \uicontrol Behavior >
\uicontrol {Show help tooltips using the mouse} >
\uicontrol {On Shift+Mouseover}. You can still view the tooltips by pressing
and holding down the \key Shift key.
To use a keyboard shortcut for viewing help tooltips, select
\uicontrol {Show help tooltips using keyboard shortcut (Alt)}.
@@ -256,7 +256,8 @@
\list 1
\li Select \uicontrol {Tools > Options > Help > Filters > Add}.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Help >
\uicontrol Filters > \uicontrol Add.
\li Enter a name for the filter and press \uicontrol {OK}.

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

@@ -50,8 +50,8 @@
To view all functions available in \QC and the keyboard shortcuts defined
for them, select
\uicontrol {Tools > Options > Environment > Keyboard}. The shortcuts are listed by
category. To find a keyboard
\uicontrol Tools > \uicontrol Options > \uicontrol Environment >
\uicontrol Keyboard. The shortcuts are listed by category. To find a keyboard
shortcut in the list, enter a function name or shortcut in the \uicontrol Filter
field.

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

@@ -255,7 +255,8 @@
create your own locator filters. That way you can locate files in a
directory structure you have defined.
To create locator filters, select \uicontrol {Tools > Options > Locator > Add}.
To create locator filters, select \uicontrol Tools > \uicontrol Options >
\uicontrol Locator > \uicontrol Add.
For more information, see \l{Creating Locator Filters}.
@@ -275,9 +276,9 @@
\section1 Add a license header template for C++ code
A file containing a license header for C++ can be specified under
\uicontrol{Tools > Options > C++ > License Template}. It may contain special
placeholders enclosed in \c{%%} that are replaced when generating a
new file:
\uicontrol Tools > \uicontrol Options > \uicontrol C++ >
\uicontrol {License Template}. It may contain special placeholders enclosed
in \c{%%} that are replaced when generating a new file:
\list 1

3
doc/qtcreator/src/howto/creator-only/creator-sessions.qdoc
View File

@@ -39,7 +39,8 @@
When you exit \QC, a snapshot of your current workspace is stored as a
\e session. To restore the session automatically when you start \QC,
select \uicontrol {File > Sessions > Manage > Restore last session on startup}.
select \uicontrol File > \uicontrol Sessions > \uicontrol Manage >
\uicontrol {Restore last session on startup}.
When you open or create any of the following items, they automatically
become a part of the session:

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

@@ -55,9 +55,9 @@
compiler. What should I do?}
Make sure that the application is in your system PATH when starting \QC.
Also select \uicontrol {Tools > Options} to check the settings specified
for the application. Many plugins specify either the path to the tool they
need or the environment they run in.
Also select \uicontrol Tools > \uicontrol Options to check the settings
specified for the application. Many plugins specify either the path to the
tool they need or the environment they run in.
This is especially relevant for the \macos where \c {/usr/local/bin} might
not be in the path when \QC is started.
@@ -66,9 +66,10 @@
\QC has been localized into several languages. If the system
language is one of the supported languages, it is automatically selected.
To change the language, select \uicontrol {Tools > Options > Environment} and
select a language in the \uicontrol Language field. Select
\uicontrol {Restart Now} to restart \QC and have the change take effect.
To change the language, select \uicontrol Tools > \uicontrol Options >
\uicontrol Environment and select a language in the \uicontrol Language
field. Select \uicontrol {Restart Now} to restart \QC and have the change
take effect.
\b {Has a reported issue been addressed?}
@@ -172,8 +173,9 @@
\uicontrol Help mode.
To view the documentation that is available and to add documentation,
select \uicontrol {Tools > Options > Help > Documentation}. For more
information, see \l{Adding External Documentation}.
select \uicontrol Tools > \uicontrol Options > \uicontrol Help >
\uicontrol Documentation. For more information, see
\l{Adding External Documentation}.
\section1 Debugger Questions
@@ -195,10 +197,11 @@
\b {How do I generate a core file in \QC?}
To trigger the GDB command that generates a core file while debugging,
select \uicontrol {Window > Views > Debugger Log}. In the \uicontrol Command field,
type \c gcore and press \key Enter. The core file is created in the
current working directory. You can specify another location for the file,
including a relative or absolute path, as an argument of the command.
select \uicontrol Window > \uicontrol Views > \uicontrol {Debugger Log}.
In the \uicontrol Command field, type \c gcore and press \key Enter. The
core file is created in the current working directory. You can specify
another location for the file, including a relative or absolute path, as an
argument of the command.
\omit
To generate a temporary core file, select \uicontrol {Create Snapshot} in the
@@ -272,8 +275,8 @@
type of application, \c qDebug() and related functions use standard output
and error output.
We recommend that you select \uicontrol {Projects > Run Settings > Run in
terminal} for console applications.
We recommend that you select \uicontrol Projects > \uicontrol {Run Settings} >
\uicontrol {Run in terminal} for console applications.
For GUI applications, \c qDebug() and related functions use the Windows API
function \c OutputDebugString(). The output is displayed in the

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

@@ -386,7 +386,7 @@
\else
\l{Using Git}{Version Control}
\endif
panes, select \uicontrol {Window > Output Panes}.
panes, select \uicontrol Window > \uicontrol {Output Panes}.
\if defined(qtcreator)
To display the \uicontrol {To-Do Entries} pane, enable the Todo plugin.
\endif

3
doc/qtcreator/src/howto/creator-views.qdoc
View File

@@ -120,7 +120,8 @@
(\uicontrol {Filter Tree}) and select \uicontrol{Simplify Tree}.
\li To hide source files which are automatically generated by the build
system, select \uicontrol {Filter Tree > Hide Generated Files}.
system, select \uicontrol {Filter Tree} >
\uicontrol {Hide Generated Files}.
\li To hide source files which are not enabled for the current target,
select \uicontrol {Filter Tree} > \uicontrol {Hide Disabled Files}.

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

@@ -60,7 +60,8 @@
\image qtcreator-kit-selector.png "Kit selector"
\li Choose \uicontrol {Build > Build Project} or press \key {Ctrl+B}.
\li Choose \uicontrol Build > \uicontrol {Build Project} or press
\key {Ctrl+B}.
You can also select the \uicontrol Run button (2) to also deploy and run
the application after building it.

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

@@ -480,8 +480,9 @@
subproject in the \uicontrol{Project Management} dialog. However, the root project
must specify that qmake uses the \c subdirs template to build the project.
To create a root project, select \uicontrol {File > New File or Project >
Other Project > Subdirs Project > Choose}.
To create a root project, select \uicontrol File >
\uicontrol {New File or Project} > \uicontrol {Other Project} >
\uicontrol {Subdirs Project} > \uicontrol Choose.
On the \uicontrol Summary page, select \uicontrol {Finish & Add Subproject} to create
the root project and to add another project, such as a C++ library.

3
doc/qtcreator/src/projects/creator-only/creator-projects-libraries.qdoc
View File

@@ -124,7 +124,8 @@
\li In the \uicontrol Projects view, right-click the project name to open the
context menu and select
\uicontrol {Add Library > Internal Library > Next}.
\uicontrol {Add Library} > \uicontrol {Internal Library} >
\uicontrol Next.
\li In the \uicontrol Library field, select \b mylib and click \uicontrol Next.

4
doc/qtcreator/src/projects/creator-only/creator-projects-settings-build.qdoc
View File

@@ -164,8 +164,8 @@
\section2 Adding Custom Build Steps
To add custom steps to the build settings, select \uicontrol {Add Build Step >
Custom Process Step}.
To add custom steps to the build settings, select
\uicontrol {Add Build Step} > \uicontrol {Custom Process Step}.
By default, custom steps are enabled. To disable a custom step, select
the \inlineimage buildstepdisable.png

2
doc/qtcreator/src/projects/creator-only/creator-projects-settings-code-style.qdoc
View File

@@ -59,7 +59,7 @@
\image qtcreator-code-style-clang-format.png "Clang Format Code Style settings in Projects mode"
To specify global code style settings sets for C++ files, select
\uicontrol {Tools > Options > C++}.
\uicontrol Tools > \uicontrol Options > \uicontrol C++.
To specify global code style settings sets for QML files, select \uicontrol {Tools
> Options > Qt Quick}.

4
doc/qtcreator/src/projects/creator-only/creator-projects-settings-editor.qdoc
View File

@@ -43,8 +43,8 @@
You can configure the text editor according to your needs. You can specify
editor behavior either globally for all projects or separately for each
project. To specify global editor behavior, select \uicontrol {Tools > Options
> Text Editor > Behavior}.
project. To specify global editor behavior, select \uicontrol Tools >
\uicontrol Options > \uicontrol {Text Editor} > \uicontrol Behavior.
To configure the text editor behavior for the current project:

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

@@ -29,7 +29,6 @@
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage{index.html}{Qt Creator}
\page index.html
@@ -132,7 +131,7 @@
\row
\li {4,1} \note To report bugs and suggestions to the
\l{https://bugreports.qt.io/}{Qt Project Bug Tracker},
select \uicontrol {Help > Report Bug}.
select \uicontrol Help > \uicontrol {Report Bug}.
To copy and paste detailed information about your system to the
bug report, select \uicontrol Help >
\uicontrol {System Information}.

10
doc/qtcreator/src/qtquick/qtquick-profiler.qdoc
View File

@@ -99,8 +99,8 @@
\note To profile applications on \l{glossary-device}{devices}, you
must install Qt 4.7.4 or later libraries on them.
\li Select \uicontrol {Analyze > QML Profiler} to profile the current
application.
\li Select \uicontrol Analyze > \uicontrol {QML Profiler} to profile the
current application.
\li Select the
\inlineimage qtcreator-analyze-start-button.png
@@ -169,9 +169,9 @@
\section1 Attaching to Running Qt Quick Applications
To profile Qt Quick applications that are not launched by \QC, select
\uicontrol {Analyze > QML Profiler (External)}. You must enable QML debugging and profiling for
the application in the project build settings. For more information, see
\l{Setting Up QML Debugging}.
\uicontrol Analyze > \uicontrol {QML Profiler (External)}. You must enable
QML debugging and profiling for the application in the project build
settings. For more information, see \l{Setting Up QML Debugging}.
In the \uicontrol {QML Profiler} dialog, \uicontrol Port field, specify the port to
listen to.

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

@@ -97,10 +97,10 @@
You can also select \uicontrol Tools and then select \uicontrol {Create Repository}
in the submenu for the version control system.
To import a project that is under version control, choose \uicontrol {File >
New File or Project > Project from Version Control} and select the
version control system that you use. Follow the instructions of the
wizard to import the project.
To import a project that is under version control, choose \uicontrol File >
\uicontrol {New File or Project} > \uicontrol {Project from Version Control}
and select the version control system that you use. Follow the instructions
of the wizard to import the project.
\section1 Using Common Functions
@@ -121,8 +121,8 @@
\endlist
The \uicontrol{Version Control} output pane displays the commands that are
executed, a timestamp, and the relevant output. Select \uicontrol {Window > Output
Panes > Version Control} to open the pane.
executed, a timestamp, and the relevant output. Select \uicontrol Window >
\uicontrol {Output Panes} > \uicontrol {Version Control} to open the pane.
\image qtcreator-vcs-pane.png

18
doc/qtcreator/src/widgets/qtdesigner-app-tutorial.qdoc
View File

@@ -48,8 +48,9 @@
\list 1
\li Select \uicontrol{File > New File or Project > Application > Qt Widgets
Application > Choose}.
\li Select \uicontrol File > \uicontrol {New File or Project} >
\uicontrol Application > \uicontrol {Qt Widgets Application} >
\uicontrol Choose.
\image qtcreator-new-qt-gui-application.png "New File or Project dialog"
@@ -190,8 +191,8 @@
\li Right-click the \uicontrol Find button to open a context-menu.
\li Select \uicontrol {Go to Slot > clicked()}, and then select
\uicontrol OK.
\li Select \uicontrol {Go to Slot} > \uicontrol {clicked()}, and
then select \uicontrol OK.
A private slot, \c{on_findButton_clicked()}, is added to the
header file, textfinder.h and a private function,
@@ -282,8 +283,8 @@
\list 1
\li Select \uicontrol{File > New File or Project > Qt > Qt Resource File >
Choose}.
\li Select \uicontrol File > \uicontrol {New File or Project} >
\uicontrol Qt > \uicontrol {Qt Resource File} > \uicontrol Choose.
\image qtcreator-add-resource-wizard.png "New File or Project dialog"
@@ -305,12 +306,13 @@
and click \uicontrol{Finish} or \uicontrol Done to open the file in the code
editor.
\li Select \uicontrol{Add > Add Prefix}.
\li Select \uicontrol Add > \uicontrol {Add Prefix}.
\li In the \uicontrol{Prefix} field, replace the default prefix with a slash
(/).
\li Select \uicontrol{Add > Add Files}, to locate and add input.txt.
\li Select \uicontrol Add > \uicontrol {Add Files}, to locate and add
input.txt.
\image qtcreator-add-resource.png "Editing resource files"

4
doc/qtcreator/src/widgets/qtdesigner-plugins.qdoc
View File

@@ -141,8 +141,8 @@
building applications is configured and built to use the MinGW/g++ compiler.
Plugins built by using this version of Qt cannot be loaded by \QC because
the build-keys do not match. The plugins can only be used in the standalone
version of \QD. Choose \uicontrol{Help > About \QC} to check the Qt version \QC
was built with.
version of \QD. Choose \uicontrol Help > \uicontrol {About \QC} to check the
Qt version \QC was built with.
To use \QD plugins that were built for the shipped Qt version, make sure
that \QC is built with the same compiler by either recompiling \QC using

2
doc/qtcreatordev/src/external-tool-spec.qdoc
View File

@@ -30,7 +30,7 @@
\title External Tool Specification Files
An external tool specification file describes a tool that can be run from
the \uicontrol { Tools > External } menu.
the \uicontrol Tools > \uicontrol External menu.
It specifies the name of the tool, the executable to run, optional
arguments, and how to handle the output from the tool.