diff options
| author | Maximilian Goldstein <max.goldstein@qt.io> | 2020-05-14 16:41:44 +0200 |
|---|---|---|
| committer | Maximilian Goldstein <max.goldstein@qt.io> | 2020-05-15 12:48:53 +0200 |
| commit | 08f24666e122f220ad4b1d65b2feaa5f58648f1a (patch) | |
| tree | be388500a8aca18bb8fa797c33cf01aae8d3e78a /src/quick/doc | |
| parent | bd221dfcb3126140071ceeb8f337cdacbe05a62e (diff) | |
Document qmlformat
Fixes: QTBUG-84218
Change-Id: I354737d839e8ebe498fbbe3d3777c0826987436e
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/quick/doc')
| -rw-r--r-- | src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc b/src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc index 36c8eae4cb..e3353ef077 100644 --- a/src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc +++ b/src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc @@ -133,4 +133,20 @@ via the -I flag. \li \l{qmltypes} \endlist +\section1 qmlformat + +qmlformat is a tool that automatically formats QML files in accordance +with the \l{QML Coding Conventions}. + +The tool groups all properties, functions, and signals together, instead of +retaining the order you specified. + +Imports will also be sorted in alphabetical order. This can be disabled +by specifying the \c{-n} flag. + +By default, qmlformat writes the formatted version of the file to stdout. +If you wish to have your file updated in-place specify the \c{-i} flag. + +\section2 Related Information +\sa \l{QML Coding Conventions} */ |