diff options
| author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2019-03-29 16:29:15 +0100 |
|---|---|---|
| committer | Kai Koehne <kai.koehne@qt.io> | 2019-04-01 11:53:57 +0000 |
| commit | f564d58dcdc614f94d2fc3147f24537c35a1317e (patch) | |
| tree | e147383af7a2e64bb8b6fc826910019ef95a9764 /src/webengine/api | |
| parent | d3c11cb4ac32f87d485e4f6bd88afdc93e9ecd16 (diff) | |
Doc: Avoid auto-linking the string 'WebEngine' to the QML type
Remove the previous workaround (internal \externalpage command) that
was used for this purpose, and replace it with a \QWE macro that
expands to the string 'Qt \WebEngine'. The backslash in the expanded
string instructs QDoc not to attempt auto-linking the word.
Change-Id: If4e1c95423fa07479b1af055e4760a890c0ac667
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/webengine/api')
| -rw-r--r-- | src/webengine/api/qquickwebenginedownloaditem.cpp | 4 | ||||
| -rw-r--r-- | src/webengine/api/qquickwebengineloadrequest.cpp | 2 | ||||
| -rw-r--r-- | src/webengine/api/qtwebengineglobal.cpp | 4 |
3 files changed, 5 insertions, 5 deletions
diff --git a/src/webengine/api/qquickwebenginedownloaditem.cpp b/src/webengine/api/qquickwebenginedownloaditem.cpp index 981d11633..cdb95fa53 100644 --- a/src/webengine/api/qquickwebenginedownloaditem.cpp +++ b/src/webengine/api/qquickwebenginedownloaditem.cpp @@ -135,7 +135,7 @@ QQuickWebEngineDownloadItemPrivate::~QQuickWebEngineDownloadItemPrivate() \l{WebEngineProfile::downloadRequested}{downloadRequested} signal together with a newly created WebEngineDownloadItem. The application can then examine this item and decide whether to accept it or not. A signal handler must - explicitly call accept() on the item for Qt WebEngine to actually start + explicitly call accept() on the item for \QWE to actually start downloading and writing data to disk. If no signal handler calls accept(), then the download request will be automatically rejected and nothing will be written to disk. @@ -154,7 +154,7 @@ QQuickWebEngineDownloadItemPrivate::~QQuickWebEngineDownloadItemPrivate() \section2 Web Page Downloads In addition to normal file downloads, which consist simply of retrieving - some raw bytes from the network and writing them to disk, Qt WebEngine also + some raw bytes from the network and writing them to disk, \QWE also supports saving complete web pages, which involves parsing the page's HTML, downloading any dependent resources, and potentially packaging everything into a special file format (\l savePageFormat). To check if a download is diff --git a/src/webengine/api/qquickwebengineloadrequest.cpp b/src/webengine/api/qquickwebengineloadrequest.cpp index b3422c516..5ad99ea2e 100644 --- a/src/webengine/api/qquickwebengineloadrequest.cpp +++ b/src/webengine/api/qquickwebengineloadrequest.cpp @@ -127,7 +127,7 @@ QString QQuickWebEngineLoadRequest::errorString() const \value WebEngineView.NoErrorDomain Error type is not known. \value WebEngineView.InternalErrorDomain - Content cannot be interpreted by Qt WebEngine. + Content cannot be interpreted by \QWE. \value WebEngineView.ConnectionErrorDomain Error results from a faulty network connection. \value WebEngineView.CertificateErrorDomain diff --git a/src/webengine/api/qtwebengineglobal.cpp b/src/webengine/api/qtwebengineglobal.cpp index d181f44aa..a11618dba 100644 --- a/src/webengine/api/qtwebengineglobal.cpp +++ b/src/webengine/api/qtwebengineglobal.cpp @@ -54,9 +54,9 @@ namespace QtWebEngine { \ingroup qtwebengine-namespaces \keyword QtWebEngine Namespace - \brief Helper functions for the Qt WebEngine (Qt Quick) module. + \brief Helper functions for the \QWE (Qt Quick) module. - The \l[CPP]{QtWebEngine} namespace is part of the Qt WebEngine module. + The \l[CPP]{QtWebEngine} namespace is part of the \QWE module. */ /*! |