Doc: Describe the Preferred comment position option

...in Preferences > Text Editor > Behavior.

Updated screenshots.

Task-number: QTCREATORBUG-29392
Change-Id: If368d6e2e05c81b3b83007bad7636e275a0f3950
Reviewed-by: David Schulz <david.schulz@qt.io>
This commit is contained in:
Leena Miettinen
2023-11-01 16:02:58 +01:00
parent 68222e6fd3
commit 0b322ef178
9 changed files with 11 additions and 23 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

View File

@@ -49,7 +49,7 @@
the \uicontrol {Skip clean whitespace for file types} check box to the \uicontrol {Skip clean whitespace for file types} check box to
exclude the specified file types. exclude the specified file types.
\image qtcreator-options-text-editor-behavior.png {Text Editor Behavior preferences} \image qtcreator-preferences-texteditor-behavior.webp {Text Editor Behavior preferences}
\section1 Show whitespace in editor \section1 Show whitespace in editor

View File

@@ -25,15 +25,6 @@
The settings you specify apply globally to all projects. The settings you specify apply globally to all projects.
To specify editor behavior for an open project, select \uicontrol Projects >
\uicontrol Editor.
\image qtcreator-editor-settings.png "Editor settings"
\if defined(qtcreator)
For more information, see \l{Specify editor settings}.
\endif
You can also specify indentation settings separately for C++ and QML files You can also specify indentation settings separately for C++ and QML files
either globally or for the open project. For more information, see either globally or for the open project. For more information, see
\l{Indent text or code}. \l{Indent text or code}.
@@ -74,16 +65,7 @@
\endlist \endlist
\if defined(qtcreator) \if defined(qtcreator)
\section1 Related Topics \sa {Specify editor settings}, {Using FakeVim Mode}
\list
\li \l{Using FakeVim Mode}
Run the main editor in a manner similar to the Vim editor in the
FakeVim mode.
\endlist
\endif \endif
*/ */

View File

@@ -20,7 +20,7 @@
QML code (such as Python code files), select \preferences > QML code (such as Python code files), select \preferences >
\uicontrol {Text Editor} > \uicontrol Behavior. \uicontrol {Text Editor} > \uicontrol Behavior.
\image qtcreator-indentation.png {Text Editor Behavior preferences} \image qtcreator-preferences-texteditor-behavior.webp {Text Editor Behavior preferences}
You can specify how to interpret the \key Tab and \key Backspace key You can specify how to interpret the \key Tab and \key Backspace key
presses and how to align continuation lines. presses and how to align continuation lines.
@@ -87,6 +87,12 @@
Your highlight definition file can have definitions for both multi and Your highlight definition file can have definitions for both multi and
single line comments. To apply the single line comment definition when single line comments. To apply the single line comment definition when
commenting out a selection, select \uicontrol {Prefer single line comments}. commenting out a selection, select \uicontrol {Prefer single line comments}.
In \uicontrol {Preferred comment position}, select \uicontrol Automatic to
let the highlight definition for the file determine the position of single
line comments. If no highlight definition is available, the comments are
placed after leading whitespace. Select \uicontrol {After Whitespace} to
always place them there. Select \uicontrol {At Line Start} to place single
line comments at the end of the line.
\if defined(qtcreator) \if defined(qtcreator)
\sa {Find preferences}, {C++ Code Style}, {Nim} \sa {Find preferences}, {C++ Code Style}, {Nim}

View File

@@ -124,5 +124,5 @@
> \uicontrol {Text Editor} > \uicontrol Behavior > > \uicontrol {Text Editor} > \uicontrol Behavior >
\uicontrol {Enable smart selection changing}. \uicontrol {Enable smart selection changing}.
\image qtcreator-options-text-editor-behavior.png "Text Editor Behavior preferences" \image qtcreator-preferences-texteditor-behavior.webp "Text Editor Behavior preferences"
*/ */

View File

@@ -32,7 +32,7 @@
\endlist \endlist
\image qtcreator-editor-settings.png "Editor view" \image qtcreator-editor-settings.webp {Editor settings for a project}
Click \uicontrol {Restore Global} to revert to the global settings. Click \uicontrol {Restore Global} to revert to the global settings.