aboutsummaryrefslogtreecommitdiffstats
path: root/doc/qtcreator/src/projects/creator-only/creator-projects-settings-code-style.qdoc
blob: 67d8859490ec79d54e54ec95c4227fad032bea8e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** 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. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/

// **********************************************************************
// 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.
// **********************************************************************

/*!
    \previouspage creator-editor-settings.html
    \page creator-code-style-settings.html
    \nextpage creator-build-dependencies.html

    \title Specifying Code Style Settings

    \QC uses the \l{Editing MIME Types}{MIME type} of the file to
    determine which mode and editor to use for opening the file.
    \QC opens C++ files in \uicontrol Edit mode in the C++ code editor and
    QML files in the Qt Quick editor.

    You can configure the code style according to your needs. You can specify
    code style either globally for all projects or separately for each
    project. You can specify several sets of code style settings and easily
    switch between them. In addition, you can import and export code style
    settings.

    \image qtcreator-projects-code-style.png "Code Style settings in Projects mode"

    Alternatively, you can enable the Clang Format plugin to enforce
    the code style specified in a \c {.clang-format} file. It uses the
    \l{https://clang.llvm.org/docs/LibFormat.html}{LibFormat} library for
    automatic code formatting and indentation. For more information, see
    \l {Automatic Formatting and Indentation}.

    \image qtcreator-code-style-clang-format.png "Clang Format Code Style settings in Projects mode"

    To specify global code style settings sets for C++ files, select
    \uicontrol Tools > \uicontrol Options > \uicontrol C++.

    To specify global code style settings sets for QML files, select \uicontrol {Tools
    > Options > Qt Quick}.

    To configure the editor behavior for the current project:

    \list 1

        \li Select \uicontrol Projects > \uicontrol {Project Settings} >
            \uicontrol {Code Style}.

        \li In the \uicontrol Language field, select \uicontrol C++,
            \uicontrol {Qt Quick}, or \uicontrol Nim.

        \li In the \uicontrol {Current settings} field, select the settings to modify
            and click \uicontrol Copy.

        \li Give a name to the settings and click \uicontrol OK.

        \li Click \uicontrol Edit to specify code style settings for the project.

            \image qtcreator-code-style-settings-edit-cpp.png "Edit Code Style Settings dialog"

            \note Only \uicontrol General settings are available for QML files.

            \image qtcreator-code-style-settings-edit-qtquick.png "Edit Code Style Settings view"

    \endlist

    For more information about the settings, see \l{Indenting Text or Code}.

*/