diff options
author | Chris Adams <christopher.adams@nokia.com> | 2012-05-28 17:12:56 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-06-21 09:58:56 +0200 |
commit | 5e33b0f580d2b20f1a2989bf2ee8dde4525a2e39 (patch) | |
tree | 780d25ce7d8955e56ea985a35dd84609df12fbf0 /src/qml/qml | |
parent | 03342a435a88656d64d1445991a4421d244fcb45 (diff) |
Create new documentation structure
The documentation currently has no clear separation between Qt QML
and Qt Quick. With recent commits like:
6c8378eaf1edbbefe6aaa3672b0127816a004fd7
and
ab1e510121c8a679fdaca12ccd30e0f7ac12a26b
the separation between the language definition and implementation,
provided by Qt QML, and the standard library for the QML language,
provided by Qt Quick, is clear.
This commit creates a new documentation structure that is more
navigable and separates concepts into logical categories, with
clear separation between QtQML and QtQuick. It also provides a more
generic QML Application Developer Resources page which contains links
to information for QML application developers.
Change-Id: Ia807ccfbfd24ffa0e1c7f0a51ed9d2ed3aa6a733
Reviewed-by: Martin Jones <martin.jones@nokia.com>
Diffstat (limited to 'src/qml/qml')
-rw-r--r-- | src/qml/qml/qqmlcomponent.cpp | 9 | ||||
-rw-r--r-- | src/qml/qml/qqmlcontext.cpp | 2 | ||||
-rw-r--r-- | src/qml/qml/qqmlengine.cpp | 2 | ||||
-rw-r--r-- | src/qml/qml/qqmlextensionplugin.cpp | 8 | ||||
-rw-r--r-- | src/qml/qml/qqmllist.cpp | 3 | ||||
-rw-r--r-- | src/qml/qml/qquickworkerscript.cpp | 4 | ||||
-rw-r--r-- | src/qml/qml/v8/qqmlbuiltinfunctions.cpp | 6 |
7 files changed, 14 insertions, 20 deletions
diff --git a/src/qml/qml/qqmlcomponent.cpp b/src/qml/qml/qqmlcomponent.cpp index ecadc00396..42dbb2baa4 100644 --- a/src/qml/qml/qqmlcomponent.cpp +++ b/src/qml/qml/qqmlcomponent.cpp @@ -118,7 +118,6 @@ static inline QString buildTypeNameForDebug(const QMetaObject *metaObject) \brief The QQmlComponent class encapsulates a QML component definition Components are reusable, encapsulated QML elements with well-defined interfaces. - They are often defined in \l {qdeclarativedocuments.html}{Component Files}. A QQmlComponent instance can be created from a QML file. For example, if there is a \c main.qml file like this: @@ -183,8 +182,6 @@ static inline QString buildTypeNameForDebug(const QMetaObject *metaObject) \endcode Note that the QtQuick 1 version is named QDeclarativeComponent. - - \sa {Using QML Bindings in C++ Applications}, {Integrating QML Code with Existing Qt UI Code} */ /*! @@ -196,7 +193,7 @@ static inline QString buildTypeNameForDebug(const QMetaObject *metaObject) Components are reusable, encapsulated QML elements with well-defined interfaces. - Components are often defined by \l {qdeclarativedocuments.html}{component files} - + Components are often defined by \l {{QML Documents}}{component files} - that is, \c .qml files. The \e Component element essentially allows QML components to be defined inline, within a \l {QML Document}{QML document}, rather than as a separate QML file. This may be useful for reusing a small component within a QML file, or for defining @@ -1082,7 +1079,7 @@ static void QQmlComponent_setQmlParent(QObject *me, QObject *parent) \endjs Dynamically created instances can be deleted with the \c destroy() method. - See \l {Dynamic Object Management in QML} for more information. + See \l {Dynamic QML Object Creation from JavaScript} for more information. \sa incubateObject() */ @@ -1197,7 +1194,7 @@ void QQmlComponent::createObject(QQmlV8Function *args) \endjs Dynamically created instances can be deleted with the \c destroy() method. - See \l {Dynamic Object Management in QML} for more information. + See \l {Dynamic QML Object Creation from JavaScript} for more information. \sa createObject() */ diff --git a/src/qml/qml/qqmlcontext.cpp b/src/qml/qml/qqmlcontext.cpp index 153d8886c3..b8e1e6d09e 100644 --- a/src/qml/qml/qqmlcontext.cpp +++ b/src/qml/qml/qqmlcontext.cpp @@ -156,7 +156,7 @@ QQmlContextPrivate::QQmlContextPrivate() to reevaluate). Thus whenever possible you should complete "setup" of the context before using it to create any objects. - \sa {Using QML Bindings in C++ Applications} + \sa {Exposing C++ Data to QML} */ /*! \internal */ diff --git a/src/qml/qml/qqmlengine.cpp b/src/qml/qml/qqmlengine.cpp index 3017c7336c..6133568426 100644 --- a/src/qml/qml/qqmlengine.cpp +++ b/src/qml/qml/qqmlengine.cpp @@ -300,7 +300,7 @@ The format specification is described at \l{Qt::formatDateTime}{Qt.formatDateTim \section1 Dynamic Object Creation The following functions on the global object allow you to dynamically create QML -items from files or strings. See \l{Dynamic Object Management in QML} for an overview +items from files or strings. See \l{Dynamic QML Object Creation from JavaScript} for an overview of their use. \list diff --git a/src/qml/qml/qqmlextensionplugin.cpp b/src/qml/qml/qqmlextensionplugin.cpp index 667e50a6bf..5ece9d51a3 100644 --- a/src/qml/qml/qqmlextensionplugin.cpp +++ b/src/qml/qml/qqmlextensionplugin.cpp @@ -61,7 +61,7 @@ QT_BEGIN_NAMESPACE \li Subclass QQmlExtensionPlugin, implement registerTypes() method to register types using qmlRegisterType(), and export the class using the Q_EXPORT_PLUGIN2() macro \li Write an appropriate project file for the plugin - \li Create a \l{Writing a qmldir file}{qmldir file} to describe the plugin + \li Create a \l{Syntax of a qmldir file}{qmldir file} to describe the plugin \endlist QML extension plugins can be used to provide either application-specific or @@ -105,7 +105,7 @@ QT_BEGIN_NAMESPACE ... \endcode - Finally, a \l{Writing a qmldir file}{qmldir file} is required in the \c com/nokia/TimeExample directory + Finally, a \l{Syntax of a qmldir file}{qmldir file} is required in the \c com/nokia/TimeExample directory that describes the plugin. This directory includes a \c Clock.qml file that should be bundled with the plugin, so it needs to be specified in the \c qmldir file: @@ -117,9 +117,9 @@ QT_BEGIN_NAMESPACE \snippet examples/qml/cppextensions/plugins/plugins.qml 0 - The full source code is available in the \l {declarative/cppextensions/plugins}{plugins example}. + The full source code is available in the \l {qml/cppextensions/plugins}{plugins example}. - The \l {Tutorial: Writing QML extensions with C++} also contains a chapter + The \l {Tutorial: Extending QML with C++} also contains a chapter on creating QML plugins. Note that the QtQuick 1 version is called QDeclarativeExtensionPlugin. diff --git a/src/qml/qml/qqmllist.cpp b/src/qml/qml/qqmllist.cpp index 14425f22e5..8698ce339e 100644 --- a/src/qml/qml/qqmllist.cpp +++ b/src/qml/qml/qqmllist.cpp @@ -346,9 +346,6 @@ QML list properties are typesafe - in this case \c {Fruit} is a QObject type tha The QtQuick 1 version of this class is named QDeclarativeListProperty. \note QQmlListProperty can only be used for lists of QObject-derived object pointers. - -\sa {Object and List Property Types} - */ /*! diff --git a/src/qml/qml/qquickworkerscript.cpp b/src/qml/qml/qquickworkerscript.cpp index 53eb60eab3..84cbdbba3f 100644 --- a/src/qml/qml/qquickworkerscript.cpp +++ b/src/qml/qml/qquickworkerscript.cpp @@ -561,9 +561,9 @@ void QQuickWorkerScriptEngine::run() /*! \qmlclass WorkerScript QQuickWorkerScript - \ingroup qml-utility-elements + \ingroup qtquick-threading \inqmlmodule QtQuick 2 - \brief Enables the use of threads in QML + \brief Enables the use of threads in a Qt Quick application Use WorkerScript to run operations in a new thread. This is useful for running operations in the background so diff --git a/src/qml/qml/v8/qqmlbuiltinfunctions.cpp b/src/qml/qml/v8/qqmlbuiltinfunctions.cpp index 787197d1d7..19a97d95d0 100644 --- a/src/qml/qml/v8/qqmlbuiltinfunctions.cpp +++ b/src/qml/qml/v8/qqmlbuiltinfunctions.cpp @@ -958,7 +958,7 @@ v8::Handle<v8::Value> atob(const v8::Arguments &args) /*! \qmlmethod Qt::quit() This function causes the QQmlEngine::quit() signal to be emitted. -Within the \l {QML Viewer}, this causes the launcher application to exit; +Within the \l {Prototyping with qmlscene}, this causes the launcher application to exit; to quit a C++ application when this method is called, connect the QQmlEngine::quit() signal to the QCoreApplication::quit() slot. */ @@ -990,7 +990,7 @@ Note that this function returns immediately, and therefore may not work if the \a qml string loads new components (that is, external QML files that have not yet been loaded). If this is the case, consider using \l{QML:Qt::createComponent()}{Qt.createComponent()} instead. -See \l {Dynamic Object Management in QML} for more information on using this function. +See \l {Dynamic QML Object Creation from JavaScript} for more information on using this function. */ v8::Handle<v8::Value> createQmlObject(const v8::Arguments &args) { @@ -1111,7 +1111,7 @@ For example: \snippet qml/createComponent-simple.qml 0 -See \l {Dynamic Object Management in QML} for more information on using this function. +See \l {Dynamic QML Object Creation from JavaScript} for more information on using this function. To create a QML object from an arbitrary string of QML (instead of a file), use \l{QML:Qt::createQmlObject()}{Qt.createQmlObject()}. |