From 3d3c020621a81d7eff08d2b538d1647b7b3b1618 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Tue, 9 Apr 2013 12:08:44 +0200 Subject: [PATCH] Doc: Reassigned types and pages to their correct modules. 1)Moved classes and basic types to \module QtQml 2. -QQml* classes are in QtQml 2 for 5.1 2)Removed \inqmlmodule commands in overviews and tutorials. -Only QML API should have \inqmlmodule commands because they are added to the auto generated list of types. Change-Id: I9aa3ca8062fa9fed76734885829879122841b119 Reviewed-by: Alan Alpert --- src/qml/doc/src/javascript/date.qdoc | 3 +-- src/qml/doc/src/javascript/number.qdoc | 3 +-- src/qml/doc/src/javascript/string.qdoc | 3 +-- src/qml/doc/src/whatsnew.qdoc | 1 - src/qml/qml/qqmlcomponent.cpp | 10 +++++----- src/qml/qml/qqmlengine.cpp | 2 +- src/qml/qml/qqmllocale.cpp | 2 +- src/qml/types/qqmldelegatemodel.cpp | 5 ++--- src/qml/types/qqmllistmodel.cpp | 4 ++-- src/qml/types/qqmlobjectmodel.cpp | 3 +-- src/quick/doc/src/advtutorial.qdoc | 5 ----- src/quick/doc/src/appdevguide/qtquicktest.qdoc | 1 - src/quick/doc/src/concepts/effects/particles.qdoc | 2 -- src/quick/doc/src/dynamicview-tutorial.qdoc | 5 ----- src/quick/doc/src/examples.qdoc | 1 - src/quick/doc/src/tutorial.qdoc | 4 ---- src/quick/doc/src/whatsnew.qdoc | 1 - 17 files changed, 15 insertions(+), 40 deletions(-) diff --git a/src/qml/doc/src/javascript/date.qdoc b/src/qml/doc/src/javascript/date.qdoc index 9f69693..7da24d4 100644 --- a/src/qml/doc/src/javascript/date.qdoc +++ b/src/qml/doc/src/javascript/date.qdoc @@ -27,7 +27,7 @@ /*! \qmltype Date - \inqmlmodule QtQuick 2 + \inqmlmodule QtQml 2 \brief Provides date functions The QML Date object extends the JS Date object with @@ -223,4 +223,3 @@ } \endcode */ - diff --git a/src/qml/doc/src/javascript/number.qdoc b/src/qml/doc/src/javascript/number.qdoc index 1e7894f..20fe40c 100644 --- a/src/qml/doc/src/javascript/number.qdoc +++ b/src/qml/doc/src/javascript/number.qdoc @@ -27,7 +27,7 @@ /*! \qmltype Number - \inqmlmodule QtQuick 2 + \inqmlmodule QtQml 2 \brief The Number object provides represents a number value The QML Number object extends the JS Number object with @@ -102,4 +102,3 @@ d = Number.fromLocaleString(german, "1.234") // d == 1234.0 \endcode */ - diff --git a/src/qml/doc/src/javascript/string.qdoc b/src/qml/doc/src/javascript/string.qdoc index cc3004d..ab7d7a4 100644 --- a/src/qml/doc/src/javascript/string.qdoc +++ b/src/qml/doc/src/javascript/string.qdoc @@ -27,7 +27,7 @@ /*! \qmltype String - \inqmlmodule QtQuick 2 + \inqmlmodule QtQml 2 \brief The String object represents a string value The QML String object extends the JS String object with @@ -48,4 +48,3 @@ console.log(message.arg(count)) \endcode */ - diff --git a/src/qml/doc/src/whatsnew.qdoc b/src/qml/doc/src/whatsnew.qdoc index 361f6e6..d7a1db9 100644 --- a/src/qml/doc/src/whatsnew.qdoc +++ b/src/qml/doc/src/whatsnew.qdoc @@ -28,7 +28,6 @@ /*! \title Qt QML Release Notes \page qtqml-releasenotes.html -\inqmlmodule QtQuick 2.0 \section1 Qt QML in Qt 5 diff --git a/src/qml/qml/qqmlcomponent.cpp b/src/qml/qml/qqmlcomponent.cpp index b8bf653..9ba1cbc 100644 --- a/src/qml/qml/qqmlcomponent.cpp +++ b/src/qml/qml/qqmlcomponent.cpp @@ -193,7 +193,7 @@ static inline QString buildTypeNameForDebug(const QMetaObject *metaObject) \qmltype Component \instantiates QQmlComponent \ingroup qml-utility-elements - \inqmlmodule QtQuick 2 + \inqmlmodule QtQml 2 \brief Encapsulates a QML component definition Components are reusable, encapsulated QML types with well-defined interfaces. @@ -300,7 +300,7 @@ static inline QString buildTypeNameForDebug(const QMetaObject *metaObject) /*! \enum QQmlComponent::Status - + Specifies the loading status of the QQmlComponent. \value Null This QQmlComponent has no data. Call loadUrl() or setData() to add QML content. @@ -600,7 +600,7 @@ void QQmlComponent::setData(const QByteArray &data, const QUrl &url) d->url = url; QQmlTypeData *typeData = QQmlEnginePrivate::get(d->engine)->typeLoader.getType(data, url); - + if (typeData->isCompleteOrError()) { d->fromTypeData(typeData); } else { @@ -1313,7 +1313,7 @@ void QQmlComponent::incubateObject(QQmlV8Function *args) } QQmlComponentExtension *e = componentExtension(args->engine()); - + QV8IncubatorResource *r = new QV8IncubatorResource(args->engine(), mode); v8::Local o = e->incubationConstructor->NewInstance(); o->SetExternalResource(r); @@ -1475,7 +1475,7 @@ void QV8IncubatorResource::setInitialState(QObject *o) qPersistentDispose(qmlGlobal); } } - + void QV8IncubatorResource::dispose() { qPersistentDispose(valuemap); diff --git a/src/qml/qml/qqmlengine.cpp b/src/qml/qml/qqmlengine.cpp index 25ef080..f128e66 100644 --- a/src/qml/qml/qqmlengine.cpp +++ b/src/qml/qml/qqmlengine.cpp @@ -120,7 +120,7 @@ void qmlRegisterBaseTypes(const char *uri, int versionMajor, int versionMinor) /*! \qmltype QtObject \instantiates QObject - \inqmlmodule QtQuick 2 + \inqmlmodule QtQml 2 \ingroup qml-utility-elements \brief A basic QML type diff --git a/src/qml/qml/qqmllocale.cpp b/src/qml/qml/qqmllocale.cpp index c9ce477..018c55a 100644 --- a/src/qml/qml/qqmllocale.cpp +++ b/src/qml/qml/qqmllocale.cpp @@ -769,7 +769,7 @@ V8_DEFINE_EXTENSION(QV8LocaleDataDeletable, localeV8Data); /*! \qmltype Locale \instantiates QQmlLocale - \inqmlmodule QtQuick 2 + \inqmlmodule QtQml 2 \brief Provides locale specific properties and formatted data The Locale object may only be created via the \l{QML:Qt::locale()}{Qt.locale()} function. diff --git a/src/qml/types/qqmldelegatemodel.cpp b/src/qml/types/qqmldelegatemodel.cpp index efbd98b..c7b6b46 100644 --- a/src/qml/types/qqmldelegatemodel.cpp +++ b/src/qml/types/qqmldelegatemodel.cpp @@ -121,7 +121,7 @@ QQmlDelegateModelParts::QQmlDelegateModelParts(QQmlDelegateModel *parent) /*! \qmltype VisualDataModel \instantiates QQmlDelegateModel - \inqmlmodule QtQuick 2 + \inqmlmodule QtQml 2 \ingroup qtquick-models \brief Encapsulates a model and delegate @@ -2140,7 +2140,7 @@ void QQmlDelegateModelGroupPrivate::destroyingPackage(QQuickPackage *package) /*! \qmltype DelegateModelGroup \instantiates QQmlDelegateModelGroup - \inqmlmodule QtQuick 2 + \inqmlmodule QtQml 2 \ingroup qtquick-models \brief Encapsulates a filtered set of visual data items @@ -3186,4 +3186,3 @@ v8::Local QQmlDelegateModelEngineData::array( } QT_END_NAMESPACE - diff --git a/src/qml/types/qqmllistmodel.cpp b/src/qml/types/qqmllistmodel.cpp index 9609e91..dcb726d 100644 --- a/src/qml/types/qqmllistmodel.cpp +++ b/src/qml/types/qqmllistmodel.cpp @@ -1436,7 +1436,7 @@ QQmlListModelParser::ListInstruction *QQmlListModelParser::ListModelData::instru /*! \qmltype ListModel \instantiates QQmlListModel - \inqmlmodule QtQuick 2 + \inqmlmodule QtQml 2 \brief Defines a free-form list data source \ingroup qtquick-models @@ -2545,7 +2545,7 @@ bool QQmlListModelParser::definesEmptyList(const QString &s) /*! \qmltype ListElement \instantiates QQmlListElement - \inqmlmodule QtQuick 2 + \inqmlmodule QtQml 2 \brief Defines a data item in a ListModel \ingroup qtquick-models diff --git a/src/qml/types/qqmlobjectmodel.cpp b/src/qml/types/qqmlobjectmodel.cpp index 7f7bf92..b60dae4 100644 --- a/src/qml/types/qqmlobjectmodel.cpp +++ b/src/qml/types/qqmlobjectmodel.cpp @@ -169,7 +169,7 @@ public: /*! \qmltype VisualItemModel \instantiates QQmlObjectModel - \inqmlmodule QtQuick 2 + \inqmlmodule QtQml 2 \brief Defines a set of objects to be used as a model The VisualItemModel type encapsulates contains the objects to be used @@ -266,4 +266,3 @@ QQmlObjectModelAttached *QQmlObjectModel::qmlAttachedProperties(QObject *obj) } QT_END_NAMESPACE - diff --git a/src/quick/doc/src/advtutorial.qdoc b/src/quick/doc/src/advtutorial.qdoc index 966233c..a27cb78 100644 --- a/src/quick/doc/src/advtutorial.qdoc +++ b/src/quick/doc/src/advtutorial.qdoc @@ -27,7 +27,6 @@ /*! \page qml-advtutorial.html tutorial -\inqmlmodule QtQuick 2 \title QML Advanced Tutorial \brief A more advanced tutorial, showing how to use QML to create a game. \nextpage QML Advanced Tutorial 1 - Creating the Game Canvas and Blocks @@ -65,7 +64,6 @@ directory. /*! \page qml-advtutorial1.html -\inqmlmodule QtQuick 2 \title QML Advanced Tutorial 1 - Creating the Game Canvas and Blocks \contentspage QML Advanced Tutorial \previouspage QML Advanced Tutorial @@ -135,7 +133,6 @@ types to get started. Next, we will populate the game canvas with some blocks. /*! \page qml-advtutorial2.html -\inqmlmodule QtQuick 2 \title QML Advanced Tutorial 2 - Populating the Game Canvas \contentspage QML Advanced Tutorial \previouspage QML Advanced Tutorial 1 - Creating the Game Canvas and Blocks @@ -211,7 +208,6 @@ Now, we have a screen of blocks, and we can begin to add the game mechanics. /*! \page qml-advtutorial3.html -\inqmlmodule QtQuick 2 \title QML Advanced Tutorial 3 - Implementing the Game Logic \contentspage QML Advanced Tutorial \previouspage QML Advanced Tutorial 2 - Populating the Game Canvas @@ -300,7 +296,6 @@ until the next chapter - where your application becomes alive! /*! \page qml-advtutorial4.html -\inqmlmodule QtQuick 2 \title QML Advanced Tutorial 4 - Finishing Touches \contentspage QML Advanced Tutorial \previouspage QML Advanced Tutorial 3 - Implementing the Game Logic diff --git a/src/quick/doc/src/appdevguide/qtquicktest.qdoc b/src/quick/doc/src/appdevguide/qtquicktest.qdoc index 6d43427..a5712ca 100644 --- a/src/quick/doc/src/appdevguide/qtquicktest.qdoc +++ b/src/quick/doc/src/appdevguide/qtquicktest.qdoc @@ -27,7 +27,6 @@ /*! \page qtquick-qtquicktest.html - \inqmlmodule QtQuick 2 \title Qt Quick Test Reference Documentation \brief unit testing framework for QML diff --git a/src/quick/doc/src/concepts/effects/particles.qdoc b/src/quick/doc/src/concepts/effects/particles.qdoc index 708e8d2..ec49c6d 100644 --- a/src/quick/doc/src/concepts/effects/particles.qdoc +++ b/src/quick/doc/src/concepts/effects/particles.qdoc @@ -44,7 +44,6 @@ /*! \page qtquick-effects-particles.html - \inqmlmodule QtQuick.Particles 2.0 \title Using the Qt Quick Particle System Documentation for all Particle System types can be found on the \l{QtQuick.Particles 2}{QtQuick.Particles} module page. @@ -132,7 +131,6 @@ /*! \page qtquick-particles-performance.html - \inqmlmodule QtQuick 2.0 \title Particle System Performance Guide The performance of the particle system scales with the number of particles it is maintaining. After prototyping the desired diff --git a/src/quick/doc/src/dynamicview-tutorial.qdoc b/src/quick/doc/src/dynamicview-tutorial.qdoc index daa14a6..a04f057 100644 --- a/src/quick/doc/src/dynamicview-tutorial.qdoc +++ b/src/quick/doc/src/dynamicview-tutorial.qdoc @@ -27,7 +27,6 @@ /*! \page qml-dynamicview-tutorial.html tutorial -\inqmlmodule QtQuick 2 \title QML Dynamic View Ordering Tutorial \brief A tutorial describing how to re-arrange items in a QML ListView \nextpage QML Dynamic View Ordering Tutorial 1 - A Simple ListView and Delegate @@ -51,7 +50,6 @@ directory. /*! \page qml-dynamicview-tutorial1.html -\inqmlmodule QtQuick 2 \title QML Dynamic View Ordering Tutorial 1 - A Simple ListView and Delegate \contentspage QML Dynamic View Ordering Tutorial \previouspage QML Dynamic View Ordering Tutorial @@ -88,7 +86,6 @@ The second part of the application is the ListView itself to which we bind the m /*! \page qml-dynamicview-tutorial2.html -\inqmlmodule QtQuick 2 \title QML Dynamic View Ordering Tutorial 2 - Dragging View Items \contentspage QML Dynamic View Ordering Tutorial \previouspage QML Dynamic View Ordering Tutorial 1 - A Simple ListView and Delegate @@ -133,7 +130,6 @@ so that is above other items in the stacking order and isn't obscured as it is d /*! \page qml-dynamicview-tutorial3.html -\inqmlmodule QtQuick 2 \title QML Dynamic View Ordering Tutorial 3 - Moving Dragged Items \contentspage QML Dynamic View Ordering Tutorial \previouspage QML Dynamic View Ordering Tutorial 2 - Dragging View Items @@ -187,7 +183,6 @@ property of the view and bind the \l {QtQuick2::VisualDataModel::model}{model} a /*! \page qml-dynamicview-tutorial4.html -\inqmlmodule QtQuick 2 \title QML Dynamic View Ordering Tutorial 4 - Sorting Items \contentspage QML Dynamic View Ordering Tutorial \previouspage QML Dynamic View Ordering Tutorial 3 - Moving Dragged Items diff --git a/src/quick/doc/src/examples.qdoc b/src/quick/doc/src/examples.qdoc index aad8cfc..6db5308 100644 --- a/src/quick/doc/src/examples.qdoc +++ b/src/quick/doc/src/examples.qdoc @@ -33,7 +33,6 @@ \ingroup all-examples \ingroup qtquick \target qtquick-samples -\inqmlmodule QtQuick 2 These are code samples that show how to use various aspects of Qt Quick. Larger compound interfaces are grouped as applications as they demonstrate more Qt diff --git a/src/quick/doc/src/tutorial.qdoc b/src/quick/doc/src/tutorial.qdoc index b1f2304..62098bc 100644 --- a/src/quick/doc/src/tutorial.qdoc +++ b/src/quick/doc/src/tutorial.qdoc @@ -27,7 +27,6 @@ /*! \page qml-tutorial.html -\inqmlmodule QtQuick 2 \title QML Tutorial \brief An introduction to the basic concepts and features of QML. \previouspage Introduction to the QML Language @@ -55,7 +54,6 @@ Tutorial chapters: /*! \page qml-tutorial1.html -\inqmlmodule QtQuick 2 \title QML Tutorial 1 - Basic Types \contentspage QML Tutorial \previouspage QML Tutorial @@ -114,7 +112,6 @@ qmlscene tutorials/helloworld/tutorial1.qml /*! \page qml-tutorial2.html -\inqmlmodule QtQuick 2 \title QML Tutorial 2 - QML Components \contentspage QML Tutorial \previouspage QML Tutorial 1 - Basic Types @@ -187,7 +184,6 @@ We can react to any signal of our component through a property of the name \e 'o /*! \page qml-tutorial3.html -\inqmlmodule QtQuick 2 \title QML Tutorial 3 - States and Transitions \contentspage QML Tutorial \previouspage QML Tutorial 2 - QML Components diff --git a/src/quick/doc/src/whatsnew.qdoc b/src/quick/doc/src/whatsnew.qdoc index 3959a1b..7651fce 100644 --- a/src/quick/doc/src/whatsnew.qdoc +++ b/src/quick/doc/src/whatsnew.qdoc @@ -28,7 +28,6 @@ /*! \title Qt Quick Release Notes \page qtquick-releasenotes.html -\inqmlmodule QtQuick 2.0 \section1 Qt 5.0 - QtQuick C++ Module -- 1.7.2.5