diff options
author | Topi Reinio <topi.reinio@qt.io> | 2019-11-09 00:44:37 +0100 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2019-11-20 14:55:12 +0100 |
commit | aca2a6df402d6454c7bbe8b0e9816645fcec8342 (patch) | |
tree | 5c5c20e19cbdc4a82227f33bacdcd0da0585753b | |
parent | ce72a40e91095dd5e1e46713fb94de493ee48d39 (diff) |
Doc: Fix documentation warnings
Remove links to example files, as QDoc no longer treats them as linkable
targets.
Fix linking to WebEngineView.selectClientCertificate().
Fix missing parameter documentation in WebEngineView.tooltipRequested().
Fixes: QTBUG-79815
Change-Id: I9090d3cfb1b698a545ae54a7426bb0a4eef892e9
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
4 files changed, 7 insertions, 8 deletions
diff --git a/examples/webengine/customdialogs/doc/src/customdialogs.qdoc b/examples/webengine/customdialogs/doc/src/customdialogs.qdoc index 6319ce53b..16eab0b6c 100644 --- a/examples/webengine/customdialogs/doc/src/customdialogs.qdoc +++ b/examples/webengine/customdialogs/doc/src/customdialogs.qdoc @@ -57,11 +57,10 @@ \section1 Triggering Dialogs - As mentioned, the \l {webengine/customdialogs/index.html}{index.html} file - is responsible for triggering the dialogs from the side of HTML and - JavaScript. Additionally, the example program starts a localhost TCP server - returning the mocked HTTP responses needed to trigger proxy and HTTP - authentication dialogs. + As mentioned, the \c index.html file is responsible for triggering the + dialogs from the side of HTML and JavaScript. Additionally, the example + program starts a localhost TCP server returning the mocked HTTP responses + needed to trigger proxy and HTTP authentication dialogs. \section1 Custom Dialogs diff --git a/examples/webenginewidgets/videoplayer/doc/src/videoplayer.qdoc b/examples/webenginewidgets/videoplayer/doc/src/videoplayer.qdoc index 5c455345b..256a69baf 100644 --- a/examples/webenginewidgets/videoplayer/doc/src/videoplayer.qdoc +++ b/examples/webenginewidgets/videoplayer/doc/src/videoplayer.qdoc @@ -113,7 +113,7 @@ request will be denied. Finally, we load some HTML (see - \l{webenginewidgets/videoplayer/data/index.html}{index.html} included with + \c webenginewidgets/videoplayer/data/index.html included with the example) into our \l QWebEngineView: \printline load diff --git a/src/webengine/doc/src/qtwebengine-features.qdoc b/src/webengine/doc/src/qtwebengine-features.qdoc index d761e910c..954992de1 100644 --- a/src/webengine/doc/src/qtwebengine-features.qdoc +++ b/src/webengine/doc/src/qtwebengine-features.qdoc @@ -129,7 +129,7 @@ To activate support for client certificates, an application needs to listen to the QWebEnginePage::selectClientCertificate or - \l{WebEnginePage::selectClientCertificate}{WebEnginePage.selectClientCertificate} + \l{WebEngineView::selectClientCertificate}{WebEngineView.selectClientCertificate} signals and select one of the offered certificates. For applications that can navigate to untrusted web sites, it is recommended to always give the user a choice before uniquely identifying them diff --git a/src/webengine/doc/src/webengineview_lgpl.qdoc b/src/webengine/doc/src/webengineview_lgpl.qdoc index df956f03e..6e349dfb3 100644 --- a/src/webengine/doc/src/webengineview_lgpl.qdoc +++ b/src/webengine/doc/src/webengineview_lgpl.qdoc @@ -1520,7 +1520,7 @@ \qmlsignal WebEngineView::tooltipRequested(TooltipRequest request) \since QtWebEngine 1.10 - This signal is emitted when the web page wants to show a tooltip at + This signal is emitted when the web page sends a \a request to show a tooltip at a specified position. \note Signal handlers need to call \c{request.accepted = true} to prevent a default tooltip from showing up. |