aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoerg Bornemann <joerg.bornemann@qt.io>2022-06-15 09:44:33 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2022-06-22 10:07:35 +0000
commitf2b7229c75a31feaf594887566efdfd5e240d85f (patch)
tree968a36a7209026e0f1ea9aae96792d7d9ca3921e
parent00af216756cc975d0ac1e8861364848eed15cb2d (diff)
Doc: Clarify naming conventions for .js files in QML modules
Fixes: QTBUG-100644 Change-Id: Iadb9d125e6de214584ab7983883d61e311a8f223 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> (cherry picked from commit 428c7e9129121097fe18ea79e93ecb13fd773e85) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/qml/doc/src/cmake/qt_add_qml_module.qdoc11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/qml/doc/src/cmake/qt_add_qml_module.qdoc b/src/qml/doc/src/cmake/qt_add_qml_module.qdoc
index 05ca519437..ae8306af6d 100644
--- a/src/qml/doc/src/cmake/qt_add_qml_module.qdoc
+++ b/src/qml/doc/src/cmake/qt_add_qml_module.qdoc
@@ -283,6 +283,17 @@ target will be the \c target followed by \c{_qmllint}. An \c{all_qmllint}
target which depends on all the individual \c{*_qmllint} targets is also
provided as a convenience.
+\target qml-naming-js-files
+\section2 Naming conventions for \c{.js} files
+
+JavaScript file names that are intended to be addressed as components should
+start with an uppercase letter.
+
+Alternatively, you may use lowercase file names and set the source file
+property
+\l{cmake-source-file-property-QT_QML_SOURCE_TYPENAME}{QT_QML_SOURCE_TYPE_NAME}
+to the desired type name.
+
\target qml-cmake-singletons
\section2 Singletons