From c990c3c37f368c075f092086388159e42f3a3783 Mon Sep 17 00:00:00 2001
From: Tobias Hunger <tobias.hunger@theqtcompany.com>
Date: Thu, 18 Jun 2015 10:40:12 +0200
Subject: [PATCH] Doc: Reformatting
No text change
Change-Id: I95233f9fbb832e356781c2bbfe6350c7f95dd6b0
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
---
doc/src/editors/creator-coding-edit-mode.qdoc | 121 +++++++++---------
1 file changed, 62 insertions(+), 59 deletions(-)
diff --git a/doc/src/editors/creator-coding-edit-mode.qdoc b/doc/src/editors/creator-coding-edit-mode.qdoc
index 9e02fd6a4fd..6793f96cfd5 100644
--- a/doc/src/editors/creator-coding-edit-mode.qdoc
+++ b/doc/src/editors/creator-coding-edit-mode.qdoc
@@ -30,8 +30,8 @@
\title Working in Edit Mode
- This section describes how to use the \uicontrol Edit mode. For more information
- about using the sidebar, see \l{Browsing Project Contents}.
+ This section describes how to use the \uicontrol Edit mode. For more
+ information about using the sidebar, see \l{Browsing Project Contents}.
\section1 Using the Editor Toolbar
@@ -41,30 +41,30 @@
\image qtcreator-editortoolbar-symbols.png
- Use the toolbar to navigate between open files and symbols in use.
- To browse backward or forward through your location history, click
+ Use the toolbar to navigate between open files and symbols in use. To browse
+ backward or forward through your location history, click
\inlineimage qtcreator-back.png
(\uicontrol {Go Back}) and \inlineimage qtcreator-forward.png
(\uicontrol {Go Forward}).
- To go to any open file, select it from the \uicontrol{Open files} drop-down menu (1).
- Right-click the menu title and select \uicontrol {Copy Full Path} to
- copy the path and name of the current file to the clipboard.
+ To go to any open file, select it from the \uicontrol {Open files} drop-down
+ menu (1). Right-click the menu title and select \uicontrol {Copy Full Path}
+ to copy the path and name of the current file to the clipboard.
To jump to any symbol used in the current file, select it from the
- \uicontrol Symbols drop-down menu (2). By default, the symbols are displayed in the
- order in which they appear in the file. Right-click the menu title and
- select \uicontrol {Sort Alphabetically} to arrange the symbols in alphabetic
- order.
+ \uicontrol Symbols drop-down menu (2). By default, the symbols are displayed
+ in the order in which they appear in the file. Right-click the menu title
+ and select \uicontrol {Sort Alphabetically} to arrange the symbols in
+ alphabetic order.
To jump to a line and column in the current file, select the line and column
- indicator (3) or press \key {Ctrl+L} (or \key {Cmd+L} on OS X) to open
- the locator. Enter the line number and column number in the locator,
- separated by a colon (:).
+ indicator (3) or press \key {Ctrl+L} (or \key {Cmd+L} on OS X) to open the
+ locator. Enter the line number and column number in the locator, separated
+ by a colon (:).
To show the file encoding of the current file on the editor toolbar (4),
- select \uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor} > \uicontrol Display >
- \uicontrol {Display file encoding}.
+ select \uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor} >
+ \uicontrol Display > \uicontrol {Display file encoding}.
\note Other convenient ways of navigating in \QC are provided by the
\l{Searching with the Locator}{locator}, \l{Keyboard Shortcuts}
@@ -82,15 +82,16 @@
\list
\li To split the editor view into a top and bottom view, select
- \uicontrol Window > \uicontrol Split, press \key{Ctrl+E, 2}, or select the
- \inlineimage qtcreator-split-button.png
+ \uicontrol Window > \uicontrol Split, press \key {Ctrl+E, 2}, or
+ select the \inlineimage qtcreator-split-button.png
(\uicontrol Split) button and then select \uicontrol Split.
Split command creates views below the currently active editor view.
\li To split the editor view into adjacent views, select
- \uicontrol Window > \uicontrol{Split Side by Side}, press \key{Ctrl+E, 3}, or
- select \uicontrol {Split > Split Side by Side}.
+ \uicontrol Window > \uicontrol {Split Side by Side}, press
+ \key {Ctrl+E, 3}, or select \uicontrol Split >
+ \uicontrol {Split Side by Side}.
Side by side split command creates views to the right of the
currently active editor view.
@@ -104,16 +105,17 @@
\endlist
- To move between split views and detached editor windows, select \uicontrol Window
- > \uicontrol{Go to Next Split or Window} or press \key{Ctrl+E, O}.
+ To move between split views and detached editor windows, select
+ \uicontrol Window > \uicontrol {Go to Next Split or Window} or press
+ \key {Ctrl+E, O}.
To remove a split view, place the cursor within the view you want to
- remove and select \uicontrol Window > \uicontrol{Remove Current Split}, press
- \key{Ctrl+E, 0}, or select the
+ remove and select \uicontrol Window > \uicontrol {Remove Current Split},
+ press \key {Ctrl+E, 0}, or select the
\inlineimage qtcreator-remove-split-button.png
- (\uicontrol {Remove Split}) button. To remove all but the currently selected split
- view,
- select \uicontrol Window > \uicontrol{Remove All Splits} or press \key{Ctrl+E, 1}.
+ (\uicontrol {Remove Split}) button. To remove all but the currently selected
+ split view, select \uicontrol Window > \uicontrol {Remove All Splits} or
+ press \key {Ctrl+E, 1}.
\section1 Using Bookmarks
@@ -132,8 +134,8 @@
\image qtcreator-togglebookmark.png
To add a note to a bookmark, right-click the bookmark and select
- \uicontrol{Edit Bookmark}. To view the note, move the mouse pointer over the
- bookmark.
+ \uicontrol {Edit Bookmark}. To view the note, move the mouse pointer over
+ the bookmark.
To go to previous bookmark in the current session, press \key {Ctrl+,}.
@@ -142,40 +144,42 @@
\section1 Moving to Symbol Definition or Declaration
You can move directly to the definition or the declaration of a symbol by
- holding the \key Ctrl key and clicking the symbol. If you have multiple splits
- opened, you can open the link in the next split by holding \key Ctrl and
- \key Alt while clicking the symbol.
+ holding the \key Ctrl key and clicking the symbol. If you have multiple
+ splits opened, you can open the link in the next split by holding \key Ctrl
+ and \key Alt while clicking the symbol.
- To enable this moving function, select \uicontrol Tools > \uicontrol{Options} >
- \uicontrol{Text Editor} > \uicontrol Behavior > \uicontrol{Enable mouse navigation}.
+ To enable this moving function, select \uicontrol Tools >
+ \uicontrol Options > \uicontrol {Text Editor} > \uicontrol Behavior >
+ \uicontrol {Enable mouse navigation}.
You can also select the symbol and press \key F2, or right-click the symbol
- and select \uicontrol {Follow Symbol Under Cursor} to move to its definition or
- declaration. This feature is supported for namespaces, classes, functions,
- variables, include statements, and macros.
+ and select \uicontrol {Follow Symbol Under Cursor} to move to its definition
+ or declaration. This feature is supported for namespaces, classes,
+ functions, variables, include statements, and macros.
To switch between the definition and declaration of a function, place the
- cursor on either and press \key {Shift+F2} or right-click and select \uicontrol
- {Switch Between Function Declaration/Definition}. For example, this allows
- you to navigate from anywhere within a function body directly to the function
- declaration.
+ cursor on either and press \key {Shift+F2} or right-click and select
+ \uicontrol {Switch Between Function Declaration/Definition}. For example,
+ this allows you to navigate from anywhere within a function body directly to
+ the function declaration.
Links are opened in the same split by default. To open links in the next
- split, prepend \key {Ctrl+E} to the shortcut. For example, press \key {Ctrl+E,F2}
- to follow the symbol in the next split. If necessary, the view is
- automatically split. To change the default behavior, select \uicontrol Tools >
- \uicontrol{Options} > \uicontrol{Text Editor} > \uicontrol Display, and then select
- \uicontrol{Always Open Links in Next Split}. Additional symbols are displayed and
- switching between definition and declaration is done in another split.
- If you change the default behavior, the shortcuts for opening link targets
- in the next split are used to open them in the current split.
+ split, prepend \key {Ctrl+E} to the shortcut. For example, press
+ \key {Ctrl+E,F2} to follow the symbol in the next split. If necessary, the
+ view is automatically split. To change the default behavior, select
+ \uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor} >
+ \uicontrol Display, and then select
+ \uicontrol {Always Open Links in Next Split}. Additional symbols are
+ displayed and switching between definition and declaration is done in
+ another split. If you change the default behavior, the shortcuts for opening
+ link targets in the next split are used to open them in the current split.
\section1 Reparsing Externally Changed Files
If source files are modified from outside \QC, the opened files will be
- reparsed automatically. For all other files, you can use \uicontrol{Tools} >
- \uicontrol{C++} > \uicontrol{Reparse Externally Changed Files} to update the code
- model.
+ reparsed automatically. For all other files, you can use \uicontrol Tools >
+ \uicontrol {C++} > \uicontrol {Reparse Externally Changed Files} to update
+ the code model.
\section1 Inspecting the Code Model
@@ -185,14 +189,13 @@
inspection.
To view information about the C++ code model in the
- \uicontrol {C++ Code Model Inspector} dialog and write it to a log file, select
- \uicontrol Tools > \uicontrol C++ > \uicontrol {Inspect C++ Code Model} or press
- \key {Ctrl+Shift+F12}.
+ \uicontrol {C++ Code Model Inspector} dialog and write it to a log file,
+ select \uicontrol Tools > \uicontrol {C++} >
+ \uicontrol {Inspect C++ Code Model} or press \key {Ctrl+Shift+F12}.
\QC generates the code model inspection log file in a temporary folder.
- \QC underlines semantic errors in olive in the C++ code editor. To
- check the correct paths for includes that are not resolved or that are
- resolved to the wrong file, select \uicontrol {Project Parts} >
- \uicontrol {Include Paths}.
+ \QC underlines semantic errors in olive in the C++ code editor. To check the
+ correct paths for includes that are not resolved or that are resolved to the
+ wrong file, select \uicontrol {Project Parts} > \uicontrol {Include Paths}.
*/
--
GitLab