aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAlan Alpert <alan.alpert@nokia.com>2011-11-28 13:11:25 +1000
committerQt by Nokia <qt-info@nokia.com>2011-11-28 07:45:43 +0100
commita736f72ad2ef3d5b72d9396c314570643cec8220 (patch)
tree746e3ecfeb8fd1d6e9393a8202271a994fbad454 /doc
parent121b5777ffb0f692310973fbe858356894c52998 (diff)
Explain the implications of QML versions a little more
Change-Id: I2b1667333a18daebba5224e210f219721096bc91 Reviewed-by: Martin Jones <martin.jones@nokia.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/src/declarative/extending.qdoc7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/src/declarative/extending.qdoc b/doc/src/declarative/extending.qdoc
index e29223da6f..c1c7547ec2 100644
--- a/doc/src/declarative/extending.qdoc
+++ b/doc/src/declarative/extending.qdoc
@@ -123,8 +123,8 @@ a type; see qmlRegisterModuleApi() for more information.
\section1 QML Type Versioning
-In C++ adding a new method or property cannot break old applications.
-In QML, however, new methods and properties can change what a name previously
+In C++ adding a new class, method or property cannot break old applications.
+In QML, however, new elements, methods and properties can change what a name previously
resolved to to within a scope chain.
For example, consider these two QML files
@@ -189,6 +189,9 @@ qmlRegisterType<QCppItem,1>("MyModule", 1, 1, "CppItem")
\c root is only available when MyModule 1.1 is imported.
+For the same reason, new elements introduced in later versions should use the minor version argument of qmlRegisterType.
+
+This feature of the language allows for behavioural changes to be made without breaking existing applications. Consequently QML module authors should always remember to document what changed between minor versions, and QML module users should check that their application still runs correctly before deploying an updated import statement.
\section1 Object and List Property Types