summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorartoka <arto.katajasalo@digia.com>2011-12-08 14:04:10 +0200
committerQt by Nokia <qt-info@nokia.com>2012-01-31 17:31:38 +0100
commitbacae725e584f51ee2fd83af7bef3e4515de9587 (patch)
tree6275b15e915e38c6e2ffb988354ea8ed3ada31d4
parent40fb4750910e23d3e7128ca8e0f1c5920b05bd5a (diff)
downloadqt4-tools-bacae725e584f51ee2fd83af7bef3e4515de9587.tar.gz
Various Qt documentation fixes (wk 44)
Task-number: QTBUG-13362 Task-number: QTBUG-18356 Task-number: QTBUG-18417 Task-number: QTBUG-18664 Task-number: QTBUG-21562 Task-number: QTBUG-22094 Task-number: QTBUG-18741 Task-number: QTBUG-15921 Task-number: QTBUG-22172 Task-number: QTBUG-15738 Change-Id: I1d383a22612cd4fbcb7e03751e76409ca57fe7a2 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
-rw-r--r--doc/src/examples/editabletreemodel.qdoc5
-rw-r--r--doc/src/external-resources.qdoc4
-rw-r--r--doc/src/files-and-resources/resources.qdoc4
-rw-r--r--doc/src/index.qdoc1
-rw-r--r--doc/src/snippets/code/src_corelib_thread_qmutex.cpp4
-rw-r--r--doc/src/sql-programming/sql-driver.qdoc2
-rw-r--r--src/corelib/tools/qregexp.cpp2
-rw-r--r--src/gui/dialogs/qdialog.cpp4
-rw-r--r--src/gui/dialogs/qmessagebox.cpp2
-rw-r--r--src/gui/kernel/qwidget.cpp4
-rw-r--r--src/gui/widgets/qabstractbutton.cpp4
-rw-r--r--src/network/kernel/qnetworkproxy.cpp6
-rw-r--r--src/xml/dom/qdom.cpp4
13 files changed, 28 insertions, 18 deletions
diff --git a/doc/src/examples/editabletreemodel.qdoc b/doc/src/examples/editabletreemodel.qdoc
index 6966ac53a4..d31e694fbb 100644
--- a/doc/src/examples/editabletreemodel.qdoc
+++ b/doc/src/examples/editabletreemodel.qdoc
@@ -48,14 +48,15 @@
As described in the \l{Model Subclassing Reference}, models must
provide implementations for the standard set of model functions:
\l{QAbstractItemModel::}{flags()}, \l{QAbstractItemModel::}{data()},
- \l{QAbstractItemModel::}{headerData()}, and
+ \l{QAbstractItemModel::}{headerData()},
+ \l{QAbstractItemModel::}{columnCount()}, and
\l{QAbstractItemModel::}{rowCount()}. In addition, hierarchical models,
such as this one, need to provide implementations of
\l{QAbstractItemModel::}{index()} and \l{QAbstractItemModel::}{parent()}.
An editable model needs to provide implementations of
\l{QAbstractItemModel::}{setData()} and
- \l{QAbstractItemModel::}{headerData()}, and must return a suitable
+ \l{QAbstractItemModel::}{setHeaderData()}, and must return a suitable
combination of flags from its \l{QAbstractItemModel::}{flags()} function.
Since this example allows the dimensions of the model to be changed,
diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc
index 2107669bca..7f40229a9f 100644
--- a/doc/src/external-resources.qdoc
+++ b/doc/src/external-resources.qdoc
@@ -235,8 +235,8 @@
*/
/*!
- \externalpage http://www.postgresql.org/docs/faqs.FAQ_MINGW.html
- \title Compiling PostgreSQL On Native Win32 FAQ
+ \externalpage http://www.postgresql.org/docs/current/static/installation-platform-notes.html#INSTALLATION-NOTES-MINGW
+ \title PostgreSQL MinGW/Native Windows
*/
/*!
diff --git a/doc/src/files-and-resources/resources.qdoc b/doc/src/files-and-resources/resources.qdoc
index 8ca19f3703..53850fe497 100644
--- a/doc/src/files-and-resources/resources.qdoc
+++ b/doc/src/files-and-resources/resources.qdoc
@@ -101,8 +101,8 @@
In this case, the file is accessible as \c
:/myresources/cut-img.png.
- Some resources, such as translation files and icons, many need to
- change based on the user's locale. This is done by adding a \c lang
+ Some resources need to change based on the user's locale,
+ such as translation files or icons. This is done by adding a \c lang
attribute to the \c qresource tag, specifying a suitable locale
string. For example:
diff --git a/doc/src/index.qdoc b/doc/src/index.qdoc
index c72c37710f..cf98c3b83e 100644
--- a/doc/src/index.qdoc
+++ b/doc/src/index.qdoc
@@ -40,7 +40,6 @@
\o \l{How to Learn Qt}
\o \l{Introduction to Qt Quick}{Qt Quick}
\o \l{Qt Whitepaper}{Qt C++ Framework}
- \o \l{Introduction to Qt Quick}{Qt Quick}
\o \l{external: Qt Mobility Manual}{Qt Mobility}
\o \l{Qt WebKit}
\endlist
diff --git a/doc/src/snippets/code/src_corelib_thread_qmutex.cpp b/doc/src/snippets/code/src_corelib_thread_qmutex.cpp
index b52709c5ce..fcee45dbc1 100644
--- a/doc/src/snippets/code/src_corelib_thread_qmutex.cpp
+++ b/doc/src/snippets/code/src_corelib_thread_qmutex.cpp
@@ -114,8 +114,8 @@ int complexFunction(int flag)
switch (flag) {
case 0:
case 1:
- mutex.unlock();
- return moreComplexFunction(flag);
+ retVal = moreComplexFunction(flag);
+ break;
case 2:
{
int status = anotherFunction();
diff --git a/doc/src/sql-programming/sql-driver.qdoc b/doc/src/sql-programming/sql-driver.qdoc
index b918da5a79..04e6f8b830 100644
--- a/doc/src/sql-programming/sql-driver.qdoc
+++ b/doc/src/sql-programming/sql-driver.qdoc
@@ -495,7 +495,7 @@
\snippet doc/src/snippets/code/doc_src_sql-driver.qdoc 15
Users of MinGW may wish to consult the following online document:
- \l{Compiling PostgreSQL On Native Win32 FAQ}.
+ \l{PostgreSQL MinGW/Native Windows}.
\bold{Note:} This database plugin is not supported for Windows CE.
diff --git a/src/corelib/tools/qregexp.cpp b/src/corelib/tools/qregexp.cpp
index b306fd22bd..405302841e 100644
--- a/src/corelib/tools/qregexp.cpp
+++ b/src/corelib/tools/qregexp.cpp
@@ -669,7 +669,7 @@ int qFindString(const QChar *haystack, int haystackLen, int from,
Wildcard matching can be convenient because of its simplicity, but
any wildcard regexp can be defined using full regexps, e.g.
- \bold{.*\.html$}. Notice that we can't match both \c .html and \c
+ \bold{.*\\.html$}. Notice that we can't match both \c .html and \c
.htm files with a wildcard unless we use \bold{*.htm*} which will
also match 'test.html.bak'. A full regexp gives us the precision
we need, \bold{.*\\.html?$}.
diff --git a/src/gui/dialogs/qdialog.cpp b/src/gui/dialogs/qdialog.cpp
index 6ef9d708ec..6df771e0f4 100644
--- a/src/gui/dialogs/qdialog.cpp
+++ b/src/gui/dialogs/qdialog.cpp
@@ -430,7 +430,9 @@ bool QDialog::event(QEvent *e)
#endif
/*!
- Returns the modal dialog's result code, \c Accepted or \c Rejected.
+ In general returns the modal dialog's result code, \c Accepted or \c Rejected.
+
+ \note When used from QMessageBox instance the result code type is \l QMessageBox::StandardButton
Do not call this function if the dialog was constructed with the
Qt::WA_DeleteOnClose attribute.
diff --git a/src/gui/dialogs/qmessagebox.cpp b/src/gui/dialogs/qmessagebox.cpp
index a60324e1a3..f9d4efa436 100644
--- a/src/gui/dialogs/qmessagebox.cpp
+++ b/src/gui/dialogs/qmessagebox.cpp
@@ -2749,6 +2749,8 @@ QPixmap QMessageBox::standardIcon(Icon icon)
When using QMessageBox with custom buttons, this function returns an
opaque value; use clickedButton() to determine which button was clicked.
+ \note The result() function returns also \l StandardButton value instead of \l QDialog::DialogCode
+
Users cannot interact with any other window in the same
application until they close the dialog, either by clicking a
button or by using a mechanism provided by the window system.
diff --git a/src/gui/kernel/qwidget.cpp b/src/gui/kernel/qwidget.cpp
index 934e2d3a4f..557329eddd 100644
--- a/src/gui/kernel/qwidget.cpp
+++ b/src/gui/kernel/qwidget.cpp
@@ -3345,8 +3345,8 @@ QList<QAction*> QWidget::actions() const
\property QWidget::enabled
\brief whether the widget is enabled
- An enabled widget handles keyboard and mouse events; a disabled
- widget does not.
+ In general an enabled widget handles keyboard and mouse events; a disabled
+ widget does not. An exception is made with \l{QAbstractButton}.
Some widgets display themselves differently when they are
disabled. For example a button might draw its label grayed out. If
diff --git a/src/gui/widgets/qabstractbutton.cpp b/src/gui/widgets/qabstractbutton.cpp
index 9842242fc8..61b0645e21 100644
--- a/src/gui/widgets/qabstractbutton.cpp
+++ b/src/gui/widgets/qabstractbutton.cpp
@@ -114,7 +114,9 @@ Q_GUI_EXPORT extern bool qt_tab_all_widgets;
checkable buttons can be checked and unchecked (see below).
\o isEnabled() indicates whether the button can be pressed by the
- user.
+ user. \note As opposed to other widgets, buttons derived from
+ QAbstractButton accepts mouse and context menu events
+ when disabled.
\o setAutoRepeat() sets whether the button will auto-repeat if the
user holds it down. \l autoRepeatDelay and \l autoRepeatInterval
diff --git a/src/network/kernel/qnetworkproxy.cpp b/src/network/kernel/qnetworkproxy.cpp
index 7a7b455611..288cab934b 100644
--- a/src/network/kernel/qnetworkproxy.cpp
+++ b/src/network/kernel/qnetworkproxy.cpp
@@ -1337,7 +1337,7 @@ void QNetworkProxyFactory::setApplicationProxyFactory(QNetworkProxyFactory *fact
/*!
\fn QList<QNetworkProxy> QNetworkProxyFactory::queryProxy(const QNetworkProxyQuery &query)
- This function examines takes the query request, \a query,
+ This function takes the query request, \a query,
examines the details of the type of socket or request and returns
a list of QNetworkProxy objects that indicate the proxy servers to
be used, in order of preference.
@@ -1358,7 +1358,7 @@ void QNetworkProxyFactory::setApplicationProxyFactory(QNetworkProxyFactory *fact
/*!
\fn QList<QNetworkProxy> QNetworkProxyFactory::systemProxyForQuery(const QNetworkProxyQuery &query)
- This function examines takes the query request, \a query,
+ This function takes the query request, \a query,
examines the details of the type of socket or request and returns
a list of QNetworkProxy objects that indicate the proxy servers to
be used, in order of preference.
@@ -1404,7 +1404,7 @@ void QNetworkProxyFactory::setApplicationProxyFactory(QNetworkProxyFactory *fact
*/
/*!
- This function examines takes the query request, \a query,
+ This function takes the query request, \a query,
examines the details of the type of socket or request and returns
a list of QNetworkProxy objects that indicate the proxy servers to
be used, in order of preference.
diff --git a/src/xml/dom/qdom.cpp b/src/xml/dom/qdom.cpp
index 6c9bd54901..d2f9675344 100644
--- a/src/xml/dom/qdom.cpp
+++ b/src/xml/dom/qdom.cpp
@@ -6570,6 +6570,10 @@ void QDomDocumentPrivate::saveDocument(QTextStream& s, const int indent, QDomNod
element is available using documentElement(). The textual
representation of the document can be obtained using toString().
+ \note The DOM tree might end up reserving a lot of memory if the XML
+ document is big. For big XML documents, the QXmlStreamReader or the QXmlQuery
+ classes might be better solutions.
+
It is possible to insert a node from another document into the
document using importNode().