diff options
| author | Chris Adams <christopher.adams@nokia.com> | 2012-08-06 12:15:32 +1000 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-08-08 13:50:40 +0200 |
| commit | 4a8a8953f70197a7ab7a62fcd01b1bc08051689e (patch) | |
| tree | 037e78c35f675e8d5b7bc00f26d8d984387eda86 /src/qml/doc/src/qmlfunctions.qdoc | |
| parent | 3b0aa0d8048ffa0bb75bb7b29c903e4499c796a8 (diff) | |
Update imports and module documentation
Recently, the qmldir syntax was modified to allow a module identifier
directive to be specified. This allows us to guarantee that types
provided in that namespace are not overridden by other modules.
Given this fundamental change, the documentation needed to be updated
to reflect the new terminology surrounding imports:
- modules
- identified vs legacy
- directories
- local and remote directory imports
- JavaScript resources
- scripts which can be imported directly
Change-Id: I5a3d38de93d0186e79b87f2b3050f2b802088348
Reviewed-by: Bea Lam <bea.lam@nokia.com>
Diffstat (limited to 'src/qml/doc/src/qmlfunctions.qdoc')
| -rw-r--r-- | src/qml/doc/src/qmlfunctions.qdoc | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/src/qml/doc/src/qmlfunctions.qdoc b/src/qml/doc/src/qmlfunctions.qdoc index 790ef5d371..21d2386827 100644 --- a/src/qml/doc/src/qmlfunctions.qdoc +++ b/src/qml/doc/src/qmlfunctions.qdoc @@ -74,7 +74,7 @@ For example, this registers a C++ class \c MySliderItem as a QML type - named \c Slider for version 1.0 of a \l{QML Modules}{module} called + named \c Slider for version 1.0 of a type namespace called "com.mycompany.qmlcomponents": \code @@ -86,7 +86,7 @@ \endcode Once this is registered, the type can be used in QML by importing the - specified module name and version number: + specified type namespace and version number: \qml import com.mycompany.qmlcomponents 1.0 @@ -118,7 +118,7 @@ \endcode This function is typically used to register the revision of a base class to - use for the specified module version (see \l {Type Revisions and Versions}). + use for the specified version of the type (see \l {Type Revisions and Versions}). */ /*! @@ -145,12 +145,12 @@ \fn int qmlRegisterTypeNotAvailable(const char *uri, int versionMajor, int versionMinor, const char *qmlName, const QString& message) \relates QQmlEngine - This function registers a type in the QML system with the name \a qmlName, in the library imported from \a uri having the + This function registers a type in the QML system with the name \a qmlName, in the type namespace imported from \a uri having the version number composed from \a versionMajor and \a versionMinor, but any attempt to instantiate the type will produce the given error \a message. - Normally, the types exported by a module should be fixed. However, if a C++ type is not available, you should - at least "reserve" the QML type name, and give the user of your module a meaningful error message. + Normally, the types exported by a plugin should be fixed. However, if a C++ type is not available, you should + at least "reserve" the QML type name, and give the user of the unavailable type a meaningful error message. Returns the QML type id. @@ -164,7 +164,7 @@ #endif \endcode - This will cause any QML which uses this module and attempts to use the type to produce an error message: + This will cause any QML which imports the "MinehuntCore" type namespace and attempts to use the type to produce an error message: \code fun.qml: Get back to work, slacker! Game { |