Add qmlRegisterUncreatableMetaObject convenience function

qmlRegisterUncreatableMetaObject is needed to register Q_NAMESPACE
QMetaObjects.

Task-number: QTBUG-54982
Change-Id: I767dfcb15db647e0dceb0c37b17e64f2a5c1dd8f
Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>

1 files changed, 36 insertions, 0 deletions

diff --git a/src/qml/doc/src/qmlfunctions.qdoc b/src/qml/doc/src/qmlfunctions.qdoc
index 26fc40ff37..8b24d19891 100644
--- a/src/qml/doc/src/qmlfunctions.qdoc
+++ b/src/qml/doc/src/qmlfunctions.qdoc
@@ -180,6 +180,42 @@
 */
 
 /*!
+  \fn static inline int qmlRegisterUncreatableMetaObject(const QMetaObject &staticMetaObject, const char *uri, int versionMajor, int versionMinor, const char *qmlName, const QString& reason)
+  \relates QQmlEngine
+  \since 5.8
+
+  This function registers the \a staticMetaObject and its extension
+  in the QML system with the name \a qmlName in the library imported
+  from \a uri having version number composed from \a versionMajor and
+  \a versionMinor.
+
+  This function is useful to register Q_NAMESPACE namespaces.
+
+  Returns the QML type id.
+
+  Example:
+
+  \code
+  namespace MyNamespace {
+    Q_NAMESPACE
+    enum MyEnum {
+        Key1,
+        Key2,
+    };
+    Q_ENUMS(MyEnum)
+  }
+
+  //...
+  qmlRegisterUncreatableMetaObject(MyNamespace::staticMetaObject, "io.qt", 1, 0, "MyNamespace", "Access to enums & flags only");
+  \endcode
+
+  Now on QML side you can use the registered enums:
+  \code
+  Component.onCompleted: console.log(MyNamespace.Key2)
+  \endcode
+*/
+
+/*!
   \fn int qmlRegisterCustomExtendedType(const char *uri, int versionMajor, int versionMinor, const char *qmlName, QQmlCustomParser *parser)
   \relates QQmlEngine
   \internal