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

Doc: Reformatting

Browse Source 
No text change.

Change-Id: Ie030930637bf25d181a9f95030aa91a50348912f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
This commit is contained in:
Tobias Hunger
2015-06-18 10:25:10 +02:00
parent 3be0745a65
commit 6f34b2f68e
1 changed files with 25 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
doc/src/editors/creator-beautifier.qdoc
View File

@@ -69,13 +69,14 @@
\li Restart \QC to be able to use the plugin. \li Restart \QC to be able to use the plugin.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Beautifier to specify \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Beautifier
settings for the tool you want to use. to specify settings for the tool you want to use.
\image beautifier_options.png \image beautifier_options.png
\li In the \uicontrol {Artistic Style command}, \uicontrol {Clang Format command}, \li In the \uicontrol {Artistic Style command},
or \uicontrol {Uncrustify command} field, specify the path to the tool \uicontrol {Clang Format command}, or
\uicontrol {Uncrustify command} field, specify the path to the tool
executable. executable.
\li In the \uicontrol Options group, select the configuration file that \li In the \uicontrol Options group, select the configuration file that
@@ -84,39 +85,40 @@
\list \list
\li Select the \uicontrol {Use file defined in project files} option \li Select the \uicontrol {Use file defined in project files}
to use the configuration file defined in the qmake option to use the configuration file defined in the qmake
DISTFILES variable as the configuration file for the DISTFILES variable as the configuration file for the
selected tool. selected tool.
\li Select the \uicontrol {Use $HOME} option to use the specified file \li Select the \uicontrol {Use $HOME} option to use the
in the user's home directory as the configuration file for specified file in the user's home directory as the
the selected tool. configuration file for the selected tool.
\li Select the \uicontrol {Use customized style} option, and then \li Select the \uicontrol {Use customized style} option, and
\uicontrol Add to define your own style. then \uicontrol Add to define your own style.
Define code formatting in the \uicontrol {Edit Configuration} Define code formatting in the
dialog. It provides syntax highlighting, auto-completion, \uicontrol {Edit Configuration} dialog. It provides syntax
and context-sensitive help. For these features, you must highlighting, auto-completion, and context-sensitive help.
have the tool installed. For these features, you must have the tool installed.
\image beautifier_editor.png \image beautifier_editor.png
\endlist \endlist
\li Select \uicontrol Tools > \uicontrol Beautifier > \uicontrol {Artistic Style}, \li Select \uicontrol Tools > \uicontrol Beautifier >
\uicontrol ClangFormat, or \uicontrol Uncrustify > \uicontrol {Format Current File} \uicontrol {Artistic Style}, \uicontrol ClangFormat, or
to format the currently open file. \uicontrol Uncrustify > \uicontrol {Format Current File} to format
the currently open file.
You can \l{Keyboard Shortcuts}{create keyboard shortcuts} for the You can \l{Keyboard Shortcuts}{create keyboard shortcuts} for the
functions. functions.
\endlist \endlist
In addition to the \uicontrol {Format Current File} command, ClangFormat provides In addition to the \uicontrol {Format Current File} command, ClangFormat
the \uicontrol {Format Selected Text} command. If you select it when no text is provides the \uicontrol {Format Selected Text} command. If you select it
selected, nothing happens. To format the entire file in this case, select when no text is selected, nothing happens. To format the entire file in this
the \uicontrol {Format entire file if no text was selected} check box in the case, select the \uicontrol {Format entire file if no text was selected}
\uicontrol {Clang Format} options. check box in the \uicontrol {Clang Format} options.
*/ */