diff options
authorMaximilian Goldstein <max.goldstein@qt.io>2020-11-23 13:17:40 +0100
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2020-11-23 14:53:16 +0000
commitdcbde9793533fbe79d8facf2e9089494765cf2bd (patch)
parent9c733e3944e93c7eb7c9e1f4dcd22dce3d34206e (diff)
qmlfunctions.qdoc: Add clarification to QML_FOREIGN
Fixes: QTBUG-87150 Change-Id: If99a06a07892bdfef7b6b1e8fa737480750992fe Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> (cherry picked from commit 56f428c360191230b571969a2651e85380030afa) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
2 files changed, 8 insertions, 0 deletions
diff --git a/examples/qml/doc/src/qml-extending.qdoc b/examples/qml/doc/src/qml-extending.qdoc
index 723e470d45..c9922ebd45 100644
--- a/examples/qml/doc/src/qml-extending.qdoc
+++ b/examples/qml/doc/src/qml-extending.qdoc
@@ -79,6 +79,10 @@ Qt's internal QLineEdit class.
\snippet referenceexamples/extended/lineedit.h 0
+Note the usage of \l QML_NAMED_ELEMENT() instead of \l QML_ELEMENT.
+QML_ELEMENT uses the name of the containing type by default, "LineEditExtension" in this case.
+As the class being an extension class is an implementation detail, we choose the more natural name "LineEdit" instead
The QML engine then instantiates a \l QLineEdit:
\snippet referenceexamples/extended/main.cpp 1
diff --git a/src/qml/doc/src/qmlfunctions.qdoc b/src/qml/doc/src/qmlfunctions.qdoc
index f7a84e6584..9136bc36cc 100644
--- a/src/qml/doc/src/qmlfunctions.qdoc
+++ b/src/qml/doc/src/qmlfunctions.qdoc
@@ -269,6 +269,10 @@
for example because they belong to 3rdparty libraries.
To register a namespace, see \l QML_FOREIGN_NAMESPACE().
+ \b{NOTE:} You may want to use \l QML_NAMED_ELEMENT() instead of \l QML_ELEMENT due to the fact that
+ the element will be named like the struct it is contained in, not the foreign type.
+ See \l {Extending QML - Extension Objects Example} for an example.