From b10d3383b8dcfafae5adad2f373cc986cc3e66cf Mon Sep 17 00:00:00 2001 From: artoka Date: Tue, 13 Dec 2011 13:02:52 +0200 Subject: 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. --- doc/src/deployment/deployment.qdoc | 1 + doc/src/development/debug.qdoc | 2 +- doc/src/development/designer-manual.qdoc | 3 ++- .../snippets/code/src_qt3support_itemviews_q3listview.cpp | 2 +- src/3rdparty/webkit/WebKit/qt/Api/qwebpage.cpp | 2 +- src/3rdparty/webkit/WebKit/qt/Api/qwebsettings.cpp | 6 ++++-- src/corelib/statemachine/qstatemachine.cpp | 2 +- src/corelib/tools/qdatetime.cpp | 2 +- src/corelib/tools/qelapsedtimer.cpp | 2 +- src/gui/widgets/qmenubar.cpp | 4 ++++ src/network/kernel/qnetworkproxy.cpp | 6 +++--- src/network/socket/qabstractsocket.cpp | 13 ++++++++----- src/script/api/qscriptengine.cpp | 4 ++-- src/sql/kernel/qsqlrecord.cpp | 4 ++-- 14 files changed, 32 insertions(+), 21 deletions(-) diff --git a/doc/src/deployment/deployment.qdoc b/doc/src/deployment/deployment.qdoc index d9b169c..193097b 100644 --- a/doc/src/deployment/deployment.qdoc +++ b/doc/src/deployment/deployment.qdoc @@ -853,6 +853,7 @@ \endlist \o \list \o MINGWM10.DLL - The MinGW run-time + \o LIBGCC_S_DW2-1.DLL \endlist \endtable diff --git a/doc/src/development/debug.qdoc b/doc/src/development/debug.qdoc index f89d522..3526db37 100644 --- a/doc/src/development/debug.qdoc +++ b/doc/src/development/debug.qdoc @@ -85,7 +85,7 @@ be excessively large. However, with the release of Xcode 2.3 it is now possible to use Dwarf symbols which take up a significantly smaller amount of space. To enable this feature when configuring - Qt, pass the \c{-dwarf-2} option to the configure script. + Qt, pass the \c{-dwarf2} option to the configure script. This is not enabled by default because previous versions of Xcode will not work with the compiler flag used to implement this diff --git a/doc/src/development/designer-manual.qdoc b/doc/src/development/designer-manual.qdoc index 9a90c79..bb02668 100644 --- a/doc/src/development/designer-manual.qdoc +++ b/doc/src/development/designer-manual.qdoc @@ -1878,7 +1878,8 @@ pixmap property in the property editor. \snippet examples/designer/calculatorform/calculatorform.cpp 0 We can connect signals and slots in user interface widgets in the usual - way, taking care to prefix the \c ui object to each widget used. + way by adding the on_ - prefix. For more information, + see \l{widgets-and-dialogs-with-auto-connect}. The advantages of this approach are its simple use of inheritance to provide a QWidget-based interface, and its encapsulation of the user diff --git a/doc/src/snippets/code/src_qt3support_itemviews_q3listview.cpp b/doc/src/snippets/code/src_qt3support_itemviews_q3listview.cpp index 07559cc..925c476 100644 --- a/doc/src/snippets/code/src_qt3support_itemviews_q3listview.cpp +++ b/doc/src/snippets/code/src_qt3support_itemviews_q3listview.cpp @@ -105,7 +105,7 @@ while (it.current()) { //! [7] QList lst; -Q3ListViewItemIterator it(myListView, Selected); +Q3ListViewItemIterator it(myListView, Q3ListViewItemIterator::Selected); while (it.current()) { lst.append(it.current()); ++it; 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 { -- cgit v0.12