Use \annotatedlist for list of examples instead of "manual links"

Change-Id: Id945fd35f5eb6a6d11156d4a1356f99cc49405e2
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
bb10
Jan Arve Saether 2012-10-22 13:39:07 +02:00 committed by Jan Arve Sæther
parent 1c370b2215
commit 294dbc7bfd
22 changed files with 56 additions and 73 deletions

View File

@ -28,8 +28,8 @@
/*!
\example widgets/calculator
\title Calculator Example
The example shows how to use signals and slots to implement the
\ingroup examples-widgets
\brief The example shows how to use signals and slots to implement the
functionality of a calculator widget, and how to use QGridLayout
to place child widgets in a grid.

View File

@ -28,8 +28,8 @@
/*!
\title Calendar Widget Example
\example widgets/calendarwidget
The Calendar Widget example shows use of \c QCalendarWidget.
\ingroup examples-widgets
\brief The Calendar Widget example shows use of \c QCalendarWidget.
\image calendarwidgetexample.png

View File

@ -28,8 +28,8 @@
/*!
\example widgets/charactermap
\title Character Map Example
The Character Map example shows how to create a custom widget that can
\ingroup examples-widgets
\brief The Character Map example shows how to create a custom widget that can
both display its own content and respond to user input.
The example displays an array of characters which the user can click on

View File

@ -28,8 +28,8 @@
/*!
\example widgets/codeeditor
\title Code Editor Example
The Code Editor example shows how to create a simple editor that
\ingroup examples-widgets
\brief The Code Editor example shows how to create a simple editor that
has line numbers and that highlights the current line.
\image codeeditor-example.png

View File

@ -28,8 +28,8 @@
/*!
\example widgets/digitalclock
\title Digital Clock Example
The Digital Clock example shows how to use QLCDNumber to display a
\ingroup examples-widgets
\brief The Digital Clock example shows how to use QLCDNumber to display a
number with LCD-like digits.
\image digitalclock-example.png Screenshot of the Digital Clock example

View File

@ -28,8 +28,8 @@
/*!
\example widgets/groupbox
\title Group Box Example
The Group Box example shows how to use the different kinds of group
\ingroup examples-widgets
\brief The Group Box example shows how to use the different kinds of group
boxes in Qt.
Group boxes are container widgets that organize buttons into groups,

View File

@ -28,11 +28,13 @@
/*!
\example widgets/icons
\title Icons Example
\ingroup examples-widgets
\brief The Icons example shows how QIcon can generate pixmaps reflecting
an icon's state, mode and size.
The Icons example shows how QIcon can generate pixmaps reflecting
an icon's state, mode and size. These pixmaps are generated from
the set of pixmaps made available to the icon, and are used by Qt
widgets to show an icon representing a particular action.
These pixmaps are generated from the set of pixmaps made available to the
icon, and are used by Qt widgets to show an icon representing a particular
action.
\image icons-example.png Screenshot of the Icons example

View File

@ -28,9 +28,11 @@
/*!
\example widgets/imageviewer
\title Image Viewer Example
\ingroup examples-widgets
\brief The example shows how to combine QLabel and QScrollArea to
display an image.
The example shows how to combine QLabel and QScrollArea to
display an image. QLabel is typically used for displaying text,
QLabel is typically used for displaying text,
but it can also display an image. QScrollArea provides a
scrolling view around another widget. If the child widget exceeds
the size of the frame, QScrollArea automatically provides scroll

View File

@ -28,10 +28,11 @@
/*!
\example widgets/lineedits
\title Line Edits Example
\ingroup examples-widgets
\brief The Line Edits example demonstrates the many ways that QLineEdit
can be used, and shows the effects of various properties and validators
on the input and output supplied by the user.
The Line Edits example demonstrates the many ways that QLineEdit can be used, and
shows the effects of various properties and validators on the input and output
supplied by the user.
\image lineedits-example.png

View File

@ -28,9 +28,11 @@
/*!
\example widgets/movie
\title Movie Example
\ingroup examples-widgets
\brief The Movie example demonstrates how to use QMovie and QLabel to
display animations.
The Movie example demonstrates how to use QMovie and QLabel to
display animations. QMovie is mostly useful if one wants to play
QMovie is mostly useful if one wants to play
a simple animation without the added complexity of a multimedia
framework to install and deploy.

View File

@ -28,8 +28,8 @@
/*!
\example widgets/scribble
\title Scribble Example
The Scribble example shows how to reimplement some of QWidget's
\ingroup examples-widgets
\brief The Scribble example shows how to reimplement some of QWidget's
event handlers to receive the events generated for the
application's widgets.

View File

@ -28,8 +28,8 @@
/*!
\example widgets/shapedclock
\title Shaped Clock Example
The Shaped Clock example shows how to apply a widget mask to a top-level
\ingroup examples-widgets
\brief The Shaped Clock example shows how to apply a widget mask to a top-level
widget to produce a shaped window.
\image shapedclock-example.png

View File

@ -28,6 +28,9 @@
/*!
\example widgets/sliders
\title Sliders Example
\ingroup examples-widgets
\brief The Sliders example shows how to use the different types of sliders
available in Qt: QSlider, QScrollBar and QDial.
Qt provides three types of slider-like widgets: QSlider,
QScrollBar and QDial. They all inherit most of their

View File

@ -28,10 +28,10 @@
/*!
\example widgets/spinboxes
\title Spin Boxes Example
The Spin Boxes example shows how to use the many different types of spin boxes
available in Qt, from a simple QSpinBox widget to more complex editors like
the QDateTimeEdit widget.
\ingroup examples-widgets
\brief The Spin Boxes example shows how to use the many different types of
spin boxes available in Qt, from a simple QSpinBox widget to more complex
editors like the QDateTimeEdit widget.
\image spinboxes-example.png

View File

@ -28,8 +28,8 @@
/*!
\example widgets/styles
\title Styles Example
The Styles example illustrates how to create custom widget
\ingroup examples-widgets
\brief The Styles example illustrates how to create custom widget
drawing styles using Qt, and demonstrates Qt's predefined styles.
\image styles-enabledwood.png Screenshot of the Styles example

View File

@ -28,8 +28,8 @@
/*!
\example widgets/stylesheet
\title Style Sheet Example
The Style Sheet Example shows how to use style sheets.
\ingroup examples-widgets
\brief The Style Sheet Example shows how to use style sheets.
\image stylesheet-pagefold.png Screen Shot of the Pagefold style sheet
*/

View File

@ -28,8 +28,8 @@
/*!
\example widgets/tablet
\title Tablet Example
This example shows how to use a Wacom tablet in Qt applications.
\ingroup examples-widgets
\brief This example shows how to use a Wacom tablet in Qt applications.
\image tabletexample.png

View File

@ -28,8 +28,8 @@
/*!
\example widgets/tetrix
\title Tetrix Example
The Tetrix example is a Qt version of the classic Tetrix game.
\ingroup examples-widgets
\brief The Tetrix example is a Qt version of the classic Tetrix game.
\image tetrix-example.png

View File

@ -28,8 +28,8 @@
/*!
\example widgets/tooltips
\title Tool Tips Example
The Tool Tips example shows how to provide static and dynamic tool
\ingroup examples-widgets
\brief The Tool Tips example shows how to provide static and dynamic tool
tips for an application's widgets.
The simplest and most common way to set a widget's tool tip is by

View File

@ -28,8 +28,8 @@
/*!
\example widgets/wiggly
\title Wiggly Example
The Wiggly example shows how to animate a widget using
\ingroup examples-widgets
\brief The Wiggly example shows how to animate a widget using
QBasicTimer and \l{QObject::timerEvent()}{timerEvent()}. In
addition, the example demonstrates how to use QFontMetrics to
determine the size of text on screen.

View File

@ -28,8 +28,8 @@
/*!
\example widgets/windowflags
\title Window Flags Example
The Window Flags example shows how to use the window flags
\ingroup examples-widgets
\brief The Window Flags example shows how to use the window flags
available in Qt.
A window flag is either a type or a hint. A type is used to

View File

@ -43,33 +43,6 @@
be used to change the appearance of standard widgets and appropriately
written custom widgets.
\list
\li \l{widgets/analogclock}{Analog Clock}\raisedaster
\li \l{widgets/calculator}{Calculator}\raisedaster
\li \l{widgets/calendarwidget}{Calendar Widget}\raisedaster
\li \l{widgets/charactermap}{Character Map}\raisedaster
\li \l{widgets/codeeditor}{Code Editor}\raisedaster
\li \l{widgets/digitalclock}{Digital Clock}\raisedaster
\li \l{widgets/groupbox}{Group Box}\raisedaster
\li \l{widgets/icons}{Icons}\raisedaster
\li \l{widgets/imageviewer}{Image Viewer}\raisedaster
\li \l{widgets/lineedits}{Line Edits}\raisedaster
\li \l{widgets/movie}{Movie}
\li \l{widgets/scribble}{Scribble}\raisedaster
\li \l{widgets/shapedclock}{Shaped Clock}\raisedaster
\li \l{widgets/sliders}{Sliders}\raisedaster
\li \l{widgets/softkeys}{Soft Keys}
\li \l{widgets/spinboxes}{Spin Boxes}\raisedaster
\li \l{widgets/styles}{Styles}\raisedaster
\li \l{widgets/stylesheet}{Style Sheet}\raisedaster
\li \l{widgets/tablet}{Tablet}\raisedaster
\li \l{widgets/tetrix}{Tetrix}\raisedaster
\li \l{widgets/tooltips}{Tooltips}\raisedaster
\li \l{widgets/validators}{Validators}
\li \l{widgets/wiggly}{Wiggly}\raisedaster
\li \l{widgets/windowflags}{Window Flags}\raisedaster
\endlist
Examples marked with an asterisk (*) are fully documented.
\annotatedlist examples-widgets
*/