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

Doc: Restructure the beautifier topic

Browse Source 
Add a screenshot of general options.

Change-Id: I32ddc7a71449b1459930e74d65b034969870e5e7
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
This commit is contained in:
Leena Miettinen
2016-08-02 14:13:57 +02:00
parent 82c565e9d3
commit 443c3f93f3
3 changed files with 22 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/images/beautifier_options.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 8.2 KiB

After

Width:  |  Height:  |  Size: 9.4 KiB

BIN
doc/images/qt-creator-beautifier-options-general.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.2 KiB

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

@@ -76,8 +76,26 @@
\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 \li Select \uicontrol Tools > \uicontrol Options >
to specify settings for the tool you want to use. \uicontrol Beautifier to specify settings for beautifying files.
\li Select the \uicontrol {Enable auto format on file save} check box to
automatically beautify files when you save them using the tool you
select in the \uicontrol Tool field.
\image qt-creator-beautifier-options-general.png
\li In the \uicontrol {Restrict to MIME types} field, define the MIME
types of the files to beautify, separated by semicolons. Leave the
field empty to apply the tool on all files.
\li Select the \uicontrol {Restrict to files contained in the current
project} check box to only beautify files that belong to the
current project.
\li Select \uicontrol {Artistic Style}, \uicontrol {Clang Format}, or
\uicontrol Uncrustify to specify settings for the tool you want to
use.
\image beautifier_options.png \image beautifier_options.png
@@ -86,10 +104,6 @@
\uicontrol {Clang Format command}, or \uicontrol {Clang Format command}, or
\uicontrol {Uncrustify command} field. \uicontrol {Uncrustify command} field.
\li In the \uicontrol {Restrict to MIME types} field, define the MIME
types of the files to beautify, separated by semicolons. Leave the
field empty to apply the tool on all files.
\li In the \uicontrol Options group, select the configuration file that \li In the \uicontrol Options group, select the configuration file that
defines the style to use in the source files. If you select several defines the style to use in the source files. If you select several
options, they are applied from top down. options, they are applied from top down.
@@ -117,8 +131,8 @@
\endlist \endlist
\li Select \uicontrol Tools > \uicontrol Beautifier > \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Beautifier
\uicontrol {Artistic Style}, \uicontrol ClangFormat, or > \uicontrol {Artistic Style}, \uicontrol ClangFormat, or
\uicontrol Uncrustify > \uicontrol {Format Current File} to format \uicontrol Uncrustify > \uicontrol {Format Current File} to format
the currently open file. the currently open file.
@@ -133,21 +147,4 @@
file in this case when using Clang, select the file in this case when using Clang, select the
\uicontrol {Format entire file if no text was selected} check box in the \uicontrol {Format entire file if no text was selected} check box in the
\uicontrol {Clang Format} options. \uicontrol {Clang Format} options.
To automatically format files when they are saved, select \uicontrol Tools >
\uicontrol Beautifier > \uicontrol General:
\list 1
\li In the \uicontrol Tool field, select the tool for formatting.
\li In the \uicontrol {Restrict to MIME types} field, specify a
semicolon-separated list of MIME types. One of these types must
match the MIME type of the file that is auto formatted.
An empty list accepts all files.
\li Select the \uicontrol {Restrict to files contained in the current
project} check box to only auto format files in the current project.
\endlist
*/ */