aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2022-04-22 23:45:17 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2022-08-10 09:31:13 +0000
commit63d0623f5c71c436d1bdda373673b4c30fde0c5e (patch)
treec4f4b1e2b28d82583a441bce93c44b5b46ffc365
parenta22236bb1b53f485f242fe69724757fa1c23fe02 (diff)
Doc: Fix linking issues
These linking issues have crept through as documentation testing in CI does not capture them. * Fix link to Qml CMake command reference. * Update link targets to the Qt Creator manual as they have changed; link to Qt Design Studio if applicable and remove links that are no longer available. * Fix linking to inherited properties for DragHandler, TableView, and TreeView. * Remove explicit linking to QSGTexture::commitTextureOperations() as that function is \internal. Change-Id: I2c20fef8bc12e639374caac25ed358da887c35b3 Reviewed-by: Kai Koehne <kai.koehne@qt.io> (cherry picked from commit 7bdfbb041a8f908c746fb8f6ac6bb5e0ef2c2f64) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/qml/doc/src/cmake/cmake-properties.qdoc4
-rw-r--r--src/qml/doc/src/qmllanguageref/documents/topic.qdoc6
-rw-r--r--src/qml/qml/qqmlbuiltinfunctions.cpp1
-rw-r--r--src/quick/doc/src/examples.qdoc3
-rw-r--r--src/quick/handlers/qquickdraghandler.cpp2
-rw-r--r--src/quick/items/qquicktableview.cpp18
-rw-r--r--src/quick/items/qquicktextinput.cpp7
-rw-r--r--src/quick/items/qquicktreeview.cpp2
-rw-r--r--src/quick/scenegraph/coreapi/qsgmaterialshader.cpp2
9 files changed, 22 insertions, 23 deletions
diff --git a/src/qml/doc/src/cmake/cmake-properties.qdoc b/src/qml/doc/src/cmake/cmake-properties.qdoc
index 1441419e5b..0b8d2c9367 100644
--- a/src/qml/doc/src/cmake/cmake-properties.qdoc
+++ b/src/qml/doc/src/cmake/cmake-properties.qdoc
@@ -5,8 +5,8 @@
\group cmake-source-file-properties-qtqml
\title CMake Source File Properties in Qt6 Qml
-\l{CMake Commands in Qt6 Qml}{CMake Commands} know about the following CMake
-source file properties:
+\l{CMake Command Reference#Qt6::Qml}{CMake Commands} know about the following
+CMake source file properties:
\sa{CMake Property Reference}
*/
diff --git a/src/qml/doc/src/qmllanguageref/documents/topic.qdoc b/src/qml/doc/src/qmllanguageref/documents/topic.qdoc
index 5e7b1aa953..3b07bf0c16 100644
--- a/src/qml/doc/src/qmllanguageref/documents/topic.qdoc
+++ b/src/qml/doc/src/qmllanguageref/documents/topic.qdoc
@@ -20,9 +20,9 @@ code.
Since Qt 5.4, a document can also have the file extension \c ".ui.qml". The QML
engine handles these files like standard .qml files and ignores the \c .ui part
-of the extension. Qt Creator handles those files as
-\l{Qt Creator: Qt Quick UI Forms}{UI forms} for the Qt Quick Designer. The files
-can contain only a subset of the QML language that is defined by Qt Creator.
+of the extension. Qt Design Studio handles those files as
+\l{Qt Design Studio: UI Files}{UI files}. The files can contain only a subset
+of the QML language features.
\section1 Structure of a QML Document
diff --git a/src/qml/qml/qqmlbuiltinfunctions.cpp b/src/qml/qml/qqmlbuiltinfunctions.cpp
index 4702797e74..30a954c24e 100644
--- a/src/qml/qml/qqmlbuiltinfunctions.cpp
+++ b/src/qml/qml/qqmlbuiltinfunctions.cpp
@@ -229,7 +229,6 @@ The following functions are also on the Qt object.
See the \l QStyleHints documentation for further details.
You should access StyleHints via \l Application::styleHints instead.
- See \l StyleHints for more details.
\note The \c styleHints object is only available when using the Qt Quick module.
*/
diff --git a/src/quick/doc/src/examples.qdoc b/src/quick/doc/src/examples.qdoc
index 2e14ed6fd0..c44a6216a1 100644
--- a/src/quick/doc/src/examples.qdoc
+++ b/src/quick/doc/src/examples.qdoc
@@ -53,8 +53,6 @@ steps such as use cases and introductory material. For more information about Qt
\b{Development Environment}
\list
\li \l{Qt Creator: Creating Qt Quick Projects}{Creating Qt Quick Projects}
- \li \l{Qt Creator: Creating Components}{Creating Components}
- \li \l{Qt Creator: Exporting QML}{Exporting Components}
\li \l{Qt Creator: Using QML Modules with Plugins}{Using QML Modules with Plugins}
\endlist
\enddiv
@@ -63,6 +61,7 @@ steps such as use cases and introductory material. For more information about Qt
\list
\li \l{First Steps with QML}
\li \l{Getting Started Programming with Qt Quick}{Qt Quick Text Editor}
+ \li \l{Qt Design Studio: Your First UI}{Qt Design Studio Tutorials}
\li \l{QML Advanced Tutorial}{SameGame}
\endlist
\enddiv
diff --git a/src/quick/handlers/qquickdraghandler.cpp b/src/quick/handlers/qquickdraghandler.cpp
index b9e832c96b..f90dd305d9 100644
--- a/src/quick/handlers/qquickdraghandler.cpp
+++ b/src/quick/handlers/qquickdraghandler.cpp
@@ -100,7 +100,7 @@ void QQuickDragHandler::onGrabChanged(QQuickPointerHandler *grabber, QPointingDe
Possible values:
\value DragHandler.SnapNever Never snap
\value DragHandler.SnapAuto The \l target snaps if the event point was pressed outside of the \l target
- item \e and the \l target is a descendant of \l parentItem (default)
+ item \e and the \l target is a descendant of \l {PointerHandler::}{parent} item (default)
\value DragHandler.SnapWhenPressedOutsideTarget The \l target snaps if the event point was pressed outside of the \l target
\value DragHandler.SnapAlways Always snap
*/
diff --git a/src/quick/items/qquicktableview.cpp b/src/quick/items/qquicktableview.cpp
index e581eca4db..a8320d99b2 100644
--- a/src/quick/items/qquicktableview.cpp
+++ b/src/quick/items/qquicktableview.cpp
@@ -480,9 +480,10 @@
\since 6.4
This property can be set to control if TableView should animate the
- \l contentItem (\l contentX and \l contentY). It is used by
+ \l {Flickable::}{contentItem} (\l {Flickable::}{contentX} and
+ \l {Flickable::}{contentY}). It is used by
\l positionViewAtCell(), and when navigating
- \l \{QItemSelectionModel::currentIndex}{the current index}
+ \l {QItemSelectionModel::currentIndex}{the current index}
with the keyboard. The default value is \c true.
If set to \c false, any ongoing animation will immediately stop.
@@ -506,7 +507,8 @@
\note In order for TableView to support keyboard navigation, you
need to assign an \l ItemSelectionModel to \l selectionModel.
- \sa {Keyboard navigation}, selectionModel, selectionBehavior, pointerNavigationEnabled, interactive
+ \sa {Keyboard navigation}, selectionModel, selectionBehavior
+ \sa pointerNavigationEnabled, {Flickable::}{interactive}
*/
/*!
@@ -517,7 +519,7 @@
to change \l {QItemSelectionModel::currentIndex()}{the current index}
using mouse or touch. The default value is \c true.
- \sa selectionModel, keyNavigationEnabled, interactive
+ \sa selectionModel, keyNavigationEnabled, {Flickable::}{interactive}
*/
/*!
@@ -696,16 +698,16 @@
\qmlmethod Point QtQuick::TableView::cellAtPosition(point position, bool includeSpacing)
Returns the cell at the given \a position in the table. \a position should be relative
- to the \l contentItem. If no \l {isRowLoaded()}{loaded} cell intersects with
- \a position, the return value will be \c point(-1, -1).
+ to the \l {Flickable::}{contentItem}. If no \l {isRowLoaded()}{loaded} cell intersects
+ with \a position, the return value will be \c point(-1, -1).
If \a includeSpacing is set to \c true, a cell's bounding box will be considered
to include half the adjacent \l rowSpacing and \l columnSpacing on each side. The
default value is \c false.
\note A \l {Qt Quick Input Handlers}{Input Handler} attached to a TableView installs
- itself on the \l contentItem rather than the view. So the position reported by the
- handler can be used directly in a call to this function without any
+ itself on the \l {Flickable::}{contentItem} rather than the view. So the position
+ reported by the handler can be used directly in a call to this function without any
\l {QQuickItem::mapFromItem()}{mapping}.
\sa columnSpacing, rowSpacing
diff --git a/src/quick/items/qquicktextinput.cpp b/src/quick/items/qquicktextinput.cpp
index 6300f38580..a980e7fbaf 100644
--- a/src/quick/items/qquicktextinput.cpp
+++ b/src/quick/items/qquicktextinput.cpp
@@ -820,10 +820,9 @@ void QQuickTextInput::setCursorVisible(bool on)
Unicode characters, such as in the case of surrogate pairs, linguistic
ligatures or diacritics.
- \l displayText is different if echoMode is set to \l TextInput.Password: then
- each passwordMaskCharacter is a "narrow" character
- (the cursorPosition always moves by 1), even if the text in the TextInput is not.
-
+ \l displayText is different if echoMode is set to \c {TextInput.Password}:
+ then each passwordCharacter is a "narrow" character (the cursorPosition always
+ moves by 1), even if the text in the TextInput is not.
*/
int QQuickTextInput::cursorPosition() const
{
diff --git a/src/quick/items/qquicktreeview.cpp b/src/quick/items/qquicktreeview.cpp
index 9b3dbad2fe..a8df1ac00a 100644
--- a/src/quick/items/qquicktreeview.cpp
+++ b/src/quick/items/qquicktreeview.cpp
@@ -90,7 +90,7 @@
If \a row is not between \c 0 and \l {TableView::}{rows}, the return value will
be \c -1.
- \sa modelIndex()
+ \sa {TableView::}{modelIndex()}
*/
/*!
diff --git a/src/quick/scenegraph/coreapi/qsgmaterialshader.cpp b/src/quick/scenegraph/coreapi/qsgmaterialshader.cpp
index 281260dd58..e1edbc2445 100644
--- a/src/quick/scenegraph/coreapi/qsgmaterialshader.cpp
+++ b/src/quick/scenegraph/coreapi/qsgmaterialshader.cpp
@@ -479,7 +479,7 @@ bool QSGMaterialShader::updateUniformData(RenderState &state,
The current rendering \a state is passed from the scene graph. Where
relevant, it is up to the material to trigger enqueuing texture data
- uploads via \l{QSGTexture::commitTextureOperations}.
+ uploads via QSGTexture::commitTextureOperations().
The subclass specific state can be extracted from \a newMaterial.