Doc: Fix qdoc warnings and enable zero warning limit

Change-Id: Ifa2914e7bca9c224670a1891785d0ba8262cd61b
Reviewed-by: Paul Wicking <paul.wicking@qt.io>

16 files changed, 77 insertions, 56 deletions

diff --git a/coin/module_config.yaml b/coin/module_config.yaml
index 741558a5a..e60412517 100644
--- a/coin/module_config.yaml
+++ b/coin/module_config.yaml
@@ -22,3 +22,4 @@ instructions:
         property: target.osVersion
         equals_value: QEMU
     - !include "{{qt/qtbase}}/coin_module_test_template_v3.yaml"
+    - !include "{{qt/qtbase}}/coin_module_test_docs.yaml"
diff --git a/examples/pdfwidgets/pdfviewer/doc/src/pdfviewer.qdoc b/examples/pdfwidgets/pdfviewer/doc/src/pdfviewer.qdoc
index 8024c0a51..0cdd671be 100644
--- a/examples/pdfwidgets/pdfviewer/doc/src/pdfviewer.qdoc
+++ b/examples/pdfwidgets/pdfviewer/doc/src/pdfviewer.qdoc
@@ -26,13 +26,15 @@
 ****************************************************************************/
 
 /*!
-    \example pdfwidgets/pdfviewer
+    \example pdfviewer
     \ingroup qtpdf-examples
 
     \title PDF Viewer Example
     \brief Renders PDF documents.
 
+    \omit
     //! TODO add thumbnail \image pdfviewer.png
+    \endomit
 
     \e {PDF Viewer} demonstrates how to use the QPdfDocument class to render
     PDF documents and the QPdfPageNavigation class to navigate them.
@@ -49,8 +51,8 @@
 
     The MainWindow class inherits the QMainWindow class:
 
-    \quotefromfile pdfwidgets/pdfviewer/mainwindow.h
-    \skipto public QMainWindow
+    \quotefromfile pdfviewer/mainwindow.h
+    \skipto public
     \printuntil ~MainWindow()
 
     The class declares public and private slots that match the actions of the
@@ -73,8 +75,8 @@
     The actual setup of the different objects is done in the MainWindow
     constructor:
 
-    \quotefromfile pdfwidgets/pdfviewer/mainwindow.cpp
-    \skipto MainWindow::
+    \quotefromfile pdfviewer/mainwindow.cpp
+    \skipto MainWindow
     \printuntil {
 
     The constructor first calls \c setupUi() to construct the zoom and page
diff --git a/src/core/doc/qtwebengine.qdocconf b/src/core/doc/qtwebengine.qdocconf
index 6a3bd9ca7..fa1c63676 100644
--- a/src/core/doc/qtwebengine.qdocconf
+++ b/src/core/doc/qtwebengine.qdocconf
@@ -33,9 +33,6 @@ qhp.QtWebEngine.subprojects.examples.sortPages = true
 manifestmeta.highlighted.names += "QtWebEngine/WebEngine Widgets Simple Browser Example" \
                 "QtWebEngine/WebEngine Quick Nano Browser"
 
-# add a generic thumbnail for an example that has no \image in its doc
-manifestmeta.thumbnail.names = "QtWebEngine/PDF Viewer Example"
-
 tagfile                 = ../../../doc/qtwebengine/qtwebengine.tags
 
 # Custom module header for clang that pulls in also QtWebEngineWidgets
@@ -77,6 +74,10 @@ exampledirs +=  ../../../examples \
                 ../../webenginequick/doc/snippets \
                 ../../webenginewidgets/doc/snippets
 
+#exclude Qt PDF example directories
+excludedirs += ../../../examples/pdfwidgets \
+               ../../../examples/pdf
+
 examples.fileextensions += *.aff *.dic *.html
 
 imagedirs += \
@@ -89,3 +90,6 @@ navigation.qmltypespage = "Qt WebEngine QML Types"
 
 # \QWE macro expands to 'Qt WebEngine' without auto-linking anywhere.
 macro.QWE    = "Qt \\WebEngine"
+
+# Fail the documentation build if there are more warnings than the limit
+warninglimit = 0
diff --git a/src/core/doc/src/qtwebengine-features.qdoc b/src/core/doc/src/qtwebengine-features.qdoc
index 2a52f8772..3b34ffbf6 100644
--- a/src/core/doc/src/qtwebengine-features.qdoc
+++ b/src/core/doc/src/qtwebengine-features.qdoc
@@ -220,12 +220,12 @@
 
     \section1 HTML5 Geolocation
 
-    \QWE supports JavaScript Geolocation API with \l {Qt Location} as a
+    \QWE supports JavaScript Geolocation API with \l {Qt Positioning} as a
     backend. The application has to explicitly allow the feature by using
     QWebEnginePage::Geolocation or \l{WebEngineView::Feature}
     {WebEngineView.Feature}.
 
-    If Qt Location has been built before \QWE then this feature can be
+    If Qt Positioning has been built before \QWE then this feature can be
     tested by using \l{WebEngine Widgets Maps Example}{Maps} and allowing it to
     find the current position of the user. Note that on Windows an external GPS
     receiver must be connected to the application. For more information, see
diff --git a/src/pdf/doc/qtpdf.qdocconf b/src/pdf/doc/qtpdf.qdocconf
index eafa0726d..75d41af1d 100644
--- a/src/pdf/doc/qtpdf.qdocconf
+++ b/src/pdf/doc/qtpdf.qdocconf
@@ -38,17 +38,22 @@ depends += qtcore \
            qtquick \
            qtcmake
 
-headerdirs  += ../api \
-               ../quick
+headerdirs  += ../
 
-sourcedirs  += .. \
-               ../quick
+sourcedirs  += ../ \
+               ../../pdfquick
 
 exampledirs += ../../../examples/pdfwidgets \
                snippets/
 
+# add a generic thumbnail for an example that has no \image in its doc
+manifestmeta.thumbnail.names = "QtPdf/PDF Viewer Example"
+
 imagedirs   += images
 
 navigation.landingpage = "Qt PDF"
 navigation.cppclassespage = "Qt PDF C++ Classes"
-navigation.qmltypespage = "Qt WebEngine QML Types"
+navigation.qmltypespage = "Qt Quick PDF QML Types"
+
+# Fail the documentation build if there are more warnings than the limit
+warninglimit = 0
diff --git a/src/pdf/doc/src/qtpdf-index.qdoc b/src/pdf/doc/src/qtpdf-index.qdoc
index b32787eb5..423a46873 100644
--- a/src/pdf/doc/src/qtpdf-index.qdoc
+++ b/src/pdf/doc/src/qtpdf-index.qdoc
@@ -55,12 +55,6 @@
 
     \snippet qtpdf_build_snippet.qdoc 0
 
-    \section1 Articles and Guides
-
-    \list
-        \li \l{Qt PDF Overview}
-    \endlist
-
     \section1 Examples
 
     \list
diff --git a/src/pdf/qpdfdocument.cpp b/src/pdf/qpdfdocument.cpp
index 8fd55dd57..dffc1e117 100644
--- a/src/pdf/qpdfdocument.cpp
+++ b/src/pdf/qpdfdocument.cpp
@@ -836,7 +836,7 @@ QPdfSelection QPdfDocument::getSelection(int page, QPointF start, QPointF end)
 
 /*!
     Returns information about the text on the given \a page that can be found
-    beginning at the given \a startIndex with at most \l maxLength characters.
+    beginning at the given \a startIndex with at most \a maxLength characters.
 */
 QPdfSelection QPdfDocument::getSelectionAtIndex(int page, int startIndex, int maxLength)
 {
diff --git a/src/pdf/qpdfdocumentrenderoptions.qdoc b/src/pdf/qpdfdocumentrenderoptions.qdoc
index cc5083f9d..b8b506271 100644
--- a/src/pdf/qpdfdocumentrenderoptions.qdoc
+++ b/src/pdf/qpdfdocumentrenderoptions.qdoc
@@ -96,10 +96,10 @@ QT_BEGIN_NAMESPACE
 */
 
 /*!
-    \fn void QPdfDocumentRenderOptions::setScaledClipRect(QRect rect)
+    \fn void QPdfDocumentRenderOptions::setScaledClipRect(const QRect &r)
 
-    Sets the region \a rect to be clipped from the page after having been
-    scaled to \l scaledSize().
+    Sets the rectangle region (\a r) to be clipped from the page after having
+    been scaled to \l scaledSize().
 
     \sa scaledClipRect()
 */
@@ -107,15 +107,15 @@ QT_BEGIN_NAMESPACE
 /*!
     \fn QRect QPdfDocumentRenderOptions::scaledSize() const
 
-    Returns the \a size of the page to be rendered, in pixels.
+    Returns the size of the page to be rendered, in pixels.
 
     \sa setScaledSize()
 */
 
 /*!
-    \fn void QPdfDocumentRenderOptions::setScaledSize(QSize size)
+    \fn void QPdfDocumentRenderOptions::setScaledSize(const QSize &s)
 
-    Sets the \a size of the page to be rendered, in pixels.
+    Sets the size (\a s) of the page to be rendered, in pixels.
 
     \sa scaledSize()
 */
diff --git a/src/pdf/qpdfselection.cpp b/src/pdf/qpdfselection.cpp
index b8ad02969..2b263f444 100644
--- a/src/pdf/qpdfselection.cpp
+++ b/src/pdf/qpdfselection.cpp
@@ -135,7 +135,7 @@ QString QPdfSelection::text() const
 }
 
 /*!
-    \property rect QPdfSelection::boundingRectangle
+    \property QPdfSelection::boundingRectangle
 
     This property holds the overall bounding rectangle (convex hull) around \l bounds.
 */
@@ -145,7 +145,7 @@ QRectF QPdfSelection::boundingRectangle() const
 }
 
 /*!
-    \property int QPdfSelection::startIndex
+    \property QPdfSelection::startIndex
 
     This property holds the index at the beginning of \l text within the full text on the page.
 */
@@ -155,7 +155,7 @@ int QPdfSelection::startIndex() const
 }
 
 /*!
-    \property int QPdfSelection::endIndex
+    \property QPdfSelection::endIndex
 
     This property holds the index at the end of \l text within the full text on the page.
 */
@@ -166,7 +166,8 @@ int QPdfSelection::endIndex() const
 
 #if QT_CONFIG(clipboard)
 /*!
-    Copies \l text to the \l {QGuiApplication::clipboard()}{system clipboard}.
+    Copies \l text to the \l {QGuiApplication::clipboard()}{system clipboard}
+    depending on the \a mode selected.
 */
 void QPdfSelection::copyToClipboard(QClipboard::Mode mode) const
 {
diff --git a/src/pdfquick/qquickpdfdocument.cpp b/src/pdfquick/qquickpdfdocument.cpp
index 79b23ca84..e2142a707 100644
--- a/src/pdfquick/qquickpdfdocument.cpp
+++ b/src/pdfquick/qquickpdfdocument.cpp
@@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE
 
 /*!
     \qmltype PdfDocument
-    \instantiates QQuickPdfDocument
+//!    \instantiates QQuickPdfDocument
     \inqmlmodule QtQuick.Pdf
     \ingroup pdf
     \brief A representation of a PDF document.
@@ -54,7 +54,7 @@ QT_BEGIN_NAMESPACE
     \l Image with source set to the URL of the PDF.
 */
 
-/*!
+/*
     Constructs a PDF document.
 */
 QQuickPdfDocument::QQuickPdfDocument(QObject *parent)
diff --git a/src/pdfquick/qquickpdflinkmodel.cpp b/src/pdfquick/qquickpdflinkmodel.cpp
index 4f3958337..68a05663d 100644
--- a/src/pdfquick/qquickpdflinkmodel.cpp
+++ b/src/pdfquick/qquickpdflinkmodel.cpp
@@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE
 
 /*!
     \qmltype PdfLinkModel
-    \instantiates QQuickPdfLinkModel
+//!    \instantiates QQuickPdfLinkModel
     \inqmlmodule QtQuick.Pdf
     \ingroup pdf
     \brief A representation of links within a PDF document.
@@ -95,7 +95,7 @@ QT_BEGIN_NAMESPACE
     \endqml
 
     \note General-purpose PDF viewing capabilities are provided by
-    \l PdfScrollablePageView and \l PdfMultiPageView. PdfLinkModel is only needed
+    \c PdfScrollablePageView and \c PdfMultiPageView. PdfLinkModel is only needed
     when building PDF view components from scratch.
 */
 
diff --git a/src/pdfquick/qquickpdfnavigationstack.cpp b/src/pdfquick/qquickpdfnavigationstack.cpp
index e41e43ed5..b1554b989 100644
--- a/src/pdfquick/qquickpdfnavigationstack.cpp
+++ b/src/pdfquick/qquickpdfnavigationstack.cpp
@@ -43,7 +43,7 @@ Q_LOGGING_CATEGORY(qLcNav, "qt.pdf.navigationstack")
 
 /*!
     \qmltype PdfNavigationStack
-    \instantiates QQuickPdfNavigationStack
+//!    \instantiates QQuickPdfNavigationStack
     \inqmlmodule QtQuick.Pdf
     \ingroup pdf
     \brief History of the destinations visited within a PDF Document.
@@ -164,13 +164,13 @@ qreal QQuickPdfNavigationStack::currentZoom() const
 }
 
 /*!
-    \qmlmethod void PdfNavigationStack::push(int page, point location, qreal zoom)
+    \qmlmethod void PdfNavigationStack::push(int page, point location, qreal zoom, bool emitJumped)
 
-    Adds the given destination, consisting of \a page, \a location and \a zoom,
+    Adds the given destination, consisting of \a page, \a location, and \a zoom,
     to the history of visited locations.  If \a emitJumped is \c false, the
     \l jumped() signal will not be emitted.
 
-    If forwardAvailable is \c true, calling this function represents a branch
+    If forwardAvailable() is \c true, calling this function represents a branch
     in the timeline which causes the "future" to be lost, and therefore
     forwardAvailable will change to \c false.
 */
@@ -252,11 +252,25 @@ void QQuickPdfNavigationStack::update(int page, QPointF location, qreal zoom)
         }();
 }
 
+/*!
+    \qmlproperty bool PdfNavigationStack::backAvailable
+    \readonly
+
+    Holds \c true if a \e back destination is available in the history.
+*/
+
 bool QQuickPdfNavigationStack::backAvailable() const
 {
     return m_currentHistoryIndex > 0;
 }
 
+/*!
+    \qmlproperty bool PdfNavigationStack::forwardAvailable
+    \readonly
+
+    Holds \c true if a \e forward destination is available in the history.
+*/
+
 bool QQuickPdfNavigationStack::forwardAvailable() const
 {
     return m_currentHistoryIndex < m_pageHistory.count() - 1;
@@ -265,8 +279,10 @@ bool QQuickPdfNavigationStack::forwardAvailable() const
 /*!
     \qmlsignal PdfNavigationStack::jumped(int page, point location, qreal zoom)
 
-    This signal is emitted when forward(), back() or push() is called, but not
-    when update() is called.
+    This signal is emitted for the given \a page, \a location, and \a zoom,
+    It is emitted on calling forward(), back(), or push() only.
+
+    \note The signal is emitted on calling update().
 */
 
 QT_END_NAMESPACE
diff --git a/src/pdfquick/qquickpdfsearchmodel.cpp b/src/pdfquick/qquickpdfsearchmodel.cpp
index d91ca69f8..85003cd0d 100644
--- a/src/pdfquick/qquickpdfsearchmodel.cpp
+++ b/src/pdfquick/qquickpdfsearchmodel.cpp
@@ -43,7 +43,7 @@ Q_LOGGING_CATEGORY(qLcSearch, "qt.pdf.search")
 
 /*!
     \qmltype PdfSearchModel
-    \instantiates QQuickPdfSearchModel
+//!    \instantiates QQuickPdfSearchModel
     \inqmlmodule QtQuick.Pdf
     \ingroup pdf
     \brief A representation of text search results within a PDF Document.
@@ -178,11 +178,11 @@ QList<QPolygonF> QQuickPdfSearchModel::currentPageBoundingPolygons() const
 }
 
 /*!
-    \qmlfunction list<list<point>> PdfSearchModel::boundingPolygonsOnPage(int page)
+    \qmlmethod list<list<point>> PdfSearchModel::boundingPolygonsOnPage(int page)
 
     Returns a set of paths in a form that can be bound to the \c paths property of a
-    \l {QtQuick::PathMultiline}{PathMultiline} instance to render a batch of
-    rectangles around all the locations where search results are found:
+    \l {QtQuick::PathMultiline}{PathMultiline} instance, which is used to render a
+    batch of rectangles around all the matching locations on the \a page:
 
     \qml
     PdfDocument {
@@ -223,7 +223,8 @@ QList<QPolygonF> QQuickPdfSearchModel::boundingPolygonsOnPage(int page)
 /*!
     \qmlproperty int PdfSearchModel::currentPage
 
-    The page on which \l currentMatchGeometry should provide filtered search results.
+    The page on which \l currentResultBoundingPolygons should provide filtered
+    search results.
 */
 void QQuickPdfSearchModel::setCurrentPage(int currentPage)
 {
diff --git a/src/pdfquick/qquickpdfselection.cpp b/src/pdfquick/qquickpdfselection.cpp
index 54a13828a..48ff0d8bd 100644
--- a/src/pdfquick/qquickpdfselection.cpp
+++ b/src/pdfquick/qquickpdfselection.cpp
@@ -53,7 +53,7 @@ static const QRegularExpression WordDelimiter(QStringLiteral("\\s"));
 
 /*!
     \qmltype PdfSelection
-    \instantiates QQuickPdfSelection
+//!    \instantiates QQuickPdfSelection
     \inqmlmodule QtQuick.Pdf
     \ingroup pdf
     \brief A representation of a text selection within a PDF Document.
@@ -73,9 +73,6 @@ static const QRegularExpression WordDelimiter(QStringLiteral("\\s"));
     it must have keyboard focus.
 */
 
-/*!
-    Constructs a SearchModel.
-*/
 QQuickPdfSelection::QQuickPdfSelection(QQuickItem *parent)
     : QQuickItem(parent)
 {
diff --git a/src/pdfquick/qquicktableviewextra.cpp b/src/pdfquick/qquicktableviewextra.cpp
index 017764a95..6ce45967f 100644
--- a/src/pdfquick/qquicktableviewextra.cpp
+++ b/src/pdfquick/qquicktableviewextra.cpp
@@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE
 /*!
     \internal
     \qmltype TableViewExtra
-    \instantiates QQuickTableViewExtra
+//!    \instantiates QQuickTableViewExtra
     \inqmlmodule QtQuick.Pdf
     \ingroup pdf
     \brief A helper class with missing TableView functions
diff --git a/src/webenginequick/api/qquickwebenginetouchselectionmenurequest.cpp b/src/webenginequick/api/qquickwebenginetouchselectionmenurequest.cpp
index 21948727e..f406587d3 100644
--- a/src/webenginequick/api/qquickwebenginetouchselectionmenurequest.cpp
+++ b/src/webenginequick/api/qquickwebenginetouchselectionmenurequest.cpp
@@ -51,17 +51,19 @@ ASSERT_ENUMS_MATCH(QQuickWebEngineTouchSelectionMenuRequest::Paste,
                    QtWebEngineCore::TouchSelectionMenuController::TouchSelectionCommandFlag::Paste)
 
 /*!
-    \class QWebEngineTouchSelectionMenuRequest
+    \class QQuickWebEngineTouchSelectionMenuRequest
     \since 6.3
     \brief The QQuickWebEngineTouchSelectionMenuRequest class provides request for a touch selection menu.
     \inmodule QtWebEngineQuick
     QQuickWebEngineTouchSelectionMenuRequest is returned after a touch selection event,
     and contains information about where the bounding box of touch selection is and what
     actions are available.
+
+    \internal
 */
 
 /*!
-    \enum QWebEngineTouchSelectionMenuRequest::TouchSelectionCommandFlag
+    \enum QQuickWebEngineTouchSelectionMenuRequest::TouchSelectionCommandFlag
     \readonly
     \since 6.3
 
@@ -99,8 +101,6 @@ int QQuickWebEngineTouchSelectionMenuRequest::buttonCount()
 }
 
 /*!
-    \qmlproperty bool QQuickWebEngineTouchSelectionMenuRequest::accepted
-
     Indicates whether the touch selection menu request has been
     accepted by the signal handler.