From: Nico Vertriest Date: Mon, 2 Feb 2015 11:43:49 +0000 (+0100) Subject: Doc: link issues qtdeclarative X-Git-Tag: v5.5.90+alpha1~3^2~242^2~14 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=566b23df8c31b50fc514a069564d23121d0f4ef9;p=platform%2Fupstream%2Fqtdeclarative.git Doc: link issues qtdeclarative Task-number: QTBUG-43810 Change-Id: I154ffa83512435c3e455937a3f81931a45d9e368 Reviewed-by: Martin Smith --- diff --git a/examples/quick/demos/photoviewer/doc/src/photoviewer.qdoc b/examples/quick/demos/photoviewer/doc/src/photoviewer.qdoc index ac56cb2..7bb27a7 100644 --- a/examples/quick/demos/photoviewer/doc/src/photoviewer.qdoc +++ b/examples/quick/demos/photoviewer/doc/src/photoviewer.qdoc @@ -306,10 +306,10 @@ \printuntil } \printuntil } - We use the \l qsTr() command to mark the button labels translatable. + We use the \l[QML]{Qt::}{qsTr()} command to mark the button labels translatable. - We use the \l lupdate tool to generate the translation source files and - the \l lrelease tool to convert the translated strings to the QM files used + We use the \c lupdate() tool to generate the translation source files and + the \c lrelease() tool to convert the translated strings to the QM files used by the application at runtime. These files are stored in the \c i18n directory. diff --git a/src/qml/doc/qtqml.qdocconf b/src/qml/doc/qtqml.qdocconf index 7738cb3..5729a60 100644 --- a/src/qml/doc/qtqml.qdocconf +++ b/src/qml/doc/qtqml.qdocconf @@ -33,7 +33,7 @@ qhp.QtQml.subprojects.qmltypes.sortPages = true tagfile = ../../../doc/qtqml/qtqml.tags -depends += qtcore qtxmlpatterns qtgui qtquick qtdoc qtlinguist qmake qtscript +depends += qtcore qtxmlpatterns qtgui qtquick qtdoc qtlinguist qmake qtscript qtwidgets headerdirs += .. \ ../../imports/models diff --git a/src/qml/doc/src/qmllanguageref/typesystem/basictypes.qdoc b/src/qml/doc/src/qmllanguageref/typesystem/basictypes.qdoc index 1a154e5..93a36e8 100644 --- a/src/qml/doc/src/qmllanguageref/typesystem/basictypes.qdoc +++ b/src/qml/doc/src/qmllanguageref/typesystem/basictypes.qdoc @@ -499,9 +499,6 @@ property is only invoked when the property is reassigned to a different object v may also explicitly preserve the scarce resource by calling the "preserve" method on the \c var property from within JavaScript. - For more information regarding the usage of a scarce resource, please - see \l{Scarce Resources in JavaScript}. - This basic type is provided by the QML language. */ @@ -543,8 +540,6 @@ property is only invoked when the property is reassigned to a different object v "destroy" method on the \c variant property from within JavaScript. They may also explicitly preserve the scarce resource by calling the "preserve" method on the \c variant property from within JavaScript. - For more information on the usage of a scarce resource, please - see \l{Scarce Resources in JavaScript}. \section1 Storing Arrays and Objects diff --git a/src/qml/doc/src/whatsnew.qdoc b/src/qml/doc/src/whatsnew.qdoc index 10e7108..11b899e 100644 --- a/src/qml/doc/src/whatsnew.qdoc +++ b/src/qml/doc/src/whatsnew.qdoc @@ -95,7 +95,6 @@ has now been replaced by the new \l {Qt QML} and \l {Qt Quick} modules. See the \li New \l var property type. This is a general-purpose property type which obsoletes the \l variant type. Properties of the \l var type may hold JavaScript references. \li QML properties of type \l var and \l variant can now hold pixmaps. - See \l {Scarce Resources in JavaScript} for more information. \li Value type improvements: \list \li QML now supports defining properties of value type basic types within QML documents. Supported types include diff --git a/src/qml/types/qquickpackage.cpp b/src/qml/types/qquickpackage.cpp index fc64b8f..ad2618d 100644 --- a/src/qml/types/qquickpackage.cpp +++ b/src/qml/types/qquickpackage.cpp @@ -60,7 +60,7 @@ QT_BEGIN_NAMESPACE \snippet package/Delegate.qml 0 These named items are used as the delegates by the two views who - reference the special \l{VisualDataModel::parts} property to select + reference the special \l{DelegateModel::parts} property to select a model which provides the chosen delegate. \snippet package/view.qml 0 diff --git a/src/quick/doc/src/dynamicview-tutorial.qdoc b/src/quick/doc/src/dynamicview-tutorial.qdoc index 619f0ab..dd5e1ce 100644 --- a/src/quick/doc/src/dynamicview-tutorial.qdoc +++ b/src/quick/doc/src/dynamicview-tutorial.qdoc @@ -165,14 +165,14 @@ to the index of the item it was dragged over. To move the items within the view we use a DelegateModel. The DelegateModel type is used by the view types to instantiate delegate items from model data and when constructed explicitly can be used to filter and re-order the model items provided to ListView. The -\l {QtQuick::DelegateModel::items}{items} property of DelegateModel provides access to the +\l [QML]{DelegateModel::}{items} property of DelegateModel provides access to the view's items and allows us to change the visible order without modifying the source model. To -determine the current visible index of the items we use \l {QtQuick::DelegateModel::itemsIndex} +determine the current visible index of the items we use \l {DelegateModel::}{itemsIndex} {itemsIndex} property on the DelegateModel attached property of the delegate item. -To utilize a DelegateModel with a ListView we bind it to the \l {QtQuick::ListView::model}{model} -property of the view and bind the \l {QtQuick::DelegateModel::model}{model} and -\l {QtQuick::DelegateModel::delegate}{delegate} to the DelegateModel. +To utilize a DelegateModel with a ListView we bind it to the \l {ListView::}{model} +property of the view and bind the \l {DelegateModel::}{model} and +\l {DelegateModel::}{delegate} to the DelegateModel. \snippet tutorials/dynamicview/dynamicview3/dynamicview.qml 4 @@ -194,7 +194,7 @@ like this: \section2 Walkthrough Items in a DelegateModel are filtered into groups represented by the DelegateModelGroup type, -normally all items in the model belong to a default \l {QtQuick::DelegateModel::items}{items} +normally all items in the model belong to a default \l {DelegateModel::}{items} group but this default can be changed with the includeByDefault property. To implement our sorting we want items to first be added to an unsorted group from where we can transfer them to a sorted position in the items group. To do that we clear includeByDefault on the items group and set it on @@ -208,7 +208,7 @@ item and then transfer the item to the items group before moving it to the pre-d repeat until the unsorted group is empty. To find the insert position for an item we request a handle for the item from the unsorted group -with the \l {QtQuick::DelegateModel::get} {get} function. Through the model property on this +with the \l {DelegateModel::}{get} function. Through the model property on this handle we can access the same model data that is available in a delegate instance of that item and compare against other items to determine relative position. @@ -220,7 +220,7 @@ of the list. In this example it can be one of the following: \snippet tutorials/dynamicview/dynamicview4/dynamicview.qml 4 A sort is triggered whenever new items are added to the unsorted DelegateModel which we are -notified of by the \l {QtQuick::DelegateModelGroup::onChanged}{onChanged} handler. If no sort +notified of by the \l {DelegateModelGroup} \c onChanged handler. If no sort function is currently selected we simply transfer all items from the unsorted group to the items group, otherwise we call sort with the selected sort function. @@ -228,8 +228,8 @@ group, otherwise we call sort with the selected sort function. Finally when the selected sort order changes we can trigger a full re-sort of the list by moving all items from the items group to the unsorted group, which will trigger the -\l {QtQuick::DelegateModelGroup::onChanged}{onChanged} handler and transfer the items back to the -items group in correct order. Note that the \l {QtQuick::DelegateModelGroup::onChanged}{onChanged} +\l {DelegateModelGroup} \c onChanged handler and transfer the items back to the +items group in correct order. Note that the \l {DelegateModelGroup} \c onChanged handler will not be invoked recursively so there's no issue with it being invoked during a sort. \snippet tutorials/dynamicview/dynamicview4/dynamicview.qml 6 diff --git a/src/quick/doc/src/whatsnew.qdoc b/src/quick/doc/src/whatsnew.qdoc index 017a534..c41ea56 100644 --- a/src/quick/doc/src/whatsnew.qdoc +++ b/src/quick/doc/src/whatsnew.qdoc @@ -312,8 +312,8 @@ the window loses focus. \li VisualDataModel: \list \li Now has features to filter the items to be displayed in a view. This is supported by the new - \l {VisualDataModel::}{groups}, \l {VisualDataModel::}{filterOnGroup}, \l {VisualDataModel::}{items} - and \l {VisualDataModel::}{persistedItems} properties. + \l {DelegateModel::}{groups}, \l {DelegateModel::}{filterOnGroup}, \l {DelegateModel::}{items} + and \l {DelegateModel::}{persistedItems} properties. \endlist \li Changes common to both ListView and GridView: \list diff --git a/src/quick/items/qquickaccessibleattached.cpp b/src/quick/items/qquickaccessibleattached.cpp index abb763c..57b8149 100644 --- a/src/quick/items/qquickaccessibleattached.cpp +++ b/src/quick/items/qquickaccessibleattached.cpp @@ -75,7 +75,7 @@ QT_BEGIN_NAMESPACE } \endqml The \l role is set to \c Button to indicate the type of control. - \l Accessible.name is the most important information and bound to the text on the button. + \l {Accessible::}{name} is the most important information and bound to the text on the button. The name is a short and consise description of the control and should reflect the visual label. In this case it is not clear what the button does with the name only, so \l description contains an explanation. @@ -123,7 +123,7 @@ QT_BEGIN_NAMESPACE \li All interactive elements \li \l focusable and \l focused \li All elements that the user can interact with should have focusable set to \c true and - set \l focus to \c true when they have the focus. This is important even for applications + set \c focus to \c true when they have the focus. This is important even for applications that run on touch-only devices since screen readers often implement a virtual focus that can be moved from item to item. \row diff --git a/src/quick/items/qquickdrag.cpp b/src/quick/items/qquickdrag.cpp index 5641c32..cff2f26 100644 --- a/src/quick/items/qquickdrag.cpp +++ b/src/quick/items/qquickdrag.cpp @@ -516,8 +516,8 @@ void QQuickDragAttached::setProposedAction(Qt::DropAction action) \endlist When using \c Drag.Automatic you should also define \l mimeData and bind the - \l active property to the active property of \l MouseArea.drag. - */ + \l active property to the active property of MouseArea : \l {MouseArea::drag.active} +*/ QQuickDrag::DragType QQuickDragAttached::dragType() const { diff --git a/src/quick/items/qquickitem.cpp b/src/quick/items/qquickitem.cpp index 2722f48..6a00f80 100644 --- a/src/quick/items/qquickitem.cpp +++ b/src/quick/items/qquickitem.cpp @@ -1756,11 +1756,9 @@ void QQuickItemPrivate::updateSubFocusItem(QQuickItem *scope, bool focus) QQmlProperty(), or QMetaProperty::write() when you need to modify those properties from C++. This ensures that the QML engine knows about the property change. Otherwise, the engine won't be able to carry out your - requested animation. For example, if you call \l setPosition() directly, - any behavior that reacts to changes in the x or y properties will not take - effect, as you are bypassing Qt's meta-object system. Note that these - functions incur a slight performance penalty. For more details, see - \l {Accessing Members of a QML Object Type from C++}. + requested animation. + Note that these functions incur a slight performance penalty. For more + details, see \l {Accessing Members of a QML Object Type from C++}. \sa QQuickWindow, QQuickPaintedItem */ @@ -5059,7 +5057,7 @@ void QQuickItem::setZ(qreal v) \endqml \endtable - \sa transform, Rotation + \sa Transform, Rotation */ /*! \property QQuickItem::rotation @@ -5085,7 +5083,7 @@ void QQuickItem::setZ(qreal v) \endqml \endtable - \sa transform, Rotation + \sa Transform, Rotation */ qreal QQuickItem::rotation() const { @@ -5145,7 +5143,7 @@ void QQuickItem::setRotation(qreal r) \endqml \endtable - \sa transform, Scale + \sa Transform, Scale */ /*! \property QQuickItem::scale @@ -5184,7 +5182,7 @@ void QQuickItem::setRotation(qreal r) \endqml \endtable - \sa transform, Scale + \sa Transform, Scale */ qreal QQuickItem::scale() const { diff --git a/src/quick/items/qquickwindow.cpp b/src/quick/items/qquickwindow.cpp index eaeb70b..129c07d 100644 --- a/src/quick/items/qquickwindow.cpp +++ b/src/quick/items/qquickwindow.cpp @@ -3008,7 +3008,7 @@ QOpenGLContext *QQuickWindow::openglContext() const (e.g. the user clicked the title bar close button). The CloseEvent contains an accepted property which can be set to false to abort closing the window. - \sa Window.closing() + \sa QQuickWindow::closing() */ /*! @@ -3032,7 +3032,7 @@ QOpenGLContext *QQuickWindow::openglContext() const This signal is emitted when the user tries to close the window. - This signal includes a \a close parameter. The \a close \l accepted + This signal includes a \a close parameter. The \c {close.accepted} property is true by default so that the window is allowed to close; but you can implement an \c onClosing handler and set \c {close.accepted = false} if you need to do something else before the window can be closed. @@ -3894,7 +3894,7 @@ void QQuickWindow::resetOpenGLState() This is equivalent to calling showFullScreen(), showMaximized(), or showNormal(), depending on the platform's default behavior for the window type and flags. - \sa showFullScreen(), showMaximized(), showNormal(), hide(), flags() + \sa showFullScreen(), showMaximized(), showNormal(), hide(), QQuickItem::flags() */ /*! diff --git a/src/quick/util/qquickfontmetrics.cpp b/src/quick/util/qquickfontmetrics.cpp index b65ad3f..0cb2c29 100644 --- a/src/quick/util/qquickfontmetrics.cpp +++ b/src/quick/util/qquickfontmetrics.cpp @@ -277,7 +277,7 @@ qreal QQuickFontMetrics::lineWidth() const \l {QQuickTextMetrics::advanceWidth}{advanceWidth} property of \l {QQuickTextMetrics::advanceWidth}{TextMetrics}. - \sa {QFontMetricsF::width()}, height() + \sa {QFontMetricsF::width()}, {QFontMetricsF::height()} */ qreal QQuickFontMetrics::advanceWidth(const QString &text) const { diff --git a/src/quick/util/qquicktextmetrics.cpp b/src/quick/util/qquicktextmetrics.cpp index fc5b6f1..666546b 100644 --- a/src/quick/util/qquicktextmetrics.cpp +++ b/src/quick/util/qquicktextmetrics.cpp @@ -131,7 +131,7 @@ void QQuickTextMetrics::setText(const QString &text) \li \c Qt::ElideRight - For example: "Hello..." \endlist - \sa elideWidth, elidedText + \sa elideWidth, QFontMetrics::elidedText */ Qt::TextElideMode QQuickTextMetrics::elide() const { @@ -153,7 +153,7 @@ void QQuickTextMetrics::setElide(Qt::TextElideMode elide) This property holds the largest width the text can have (in pixels) before eliding will occur. - \sa elide, elidedText + \sa elide, QFontMetrics::elidedText */ qreal QQuickTextMetrics::elideWidth() const {