From 08f24666e122f220ad4b1d65b2feaa5f58648f1a Mon Sep 17 00:00:00 2001 From: Maximilian Goldstein Date: Thu, 14 May 2020 16:41:44 +0200 Subject: Document qmlformat Fixes: QTBUG-84218 Change-Id: I354737d839e8ebe498fbbe3d3777c0826987436e Reviewed-by: Paul Wicking --- .../doc/src/guidelines/qtquick-toolsnutilities.qdoc | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'src/quick/doc/src') 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} */ -- cgit v1.2.3