diff options
author | Topi Reinio <topi.reinio@qt.io> | 2021-06-30 14:04:31 +0200 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-07-07 15:21:28 +0000 |
commit | a864df85a9e46c5dcd7a03a444d3b8a7717946f7 (patch) | |
tree | 0c70ac6ece86802a0ad3bc42f7f2bd51edd84eee /examples/webenginewidgets/simplebrowser | |
parent | bbab484dc45ae2391065d07e1f68027bb53e44d9 (diff) |
Doc: Fix documentation issues for Qt WebEngine
API and documentation changes since 5.15 caused multiple warnings from
QDoc; this change addresses most of them. Some warnings indicate
missing documentation, those issues still remain.
Change-Id: I96be38b7daac37a7e35c149b4b3ec3f18c4415c9
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
(cherry picked from commit c248844b3b8ee004800606d1a6c6e6d6bee31738)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'examples/webenginewidgets/simplebrowser')
-rw-r--r-- | examples/webenginewidgets/simplebrowser/doc/src/simplebrowser.qdoc | 24 |
1 files changed, 14 insertions, 10 deletions
diff --git a/examples/webenginewidgets/simplebrowser/doc/src/simplebrowser.qdoc b/examples/webenginewidgets/simplebrowser/doc/src/simplebrowser.qdoc index 905fc3244..2e68df337 100644 --- a/examples/webenginewidgets/simplebrowser/doc/src/simplebrowser.qdoc +++ b/examples/webenginewidgets/simplebrowser/doc/src/simplebrowser.qdoc @@ -197,22 +197,26 @@ \printuntil menu->popup \printline } - \section1 Implementing WebPage Functionality + \section1 Implementing WebPage and WebView Functionality - We implement \c WebPage as a subclass of QWebEnginePage to enable HTTP, - proxy authentication, and ignoring SSL certificate errors when accessing web - pages: + We implement \c WebPage as a subclass of QWebEnginePage and \c WebView as + as subclass of QWebEngineView to enable HTTP, proxy authentication, as well + as ignoring SSL certificate errors when accessing web pages: \quotefromfile webenginewidgets/simplebrowser/webpage.h \skipto WebPage : \printuntil } + \quotefromfile webenginewidgets/simplebrowser/webview.h + \skipto WebView : + \printuntil } + In all the cases above, we display the appropriate dialog to the user. In case of authentication, we need to set the correct credential values on the QAuthenticator object: - \quotefromfile webenginewidgets/simplebrowser/webpage.cpp - \skipto WebPage::handleAuthenticationRequired( + \quotefromfile webenginewidgets/simplebrowser/webview.cpp + \skipto WebView::handleAuthenticationRequired( \printuntil } \printuntil } \printline } @@ -281,8 +285,8 @@ \skipto private: \printline private: \dots - \skipto m_otrProfile - \printline m_otrProfile + \skipto m_profile + \printline m_profile \printline /^\};$/ Required profile for \e{private browsing} is created together with its @@ -292,7 +296,7 @@ \quotefromfile webenginewidgets/simplebrowser/browser.cpp \skipto Browser::createWindow - \printuntil m_otrProfile.reset + \printuntil m_profile.reset \dots All that is left to do is to pass the appropriate profile down to the @@ -302,7 +306,7 @@ \e{off-the-record} profile instance: \dots - \skipto m_otrProfile.get + \skipto m_profile.get \printuntil mainWindow = new BrowserWindow \skipto return mainWindow \printuntil /^\}/ |