summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2022-06-30 14:18:28 +0200
committerTopi Reinio <topi.reinio@qt.io>2022-07-05 23:36:42 +0200
commit5797071594d1081cddb30386a94196c839d90064 (patch)
tree337eec9fb50042601341d3e1b77aabcb463275d5
parent8be487992f9bb4c67e308f87c5d25836d630a071 (diff)
downloadqtwebengine-5797071594d1081cddb30386a94196c839d90064.tar.gz
Doc: Fix linking issues on Qt PDF documentation
These warnings were not captured by the documentation testing in CI. Fix or remove links to properties from inherited QML types, and remove \sa entries that are already linked to in the documentation. Fix incorrect \inqmlmodule argument for PdfPageImage. Pick-to: 6.4 Change-Id: If2c14d468a6dc3cd464ca4de1f4e39ad48d4d326 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
-rw-r--r--src/pdf/doc/qtpdf.qdocconf3
-rw-r--r--src/pdfquick/PdfMultiPageView.qml10
-rw-r--r--src/pdfquick/PdfPageView.qml14
-rw-r--r--src/pdfquick/PdfScrollablePageView.qml12
-rw-r--r--src/pdfquick/qquickpdfpageimage.cpp2
5 files changed, 13 insertions, 28 deletions
diff --git a/src/pdf/doc/qtpdf.qdocconf b/src/pdf/doc/qtpdf.qdocconf
index 34f495a9d..aa97d8090 100644
--- a/src/pdf/doc/qtpdf.qdocconf
+++ b/src/pdf/doc/qtpdf.qdocconf
@@ -39,7 +39,8 @@ depends += qtcore \
qtdesigner \
qtquick \
qtquickcontrols \
- qtcmake
+ qtcmake \
+ qtsvg
headerdirs += ../ \
../../pdfwidgets
diff --git a/src/pdfquick/PdfMultiPageView.qml b/src/pdfquick/PdfMultiPageView.qml
index 309088085..6b9cf329d 100644
--- a/src/pdfquick/PdfMultiPageView.qml
+++ b/src/pdfquick/PdfMultiPageView.qml
@@ -172,8 +172,6 @@ Item {
This property holds the \l {QtQuick::Image::status}{rendering status} of
the \l {currentPage}{current page}.
-
- \sa PdfPageImage::status
*/
property int currentPageRenderingStatus: Image.Null
@@ -185,8 +183,6 @@ Item {
This property holds the ratio of pixels to points. The default is \c 1,
meaning one point (1/72 of an inch) equals 1 logical pixel.
-
- \sa PdfPageImage::status
*/
property real renderScale: 1
@@ -197,8 +193,6 @@ Item {
The default value is \c 0 degrees (that is, no rotation relative to the
orientation of the pages as stored in the PDF file).
-
- \sa PdfPageImage::rotation
*/
property real pageRotation: 0
@@ -264,8 +258,8 @@ Item {
\qmlproperty string PdfMultiPageView::searchString
This property holds the search string that the user may choose to search
- for. It is typically used in a binding to the
- \l {QtQuick.Controls::TextField::text}{text} property of a TextField.
+ for. It is typically used in a binding to the \c text property of a
+ TextField.
\sa searchModel
*/
diff --git a/src/pdfquick/PdfPageView.qml b/src/pdfquick/PdfPageView.qml
index bb9f01b0e..8e99ead7e 100644
--- a/src/pdfquick/PdfPageView.qml
+++ b/src/pdfquick/PdfPageView.qml
@@ -37,8 +37,6 @@ Rectangle {
This property holds the \l {QtQuick::Image::status}{rendering status} of
the \l {currentPage}{current page}.
-
- \sa PdfPageImage::status
*/
property alias status: image.status
@@ -177,8 +175,6 @@ Rectangle {
This property holds the ratio of pixels to points. The default is \c 1,
meaning one point (1/72 of an inch) equals 1 logical pixel.
-
- \sa PdfPageImage::status
*/
property real renderScale: 1
@@ -187,7 +183,7 @@ Rectangle {
This property holds the scaled width and height of the full-frame image.
- \sa PdfPageImage::sourceSize
+ \sa {QtQuick::Image::sourceSize}{Image.sourceSize}
*/
property alias sourceSize: image.sourceSize
@@ -224,8 +220,8 @@ Rectangle {
Sets \l renderScale such that the whole first page will fit into a viewport
with the given \a width and \a height. The resulting \l renderScale depends
- on \l pageRotation: the page will fit into the viewport at a larger size if
- it is first rotated to have a matching aspect ratio.
+ on page rotation: the page will fit into the viewport at a larger size if it
+ is first rotated to have a matching aspect ratio.
*/
function scaleToPage(width, height) {
const windowAspect = width / height
@@ -269,8 +265,8 @@ Rectangle {
\qmlproperty string PdfPageView::searchString
This property holds the search string that the user may choose to search
- for. It is typically used in a binding to the
- \l {QtQuick.Controls::TextField::text}{text} property of a TextField.
+ for. It is typically used in a binding to the \c text property of a
+ TextField.
\sa searchModel
*/
diff --git a/src/pdfquick/PdfScrollablePageView.qml b/src/pdfquick/PdfScrollablePageView.qml
index b0d8fa8b8..7d3a411a8 100644
--- a/src/pdfquick/PdfScrollablePageView.qml
+++ b/src/pdfquick/PdfScrollablePageView.qml
@@ -39,8 +39,6 @@ Flickable {
This property holds the \l {QtQuick::Image::status}{rendering status} of
the \l {currentPage}{current page}.
-
- \sa PdfPageImage::status
*/
property alias status: image.status
@@ -173,8 +171,6 @@ Flickable {
This property holds the ratio of pixels to points. The default is \c 1,
meaning one point (1/72 of an inch) equals 1 logical pixel.
-
- \sa PdfPageImage::status
*/
property real renderScale: 1
@@ -185,8 +181,6 @@ Flickable {
The default value is \c 0 degrees (that is, no rotation relative to the
orientation of the pages as stored in the PDF file).
-
- \sa PdfPageImage::rotation
*/
property real pageRotation: 0
@@ -195,7 +189,7 @@ Flickable {
This property holds the scaled width and height of the full-frame image.
- \sa PdfPageImage::sourceSize
+ \sa {QtQuick::Image::sourceSize}{Image.sourceSize}
*/
property alias sourceSize: image.sourceSize
@@ -259,8 +253,8 @@ Flickable {
\qmlproperty string PdfScrollablePageView::searchString
This property holds the search string that the user may choose to search
- for. It is typically used in a binding to the
- \l {QtQuick.Controls::TextField::text}{text} property of a TextField.
+ for. It is typically used in a binding to the \c text property of a
+ TextField.
\sa searchModel
*/
diff --git a/src/pdfquick/qquickpdfpageimage.cpp b/src/pdfquick/qquickpdfpageimage.cpp
index e002e9498..2ea8ebc12 100644
--- a/src/pdfquick/qquickpdfpageimage.cpp
+++ b/src/pdfquick/qquickpdfpageimage.cpp
@@ -13,7 +13,7 @@ Q_LOGGING_CATEGORY(qLcImg, "qt.pdf.image")
/*!
\qmltype PdfPageImage
//! \instantiates QQuickPdfPageImage
- \inqmlmodule QtPdf
+ \inqmlmodule QtQuick.Pdf
\ingroup pdf
\inherits Image
\brief Displays one page from a PDF document.