aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2022-06-08 12:27:10 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2022-06-20 18:28:35 +0000
commit7f42acf20b3ce2c2ae29c575963f953d722df085 (patch)
treec52d448c9dfab58963b78a5def15a611fd9c0efa
parent4406796903ea4c95bb29a0ea53e05689e3de623f (diff)
Doc: Update external page linking
* Remove obsolete, unused \externalpage links. * Update remaining ones to use https. * Update titles of external pages to be more specific. This avoids incorrect linking when there are multiple conflicting titles. * Remove excessive linking on qtquick-toolsnutilities.qdoc. Fixes: QTBUG-104138 Change-Id: I4efb79a938d84c109db9db2bf5182b324e9940aa Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io> (cherry picked from commit 1c0f3cc4d9080ff51bb8a8adbdae1a61fe34871f) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/qml/doc/src/external-resources.qdoc39
-rw-r--r--src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc54
2 files changed, 40 insertions, 53 deletions
diff --git a/src/qml/doc/src/external-resources.qdoc b/src/qml/doc/src/external-resources.qdoc
index 0999abc5af..cd8c895e17 100644
--- a/src/qml/doc/src/external-resources.qdoc
+++ b/src/qml/doc/src/external-resources.qdoc
@@ -26,52 +26,39 @@
****************************************************************************/
/*!
- \externalpage http://www.ecma-international.org/publications/standards/Ecma-262.htm
+ \externalpage https://www.ecma-international.org/publications-and-standards/standards/ecma-262/
\title ECMA-262
*/
/*!
- \externalpage http://qmlbook.github.io/
- \title Qt5 Cadaques
-*/
-
-/*!
- \externalpage http://www.w3schools.com/jsref/default.asp
+ \externalpage https://www.w3schools.com/jsref/default.asp
\title W3Schools JavaScript Reference
*/
/*!
\externalpage https://tc39.es/ecma262/#sec-date-objects
- \title {ECMAScript Specification of Date}
+ \title ECMAScript Specification of Date
*/
/*!
- \externalpage https://www.froglogic.com/squish/gui-testing
- \title Squish
-*/
-/*!
- \externalpage http://doc.qt.io/GammaRay
- \title GammaRay
-*/
-/*!
- \externalpage http://doc.qt.io/QtQmlLive
- \title QmlLive
+ \externalpage https://www.qt.io/product/testing-tools#squish
+ \title Squish GUI Test Automation Tool
*/
/*!
- \externalpage http://doc.qt.io/qtcreator/creator-debugging-qml.html
- \title QML Debugger
+ \externalpage https://doc.qt.io/GammaRay
+ \title GammaRay Manual
*/
/*!
- \externalpage http://doc.qt.io/qtcreator/creator-qml-performance-monitor.html
- \title QML Profiler
+ \externalpage https://doc.qt.io/QtQmlLive
+ \title QmlLive Manual
*/
/*!
- \externalpage http://doc.qt.io/qtcreator/index.html
- \title Qt Creator Manual
+ \externalpage https://doc.qt.io/qtcreator/creator-debugging-qml.html
+ \title Qt Creator: QML Debugger
*/
/*!
- \externalpage https://doc.qt.io/qtcreator/creator-project-creating.html#creating-resource-files
- \title Creating Resource Files
+ \externalpage https://doc.qt.io/qtcreator/creator-qml-performance-monitor.html
+ \title Qt Creator: QML Profiler
*/
/*!
\externalpage https://fontawesome.com/
diff --git a/src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc b/src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc
index 9d1ff64f81..39f01bf9aa 100644
--- a/src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc
+++ b/src/quick/doc/src/guidelines/qtquick-toolsnutilities.qdoc
@@ -43,60 +43,60 @@ debugging features for Qt Quick make working with Qt Quick easier.
\section1 Qt Design Studio
-\l{Qt Design Studio} enables designing Qt Quick-based UIs using simple
-drag-n-drop gestures that most designers are familiar with. It offers UI
-elements from the Qt Quick and Qt Quick Controls modules, as well as
-integration for custom UI elements.
+\l{Qt Design Studio Manual}{Qt Design Studio} enables designing Qt Quick-based
+UIs using simple drag-n-drop gestures that most designers are familiar with.
+It offers UI elements from the Qt Quick and Qt Quick Controls modules, as well
+as integration for custom UI elements.
\section1 QML Debugger
-The \l{QML debugger} is a very useful utility that enables:
+The \l{Qt Creator: QML Debugger}{QML Debugger} is a very useful utility that
+enables:
\list
\li debugging JavaScript functions,
\li executing JavaScript expressions,
\li and inspecting QML properties.
\endlist
-The QML debugger is part of both \l{Qt Creator} and \l{Qt Design Studio}.
+The QML debugger is part of both \e{Qt Creator} and \e{Qt Design Studio}.
\section1 QML Profiler
-The \l{QML profiler} enables you to get necessary diagnostic information,
-allowing you to analyze the application code for performance issues. For
-example, too much JavaScript in each frame, long-running C++ functions, and
-so on.
+The \l{Qt Creator: QML Profiler}{QML Profiler} enables you to get necessary
+diagnostic information, allowing you to analyze the application code for
+performance issues. For example, too much JavaScript in each frame,
+long-running C++ functions, and so on.
-The profiler is part of both \l{Qt Creator} and \l{Qt Design Studio}.
+The profiler is part of both \e{Qt Creator} and \e{Qt Design Studio}.
\section1 QmlLive
-\l{QmlLive} is a 3rd party tool that offers a QML runtime capable of rendering
-changes to the code in realtime. It avoids the need to rebuild the
-application after every code change and install it on the target device.
-You can also extend it to build a custom runtime that suits your needs.
+\l{QmlLive Manual}{QmlLive} is a 3rd party tool that offers a QML runtime
+capable of rendering changes to the code in realtime. It avoids the need to
+rebuild the application after every code change and install it on the target
+device. You can also extend it to build a custom runtime that suits your needs.
\section1 GammaRay
-\l{GammaRay} is a useful utility that provides diagnostic information
-about your application. It is similar to the QML Profiler described in the
-earlier section, but offers a lot more. For example, the number of items or
-QObjects created, function calls made, time taken by each function call,
+\l{GammaRay Manual}{GammaRay} is a useful utility that provides diagnostic
+information about your application. It is similar to the QML Profiler described
+in the earlier section, but offers a lot more. For example, the number of items
+or QObjects created, function calls made, time taken by each function call,
property value introspection at runtime, and so on. Such information is very
handy, especially while debugging QML applications.
\section1 Squish
-\l{Squish} is a well-known testing tool that automates UI testing by recording
-your actions or running scripts. Once the tests are setup, UI tests are a lot
-easier to run.
+\l{Squish GUI Test Automation Tool}{Squish} is a well-known testing tool that
+automates UI testing by recording your actions or running scripts. Once the
+tests are setup, UI tests are a lot easier to run.
\section1 qmllint
-\l{qmllint} is a tool shipped with Qt, that verifies the syntatic validity of QML files.
-It also warns about some QML anti-patterns. If you want to disable a specific
-warning type, you can find the appropriate flag for doing so by passing \c{--help} on the command line.
-
-See the full documentation page of \l{qmllint} for details.
+\l{qtquick-tool-qmllint.html}{qmllint} is a tool shipped with Qt, that verifies
+the syntatic validity of QML files. It also warns about some QML anti-patterns.
+If you want to disable a specific warning type, you can find the appropriate
+flag for doing so by passing \c{--help} on the command line.
\section1 qmlformat