doc: document qmlpreview

Change-Id: I6e526c8a6526a2b3da443c310dab6690db9d9b3f
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>

2 files changed, 68 insertions, 0 deletions

diff --git a/src/qml/doc/src/external-resources.qdoc b/src/qml/doc/src/external-resources.qdoc
index c120257247..123b564f92 100644
--- a/src/qml/doc/src/external-resources.qdoc
+++ b/src/qml/doc/src/external-resources.qdoc
@@ -37,6 +37,10 @@
     \title Qt Creator: QML Profiler
 */
 /*!
+    \externalpage https://doc.qt.io/qtcreator/creator-live-preview-desktop.html
+    \title Qt Creator: QML Preview On Desktop
+*/
+/*!
     \externalpage https://fontawesome.com/
     \title Font Awesome
 */
diff --git a/src/qml/doc/src/tools/qtqml-tooling-qmlpreview.qdoc b/src/qml/doc/src/tools/qtqml-tooling-qmlpreview.qdoc
index a76d30f543..5e9da3d2f4 100644
--- a/src/qml/doc/src/tools/qtqml-tooling-qmlpreview.qdoc
+++ b/src/qml/doc/src/tools/qtqml-tooling-qmlpreview.qdoc
@@ -7,4 +7,68 @@
 \brief Overview of the qmlpreview utility.
 \ingroup qtqml-tooling
 
+\section1 The Qml Preview
+The QML Preview tool watches QML and JavaScript files on disk and updates
+the application live with any changes. The application to be previewed
+has to have QML debugging enabled. \l {details}{More...}
+
+\table
+\header
+    \li Usage
+\row
+    \li qmlpreview [\l{options}] executable [parameters...]
+\endtable
+
+\section2 options
+
+\table
+\header
+    \li Option
+    \li Description
+\row
+    \li   --verbose
+    \li Print debugging output.
+\row
+    \li -h, --help
+    \li Displays help on commandline options.
+\row
+    \li --help-all
+    \li Displays help, including generic Qt options.
+\row
+    \li -v, --version
+    \li Displays version information.
+\endtable
+
+\section2 Arguments
+
+\table
+    \header
+        \li Argument
+        \li Description
+    \row
+        \li executable
+        \li The path of the executable file that loads a QML document.
+    \row
+        \li parameters
+        \li Arguments of the executable
+
+\endtable
+
+\section2 Details
+\target details
+
+\section3 Enable QML Debugging
+To enable QML debugging, make sure you build your application with appropriate
+configuration parameters. When using qmake, you should add \c {CONFIG+=qml_debug}
+in the \c {.pro} file. If you use another build system, then \c {QT_QML_DEBUG}
+variable should be defined.
+
+\badcode
+    qt_add_executable(MyApp
+    ...
+    )
+
+    target_compile_definitions(MyApp PRIVATE QT_QML_DEBUG)
+\endcode
+
 */