diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2017-02-08 17:44:36 +0100 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2017-02-09 08:27:54 +0000 |
commit | 8b3815a88ad48f439df3188bd9c9138e8254b3c1 (patch) | |
tree | 2a7a78bb651cb791d69706dc87b630eb3c6e8fcd | |
parent | 9ff8eda0af657ad504318aebea5349b76fbb107a (diff) |
Doc: Fix \sa links in the docs
- Leave out the class name for the members of the class
- Add brackets in the end of method names
Change-Id: I5429be5620c5c192aa872d94ab047eebe39a13da
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
-rw-r--r-- | src/core/api/qwebengineurlrequestinfo.cpp | 8 | ||||
-rw-r--r-- | src/webengine/api/qquickwebengineprofile.cpp | 2 | ||||
-rw-r--r-- | src/webenginewidgets/api/qwebenginedownloaditem.cpp | 4 | ||||
-rw-r--r-- | src/webenginewidgets/api/qwebenginepage.cpp | 2 | ||||
-rw-r--r-- | src/webenginewidgets/api/qwebenginescript.cpp | 4 | ||||
-rw-r--r-- | src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc | 2 |
6 files changed, 11 insertions, 11 deletions
diff --git a/src/core/api/qwebengineurlrequestinfo.cpp b/src/core/api/qwebengineurlrequestinfo.cpp index a3806fc63..877b376b0 100644 --- a/src/core/api/qwebengineurlrequestinfo.cpp +++ b/src/core/api/qwebengineurlrequestinfo.cpp @@ -96,7 +96,7 @@ ASSERT_ENUMS_MATCH(QtWebEngineCore::WebContentsAdapterClient::OtherNavigation, Q interceptor on the profile enables intercepting, blocking, and modifying URL requests before they reach the networking stack of Chromium. - \sa QWebEngineUrlRequestInterceptor::interceptRequest, QWebEngineUrlRequestInfo + \sa interceptRequest(), QWebEngineUrlRequestInfo */ /*! @@ -115,7 +115,7 @@ ASSERT_ENUMS_MATCH(QtWebEngineCore::WebContentsAdapterClient::OtherNavigation, Q \a info contains the information about the URL request and will track internally whether its members have been altered. - \sa QWebEngineProfile::setRequestInterceptor + \sa QWebEngineProfile::setRequestInterceptor() */ @@ -183,7 +183,7 @@ QWebEngineUrlRequestInfo::QWebEngineUrlRequestInfo(QWebEngineUrlRequestInfoPriva /*! Returns the resource type of the request. - \sa QWebEngineUrlRequestInfo::ResourceType + \sa ResourceType */ QWebEngineUrlRequestInfo::ResourceType QWebEngineUrlRequestInfo::resourceType() const @@ -208,7 +208,7 @@ QWebEngineUrlRequestInfo::ResourceType QWebEngineUrlRequestInfo::resourceType() /*! Returns the navigation type of the request. - \sa QWebEngineUrlRequestInfo::NavigationType + \sa NavigationType */ QWebEngineUrlRequestInfo::NavigationType QWebEngineUrlRequestInfo::navigationType() const diff --git a/src/webengine/api/qquickwebengineprofile.cpp b/src/webengine/api/qquickwebengineprofile.cpp index 871428f33..35efcb3b4 100644 --- a/src/webengine/api/qquickwebengineprofile.cpp +++ b/src/webengine/api/qquickwebengineprofile.cpp @@ -302,7 +302,7 @@ QQuickWebEngineProfile::~QQuickWebEngineProfile() The storage name that is used to create separate subdirectories for each profile that uses the disk for storing persistent data and cache. - \sa QQuickWebEngineProfile::persistentStoragePath, QQuickWebEngineProfile::cachePath + \sa persistentStoragePath, cachePath */ QString QQuickWebEngineProfile::storageName() const diff --git a/src/webenginewidgets/api/qwebenginedownloaditem.cpp b/src/webenginewidgets/api/qwebenginedownloaditem.cpp index b777a0898..0bf02a7fc 100644 --- a/src/webenginewidgets/api/qwebenginedownloaditem.cpp +++ b/src/webenginewidgets/api/qwebenginedownloaditem.cpp @@ -179,7 +179,7 @@ quint32 QWebEngineDownloadItem::id() const This signal is emitted whenever the download's \a state changes. - \sa state(), QWebEngineDownloadItem::DownloadState + \sa state(), DownloadState */ /*! @@ -240,7 +240,7 @@ quint32 QWebEngineDownloadItem::id() const /*! Returns the download item's current state. - \sa QWebEngineDownloadItem::DownloadState + \sa DownloadState */ QWebEngineDownloadItem::DownloadState QWebEngineDownloadItem::state() const diff --git a/src/webenginewidgets/api/qwebenginepage.cpp b/src/webenginewidgets/api/qwebenginepage.cpp index 16e9438c9..abf91f5a4 100644 --- a/src/webenginewidgets/api/qwebenginepage.cpp +++ b/src/webenginewidgets/api/qwebenginepage.cpp @@ -823,7 +823,7 @@ QWebEngineSettings *QWebEnginePage::settings() const * that is exposed in the JavaScript context of this page as \c qt.webChannelTransport. * * \since 5.5 - * \sa setWebChannel + * \sa setWebChannel() */ QWebChannel *QWebEnginePage::webChannel() const { diff --git a/src/webenginewidgets/api/qwebenginescript.cpp b/src/webenginewidgets/api/qwebenginescript.cpp index 04a9d979a..d5247cde1 100644 --- a/src/webenginewidgets/api/qwebenginescript.cpp +++ b/src/webenginewidgets/api/qwebenginescript.cpp @@ -196,7 +196,7 @@ ASSERT_ENUMS_MATCH(QWebEngineScript::DocumentCreation, UserScript::DocumentEleme * Returns the point in the loading process at which the script will be executed. * The default value is QWebEngineScript::Deferred. * - * \sa setInjectionPoint + * \sa setInjectionPoint() */ QWebEngineScript::InjectionPoint QWebEngineScript::injectionPoint() const { @@ -205,7 +205,7 @@ QWebEngineScript::InjectionPoint QWebEngineScript::injectionPoint() const /*! * Sets the point at which to execute the script to be \a p. * - * \sa QWebEngineScript::InjectionPoint + * \sa InjectionPoint */ void QWebEngineScript::setInjectionPoint(QWebEngineScript::InjectionPoint p) { diff --git a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc index 58abc9fa1..6dc9b20e2 100644 --- a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc +++ b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc @@ -538,7 +538,7 @@ This signal is emitted whenever the page requests the web browser window to be closed, for example through the JavaScript \c{window.close()} call. - \sa QWebEnginePage::RequestClose + \sa RequestClose */ /*! |