Fix linking in painting, richtext and desktop examples
authorGunnar Sletta <gunnar.sletta@digia.com>
Fri, 30 Nov 2012 12:21:35 +0000 (13:21 +0100)
committerThe Qt Project <gerrit-noreply@qt-project.org>
Fri, 30 Nov 2012 18:40:19 +0000 (19:40 +0100)
Change-Id: If08b2c3366610f74201ab6736f216f1a7d29b3c7
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
21 files changed:
examples/widgets/doc/src/affine.qdoc
examples/widgets/doc/src/basicdrawing.qdoc
examples/widgets/doc/src/calendar.qdoc
examples/widgets/doc/src/calendarwidget.qdoc
examples/widgets/doc/src/composition.qdoc
examples/widgets/doc/src/concentriccircles.qdoc
examples/widgets/doc/src/deform.qdoc
examples/widgets/doc/src/fontsampler.qdoc
examples/widgets/doc/src/gradients.qdoc
examples/widgets/doc/src/imagecomposition.qdoc
examples/widgets/doc/src/orderform.qdoc
examples/widgets/doc/src/painterpaths.qdoc
examples/widgets/doc/src/pathstroke.qdoc
examples/widgets/doc/src/screenshot.qdoc
examples/widgets/doc/src/syntaxhighlighter.qdoc
examples/widgets/doc/src/textedit.qdoc
examples/widgets/doc/src/transformations.qdoc
src/widgets/doc/images/desktop-examples.png [new file with mode: 0644]
src/widgets/doc/images/painting-examples.png [new file with mode: 0644]
src/widgets/doc/images/richtext-examples.png [new file with mode: 0644]
src/widgets/doc/src/qtwidgets-examples.qdoc

index 46c97a3..da4a103 100644 (file)
@@ -28,6 +28,8 @@
 /*!
     \example painting/affine
     \title Affine Transformations
+    \ingroup examples-painting
+    \brief Demonstrates how affine transformations in QPainter works.
 
     \brief In this example we show Qt's ability to perform affine transformations
     on painting operations.
index 295822d..b8ff580 100644 (file)
 /*!
     \example painting/basicdrawing
     \title Basic Drawing Example
+    \ingroup examples-painting
+    \brief The Basic Drawing example shows how to display basic
+    graphics primitives in a variety of styles using the QPainter
+    class.
 
     \brief The Basic Drawing example shows how to display basic graphics
     primitives in a variety of styles using the QPainter class.
index 9168bfd..ea7b563 100644 (file)
@@ -28,6 +28,9 @@
 /*!
     \example richtext/calendar
     \title Calendar Example
+    \ingroup examples-richtext
+    \brief The Calendar example shows how to create rich text content
+    and display it using a rich text editor.
 
     \brief The Calendar example shows how to create rich text content and display it using
     a rich text editor.
index 027da90..18ac8db 100644 (file)
@@ -29,7 +29,7 @@
     \title Calendar Widget Example
     \example widgets/calendarwidget
     \ingroup examples-widgets
-    \brief The Calendar Widget example shows use of \c QCalendarWidget.
+    \brief The Calendar Widget example shows use of QCalendarWidget.
 
     \image calendarwidgetexample.png
 
index e39083b..bb34d39 100644 (file)
@@ -28,6 +28,8 @@
 /*!
     \example painting/composition
     \title Composition Modes
+    \ingroup examples-painting
+    \brief Demonstrates how Composition Modes work in QPainter.
 
     \brief This demo shows some of the more advanced composition modes supported by Qt.
 
index 5633833..40a4d19 100644 (file)
@@ -28,6 +28,8 @@
 /*!
     \example painting/concentriccircles
     \title Concentric Circles Example
+    \ingroup examples-painting
+    \brief Demonstrates the improved quality that antialiasing and floating point precision gives.
 
     \brief The Concentric Circles example shows the improved rendering
     quality that can be obtained using floating point precision and
index 742f552..3439c76 100644 (file)
@@ -28,6 +28,8 @@
 /*!
     \example painting/deform
     \title Vector Deformation
+    \ingroup examples-painting
+    \brief Demonstrates how to manipulate the elements of a QPainterPath.
 
     \brief This example shows how to use advanced vector techniques to draw text
     using a \c QPainterPath.
index 753e5b0..e112927 100644 (file)
 /*!
   \example painting/fontsampler
   \title Font Sampler Example
-
+  \ingroup examples-painting
   \brief The Font Sampler example shows how to preview and print multi-page documents.
+  
+  The Font Sampler example shows how to preview and print multi-page documents.
 
   \image fontsampler-example.png
 */
index a730154..0137f76 100644 (file)
@@ -28,6 +28,8 @@
 /*!
     \example painting/gradients
     \title Gradients
+    \ingroup examples-painting
+    \brief Shows how gradients can be used with QPainter.
 
     \brief In this example we show the various types of gradients that can
     be used in Qt.
index 31ef4c7..537d8ec 100644 (file)
@@ -28,6 +28,8 @@
 /*!
     \example painting/imagecomposition
     \title Image Composition Example
+    \ingroup examples-painting
+    \brief Shows how composition modes work in QPainter.
 
     \brief The Image Composition example lets the user combine images
     together using any composition mode supported by QPainter, described
index 5b2f9a0..80814b5 100644 (file)
 /*!
     \example richtext/orderform
     \title Order Form Example
+    \ingroup examples-richtext
+    \brief The Order Form example shows how to generate rich text
+    documents by combining a simple template with data input by the
+    user in a dialog.
 
     \brief The Order Form example shows how to generate rich text documents by
     combining a simple template with data input by the user in a dialog. Data
index 2266cec..46e5228 100644 (file)
@@ -28,6 +28,9 @@
 /*!
     \example painting/painterpaths
     \title Painter Paths Example
+    \ingroup examples-painting
+    \brief The Painter Paths example shows how painter paths can be
+    used to beuild complex shapes for rendering.
 
     \brief The Painter Paths example shows how painter paths can be used to
     build complex shapes for rendering.
index b11cc1b..6a21eb7 100644 (file)
@@ -28,6 +28,9 @@
 /*!
     \example painting/pathstroke
     \title Path Stroking
+    \ingroup examples-painting
+    \brief The Path Stroking example shows various types of pens that
+    can be used with QPainter.
 
     \brief In this example we show some of the various types of pens that can be
     used in Qt.
index f0d2f2b..72f366f 100644 (file)
@@ -28,6 +28,9 @@
 /*!
     \example desktop/screenshot
     \title Screenshot Example
+    \ingroup examples-desktop
+    \brief The Screenshot example shows how to take a screenshot of the
+    desktop.
 
     \brief The Screenshot example shows how to take a screenshot of the
     desktop using QApplication and QDesktopWidget. It also shows how
index 8167137..b417499 100644 (file)
@@ -28,6 +28,9 @@
 /*!
     \example richtext/syntaxhighlighter
     \title Syntax Highlighter Example
+    \group examples-richtext
+    \brief The Syntax Highligher example shows how to perform
+    simple syntax highlighing.
 
     \brief The Syntax Highlighter example shows how to perform simple syntax
     highlighting by subclassing the QSyntaxHighlighter class.
index 4f1f618..c3651a0 100644 (file)
@@ -28,6 +28,9 @@
 /*!
     \example richtext/textedit
     \title Text Edit
+    \ingroup examples-richtext
+    \brief The Text Edit example shows Qt's rich text editing facilities
+    in action.
 
     \brief The Text Edit example shows Qt's rich text editing facilities in action,
     providing an example document for you to experiment with.
index 47d8445..2824d4a 100644 (file)
@@ -28,6 +28,9 @@
 /*!
     \example painting/transformations
     \title Transformations Example
+    \ingroup examples-painting
+    \brief The Transformations example shows how transformations
+    influence the way that QPainter renders graphics primitives.
 
     \brief The Transformations example shows how transformations influence
     the way that QPainter renders graphics primitives. In particular
diff --git a/src/widgets/doc/images/desktop-examples.png b/src/widgets/doc/images/desktop-examples.png
new file mode 100644 (file)
index 0000000..86b16b4
Binary files /dev/null and b/src/widgets/doc/images/desktop-examples.png differ
diff --git a/src/widgets/doc/images/painting-examples.png b/src/widgets/doc/images/painting-examples.png
new file mode 100644 (file)
index 0000000..214004c
Binary files /dev/null and b/src/widgets/doc/images/painting-examples.png differ
diff --git a/src/widgets/doc/images/richtext-examples.png b/src/widgets/doc/images/richtext-examples.png
new file mode 100644 (file)
index 0000000..1091c20
Binary files /dev/null and b/src/widgets/doc/images/richtext-examples.png differ
index b199c97..05402d9 100644 (file)
 
     \annotatedlist examples-widgets
 
-*/
\ No newline at end of file
+*/
+
+/*!
+    \page examples-painting.html
+    \ingroup all-examples
+    \title Painting Examples
+    \brief How to use the Qt painting system.
+    \group examples-painting
+
+    \image painting-examples.png
+
+    Qt's painting system is able to render vector graphics, images, and outline
+    font-based text with sub-pixel accuracy accuracy using anti-aliasing to
+    improve rendering quality.
+
+    These examples show the most common techniques that are used when painting
+    with Qt, from basic concepts such as drawing simple primitives to the use of
+    transformations.
+
+    \annotatedlist{painting-examples}
+*/
+
+/*!
+    \page examples-richtext.html
+    \ingroup all-examples
+    \title Rich Text Examples
+    \brief Using the document-oriented rich text engine.
+    \group examples-richtext
+
+    \image richtext-examples.png
+
+    Qt provides powerful document-oriented rich text engine that supports Unicode
+    and right-to-left scripts. Documents can be manipulated using a cursor-based
+    API, and their contents can be imported and exported as both HTML and in a
+    custom XML format.
+
+ */
+
+/*!
+    \page examples-desktop.html
+    \ingroup all-examples
+    \title Desktop Examples
+    \brief Integrating your Qt application with your favorite desktop.
+    \group examples-desktop
+
+    \image desktop-examples.png
+
+    Qt provides features to enable applications to integrate with the user's
+    preferred desktop environment.
+
+    Features such as system tray icons, access to the desktop widget, and
+    support for desktop services can be used to improve the appearance of
+    applications and take advantage of underlying desktop facilities.
+
+*/
+