summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorartoka <arto.katajasalo@digia.com>2011-12-13 11:02:52 (GMT)
committerQt Commercial Integration <QtCommercial@digia.com>2012-01-31 10:25:07 (GMT)
commitb10d3383b8dcfafae5adad2f373cc986cc3e66cf (patch)
treef0170e50772e4152f10699a46699b8eddff507c9 /src
parent3e42111e96e18fd60ec6d6b8b386c2f4a4b401ac (diff)
downloadQt-b10d3383b8dcfafae5adad2f373cc986cc3e66cf.zip
Qt-b10d3383b8dcfafae5adad2f373cc986cc3e66cf.tar.gz
Qt-b10d3383b8dcfafae5adad2f373cc986cc3e66cf.tar.bz2
Various qt documentation fixes (wk 42)
Fixes for bugs: QTBUG-8673, QTBUG-18101, QTBUG-14194, QTBUG-9109, QTBUG-8331, QTBUG-8329, QTBUG-8786, QTBUG-8787, QTBUG-21295, QTBUG-14554, QTBUG-19367, QTBUG-8323, QTBUG-9466, QTBUG-7924 and QTBUG-20355.
Diffstat (limited to 'src')
-rw-r--r--src/3rdparty/webkit/WebKit/qt/Api/qwebpage.cpp2
-rw-r--r--src/3rdparty/webkit/WebKit/qt/Api/qwebsettings.cpp6
-rw-r--r--src/corelib/statemachine/qstatemachine.cpp2
-rw-r--r--src/corelib/tools/qdatetime.cpp2
-rw-r--r--src/corelib/tools/qelapsedtimer.cpp2
-rw-r--r--src/gui/widgets/qmenubar.cpp4
-rw-r--r--src/network/kernel/qnetworkproxy.cpp6
-rw-r--r--src/network/socket/qabstractsocket.cpp13
-rw-r--r--src/script/api/qscriptengine.cpp4
-rw-r--r--src/sql/kernel/qsqlrecord.cpp4
10 files changed, 27 insertions, 18 deletions
diff --git a/src/3rdparty/webkit/WebKit/qt/Api/qwebpage.cpp b/src/3rdparty/webkit/WebKit/qt/Api/qwebpage.cpp
index 5bb3c57..19a4249 100644
--- a/src/3rdparty/webkit/WebKit/qt/Api/qwebpage.cpp
+++ b/src/3rdparty/webkit/WebKit/qt/Api/qwebpage.cpp
@@ -1742,7 +1742,7 @@ InspectorController* QWebPagePrivate::inspectorController()
changes the behaviour to a case sensitive find operation.
\value FindWrapsAroundDocument Makes findText() restart from the beginning of the document if the end
was reached and the text was not found.
- \value HighlightAllOccurrences Highlights all existing occurrences of a specific string.
+ \value HighlightAllOccurrences Highlights all existing occurrences of a specific string. (This value was introduced in 4.6.)
*/
/*!
diff --git a/src/3rdparty/webkit/WebKit/qt/Api/qwebsettings.cpp b/src/3rdparty/webkit/WebKit/qt/Api/qwebsettings.cpp
index d907d86..894731b 100644
--- a/src/3rdparty/webkit/WebKit/qt/Api/qwebsettings.cpp
+++ b/src/3rdparty/webkit/WebKit/qt/Api/qwebsettings.cpp
@@ -400,12 +400,14 @@ QWebSettings* QWebSettings::globalSettings()
\value OfflineWebApplicationCacheEnabled Specifies whether support for the HTML 5
web application cache feature is enabled or not. This is disabled by default.
\value LocalStorageEnabled Specifies whether support for the HTML 5
- local storage feature is enabled or not. This is disabled by default.
+ local storage feature is enabled or not. This is disabled by default.
+ (This value was introduced in 4.6.)
\value LocalStorageDatabaseEnabled \e{This enum value is deprecated.} Use
QWebSettings::LocalStorageEnabled instead.
\value LocalContentCanAccessRemoteUrls Specifies whether locally loaded documents are
allowed to access remote urls. This is disabled by default. For more information
- about security origins and local vs. remote content see QWebSecurityOrigin.
+ about security origins and local vs. remote content see QWebSecurityOrigin.
+ (This value was introduced in 4.6.)
\value LocalContentCanAccessFileUrls Specifies whether locally loaded documents are
allowed to access other local urls. This is enabled by default. For more information
about security origins and local vs. remote content see QWebSecurityOrigin.
diff --git a/src/corelib/statemachine/qstatemachine.cpp b/src/corelib/statemachine/qstatemachine.cpp
index d2fef8e..b6e0c68 100644
--- a/src/corelib/statemachine/qstatemachine.cpp
+++ b/src/corelib/statemachine/qstatemachine.cpp
@@ -2340,7 +2340,7 @@ QStateMachine::SignalEvent::~SignalEvent()
/*!
\class QStateMachine::WrappedEvent
- \brief The WrappedEvent class holds a clone of an event associated with a QObject.
+ \brief The WrappedEvent class inherits QEvent and holds a clone of an event associated with a QObject.
\since 4.6
\ingroup statemachine
diff --git a/src/corelib/tools/qdatetime.cpp b/src/corelib/tools/qdatetime.cpp
index 946e721..acd48be 100644
--- a/src/corelib/tools/qdatetime.cpp
+++ b/src/corelib/tools/qdatetime.cpp
@@ -387,7 +387,7 @@ int QDate::day() const
}
/*!
- Returns the weekday (1 to 7) for this date.
+ Returns the weekday (1 = Monday to 7 = Sunday) for this date.
\sa day(), dayOfYear(), Qt::DayOfWeek
*/
diff --git a/src/corelib/tools/qelapsedtimer.cpp b/src/corelib/tools/qelapsedtimer.cpp
index 61ec2c2..03e174a 100644
--- a/src/corelib/tools/qelapsedtimer.cpp
+++ b/src/corelib/tools/qelapsedtimer.cpp
@@ -223,7 +223,7 @@ void QElapsedTimer::invalidate()
}
/*!
- Returns true if this object was invalidated by a call to invalidate() and
+ Returns false if this object was invalidated by a call to invalidate() and
has not been restarted since.
\sa invalidate(), start(), restart()
diff --git a/src/gui/widgets/qmenubar.cpp b/src/gui/widgets/qmenubar.cpp
index 6a41c74..fb509ec 100644
--- a/src/gui/widgets/qmenubar.cpp
+++ b/src/gui/widgets/qmenubar.cpp
@@ -1915,6 +1915,8 @@ QWidget *QMenuBar::cornerWidget(Qt::Corner corner) const
The default is to follow whether the Qt::AA_DontUseNativeMenuBar attribute
is set for the application. Explicitly settings this property overrides
the presence (or abscence) of the attribute.
+
+ \sa void-qt-mac-set-native-menubar-bool-enable
*/
void QMenuBar::setNativeMenuBar(bool nativeMenuBar)
@@ -2014,6 +2016,8 @@ QAction *QMenuBar::defaultAction() const
This signal is emitted when an action in a menu belonging to this menubar
is triggered as a result of a mouse click; \a action is the action that
caused the signal to be emitted.
+
+ \note QMenuBar has to have ownership of the QMenu in order this signal to work.
Normally, you connect each menu action to a single slot using
QAction::triggered(), but sometimes you will want to connect
diff --git a/src/network/kernel/qnetworkproxy.cpp b/src/network/kernel/qnetworkproxy.cpp
index d3e4c94..c097ed9 100644
--- a/src/network/kernel/qnetworkproxy.cpp
+++ b/src/network/kernel/qnetworkproxy.cpp
@@ -129,9 +129,9 @@
\value NoProxy No proxying is used
\value DefaultProxy Proxy is determined based on the application proxy set using setApplicationProxy()
\value Socks5Proxy \l Socks5 proxying is used
- \value HttpProxy HTTP transparent proxying is used
- \value HttpCachingProxy Proxying for HTTP requests only
- \value FtpCachingProxy Proxying for FTP requests only
+ \value HttpProxy HTTP transparent proxying is used (This value was introduced in 4.3.)
+ \value HttpCachingProxy Proxying for HTTP requests only (This value was introduced in 4.4.)
+ \value FtpCachingProxy Proxying for FTP requests only (This value was introduced in 4.4.)
The table below lists different proxy types and their
capabilities. Since each proxy type has different capabilities, it
diff --git a/src/network/socket/qabstractsocket.cpp b/src/network/socket/qabstractsocket.cpp
index fd33b5f..a8c3964 100644
--- a/src/network/socket/qabstractsocket.cpp
+++ b/src/network/socket/qabstractsocket.cpp
@@ -301,20 +301,23 @@
\value ProxyAuthenticationRequiredError The socket is using a proxy, and
the proxy requires authentication.
\value SslHandshakeFailedError The SSL/TLS handshake failed, so
- the connection was closed (only used in QSslSocket)
+ the connection was closed (only used in QSslSocket) (This value was introduced in 4.4.)
\value UnfinishedSocketOperationError Used by QAbstractSocketEngine only,
The last operation attempted has not finished yet (still in progress in
- the background).
+ the background). (This value was introduced in 4.4.)
\value ProxyConnectionRefusedError Could not contact the proxy server because
- the connection to that server was denied
+ the connection to that server was denied (This value was introduced in 4.5.)
\value ProxyConnectionClosedError The connection to the proxy server was closed
- unexpectedly (before the connection to the final peer was established)
+ unexpectedly (before the connection to the final peer was established)
+ (This value was introduced in 4.5.)
\value ProxyConnectionTimeoutError The connection to the proxy server timed out
or the proxy server stopped responding in the authentication phase.
+ (This value was introduced in 4.5.)
\value ProxyNotFoundError The proxy address set with setProxy() (or the application
- proxy) was not found.
+ proxy) was not found. (This value was introduced in 4.5.)
\value ProxyProtocolError The connection negotiation with the proxy server
because the response from the proxy server could not be understood.
+ (This value was introduced in 4.5.)
\value UnknownSocketError An unidentified error occurred.
\sa QAbstractSocket::error()
diff --git a/src/script/api/qscriptengine.cpp b/src/script/api/qscriptengine.cpp
index 25137eb..cd40d0d 100644
--- a/src/script/api/qscriptengine.cpp
+++ b/src/script/api/qscriptengine.cpp
@@ -196,8 +196,8 @@ QT_BEGIN_NAMESPACE
"standard" Qt constructor, Qt Script can provide a default script
constructor for you; see scriptValueFromQMetaObject().
- See the \l{QtScript} documentation for more information on
- the QObject integration.
+ For more information about QObject integration, see
+ \l{Making Applications Scriptable}
\section1 Support for Custom C++ Types
diff --git a/src/sql/kernel/qsqlrecord.cpp b/src/sql/kernel/qsqlrecord.cpp
index dfeb3e0..cee1a59 100644
--- a/src/sql/kernel/qsqlrecord.cpp
+++ b/src/sql/kernel/qsqlrecord.cpp
@@ -273,8 +273,8 @@ const QSqlField* QSqlRecord::fieldPtr(const QString& name) const
#endif //QT3_SUPPORT
/*!
- Returns the field at position \a index. If the position is out of
- range, an empty field is returned.
+ Returns the field at position \a index. If the \a index
+ is out of range, function returns a \l{default-constructed value}.
*/
QSqlField QSqlRecord::field(int index) const
{