qiurui
/
qtdeclarative
mirror of https://github.com/qt/qtdeclarative.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Doc: Update qmlformat description 

The behavior of qmlformat has changed. Update the documentation to
reflect it.

Pick-to: 6.5
Fixes: QTBUG-107213
Change-Id: I7a53ad7b62edce0f078782dbef340236d20c9781
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
This commit is contained in:
Ulf Hermann 2023-01-30 13:41:39 +01:00
parent b04776e82e
commit 506c74d782
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc
View File

@ -79,17 +79,20 @@ flag for doing so by passing \c{--help} on the command line.
\e qmlformat is a tool that automatically formats QML files in accordance \e qmlformat is a tool that automatically formats QML files in accordance
with the \l{QML Coding Conventions}. with the \l{QML Coding Conventions}.
The tool groups all properties, functions, and signals together, instead of If you pass the \c{-n} or \c{--normalize} flag, \e qmlformat groups all
retaining the order you specified. 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. 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. If you wish to have your file updated in-place specify the \c{-i} flag.
You may also change tab widths and line ending types among other settings, You may also change tab widths and line ending types among other settings,
either via command line options or by using a settings file. either via command line options or by using a settings file called
\c{.qmlformat.ini}. A default settings file can be obtained by passing the
\c{--write-defaults} flag.
As with all tools, the \c{-h} or \c{--help} flag will print some information on
all the available options.
\section1 Qt Quick Compiler \section1 Qt Quick Compiler