summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Olav Tvete <paul.tvete@digia.com>2012-11-30 13:50:14 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2012-11-30 23:56:53 +0100
commite62198967c2a5da4bd7da1c6c4002ca86400a6b7 (patch)
tree2f426061491daff5632620226935989d6bbc1203
parent4cbe999921be70a7ee10fa63cfb199ce82371bda (diff)
Fix links for threading examples
Change-Id: I498936e91e3bbf5658ea9f3f0eb33cff271a1d62 Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
-rw-r--r--examples/threads/doc/images/mandelbrot-example.png (renamed from doc/src/images/mandelbrot-example.png)bin84202 -> 84202 bytes
-rw-r--r--examples/threads/doc/images/mandelbrot_scroll1.pngbin0 -> 19615 bytes
-rw-r--r--examples/threads/doc/images/mandelbrot_scroll2.pngbin0 -> 13901 bytes
-rw-r--r--examples/threads/doc/images/mandelbrot_scroll3.pngbin0 -> 18976 bytes
-rw-r--r--examples/threads/doc/images/mandelbrot_zoom1.pngbin0 -> 16000 bytes
-rw-r--r--examples/threads/doc/images/mandelbrot_zoom2.pngbin0 -> 8163 bytes
-rw-r--r--examples/threads/doc/images/mandelbrot_zoom3.pngbin0 -> 9848 bytes
-rw-r--r--examples/threads/doc/images/queuedcustomtype-example.png (renamed from doc/src/images/queuedcustomtype-example.png)bin44851 -> 44851 bytes
-rw-r--r--examples/threads/doc/src/mandelbrot.qdoc (renamed from doc/src/examples/mandelbrot.qdoc)66
-rw-r--r--examples/threads/doc/src/queuedcustomtype.qdoc (renamed from doc/src/examples/queuedcustomtype.qdoc)22
-rw-r--r--examples/threads/doc/src/semaphores.qdoc (renamed from doc/src/examples/semaphores.qdoc)14
-rw-r--r--examples/threads/doc/src/waitconditions.qdoc (renamed from doc/src/examples/waitconditions.qdoc)14
-rw-r--r--examples/threads/threads.pro2
-rw-r--r--src/corelib/doc/qtcore.qdocconf4
14 files changed, 61 insertions, 61 deletions
diff --git a/doc/src/images/mandelbrot-example.png b/examples/threads/doc/images/mandelbrot-example.png
index f5817834e1..f5817834e1 100644
--- a/doc/src/images/mandelbrot-example.png
+++ b/examples/threads/doc/images/mandelbrot-example.png
Binary files differ
diff --git a/examples/threads/doc/images/mandelbrot_scroll1.png b/examples/threads/doc/images/mandelbrot_scroll1.png
new file mode 100644
index 0000000000..b800455821
--- /dev/null
+++ b/examples/threads/doc/images/mandelbrot_scroll1.png
Binary files differ
diff --git a/examples/threads/doc/images/mandelbrot_scroll2.png b/examples/threads/doc/images/mandelbrot_scroll2.png
new file mode 100644
index 0000000000..704ea0a7c1
--- /dev/null
+++ b/examples/threads/doc/images/mandelbrot_scroll2.png
Binary files differ
diff --git a/examples/threads/doc/images/mandelbrot_scroll3.png b/examples/threads/doc/images/mandelbrot_scroll3.png
new file mode 100644
index 0000000000..8b48211444
--- /dev/null
+++ b/examples/threads/doc/images/mandelbrot_scroll3.png
Binary files differ
diff --git a/examples/threads/doc/images/mandelbrot_zoom1.png b/examples/threads/doc/images/mandelbrot_zoom1.png
new file mode 100644
index 0000000000..30190e44eb
--- /dev/null
+++ b/examples/threads/doc/images/mandelbrot_zoom1.png
Binary files differ
diff --git a/examples/threads/doc/images/mandelbrot_zoom2.png b/examples/threads/doc/images/mandelbrot_zoom2.png
new file mode 100644
index 0000000000..148ac777b8
--- /dev/null
+++ b/examples/threads/doc/images/mandelbrot_zoom2.png
Binary files differ
diff --git a/examples/threads/doc/images/mandelbrot_zoom3.png b/examples/threads/doc/images/mandelbrot_zoom3.png
new file mode 100644
index 0000000000..a669f4b5fe
--- /dev/null
+++ b/examples/threads/doc/images/mandelbrot_zoom3.png
Binary files differ
diff --git a/doc/src/images/queuedcustomtype-example.png b/examples/threads/doc/images/queuedcustomtype-example.png
index 4399b631d7..4399b631d7 100644
--- a/doc/src/images/queuedcustomtype-example.png
+++ b/examples/threads/doc/images/queuedcustomtype-example.png
Binary files differ
diff --git a/doc/src/examples/mandelbrot.qdoc b/examples/threads/doc/src/mandelbrot.qdoc
index 898741fad5..842f4222ae 100644
--- a/doc/src/examples/mandelbrot.qdoc
+++ b/examples/threads/doc/src/mandelbrot.qdoc
@@ -99,7 +99,7 @@
We'll start with the definition of the \c RenderThread class:
- \snippet examples/threads/mandelbrot/renderthread.h 0
+ \snippet mandelbrot/renderthread.h 0
The class inherits QThread so that it gains the ability to run in
a separate thread. Apart from the constructor and destructor, \c
@@ -115,7 +115,7 @@
\section1 RenderThread Class Implementation
- \snippet examples/threads/mandelbrot/renderthread.cpp 0
+ \snippet mandelbrot/renderthread.cpp 0
In the constructor, we initialize the \c restart and \c abort
variables to \c false. These variables control the flow of the \c
@@ -124,7 +124,7 @@
We also initialize the \c colormap array, which contains a series
of RGB colors.
- \snippet examples/threads/mandelbrot/renderthread.cpp 1
+ \snippet mandelbrot/renderthread.cpp 1
The destructor can be called at any point while the thread is
active. We set \c abort to \c true to tell \c run() to stop
@@ -145,7 +145,7 @@
until \c run() has exited before the base class destructor is
invoked.
- \snippet examples/threads/mandelbrot/renderthread.cpp 2
+ \snippet mandelbrot/renderthread.cpp 2
The \c render() function is called by the \c MandelbrotWidget
whenever it needs to generate a new image of the Mandelbrot set.
@@ -159,7 +159,7 @@
computation and start again with the new parameters) and wakes up
the thread, which might be sleeping.
- \snippet examples/threads/mandelbrot/renderthread.cpp 3
+ \snippet mandelbrot/renderthread.cpp 3
\c run() is quite a big function, so we'll break it down into
parts.
@@ -175,10 +175,10 @@
The \c forever keyword is, like \c foreach, a Qt pseudo-keyword.
- \snippet examples/threads/mandelbrot/renderthread.cpp 4
- \snippet examples/threads/mandelbrot/renderthread.cpp 5
- \snippet examples/threads/mandelbrot/renderthread.cpp 6
- \snippet examples/threads/mandelbrot/renderthread.cpp 7
+ \snippet mandelbrot/renderthread.cpp 4
+ \snippet mandelbrot/renderthread.cpp 5
+ \snippet mandelbrot/renderthread.cpp 6
+ \snippet mandelbrot/renderthread.cpp 7
Then comes the core of the algorithm. Instead of trying to create
a perfect Mandelbrot set image, we do multiple passes and
@@ -195,15 +195,15 @@
The core algorithm is beyond the scope of this tutorial.
- \snippet examples/threads/mandelbrot/renderthread.cpp 8
- \snippet examples/threads/mandelbrot/renderthread.cpp 9
+ \snippet mandelbrot/renderthread.cpp 8
+ \snippet mandelbrot/renderthread.cpp 9
Once we're done with all the iterations, we call
QWaitCondition::wait() to put the thread to sleep by calling,
unless \c restart is \c true. There's no use in keeping a worker
thread looping indefinitely while there's nothing to do.
- \snippet examples/threads/mandelbrot/renderthread.cpp 10
+ \snippet mandelbrot/renderthread.cpp 10
The \c rgbFromWaveLength() function is a helper function that
converts a wave length to a RGB value compatible with 32-bit
@@ -215,7 +215,7 @@
The \c MandelbrotWidget class uses \c RenderThread to draw the
Mandelbrot set on screen. Here's the class definition:
- \snippet examples/threads/mandelbrot/mandelbrotwidget.h 0
+ \snippet mandelbrot/mandelbrotwidget.h 0
The widget reimplements many event handlers from QWidget. In
addition, it has an \c updatePixmap() slot that we'll connect to
@@ -228,12 +228,12 @@
\section1 MandelbrotWidget Class Implementation
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 0
+ \snippet mandelbrot/mandelbrotwidget.cpp 0
The implementation starts with a few contants that we'll need
later on.
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 1
+ \snippet mandelbrot/mandelbrotwidget.cpp 1
The interesting part of the constructor is the
qRegisterMetaType() and QObject::connect() calls. Let's start
@@ -256,19 +256,19 @@
template function qRegisterMetaType() before we can use QImage
as parameter in queued connections.
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 2
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 3
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 4
+ \snippet mandelbrot/mandelbrotwidget.cpp 2
+ \snippet mandelbrot/mandelbrotwidget.cpp 3
+ \snippet mandelbrot/mandelbrotwidget.cpp 4
In \l{QWidget::paintEvent()}{paintEvent()}, we start by filling
the background with black. If we have nothing yet to paint (\c
pixmap is null), we print a message on the widget asking the user
to be patient and return from the function immediately.
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 5
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 6
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 7
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 8
+ \snippet mandelbrot/mandelbrotwidget.cpp 5
+ \snippet mandelbrot/mandelbrotwidget.cpp 6
+ \snippet mandelbrot/mandelbrotwidget.cpp 7
+ \snippet mandelbrot/mandelbrotwidget.cpp 8
If the pixmap has the right scale factor, we draw the pixmap directly onto
the widget. Otherwise, we scale and translate the \l{Coordinate
@@ -278,12 +278,12 @@
QPainter::save() and QPainter::restore() make sure that any painting
performed afterwards uses the standard coordinate system.
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 9
+ \snippet mandelbrot/mandelbrotwidget.cpp 9
At the end of the paint event handler, we draw a text string and
a semi-transparent rectangle on top of the fractal.
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 10
+ \snippet mandelbrot/mandelbrotwidget.cpp 10
Whenever the user resizes the widget, we call \c render() to
start generating a new image, with the same \c centerX, \c
@@ -293,13 +293,13 @@
called by Qt when the widget is shown the first time to generate
the image the very first time.
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 11
+ \snippet mandelbrot/mandelbrotwidget.cpp 11
The key press event handler provides a few keyboard bindings for
the benefit of users who don't have a mouse. The \c zoom() and \c
scroll() functions will be covered later.
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 12
+ \snippet mandelbrot/mandelbrotwidget.cpp 12
The wheel event handler is reimplemented to make the mouse wheel
control the zoom level. QWheelEvent::delta() returns the angle of
@@ -310,18 +310,18 @@
(i.e., +30 degrees), the zoom factor becomes \c ZoomInFactor
to the second power, i.e. 0.8 * 0.8 = 0.64.
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 13
+ \snippet mandelbrot/mandelbrotwidget.cpp 13
When the user presses the left mouse button, we store the mouse
pointer position in \c lastDragPos.
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 14
+ \snippet mandelbrot/mandelbrotwidget.cpp 14
When the user moves the mouse pointer while the left mouse button
is pressed, we adjust \c pixmapOffset to paint the pixmap at a
shifted position and call QWidget::update() to force a repaint.
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 15
+ \snippet mandelbrot/mandelbrotwidget.cpp 15
When the left mouse button is released, we update \c pixmapOffset
just like we did on a mouse move and we reset \c lastDragPos to a
@@ -330,7 +330,7 @@
because areas revealed when dragging the pixmap are drawn in
black.)
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 16
+ \snippet mandelbrot/mandelbrotwidget.cpp 16
The \c updatePixmap() slot is invoked when the worker thread has
finished rendering an image. We start by checking whether a drag
@@ -347,14 +347,14 @@
be converted into a pixmap. It's better to do the conversion once
and for all here, rather than in \c paintEvent().
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 17
+ \snippet mandelbrot/mandelbrotwidget.cpp 17
In \c zoom(), we recompute \c curScale. Then we call
QWidget::update() to draw a scaled pixmap, and we ask the worker
thread to render a new image corresponding to the new \c curScale
value.
- \snippet examples/threads/mandelbrot/mandelbrotwidget.cpp 18
+ \snippet mandelbrot/mandelbrotwidget.cpp 18
\c scroll() is similar to \c zoom(), except that the affected
parameters are \c centerX and \c centerY.
@@ -364,5 +364,5 @@
The application's multithreaded nature has no impact on its \c
main() function, which is as simple as usual:
- \snippet examples/threads/mandelbrot/main.cpp 0
+ \snippet mandelbrot/main.cpp 0
*/
diff --git a/doc/src/examples/queuedcustomtype.qdoc b/examples/threads/doc/src/queuedcustomtype.qdoc
index cd3b40f0c7..a1f2d54a21 100644
--- a/doc/src/examples/queuedcustomtype.qdoc
+++ b/examples/threads/doc/src/queuedcustomtype.qdoc
@@ -54,7 +54,7 @@
constructor and destructor in the public section of the class that the
meta-object system requires. It describes a colored rectangle.
- \snippet examples/threads/queuedcustomtype/block.h custom type definition and meta-type declaration
+ \snippet queuedcustomtype/block.h custom type definition and meta-type declaration
We will still need to register it with the meta-object system at
run-time by calling the qRegisterMetaType() template function before
@@ -71,7 +71,7 @@
\c Block object. The rest of the class is concerned with managing the
user interface and handling images.
- \snippet examples/threads/queuedcustomtype/window.h Window class definition
+ \snippet queuedcustomtype/window.h Window class definition
The \c Window class also contains a worker thread, provided by a
\c RenderThread object. This will emit signals to send \c Block objects
@@ -84,22 +84,22 @@
interface containing a label and two push buttons that are connected to
slots in the same class.
- \snippet examples/threads/queuedcustomtype/window.cpp Window constructor start
- \snippet examples/threads/queuedcustomtype/window.cpp set up widgets and connections
- \snippet examples/threads/queuedcustomtype/window.cpp connecting signal with custom type
+ \snippet queuedcustomtype/window.cpp Window constructor start
+ \snippet queuedcustomtype/window.cpp set up widgets and connections
+ \snippet queuedcustomtype/window.cpp connecting signal with custom type
In the last of these connections, we connect a signal in the
\c RenderThread object to the \c addBlock(Block) slot in the window.
\dots
- \snippet examples/threads/queuedcustomtype/window.cpp Window constructor finish
+ \snippet queuedcustomtype/window.cpp Window constructor finish
The rest of the constructor simply sets up the layout of the window.
The \c addBlock(Block) slot receives blocks from the rendering thread via
the signal-slot connection set up in the constructor:
- \snippet examples/threads/queuedcustomtype/window.cpp Adding blocks to the display
+ \snippet queuedcustomtype/window.cpp Adding blocks to the display
We simply paint these onto the label as they arrive.
@@ -109,7 +109,7 @@
and using the \c sendBlock(Block) signal to send them to other components
in the example.
- \snippet examples/threads/queuedcustomtype/renderthread.h RenderThread class definition
+ \snippet queuedcustomtype/renderthread.h RenderThread class definition
The constructor and destructor are not quoted here. These take care of
setting up the thread's internal state and cleaning up when it is destroyed.
@@ -117,13 +117,13 @@
Processing is started with the \c processImage() function, which calls the
\c RenderThread class's reimplementation of the QThread::run() function:
- \snippet examples/threads/queuedcustomtype/renderthread.cpp processing the image (start)
+ \snippet queuedcustomtype/renderthread.cpp processing the image (start)
Ignoring the details of the way the image is processed, we see that the
signal containing a block is emitted in the usual way:
\dots
- \snippet examples/threads/queuedcustomtype/renderthread.cpp processing the image (finish)
+ \snippet queuedcustomtype/renderthread.cpp processing the image (finish)
Each signal that is emitted will be queued and delivered later to the
window's \c addBlock(Block) slot.
@@ -134,7 +134,7 @@
\c Block class as a custom type with the meta-object system by calling the
qRegisterMetaType() template function:
- \snippet examples/threads/queuedcustomtype/main.cpp main function
+ \snippet queuedcustomtype/main.cpp main function
This call is placed here to ensure that the type is registered before any
signal-slot connections are made that use it.
diff --git a/doc/src/examples/semaphores.qdoc b/examples/threads/doc/src/semaphores.qdoc
index b6b4d68f9b..a712cb6414 100644
--- a/doc/src/examples/semaphores.qdoc
+++ b/examples/threads/doc/src/semaphores.qdoc
@@ -59,7 +59,7 @@
Let's start by reviewing the circular buffer and the associated
semaphores:
- \snippet examples/threads/semaphores/semaphores.cpp 0
+ \snippet semaphores/semaphores.cpp 0
\c DataSize is the amout of data that the producer will generate.
To keep the example as simple as possible, we make it a constant.
@@ -87,8 +87,8 @@
Let's review the code for the \c Producer class:
- \snippet examples/threads/semaphores/semaphores.cpp 1
- \snippet examples/threads/semaphores/semaphores.cpp 2
+ \snippet semaphores/semaphores.cpp 1
+ \snippet semaphores/semaphores.cpp 2
The producer generates \c DataSize bytes of data. Before it
writes a byte to the circular buffer, it must acquire a "free"
@@ -104,8 +104,8 @@
Let's now turn to the \c Consumer class:
- \snippet examples/threads/semaphores/semaphores.cpp 3
- \snippet examples/threads/semaphores/semaphores.cpp 4
+ \snippet semaphores/semaphores.cpp 3
+ \snippet semaphores/semaphores.cpp 4
The code is very similar to the producer, except that this time
we acquire a "used" byte and release a "free" byte, instead of
@@ -116,8 +116,8 @@
In \c main(), we create the two threads and call QThread::wait()
to ensure that both threads get time to finish before we exit:
- \snippet examples/threads/semaphores/semaphores.cpp 5
- \snippet examples/threads/semaphores/semaphores.cpp 6
+ \snippet semaphores/semaphores.cpp 5
+ \snippet semaphores/semaphores.cpp 6
So what happens when we run the program? Initially, the producer
thread is the only one that can do anything; the consumer is
diff --git a/doc/src/examples/waitconditions.qdoc b/examples/threads/doc/src/waitconditions.qdoc
index a0b433ca9a..3ca1970685 100644
--- a/doc/src/examples/waitconditions.qdoc
+++ b/examples/threads/doc/src/waitconditions.qdoc
@@ -59,7 +59,7 @@
Let's start by reviewing the circular buffer and the associated
synchronization tools:
- \snippet examples/threads/waitconditions/waitconditions.cpp 0
+ \snippet waitconditions/waitconditions.cpp 0
\c DataSize is the amount of data that the producer will generate.
To keep the example as simple as possible, we make it a constant.
@@ -84,8 +84,8 @@
Let's review the code for the \c Producer class:
- \snippet examples/threads/waitconditions/waitconditions.cpp 1
- \snippet examples/threads/waitconditions/waitconditions.cpp 2
+ \snippet waitconditions/waitconditions.cpp 1
+ \snippet waitconditions/waitconditions.cpp 2
The producer generates \c DataSize bytes of data. Before it
writes a byte to the circular buffer, it must first check whether
@@ -108,8 +108,8 @@
Let's turn to the \c Consumer class:
- \snippet examples/threads/waitconditions/waitconditions.cpp 3
- \snippet examples/threads/waitconditions/waitconditions.cpp 4
+ \snippet waitconditions/waitconditions.cpp 3
+ \snippet waitconditions/waitconditions.cpp 4
The code is very similar to the producer. Before we read the
byte, we check whether the buffer is empty (\c numUsedBytes is 0)
@@ -124,8 +124,8 @@
In \c main(), we create the two threads and call QThread::wait()
to ensure that both threads get time to finish before we exit:
- \snippet examples/threads/waitconditions/waitconditions.cpp 5
- \snippet examples/threads/waitconditions/waitconditions.cpp 6
+ \snippet waitconditions/waitconditions.cpp 5
+ \snippet waitconditions/waitconditions.cpp 6
So what happens when we run the program? Initially, the producer
thread is the only one that can do anything; the consumer is
diff --git a/examples/threads/threads.pro b/examples/threads/threads.pro
index 1ab89c4e0a..027d4c2ebb 100644
--- a/examples/threads/threads.pro
+++ b/examples/threads/threads.pro
@@ -1,4 +1,6 @@
TEMPLATE = subdirs
+CONFIG += no_docs_target
+
SUBDIRS = semaphores \
waitconditions
diff --git a/src/corelib/doc/qtcore.qdocconf b/src/corelib/doc/qtcore.qdocconf
index 5ee1c832ae..2151d95f65 100644
--- a/src/corelib/doc/qtcore.qdocconf
+++ b/src/corelib/doc/qtcore.qdocconf
@@ -35,8 +35,6 @@ sourcedirs += ..
exampledirs += \
../ \
snippets \
- ../../../examples/widgets
-
-excludedirs += ../../../examples/widgets/doc
+ ../../../examples/threads
imagedirs += images