summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorartoka <arto.katajasalo@digia.com>2011-12-13 15:06:03 +0200
committerQt Commercial Integration <QtCommercial@digia.com>2012-01-31 12:25:08 +0200
commit45bdaac4636b69ddbae446ec65082a90290dda52 (patch)
tree42ebdbee0b784783ceaf53a9d1b38948b8add90c
parent08e5e81d5ebece3eb3f489d438e2cea5d4adcb4f (diff)
Various qt documentation fixes (wk 44)
-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/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
12 files changed, 28 insertions, 17 deletions
diff --git a/doc/src/examples/editabletreemodel.qdoc b/doc/src/examples/editabletreemodel.qdoc
index 8be3037750..50d1091b58 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 fed5c33a70..427cf6c7ed 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 d6e320bf04..434eef1855 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/snippets/code/src_corelib_thread_qmutex.cpp b/doc/src/snippets/code/src_corelib_thread_qmutex.cpp
index 7800a4da2d..d02268fa44 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 40c7c6a23c..60e31c38ae 100644
--- a/doc/src/sql-programming/sql-driver.qdoc
+++ b/doc/src/sql-programming/sql-driver.qdoc
@@ -494,7 +494,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 bfdcc338c6..8c7d34bd85 100644
--- a/src/corelib/tools/qregexp.cpp
+++ b/src/corelib/tools/qregexp.cpp
@@ -668,7 +668,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 4c6c3bceb7..d7d9a95e6e 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 f18fe6023b..ebfc0eb4c3 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 39b15a3890..952966e767 100644
--- a/src/gui/kernel/qwidget.cpp
+++ b/src/gui/kernel/qwidget.cpp
@@ -3302,8 +3302,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 354677d3f6..0f9a5be4fe 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 c097ed9839..9b7a9f5d1a 100644
--- a/src/network/kernel/qnetworkproxy.cpp
+++ b/src/network/kernel/qnetworkproxy.cpp
@@ -1226,7 +1226,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.
@@ -1247,7 +1247,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.
@@ -1293,7 +1293,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 db5306ee42..8d655eaa68 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().