aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVenu <venugopal.shivashankar@digia.com>2014-01-29 12:46:05 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-02-12 12:30:49 +0100
commitfa27ed3024e473be80ea70e5b2dc2f905cab2111 (patch)
treec78fc04738b8b5c99a05f3b565e0fade6850e2e5
parent8730085fe4ce124cefaa563b42f433cbd31a3860 (diff)
Doc: Added information about classname in qmldir
QML modules that depend on C++ plugins must provide the plugin class name information in their qmldir to support statically built Qt Quick applications. Task-number: QTBUG-35369 Change-Id: I15432fec4f8a72be4f851da061ac0c091696d8c9 Reviewed-by: Morten Johan Sørvig <morten.sorvig@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
-rw-r--r--src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc14
1 files changed, 13 insertions, 1 deletions
diff --git a/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc b/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc
index c89d4a3c0d..88c866baf3 100644
--- a/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc
+++ b/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc
@@ -27,7 +27,7 @@
/*!
\page qtqml-modules-qmldir.html
\title Module Definition qmldir Files
-\brief How to write a qmldir file which defines a QML module
+\brief Defines a QML module
There are two distinct types of \c qmldir files:
\list
@@ -177,6 +177,18 @@ plugin <Name> [<Path>]
\code
plugin MyPluginLibrary
\endcode
+ \row
+ \li C++ Plugin Class
+ \li
+ \code
+ classname <C++ plugin class>
+ \endcode
+ \li Provides the class name of the C++ plugin used by the module.
+
+ This information is required for all the QML modules that depend
+ on a C++ plugin for additional functionality. Qt Quick applications
+ built with static linking cannot resolve the module imports without
+ this information.
\row
\li Type Information Description File Declaration