summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorartoka <arto.katajasalo@digia.com>2011-12-13 12:06:14 +0200
committerQt Commercial Integration <QtCommercial@digia.com>2012-01-31 12:25:07 +0200
commit3e42111e96e18fd60ec6d6b8b386c2f4a4b401ac (patch)
treef1a207c1347398428a886857a5c3c3f2ab4e5d84
parent8392eebfdacdcb7d318e786eafffc2d48db77bcc (diff)
Various qt documentation fixes (wk 40&41)
-rw-r--r--doc/src/development/designer-manual.qdoc5
-rw-r--r--doc/src/development/qmake-manual.qdoc8
-rw-r--r--doc/src/examples/diagramscene.qdoc12
-rw-r--r--doc/src/external-resources.qdoc2
-rw-r--r--doc/src/getting-started/installation.qdoc4
-rw-r--r--doc/src/howtos/appicon.qdoc2
-rw-r--r--doc/src/images/editbreaklayout.pngbin0 -> 1321 bytes
-rw-r--r--doc/src/network-programming/ssl.qdoc2
-rw-r--r--doc/src/platforms/symbian-introduction.qdoc2
-rw-r--r--doc/src/snippets/code/doc_src_stylesheet.qdoc4
-rw-r--r--doc/src/snippets/code/src_corelib_tools_qvector.cpp4
-rw-r--r--doc/src/snippets/code/src_opengl_qglcolormap.cpp5
-rw-r--r--doc/src/snippets/code/src_sql_kernel_qsqldriver.cpp6
-rw-r--r--doc/src/snippets/qxmlquery/bindingExample.cpp2
-rw-r--r--examples/draganddrop/fridgemagnets/dragwidget.cpp2
-rw-r--r--src/3rdparty/webkit/WebKit/qt/docs/webkitsnippets/webelement/main.cpp2
-rw-r--r--src/corelib/kernel/qpointer.cpp2
-rw-r--r--src/corelib/tools/qline.cpp7
-rw-r--r--src/corelib/tools/qlist.cpp5
-rw-r--r--src/gui/painting/qpainter.cpp22
-rw-r--r--src/network/access/qnetworkdiskcache.cpp4
21 files changed, 56 insertions, 46 deletions
diff --git a/doc/src/development/designer-manual.qdoc b/doc/src/development/designer-manual.qdoc
index 410ca8c3c6..9a90c7990a 100644
--- a/doc/src/development/designer-manual.qdoc
+++ b/doc/src/development/designer-manual.qdoc
@@ -694,8 +694,9 @@
the object's name with the in-place editor.
Since Qt 4.5, the \gui{Object Inspector} displays the layout state of
- the containers. The broken layout icon ###ICON is displayed if there is
- something wrong with the layouts.
+ the containers. The broken layout icon \inlineimage editbreaklayout.png
+ is displayed if there is something wrong (e.g. layout missing from the
+ container) with the layouts.
\endtable
*/
diff --git a/doc/src/development/qmake-manual.qdoc b/doc/src/development/qmake-manual.qdoc
index 44e710320a..504136a9c8 100644
--- a/doc/src/development/qmake-manual.qdoc
+++ b/doc/src/development/qmake-manual.qdoc
@@ -441,7 +441,9 @@
Note, that you must use "+=", not "=", or \l{qmake Manual#qmake}{\c qmake}
will not be able to use Qt's configuration to determine the settings
- needed for your project.
+ needed for your project. More information about operators can be found in the
+ \l{qmake Advanced Usage#Operators}{Operators} section of the \l{qmake Advanced Usage}
+ chapter.
\section1 Declaring Qt Libraries
@@ -467,6 +469,10 @@
\snippet doc/src/snippets/code/doc_src_qmake-manual.pro 4
+ More information about operators can be found in the
+ \l{qmake Advanced Usage#Operators}{Operators} section of the
+ \l{qmake Advanced Usage} chapter.
+
The table below shows the options that can be used with the \c QT variable
and the features that are associated with each of them:
diff --git a/doc/src/examples/diagramscene.qdoc b/doc/src/examples/diagramscene.qdoc
index 7d3c0e6bc3..38875edc83 100644
--- a/doc/src/examples/diagramscene.qdoc
+++ b/doc/src/examples/diagramscene.qdoc
@@ -149,11 +149,11 @@
Example}{application example} if you need a high-level
introduction to actions.
- The is the \c createMenus() function:
+ Here is the \c createMenus() function:
\snippet examples/graphicsview/diagramscene/mainwindow.cpp 24
- We create the three menus' of the example.
+ We create the three menus of the example.
The \c createToolbars() function sets up the examples tool
bars. The three \l{QToolButton}s in the \c colorToolBar, the \c
@@ -199,7 +199,7 @@
each button; we store the diagram's type, i.e., the
DiagramItem::DiagramType enum. We use the stored diagram type when
we create new diagram items for the scene. The widgets created
- with this function is used in the tool box.
+ with this function are used in the tool box.
Here is the \c createColorMenu() function:
@@ -443,7 +443,7 @@
In the \c DiagramScene a mouse click can give three different
actions: the item under the mouse can be moved, an item may be
- inserted, or an arrow may be connected between to diagram items.
+ inserted, or an arrow may be connected between two diagram items.
Which action a mouse click has depends on the mode, given by the
Mode enum, the scene is in. The mode is set with the \c setMode()
function.
@@ -456,7 +456,7 @@
inserted is set with the \c setItemType() slot.
The \c MainWindow and \c DiagramScene share responsibility for
- the examples functionality. \c MainWindow handles the following
+ the example's functionality. \c MainWindow handles the following
tasks: the deletion of items, text, and arrows; moving diagram
items to the back and front; and setting the scale of the scene.
@@ -624,7 +624,7 @@
\snippet examples/graphicsview/diagramscene/diagramitem.cpp 0
- In the constructor we create the items polygon according to
+ In the constructor we create the item's polygon according to
\a diagramType. \l{QGraphicsItem}s are not movable or selectable
by default, so we must set these properties.
diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc
index 50e5a214c7..fed5c33a70 100644
--- a/doc/src/external-resources.qdoc
+++ b/doc/src/external-resources.qdoc
@@ -420,7 +420,7 @@
*/
/*!
- \externalpage http://developer.symbian.org/wiki/index.php/Platform_Security_%28Fundamentals_of_Symbian_C%2B%2B%29#Self-Signed_Applications
+ \externalpage http://www.developer.nokia.com/Community/Wiki/Qt_&_Symbian_Platform_Security
\title Symbian Platform Security
*/
diff --git a/doc/src/getting-started/installation.qdoc b/doc/src/getting-started/installation.qdoc
index c166794772..143bdee015 100644
--- a/doc/src/getting-started/installation.qdoc
+++ b/doc/src/getting-started/installation.qdoc
@@ -590,7 +590,7 @@ the Symbian platform from scratch.
The \l{Configuration Options for Qt} page gives a brief overview
of these.
- SBSv2 (also known as \l{http://developer.symbian.org/wiki/index.php/Introduction_to_RAPTOR} {Raptor})
+ SBSv2 (also known as \l{http://projects.developer.nokia.com/raptor/wiki} {Raptor})
is a next-generation Symbian build system. SBSv2 is not officially supported
by any of the S60 SDKs currently available from Forum Nokia.
@@ -1348,7 +1348,7 @@ We hope you will enjoy using Qt.
\endlist
- We recommend you to take a look at \l{http://developer.symbian.org/wiki/index.php/Qt_Quick_Start}{Symbian Foundation - Qt Quick Start}
+ We recommend you to take a look at \l{http://doc.qt.nokia.com/latest/install-symbian.html}{Installing Qt for the Symbian platform}
to get more information about how to setup the development environment.
\sa {Known Issues}
diff --git a/doc/src/howtos/appicon.qdoc b/doc/src/howtos/appicon.qdoc
index 8e7601f4f3..2879b0543b 100644
--- a/doc/src/howtos/appicon.qdoc
+++ b/doc/src/howtos/appicon.qdoc
@@ -205,7 +205,7 @@
In order to set the application icon for Symbian platform applications, you need
an SVG-T icon. For information on how to create SVG-T compliant icons,
please refer to
- \l{http://wiki.forum.nokia.com/index.php/How_to_create_application_icon(SVG)_in_S60_3rd_edition/}
+ \l{http://wiki.forum.nokia.com/index.php/How_to_create_application_icon(SVG)_in_S60_3rd_edition}
Once the icon is available in the correct format and assuming you are
using \c qmake to generate your makefiles, you only need to add a single
diff --git a/doc/src/images/editbreaklayout.png b/doc/src/images/editbreaklayout.png
new file mode 100644
index 0000000000..07c5fae696
--- /dev/null
+++ b/doc/src/images/editbreaklayout.png
Binary files differ
diff --git a/doc/src/network-programming/ssl.qdoc b/doc/src/network-programming/ssl.qdoc
index 0bbcd8afb7..0ae68466f7 100644
--- a/doc/src/network-programming/ssl.qdoc
+++ b/doc/src/network-programming/ssl.qdoc
@@ -58,7 +58,7 @@
system:
\code
- ./configure -openssl-linked OPENSSL_LIBS='-L/opt/ssl/lib -lssl -lcrypto'
+ OPENSSL_LIBS='-L/opt/ssl/lib -lssl -lcrypto' ./configure -openssl-linked
\endcode
To disable SSL support in a Qt build, configure Qt with the \c{-no-openssl}
diff --git a/doc/src/platforms/symbian-introduction.qdoc b/doc/src/platforms/symbian-introduction.qdoc
index 82d39f32a4..56534bd3b8 100644
--- a/doc/src/platforms/symbian-introduction.qdoc
+++ b/doc/src/platforms/symbian-introduction.qdoc
@@ -205,7 +205,7 @@
\table
\row \o \c QT_SIS_OPTIONS \o Options accepted by \c .sis creation. See
\l{Supported options for QT_SIS_OPTIONS}{Supported options}
- below. By default no otions are given.
+ below. By default no options are given.
\row \o \c QT_SIS_TARGET \o Target for which \c .sis file is created.
Accepted values are build targets listed in
previous table. By default last build target.
diff --git a/doc/src/snippets/code/doc_src_stylesheet.qdoc b/doc/src/snippets/code/doc_src_stylesheet.qdoc
index 99b31c9387..78d76a8b08 100644
--- a/doc/src/snippets/code/doc_src_stylesheet.qdoc
+++ b/doc/src/snippets/code/doc_src_stylesheet.qdoc
@@ -481,7 +481,7 @@ QTextEdit { background-position: bottom center }
//! [81]
-QDialog { etch-disabled-text: 1 }
+QDialogButtonBox { dialogbuttonbox-buttons-have-icons: 1; }
//! [81]
@@ -1479,7 +1479,7 @@ QSplitter::handle:vertical {
}
QSplitter::handle:pressed {
- url(images/splitter_pressed.png);
+ image: url(images/splitter_pressed.png);
}
//! [142]
diff --git a/doc/src/snippets/code/src_corelib_tools_qvector.cpp b/doc/src/snippets/code/src_corelib_tools_qvector.cpp
index fc46d913d3..fc1a7f7cc2 100644
--- a/doc/src/snippets/code/src_corelib_tools_qvector.cpp
+++ b/doc/src/snippets/code/src_corelib_tools_qvector.cpp
@@ -148,10 +148,10 @@ vector.lastIndexOf("X"); // returns -1
//! [14]
-QVector<double> vect;
+QVector<QString> vect;
vect << "red" << "green" << "blue" << "black";
-QList<double> list = vect.toList();
+QList<QString> list = vect.toList();
// list: ["red", "green", "blue", "black"]
//! [14]
diff --git a/doc/src/snippets/code/src_opengl_qglcolormap.cpp b/doc/src/snippets/code/src_opengl_qglcolormap.cpp
index 3bd780ba45..bf5cd4b12b 100644
--- a/doc/src/snippets/code/src_opengl_qglcolormap.cpp
+++ b/doc/src/snippets/code/src_opengl_qglcolormap.cpp
@@ -42,7 +42,7 @@
#include <QApplication>
#include <QGLColormap>
-int main()
+int main(int argc, char *argv[])
{
QApplication app(argc, argv);
@@ -51,7 +51,8 @@ int main()
// This will fill the colormap with colors ranging from
// black to white.
- for (int i = 0; i < colormap.size(); i++)
+ const int size = 256;
+ for (int i = 0; i < size; i++)
colormap.setEntry(i, qRgb(i, i, i));
widget.setColormap(colormap);
diff --git a/doc/src/snippets/code/src_sql_kernel_qsqldriver.cpp b/doc/src/snippets/code/src_sql_kernel_qsqldriver.cpp
index d49b6e0e19..1a3772f663 100644
--- a/doc/src/snippets/code/src_sql_kernel_qsqldriver.cpp
+++ b/doc/src/snippets/code/src_sql_kernel_qsqldriver.cpp
@@ -41,7 +41,7 @@
//! [0]
QSqlDatabase db = ...;
QVariant v = db.driver()->handle();
-if (v.isValid() && qstrcmp(v.typeName(), "sqlite3*")==0) {
+if (v.isValid() && qstrcmp(v.typeName(), "sqlite3*") == 0) {
// v.data() returns a pointer to the handle
sqlite3 *handle = *static_cast<sqlite3 **>(v.data());
if (handle != 0) { // check that it is not NULL
@@ -52,12 +52,12 @@ if (v.isValid() && qstrcmp(v.typeName(), "sqlite3*")==0) {
//! [1]
-if (v.typeName() == "PGconn*") {
+if (qstrcmp(v.typeName(), "PGconn*") == 0) {
PGconn *handle = *static_cast<PGconn **>(v.data());
if (handle != 0) ...
}
-if (v.typeName() == "MYSQL*") {
+if (qstrcmp(v.typeName(), "MYSQL*") == 0) {
MYSQL *handle = *static_cast<MYSQL **>(v.data());
if (handle != 0) ...
}
diff --git a/doc/src/snippets/qxmlquery/bindingExample.cpp b/doc/src/snippets/qxmlquery/bindingExample.cpp
index 62e19be86a..b81dcfef3e 100644
--- a/doc/src/snippets/qxmlquery/bindingExample.cpp
+++ b/doc/src/snippets/qxmlquery/bindingExample.cpp
@@ -44,6 +44,6 @@
device.open(QIODevice::ReadOnly);
QXmlQuery query;
- query.setQuery("doc($inputDocument)/query[theDocument]");
query.bindVariable("inputDocument", &device);
+ query.setQuery("doc($inputDocument)/query[theDocument]");
//! [0]
diff --git a/examples/draganddrop/fridgemagnets/dragwidget.cpp b/examples/draganddrop/fridgemagnets/dragwidget.cpp
index aeab3ade12..35e6e55af6 100644
--- a/examples/draganddrop/fridgemagnets/dragwidget.cpp
+++ b/examples/draganddrop/fridgemagnets/dragwidget.cpp
@@ -58,7 +58,7 @@ DragWidget::DragWidget(QWidget *parent)
while (!inputStream.atEnd()) {
QString word;
- inputStream >> word;
+ word = inputStream.readLine();
if (!word.isEmpty()) {
DragLabel *wordLabel = new DragLabel(word, this);
wordLabel->move(x, y);
diff --git a/src/3rdparty/webkit/WebKit/qt/docs/webkitsnippets/webelement/main.cpp b/src/3rdparty/webkit/WebKit/qt/docs/webkitsnippets/webelement/main.cpp
index b1781a6f44..59c124c92b 100644
--- a/src/3rdparty/webkit/WebKit/qt/docs/webkitsnippets/webelement/main.cpp
+++ b/src/3rdparty/webkit/WebKit/qt/docs/webkitsnippets/webelement/main.cpp
@@ -57,7 +57,7 @@ static void findButtonAndClick()
*/
QWebElement button = document.findFirst("input[type=submit]");
- button.evaluateJavaScript("click()");
+ button.evaluateJavaScript("this.click()");
//! [Calling a DOM element method]
diff --git a/src/corelib/kernel/qpointer.cpp b/src/corelib/kernel/qpointer.cpp
index 1859e6511b..a7df91c157 100644
--- a/src/corelib/kernel/qpointer.cpp
+++ b/src/corelib/kernel/qpointer.cpp
@@ -97,7 +97,7 @@
Note that class \c T must inherit QObject, or a compilation or
link error will result.
- \sa QSharedPointer, QObject, QObjectCleanupHandler
+ \sa QSharedPointer, QWeakPointer, QObject, QObjectCleanupHandler
*/
/*!
diff --git a/src/corelib/tools/qline.cpp b/src/corelib/tools/qline.cpp
index 0f67652fb5..a909b43a6e 100644
--- a/src/corelib/tools/qline.cpp
+++ b/src/corelib/tools/qline.cpp
@@ -155,7 +155,8 @@ QT_BEGIN_NAMESPACE
/*!
\fn int QLine::dx() const
- Returns the horizontal component of the line's vector.
+ Returns the horizontal component of the line's vector.
+ Return value is positive if x2() >= x1() and negative if x2() < x1().
\sa dy()
*/
@@ -164,6 +165,7 @@ QT_BEGIN_NAMESPACE
\fn int QLine::dy() const
Returns the vertical component of the line's vector.
+ Return value is positive if y2() >= y1() and negative if y2() < y1().
\sa dx()
*/
@@ -501,6 +503,7 @@ bool QLineF::isNull() const
Sets the length of the line to the given \a length. QLineF will
move the end point - p2() - of the line to give the line its new length.
+ If the given \a length is negative the angle() is also changed.
If the line is a null line, the length will remain zero regardless
of the length specified.
@@ -757,7 +760,7 @@ QLineF::IntersectType QLineF::intersect(const QLineF &l, QPointF *intersectionPo
\since 4.4
- Returns the angle (in degrees) from this line to the given \a
+ Returns the angle (in positive degrees) from this line to the given \a
line, taking the direction of the lines into account. If the lines
do not intersect within their range, it is the intersection point of
the extended lines that serves as origin (see
diff --git a/src/corelib/tools/qlist.cpp b/src/corelib/tools/qlist.cpp
index 764a1d650c..1b8d330494 100644
--- a/src/corelib/tools/qlist.cpp
+++ b/src/corelib/tools/qlist.cpp
@@ -469,9 +469,8 @@ void **QListData::erase(void **xi)
\snippet doc/src/snippets/code/src_corelib_tools_qlistdata.cpp 0
Qt includes a QStringList class that inherits QList\<QString\>
- and adds a few convenience functions, such as QStringList::join()
- and QStringList::find(). (QString::split() creates QStringLists
- from strings.)
+ and adds a convenience function QStringList::join().
+ (QString::split() creates QStringLists from strings.)
QList stores a list of items. The default constructor creates an
empty list. To insert items into the list, you can use
diff --git a/src/gui/painting/qpainter.cpp b/src/gui/painting/qpainter.cpp
index 754b16e730..6cee8974d0 100644
--- a/src/gui/painting/qpainter.cpp
+++ b/src/gui/painting/qpainter.cpp
@@ -9316,7 +9316,7 @@ void qt_draw_helper(QPainterPrivate *p, const QPainterPath &path, QPainterPrivat
\oldcode
void *visual = QPaintDevice::x11AppVisual(screen);
\newcode
- void *visual = qApp->x11Info(screen).visual();
+ void *visual = widget->x11Info().appVisual(screen);
\endcode
\sa QWidget::x11Info(), QPixmap::x11Info()
@@ -9328,7 +9328,7 @@ void qt_draw_helper(QPainterPrivate *p, const QPainterPath &path, QPainterPrivat
\oldcode
unsigned long colormap = QPaintDevice::x11AppColormap(screen);
\newcode
- unsigned long colormap = qApp->x11Info(screen).colormap();
+ unsigned long colormap = widget->x11Info().appColormap(screen);
\endcode
\sa QWidget::x11Info(), QPixmap::x11Info()
@@ -9340,7 +9340,7 @@ void qt_draw_helper(QPainterPrivate *p, const QPainterPath &path, QPainterPrivat
\oldcode
Display *display = QPaintDevice::x11AppDisplay();
\newcode
- Display *display = qApp->x11Info().display();
+ Display *display = widget->x11Info().display();
\endcode
\sa QWidget::x11Info(), QPixmap::x11Info()
@@ -9352,7 +9352,7 @@ void qt_draw_helper(QPainterPrivate *p, const QPainterPath &path, QPainterPrivat
\oldcode
int screen = QPaintDevice::x11AppScreen();
\newcode
- int screen = qApp->x11Info().screen();
+ int screen = widget->x11Info().appScreen();
\endcode
\sa QWidget::x11Info(), QPixmap::x11Info()
@@ -9364,7 +9364,7 @@ void qt_draw_helper(QPainterPrivate *p, const QPainterPath &path, QPainterPrivat
\oldcode
int depth = QPaintDevice::x11AppDepth(screen);
\newcode
- int depth = qApp->x11Info(screen).depth();
+ int depth = widget->x11Info().appDepth(screen);
\endcode
\sa QWidget::x11Info(), QPixmap::x11Info()
@@ -9376,7 +9376,7 @@ void qt_draw_helper(QPainterPrivate *p, const QPainterPath &path, QPainterPrivat
\oldcode
int cells = QPaintDevice::x11AppCells(screen);
\newcode
- int cells = qApp->x11Info(screen).cells();
+ int cells = widget->x11Info().appCells(screen);
\endcode
\sa QWidget::x11Info(), QPixmap::x11Info()
@@ -9388,7 +9388,7 @@ void qt_draw_helper(QPainterPrivate *p, const QPainterPath &path, QPainterPrivat
\oldcode
unsigned long window = QPaintDevice::x11AppRootWindow(screen);
\newcode
- unsigned long window = qApp->x11Info(screen).appRootWindow();
+ unsigned long window = widget->x11Info().appRootWindow(screen);
\endcode
\sa QWidget::x11Info(), QPixmap::x11Info()
@@ -9400,7 +9400,7 @@ void qt_draw_helper(QPainterPrivate *p, const QPainterPath &path, QPainterPrivat
\oldcode
bool isDefault = QPaintDevice::x11AppDefaultColormap(screen);
\newcode
- bool isDefault = qApp->x11Info(screen).defaultColormap();
+ bool isDefault = widget->x11Info().appDefaultColormap(screen);
\endcode
\sa QWidget::x11Info(), QPixmap::x11Info()
@@ -9412,7 +9412,7 @@ void qt_draw_helper(QPainterPrivate *p, const QPainterPath &path, QPainterPrivat
\oldcode
bool isDefault = QPaintDevice::x11AppDefaultVisual(screen);
\newcode
- bool isDefault = qApp->x11Info(screen).defaultVisual();
+ bool isDefault = widget->x11Info().appDefaultVisual(screen);
\endcode
\sa QWidget::x11Info(), QPixmap::x11Info()
@@ -9432,7 +9432,7 @@ void qt_draw_helper(QPainterPrivate *p, const QPainterPath &path, QPainterPrivat
\oldcode
bool isDefault = QPaintDevice::x11AppDpiX(screen);
\newcode
- bool isDefault = qApp->x11Info(screen).appDpiX();
+ bool isDefault = widget->x11Info().appDpiX(screen);
\endcode
\sa QWidget::x11Info(), QPixmap::x11Info()
@@ -9444,7 +9444,7 @@ void qt_draw_helper(QPainterPrivate *p, const QPainterPath &path, QPainterPrivat
\oldcode
bool isDefault = QPaintDevice::x11AppDpiY(screen);
\newcode
- bool isDefault = qApp->x11Info(screen).appDpiY();
+ bool isDefault = widget->x11Info().appDpiY(screen);
\endcode
\sa QWidget::x11Info(), QPixmap::x11Info()
diff --git a/src/network/access/qnetworkdiskcache.cpp b/src/network/access/qnetworkdiskcache.cpp
index 9d91a8f88e..7410d4cb7b 100644
--- a/src/network/access/qnetworkdiskcache.cpp
+++ b/src/network/access/qnetworkdiskcache.cpp
@@ -453,7 +453,7 @@ void QNetworkDiskCache::updateMetaData(const QNetworkCacheMetaData &metaData)
}
/*!
- Returns the current maximum size for the disk cache.
+ Returns the current maximum size in bytes for the disk cache.
\sa setMaximumCacheSize()
*/
@@ -464,7 +464,7 @@ qint64 QNetworkDiskCache::maximumCacheSize() const
}
/*!
- Sets the maximum size of the disk cache to be \a size.
+ Sets the maximum size of the disk cache to be \a size in bytes.
If the new size is smaller then the current cache size then the cache will call expire().