From 9df0c50fe588df64b65b968cd59f98d06024aad1 Mon Sep 17 00:00:00 2001 From: Bea Lam Date: Tue, 3 Jul 2012 15:51:04 +1000 Subject: Fix various QtQuick.* submodule docs - Create module index pages for QtQuick.Window, QtQuick.XmlListModel and QtQuick.LocalStorage. - Fix references to module names in docs so that docs for properties and methods are actually generated e.g. use "QtQuick.Window2" instead of "QtQuick2.Window". There's no easy way to document Module APIs at the moment so the QtQuick.LocalStorage documentation has been updated in a hacky way to generate the correct method documentation. Change-Id: I7b34e4b4ac794acffc6d198b98e2115ccf0fa9a6 Reviewed-by: Martin Jones --- src/imports/xmllistmodel/qqmlxmllistmodel.cpp | 46 +++++++++++++++++---------- 1 file changed, 30 insertions(+), 16 deletions(-) (limited to 'src/imports/xmllistmodel/qqmlxmllistmodel.cpp') diff --git a/src/imports/xmllistmodel/qqmlxmllistmodel.cpp b/src/imports/xmllistmodel/qqmlxmllistmodel.cpp index 41e66b0406..5a06855f1e 100644 --- a/src/imports/xmllistmodel/qqmlxmllistmodel.cpp +++ b/src/imports/xmllistmodel/qqmlxmllistmodel.cpp @@ -68,9 +68,23 @@ typedef QPair QQuickXmlListRange; #define XMLLISTMODEL_CLEAR_ID 0 +/*! + \qmlmodule QtQuick.XmlListModel 2 + \title QML Module QtQuick.XmlListModel 2.0 + \brief Contains types for creating models from XML data + + This QML module contains types for creating models from XML data. + + To use the types in this module, import the module with the following line: + + \code + import QtQuick.XmlListModel 2.0 + \endcode +*/ + /*! \qmlclass XmlRole QQuickXmlListModelRole - \inqmlmodule QtQuick 2 + \inqmlmodule QtQuick.XmlListModel 2 \brief For specifying a role to an XmlListModel \ingroup qtquick-models @@ -78,7 +92,7 @@ typedef QPair QQuickXmlListRange; */ /*! - \qmlproperty string QtQuick2::XmlRole::name + \qmlproperty string QtQuick.XmlListModel2::XmlRole::name The name for the role. This name is used to access the model data for this role. @@ -105,7 +119,7 @@ typedef QPair QQuickXmlListRange; */ /*! - \qmlproperty string QtQuick2::XmlRole::query + \qmlproperty string QtQuick.XmlListModel2::XmlRole::query The relative XPath expression query for this role. The query must be relative; it cannot start with a '/'. @@ -122,7 +136,7 @@ typedef QPair QQuickXmlListRange; */ /*! - \qmlproperty bool QtQuick2::XmlRole::isKey + \qmlproperty bool QtQuick.XmlListModel2::XmlRole::isKey Defines whether this is a key role. Key roles are used to to determine whether a set of values should be updated or added to the XML list model when XmlListModel::reload() @@ -595,7 +609,7 @@ void QQuickXmlListModelPrivate::clear_role(QQmlListProperty QtQuick2::XmlListModel::roles + \qmlproperty list QtQuick.XmlListModel2::XmlListModel::roles The roles to make available for this model. */ @@ -740,7 +754,7 @@ QVariant QQuickXmlListModel::data(int index, int role) const } /*! - \qmlproperty int QtQuick2::XmlListModel::count + \qmlproperty int QtQuick.XmlListModel2::XmlListModel::count The number of data entries in the model. */ int QQuickXmlListModel::count() const @@ -765,7 +779,7 @@ QString QQuickXmlListModel::toString(int role) const } /*! - \qmlproperty url QtQuick2::XmlListModel::source + \qmlproperty url QtQuick.XmlListModel2::XmlListModel::source The location of the XML data source. If both \c source and \l xml are set, \l xml is used. @@ -788,7 +802,7 @@ void QQuickXmlListModel::setSource(const QUrl &src) } /*! - \qmlproperty string QtQuick2::XmlListModel::xml + \qmlproperty string QtQuick.XmlListModel2::XmlListModel::xml This property holds the XML data for this model, if set. The text is assumed to be UTF-8 encoded. @@ -812,7 +826,7 @@ void QQuickXmlListModel::setXml(const QString &xml) } /*! - \qmlproperty string QtQuick2::XmlListModel::query + \qmlproperty string QtQuick.XmlListModel2::XmlListModel::query An absolute XPath query representing the base query for creating model items from this model's XmlRole objects. The query should start with '/' or '//'. */ @@ -838,7 +852,7 @@ void QQuickXmlListModel::setQuery(const QString &query) } /*! - \qmlproperty string QtQuick2::XmlListModel::namespaceDeclarations + \qmlproperty string QtQuick.XmlListModel2::XmlListModel::namespaceDeclarations The namespace declarations to be used in the XPath queries. The namespaces should be declared as in XQuery. For example, if a requested document @@ -872,7 +886,7 @@ void QQuickXmlListModel::setNamespaceDeclarations(const QString &declarations) } /*! - \qmlmethod object QtQuick2::XmlListModel::get(int index) + \qmlmethod object QtQuick.XmlListModel2::XmlListModel::get(int index) Returns the item at \a index in the model. @@ -912,7 +926,7 @@ QQmlV8Handle QQuickXmlListModel::get(int index) const } /*! - \qmlproperty enumeration QtQuick2::XmlListModel::status + \qmlproperty enumeration QtQuick.XmlListModel2::XmlListModel::status Specifies the model loading status, which can be one of the following: \list @@ -933,7 +947,7 @@ QQuickXmlListModel::Status QQuickXmlListModel::status() const } /*! - \qmlproperty real QtQuick2::XmlListModel::progress + \qmlproperty real QtQuick.XmlListModel2::XmlListModel::progress This indicates the current progress of the downloading of the XML data source. This value ranges from 0.0 (no data downloaded) to @@ -954,7 +968,7 @@ qreal QQuickXmlListModel::progress() const } /*! - \qmlmethod void QtQuick2::XmlListModel::errorString() + \qmlmethod void QtQuick.XmlListModel2::XmlListModel::errorString() Returns a string description of the last error that occurred if \l status is XmlListModel::Error. @@ -985,7 +999,7 @@ void QQuickXmlListModel::componentComplete() } /*! - \qmlmethod QtQuick2::XmlListModel::reload() + \qmlmethod QtQuick.XmlListModel2::XmlListModel::reload() Reloads the model. -- cgit v1.2.3