From b9f143945982ae1775c69b9a09dc5e3912a17324 Mon Sep 17 00:00:00 2001
From: Shawn Rutledge <shawn.rutledge@digia.com>
Date: Tue, 30 Sep 2014 09:00:21 +0200
Subject: [PATCH] documentation for qmldir "depends" declaration
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
[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>
---
.../src/qmllanguageref/modules/qmldir.qdoc | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
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
@@ -209,6 +209,25 @@ typeinfo mymodule.qmltypes
Without such a file, QML tools may be unable to offer features such
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
--
GitLab