diff options
| author | Shawn Rutledge <shawn.rutledge@digia.com> | 2014-09-30 09:00:21 +0200 |
|---|---|---|
| committer | Shawn Rutledge <shawn.rutledge@digia.com> | 2014-10-01 14:41:04 +0200 |
| commit | b9f143945982ae1775c69b9a09dc5e3912a17324 (patch) | |
| tree | 0c42d7100fb0a6ed16a789d4912aba3389ecf796 /src/qml/doc | |
| parent | 3ec6520117ffde0dfa2e029ca3214986506c54d8 (diff) | |
documentation for qmldir "depends" declaration
[ChangeLog][QtQml][qmldir] added the ability to declare dependencies
on other modules in a module definition qmldir file
Task-number: QTBUG-41489
Change-Id: Icd526bc7617bc3e4f725c7d008d0522a201cf645
Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Diffstat (limited to 'src/qml/doc')
| -rw-r--r-- | src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc b/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc index a3ea25c005..def2216cbd 100644 --- a/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc +++ b/src/qml/doc/src/qmllanguageref/modules/qmldir.qdoc @@ -210,6 +210,25 @@ typeinfo mymodule.qmltypes as code completion for the types defined in your plugins. \row + \li Dependency Declaration + \li + \code +depends <ModuleIdentifier> <InitialVersion> + \endcode + \li Declares that this module depends on another. + + Example: + \code +depends MyOtherModule 1.0 + \endcode + + This declaration is necessary only in cases when the dependency is + hidden: for example, when the C++ code for one module is used to + load QML (perhaps conditionally) which then depends on other + modules. In such cases, the \c depends declaration is necessary + to include the other modules in application packages. + + \row \li Comment \li \code |