Commit ee26bcb7 authored by hausmann@webkit.org's avatar hausmann@webkit.org

Fixed a bunch of documentation warnings.

Patch by Simon Hausmann <simon.hausmann@nokia.com> on 2009-09-18
Reviewed by Ariya Hidayat.

* Api/qwebgraphicsitem.cpp:
* Api/qwebplugindatabase.cpp:
* Api/qwebpluginfactory.cpp:
* Api/qwebsecurityorigin.cpp:

git-svn-id: http://svn.webkit.org/repository/webkit/trunk@48502 268f45cc-cd09-0410-ab3c-d52691b4dbfc
parent ba1be41c
......@@ -93,7 +93,6 @@ void QWebGraphicsItemPrivate::_q_setStatusBarMessage(const QString& s)
/*!
\class QWebGraphicsItem
\brief The QWebGraphicsItem class allows web content to be added to a GraphicsView.
\inherits QGraphicsWidget.
\since 4.6
A WebGraphicsItem renders web content based on a URL or set data.
......@@ -350,7 +349,7 @@ QString QWebGraphicsItem::status() const
/*!
Convenience slot that stops loading the document.
\sa reload(), pageAction(), loadFinished()
\sa reload(), loadFinished()
*/
void QWebGraphicsItem::stop()
{
......@@ -362,7 +361,7 @@ void QWebGraphicsItem::stop()
Convenience slot that loads the previous document in the list of documents
built by navigating links. Does nothing if there is no previous document.
\sa forward(), pageAction()
\sa forward()
*/
void QWebGraphicsItem::back()
{
......@@ -374,7 +373,7 @@ void QWebGraphicsItem::back()
Convenience slot that loads the next document in the list of documents
built by navigating links. Does nothing if there is no next document.
\sa back(), pageAction()
\sa back()
*/
void QWebGraphicsItem::forward()
{
......@@ -385,7 +384,7 @@ void QWebGraphicsItem::forward()
/*!
Reloads the current document.
\sa stop(), pageAction(), loadStarted()
\sa stop(), loadStarted()
*/
void QWebGraphicsItem::reload()
{
......
......@@ -195,16 +195,26 @@ bool QWebPluginInfo::isEnabled() const
return m_package->isEnabled();
}
/*!
Returns true if this plugin info is the same as the \a other plugin info.
*/
bool QWebPluginInfo::operator==(const QWebPluginInfo& other) const
{
return m_package == other.m_package;
}
/*!
Returns true if this plugin info is different from the \a other plugin info.
*/
bool QWebPluginInfo::operator!=(const QWebPluginInfo& other) const
{
return m_package != other.m_package;
}
/*!
Assigns the \a other plugin info to this plugin info, and returns a reference
to this plugin info.
*/
QWebPluginInfo &QWebPluginInfo::operator=(const QWebPluginInfo& other)
{
if (this == &other)
......
......@@ -76,6 +76,9 @@
\inmodule QtWebKit
*/
/*!
Returns true if this mimetype is the same as the \a other mime type.
*/
bool QWebPluginFactory::MimeType::operator==(const MimeType& other) const
{
return name == other.name
......@@ -83,6 +86,12 @@ bool QWebPluginFactory::MimeType::operator==(const MimeType& other) const
&& fileExtensions == other.fileExtensions;
}
/*!
\fn bool QWebPluginFactory::MimeType::operator!=(const MimeType& other) const
Returns true if this mimetype is different from the \a other mime type.
*/
/*!
\variable QWebPluginFactory::MimeType::name
......
......@@ -202,8 +202,9 @@ QList<QWebDatabase> QWebSecurityOrigin::databases() const
/*!
\since 4.6
Allow applications to use a custome scheme instead of file: scheme,
without being subjected to cross domain restrictions.
Adds the given \a scheme to the list of schemes that are considered equivalent
to the \c file: scheme. They are not subject to cross domain restrictions.
*/
void QWebSecurityOrigin::addLocalScheme(const QString& scheme)
{
......@@ -212,8 +213,10 @@ void QWebSecurityOrigin::addLocalScheme(const QString& scheme)
/*!
\since 4.6
Allow applications to stop using a custome scheme that was previously used,
\sa addLocalScheme().
Removes the given \a scheme from the list of local schemes.
\sa addLocalScheme()
*/
void QWebSecurityOrigin::removeLocalScheme(const QString& scheme)
{
......@@ -223,7 +226,7 @@ void QWebSecurityOrigin::removeLocalScheme(const QString& scheme)
/*!
\since 4.6
Returns a list of all the schemes that were set by the application as local schemes,
\sa addLocalScheme(), removeLocalScheme().
\sa addLocalScheme(), removeLocalScheme()
*/
QStringList QWebSecurityOrigin::localSchemes()
{
......@@ -237,11 +240,19 @@ QStringList QWebSecurityOrigin::localSchemes()
return list;
}
/*!
\since 4.6
\internal
*/
void QWebSecurityOrigin::whiteListAccessFromOrigin(const QString& sourceOrigin, const QString& destinationProtocol, const QString& destinationHost, bool allowDestinationSubdomains)
{
SecurityOrigin::whiteListAccessFromOrigin(*SecurityOrigin::createFromString(sourceOrigin), destinationProtocol, destinationHost, allowDestinationSubdomains);
}
/*!
\since 4.6
\internal
*/
void QWebSecurityOrigin::resetOriginAccessWhiteLists()
{
SecurityOrigin::resetOriginAccessWhiteLists();
......
2009-09-18 Simon Hausmann <simon.hausmann@nokia.com>
Reviewed by Ariya Hidayat.
Fixed a bunch of documentation warnings.
* Api/qwebgraphicsitem.cpp:
* Api/qwebplugindatabase.cpp:
* Api/qwebpluginfactory.cpp:
* Api/qwebsecurityorigin.cpp:
2009-09-18 Warwick Allison <warwick.allison@nokia.com>
Reviewed by Simon Hausmann.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment