diff --git a/doc/images/beautifier_editor.png b/doc/images/beautifier_editor.png new file mode 100755 index 00000000000..52dce630f96 Binary files /dev/null and b/doc/images/beautifier_editor.png differ diff --git a/doc/images/beautifier_options.png b/doc/images/beautifier_options.png new file mode 100644 index 00000000000..4c91dcc3373 Binary files /dev/null and b/doc/images/beautifier_options.png differ diff --git a/doc/src/editors/creator-beautifier.qdoc b/doc/src/editors/creator-beautifier.qdoc new file mode 100755 index 00000000000..7181381c38a --- /dev/null +++ b/doc/src/editors/creator-beautifier.qdoc @@ -0,0 +1,99 @@ +/**************************************************************************** +** +** Copyright (c) 2014 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of Qt Creator +** +** +** GNU Free Documentation License +** +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of this +** file. +** +** +****************************************************************************/ + +// ********************************************************************** +// NOTE: the sections are not ordered by their logical order to avoid +// reshuffling the file each time the index order changes (i.e., often). +// Run the fixnavi.pl script to adjust the links to the index order. +// ********************************************************************** + +/*! + \contentspage index.html + \previouspage creator-editor-refactoring.html + \page creator-beautifier.html + \nextpage creator-editor-options.html + + \title Beautifying Source Code + + You can use the experimental Beautifier plugin to format your source code + by using the following external tools: + + \list + + \li \l{http://astyle.sourceforge.net}{Artistic Style} + + \li \l{http://clang.llvm.org/docs/ClangFormat.html}{ClangFormat} + + \li \l{http://uncrustify.sourceforge.net}{Uncrustify} + + \endlist + + The Beautifier plugin parses the source code into component structures, such + as assignment statements, if blocks, loops, and so on, and formats them as + specified in the Beautifier options. You can use a predefined style or + define your own style. + + To use the Beautifier plugin: + + \list 1 + + \li Download and install the tool to use for formatting source code. + + \li Select \gui Help > \gui {About Plugins} > \gui {C++} > + \gui Beautifier to enable the plugin. + + \li Restart \QC to be able to use the plugin. + + \li Select \gui Tools > \gui Options > \gui Beautifier to specify + settings for the tool you want to use. The options you have depend + on the tool. + + \li Select \gui Tools > \gui Beautifier > \gui {Artistic Style}, + \gui ClangFormat or \gui Uncrustify > \gui {Format Current File} + to format the currently open file. + + You can \l{Keyboard Shortcuts}{create keyboard shortcuts} for the + functions. + + \endlist + + \section1 Specifying Styles + + Select \gui Tools > \gui Options > \gui Beautifier to set the configuration + file that defines the style to use in the source files. + + \image beautifier_options.png + + Select the \gui {Use file defined in project file} option to use the + configuration file defined in the qmake OTHER_FILES variable as the + configuration file for the selected tool. For example, \c{uncrustify.cfg}. + + Select the \gui {Use $HOME} option to use the specified file in the user's + home directory as the configuration file for the selected tool. For example, + \c{.uncrustify.cgf} or \c{uncrustify.cgf}. + + Select the \gui {Use self-defined Style} option, and then \gui Add to define + your own style. The \gui {Edit Configuration} dialog provides syntax + highlighting, auto-completion, and context-sensitive help. + + \image beautifier_editor.png + + By default, ClangFormat formats only the selected text. To format the entire + file when no text is selected, select the + \gui {Format entire file if no text was selected} check box. +*/ diff --git a/doc/src/editors/creator-coding.qdoc b/doc/src/editors/creator-coding.qdoc index 38ae2ec9067..f5cb4224a99 100644 --- a/doc/src/editors/creator-coding.qdoc +++ b/doc/src/editors/creator-coding.qdoc @@ -55,6 +55,12 @@ can easily find and rename symbols and apply predefined actions to refactor code. + \li \l{Beautifying Source Code} + + Beautifying code means applying indentation and style to source + code files. You can use the Artistic Style, ClangFormat, or + Uncrustify tool to format source files. + \li \l{Configuring the Editor} You can change the fonts, colors, highlighting, and indentation. diff --git a/doc/src/editors/creator-editors-options.qdoc b/doc/src/editors/creator-editors-options.qdoc index 5f4efba9581..ae08313a77d 100644 --- a/doc/src/editors/creator-editors-options.qdoc +++ b/doc/src/editors/creator-editors-options.qdoc @@ -24,7 +24,7 @@ /*! \contentspage index.html - \previouspage creator-editor-refactoring.html + \previouspage creator-beautifier.html \page creator-editor-options.html \nextpage creator-editor-options-text.html diff --git a/doc/src/editors/creator-editors.qdoc b/doc/src/editors/creator-editors.qdoc index bb5a8a5100e..da5a4e94af0 100644 --- a/doc/src/editors/creator-editors.qdoc +++ b/doc/src/editors/creator-editors.qdoc @@ -1430,7 +1430,7 @@ \contentspage index.html \previouspage creator-editor-locator.html \page creator-editor-refactoring.html - \nextpage creator-editor-options.html + \nextpage creator-beautifier.html \title Refactoring diff --git a/doc/src/qtcreator.qdoc b/doc/src/qtcreator.qdoc index 782d6dc7d38..107c32bb458 100644 --- a/doc/src/qtcreator.qdoc +++ b/doc/src/qtcreator.qdoc @@ -200,6 +200,7 @@ \li \l{Searching with the Locator} \endlist \li \l{Refactoring} + \li \l{Beautifying Source Code} \li \l{Configuring the Editor} \list \li \l{Specifying Text Editor Settings}