summaryrefslogtreecommitdiff
path: root/Source/WebKit
diff options
context:
space:
mode:
authorJocelyn Turcotte <jocelyn.turcotte@digia.com>2014-03-13 15:24:29 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-17 17:03:00 +0100
commit95cbee1ed1ce6102d407f8610b23660d52462d11 (patch)
tree4c0d9ef7c20dd5cd8fc72f30ffe224c0042a1c62 /Source/WebKit
parentb2254b0e8d6e82a312edcb05086ed08885e78533 (diff)
downloadqtwebkit-95cbee1ed1ce6102d407f8610b23660d52462d11.tar.gz
Fix doc warnings
- Qt for Embedded Linux Requirements isn't available since Qt5 - NOTIFY signal documentations are now ignored and are part of their property - The QtQuick1 WebView code isn't available anymore - Adjust to other renamed and removed pages Change-Id: Ife04becb1a847fb0bfb11dfafa6db2caa36aa9f0 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@digia.com>
Diffstat (limited to 'Source/WebKit')
-rw-r--r--Source/WebKit/qt/Api/qwebelement.cpp3
-rw-r--r--Source/WebKit/qt/Api/qwebsettings.cpp2
-rw-r--r--Source/WebKit/qt/WidgetApi/qgraphicswebview.cpp41
-rw-r--r--Source/WebKit/qt/WidgetApi/qwebpage.cpp5
-rw-r--r--Source/WebKit/qt/WidgetApi/qwebview.cpp4
-rw-r--r--Source/WebKit/qt/docs/qtwebkit-goes-mobile.qdoc6
-rw-r--r--Source/WebKit/qt/docs/qtwebkit.qdoc6
7 files changed, 18 insertions, 49 deletions
diff --git a/Source/WebKit/qt/Api/qwebelement.cpp b/Source/WebKit/qt/Api/qwebelement.cpp
index 17811cdc1..26aedc1f5 100644
--- a/Source/WebKit/qt/Api/qwebelement.cpp
+++ b/Source/WebKit/qt/Api/qwebelement.cpp
@@ -1529,6 +1529,7 @@ QWebElementCollectionPrivate* QWebElementCollectionPrivate::create(const PassRef
/*!
\class QWebElementCollection
+ \inmodule QtWebKit
\since 4.6
\brief The QWebElementCollection class represents a collection of web elements.
\preliminary
@@ -1719,6 +1720,7 @@ QList<QWebElement> QWebElementCollection::toList() const
/*!
\class QWebElementCollection::const_iterator
+ \inmodule QtWebKit
\since 4.6
\brief The QWebElementCollection::const_iterator class provides an STL-style const iterator for QWebElementCollection.
@@ -1909,6 +1911,7 @@ QList<QWebElement> QWebElementCollection::toList() const
/*!
\class QWebElementCollection::iterator
+ \inmodule QtWebKit
\since 4.6
\brief The QWebElementCollection::iterator class provides an STL-style iterator for QWebElementCollection.
diff --git a/Source/WebKit/qt/Api/qwebsettings.cpp b/Source/WebKit/qt/Api/qwebsettings.cpp
index f8e4d42ed..325342e86 100644
--- a/Source/WebKit/qt/Api/qwebsettings.cpp
+++ b/Source/WebKit/qt/Api/qwebsettings.cpp
@@ -371,7 +371,7 @@ QWebSettings* QWebSettings::globalSettings()
setOfflineStoragePath() with an appropriate file path, and can limit the quota
for each application by calling setOfflineStorageDefaultQuota().
- \sa QWebPage::settings(), QWebView::settings(), {Web Browser}
+ \sa QWebPage::settings(), QWebView::settings(), {Tab Browser}
*/
/*!
diff --git a/Source/WebKit/qt/WidgetApi/qgraphicswebview.cpp b/Source/WebKit/qt/WidgetApi/qgraphicswebview.cpp
index 4aa6a5f8d..a35252093 100644
--- a/Source/WebKit/qt/WidgetApi/qgraphicswebview.cpp
+++ b/Source/WebKit/qt/WidgetApi/qgraphicswebview.cpp
@@ -142,6 +142,7 @@ void QGraphicsWebViewPrivate::_q_scaleChanged()
/*!
\class QGraphicsWebView
\brief The QGraphicsWebView class allows Web content to be added to a GraphicsView.
+ \inmodule QtWebKit
\since 4.6
An instance of this class renders Web content from a URL or supplied as data, using
@@ -170,33 +171,6 @@ void QGraphicsWebViewPrivate::_q_scaleChanged()
*/
/*!
- \fn void QGraphicsWebView::titleChanged(const QString &title)
-
- This signal is emitted whenever the \a title of the main frame changes.
-
- \sa title()
-*/
-
-/*!
- \fn void QGraphicsWebView::urlChanged(const QUrl &url)
-
- This signal is emitted when the \a url of the view changes.
-
- \sa url(), load()
-*/
-
-/*!
- \fn void QGraphicsWebView::iconChanged()
-
- This signal is emitted whenever the icon of the page is loaded or changes.
-
- In order for icons to be loaded, you will need to set an icon database path
- using QWebSettings::setIconDatabasePath().
-
- \sa icon(), QWebSettings::setIconDatabasePath()
-*/
-
-/*!
\fn void QGraphicsWebView::loadStarted()
This signal is emitted when a new load of the page is started.
@@ -524,7 +498,7 @@ void QGraphicsWebView::setPage(QWebPage* page)
By default, this property contains an empty, invalid URL.
- \sa load(), urlChanged()
+ \sa load()
*/
void QGraphicsWebView::setUrl(const QUrl &url)
@@ -545,8 +519,6 @@ QUrl QGraphicsWebView::url() const
\brief the title of the web page currently viewed
By default, this property contains an empty string.
-
- \sa titleChanged()
*/
QString QGraphicsWebView::title() const
{
@@ -562,7 +534,10 @@ QString QGraphicsWebView::title() const
By default, this property contains a null icon.
- \sa iconChanged(), QWebSettings::iconForUrl()
+ In order for icons to be loaded, you will need to set an icon database path
+ using QWebSettings::setIconDatabasePath().
+
+ \sa QWebSettings::iconForUrl(), QWebSettings::setIconDatabasePath()
*/
QIcon QGraphicsWebView::icon() const
{
@@ -675,7 +650,7 @@ void QGraphicsWebView::reload()
\note The view remains the same until enough data has arrived to display the new \a url.
- \sa setUrl(), url(), urlChanged()
+ \sa setUrl(), url()
*/
void QGraphicsWebView::load(const QUrl& url)
{
@@ -691,7 +666,7 @@ void QGraphicsWebView::load(const QUrl& url)
\note The view remains the same until enough data has arrived to display the new url.
- \sa url(), urlChanged()
+ \sa url()
*/
void QGraphicsWebView::load(const QNetworkRequest& request, QNetworkAccessManager::Operation operation, const QByteArray& body)
diff --git a/Source/WebKit/qt/WidgetApi/qwebpage.cpp b/Source/WebKit/qt/WidgetApi/qwebpage.cpp
index 05caf7134..cb857fdf5 100644
--- a/Source/WebKit/qt/WidgetApi/qwebpage.cpp
+++ b/Source/WebKit/qt/WidgetApi/qwebpage.cpp
@@ -3471,9 +3471,4 @@ QWebPage::VisibilityState QWebPage::visibilityState() const
This signal is emitted when the load of \a frame is finished and the application may now update its state accordingly.
*/
-/*!
- \fn QWebPagePrivate* QWebPage::handle() const
- \internal
-*/
-
#include "moc_qwebpage.cpp"
diff --git a/Source/WebKit/qt/WidgetApi/qwebview.cpp b/Source/WebKit/qt/WidgetApi/qwebview.cpp
index f5c4050c9..1a35b325c 100644
--- a/Source/WebKit/qt/WidgetApi/qwebview.cpp
+++ b/Source/WebKit/qt/WidgetApi/qwebview.cpp
@@ -147,8 +147,8 @@ void QWebViewPrivate::_q_pageDestroyed()
if you do not require QWidget attributes. Nevertheless, Qt WebKit depends
on QtGui, so you should use a QApplication instead of QCoreApplication.
- \sa {Previewer Example}, {Web Browser}, {Form Extractor Example},
- {Google Chat Example}, {Fancy Browser Example}
+ \sa {Previewer Example}, {Tab Browser}, {Form Extractor Example},
+ {Fancy Browser Example}
*/
#ifndef QT_NO_ACCESSIBILITY
diff --git a/Source/WebKit/qt/docs/qtwebkit-goes-mobile.qdoc b/Source/WebKit/qt/docs/qtwebkit-goes-mobile.qdoc
index f1236b9c0..60787721e 100644
--- a/Source/WebKit/qt/docs/qtwebkit-goes-mobile.qdoc
+++ b/Source/WebKit/qt/docs/qtwebkit-goes-mobile.qdoc
@@ -155,9 +155,9 @@
More info can be found in the
\l{http://developer.apple.com/safari/library/documentation/appleapplications/reference/safariwebcontent/usingtheviewport/usingtheviewport.html}{Safari Developer Library}.
- You must connect the signal \c{QWebPage::viewportChangeRequested(const
- QWebPage::ViewportHints& hints)} to a slot of your mobile web view and use what
- is provided by \l{QWebPage::ViewportHints} to update your viewport size, scale
+ You must connect the signal \c{QWebPage::viewportChangeRequested()}
+ to a slot of your mobile web view and use what
+ is provided by \l{QWebPage::ViewportAttributes} to update your viewport size, scale
range, and so on.
diff --git a/Source/WebKit/qt/docs/qtwebkit.qdoc b/Source/WebKit/qt/docs/qtwebkit.qdoc
index f7dcfcb12..3e1fd4636 100644
--- a/Source/WebKit/qt/docs/qtwebkit.qdoc
+++ b/Source/WebKit/qt/docs/qtwebkit.qdoc
@@ -58,7 +58,7 @@
attribute on HTML elements.
QtWebKit has been enhanced to become more attractive on the mobile front as well.
- For more information see \l{QtWebKit Goes Mobile}.
+ For more information see \l{Qt WebKit Goes Mobile}.
Qt WebKit is based on the Open Source WebKit engine. More information about
WebKit itself can be found on the \l{WebKit Open Source Project} Web site.
@@ -87,10 +87,6 @@
\note Web site icons, also known as "FavIcons", are currently not supported
on Windows. We plan to address this in a future release.
- \note WebKit has certain minimum requirements that must be met on
- Embedded Linux systems. See the \l{Qt for Embedded Linux Requirements}
- document for more information.
-
\section1 Architecture
The easiest way to render content is through the QWebView class. As a