diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2016-08-02 14:13:57 +0200 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2016-08-02 15:11:20 +0000 |
commit | 443c3f93f3cbad3427b2f96bce1e06f545a1af89 (patch) | |
tree | 4e077ec3b1b10051c0f87158ce1fd6febaca8ac0 | |
parent | 82c565e9d31e86a61c47515548ad469bb9cfb476 (diff) | |
download | qt-creator-443c3f93f3cbad3427b2f96bce1e06f545a1af89.tar.gz |
Doc: Restructure the beautifier topic
Add a screenshot of general options.
Change-Id: I32ddc7a71449b1459930e74d65b034969870e5e7
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
-rw-r--r-- | doc/images/beautifier_options.png | bin | 8354 -> 9586 bytes | |||
-rw-r--r-- | doc/images/qt-creator-beautifier-options-general.png | bin | 0 -> 6397 bytes | |||
-rw-r--r-- | doc/src/editors/creator-beautifier.qdoc | 47 |
3 files changed, 22 insertions, 25 deletions
diff --git a/doc/images/beautifier_options.png b/doc/images/beautifier_options.png Binary files differindex a6a7767ba8..23152694ae 100644 --- a/doc/images/beautifier_options.png +++ b/doc/images/beautifier_options.png diff --git a/doc/images/qt-creator-beautifier-options-general.png b/doc/images/qt-creator-beautifier-options-general.png Binary files differnew file mode 100644 index 0000000000..3f476be156 --- /dev/null +++ b/doc/images/qt-creator-beautifier-options-general.png diff --git a/doc/src/editors/creator-beautifier.qdoc b/doc/src/editors/creator-beautifier.qdoc index 76c3d18d21..1ac074ce24 100644 --- a/doc/src/editors/creator-beautifier.qdoc +++ b/doc/src/editors/creator-beautifier.qdoc @@ -76,8 +76,26 @@ \li Restart \QC to be able to use the plugin. - \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Beautifier - to specify settings for the tool you want to use. + \li Select \uicontrol Tools > \uicontrol Options > + \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 @@ -86,10 +104,6 @@ \uicontrol {Clang Format command}, or \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 defines the style to use in the source files. If you select several options, they are applied from top down. @@ -117,8 +131,8 @@ \endlist - \li Select \uicontrol Tools > \uicontrol Beautifier > - \uicontrol {Artistic Style}, \uicontrol ClangFormat, or + \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Beautifier + > \uicontrol {Artistic Style}, \uicontrol ClangFormat, or \uicontrol Uncrustify > \uicontrol {Format Current File} to format the currently open file. @@ -133,21 +147,4 @@ file in this case when using Clang, select the \uicontrol {Format entire file if no text was selected} check box in the \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 */ |