diff options
| author | Casper van Donderen <casper.vandonderen@nokia.com> | 2011-10-14 09:29:10 (GMT) |
|---|---|---|
| committer | Casper van Donderen <casper.vandonderen@nokia.com> | 2011-10-14 09:29:10 (GMT) |
| commit | 2149ddf44417ca3e266a692501394d0f7be9674e (patch) | |
| tree | 39958b4ba91a2c2d0dad1693748da9577b371734 /doc | |
| parent | 895d9b6e1566f74748b4fd90c8a5811e0a22e0e8 (diff) | |
| parent | 5514d98d412022311f42de50719da242aaa71490 (diff) | |
| download | Qt-2149ddf44417ca3e266a692501394d0f7be9674e.zip Qt-2149ddf44417ca3e266a692501394d0f7be9674e.tar.gz Qt-2149ddf44417ca3e266a692501394d0f7be9674e.tar.bz2 | |
Merge remote-tracking branch 'qt-doc-review/master'
Diffstat (limited to 'doc')
305 files changed, 703 insertions, 398 deletions
diff --git a/doc/src/demos/affine.qdoc b/doc/src/demos/affine.qdoc index adc1a78..912e412 100644 --- a/doc/src/demos/affine.qdoc +++ b/doc/src/demos/affine.qdoc @@ -29,7 +29,7 @@ \example demos/affine \title Affine Transformations - In this demo we show Qt's ability to perform affine transformations + \brief The Affine Transformations demo shows Qt's ability to perform affine transformations on painting operations. \image affine-demo.png diff --git a/doc/src/demos/anomaly.qdoc b/doc/src/demos/anomaly.qdoc index 9d19099..c6dfcf2 100644 --- a/doc/src/demos/anomaly.qdoc +++ b/doc/src/demos/anomaly.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/anomaly \title Anomaly Demonstration + \brief The anomaly demo shows a QtWebKit browser for mobile devices. + \image anomaly-demo.png */ diff --git a/doc/src/demos/arthurplugin.qdoc b/doc/src/demos/arthurplugin.qdoc index c5daf18..3d168e3 100644 --- a/doc/src/demos/arthurplugin.qdoc +++ b/doc/src/demos/arthurplugin.qdoc @@ -29,7 +29,7 @@ \example demos/arthurplugin \title Arthur Plugin - In this demo we demonstrate the abilities of Qt's painting system + \brief The Arthur Plugin demo demonstrates the abilities of Qt's painting system in combination with \QD's custom widget plugin facilities. \image arthurplugin-demo.png diff --git a/doc/src/demos/books.qdoc b/doc/src/demos/books.qdoc index 7eccd5b..220f5eb 100644 --- a/doc/src/demos/books.qdoc +++ b/doc/src/demos/books.qdoc @@ -29,7 +29,7 @@ \example demos/books \title Books Demonstration - The Books demonstration shows how Qt's SQL classes can be used with the model/view + \brief The Books demonstration shows how Qt's SQL classes can be used with the model/view framework to create rich user interfaces for information stored in a database. \image books-demo.png diff --git a/doc/src/demos/boxes.qdoc b/doc/src/demos/boxes.qdoc index 52ee63b..ae2cbe6 100644 --- a/doc/src/demos/boxes.qdoc +++ b/doc/src/demos/boxes.qdoc @@ -29,7 +29,7 @@ \example demos/boxes \title Boxes - This demo shows Qt's ability to combine advanced OpenGL rendering with the + \brief The Boxes demo shows Qt's ability to combine advanced OpenGL rendering with the the \l{Graphics View Framework}. \image boxes-demo.png diff --git a/doc/src/demos/browser.qdoc b/doc/src/demos/browser.qdoc index 2cfc933..61b869c 100644 --- a/doc/src/demos/browser.qdoc +++ b/doc/src/demos/browser.qdoc @@ -29,7 +29,7 @@ \page demos-browser.html \title Web Browser - The Web Browser demonstration shows Qt's WebKit module in action, + \brief The Web Browser demonstration shows Qt's WebKit module in action, providing a little Web browser application. \image browser-demo.png diff --git a/doc/src/demos/chip.qdoc b/doc/src/demos/chip.qdoc index eda0bed..fd1b3c7 100644 --- a/doc/src/demos/chip.qdoc +++ b/doc/src/demos/chip.qdoc @@ -29,7 +29,7 @@ \example demos/chip \title 40000 Chips - This demo shows how to visualize a huge scene with 40000 chip items + \brief The 40000 Chips demo shows how to visualize a huge scene with 40000 chip items using Graphics View. It also shows Graphics View's powerful navigation and interaction features, allowing you to zoom and rotate each of four views independently, and you can select and move items around the scene. diff --git a/doc/src/demos/composition.qdoc b/doc/src/demos/composition.qdoc index c2eadc7..23a2815 100644 --- a/doc/src/demos/composition.qdoc +++ b/doc/src/demos/composition.qdoc @@ -29,7 +29,7 @@ \example demos/composition \title Composition Modes - This demo shows some of the more advanced composition modes supported by Qt. + \brief The Composition Modes demo shows some of the more advanced composition modes supported by Qt. \image composition-demo.png diff --git a/doc/src/demos/deform.qdoc b/doc/src/demos/deform.qdoc index 7b11a9a..aa2a1ae 100644 --- a/doc/src/demos/deform.qdoc +++ b/doc/src/demos/deform.qdoc @@ -29,7 +29,7 @@ \example demos/deform \title Vector Deformation - This demo shows how to use advanced vector techniques to draw text + \brief The Vector Deformation demo shows how to use advanced vector techniques to draw text using a \c QPainterPath. \image deform-demo.png diff --git a/doc/src/demos/desktopservices.qdoc b/doc/src/demos/desktopservices.qdoc index f1abed8..c83605d 100644 --- a/doc/src/demos/desktopservices.qdoc +++ b/doc/src/demos/desktopservices.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/desktopservices \title Embedded Desktop Services Demonstration + \brief The Embedded Desktop Services demo shows the Qt Desktop Services API. + \image embeddeddesktopservices-demo.png */ diff --git a/doc/src/demos/digiflip.qdoc b/doc/src/demos/digiflip.qdoc index 33f083f..40172f2 100644 --- a/doc/src/demos/digiflip.qdoc +++ b/doc/src/demos/digiflip.qdoc @@ -27,5 +27,8 @@ /*! \example demos/embedded/digiflip + + \brief The Digiflip demo shows the Animation Framework in an embedded context. + \title Digiflip Demonstration */ diff --git a/doc/src/demos/embeddeddialogs.qdoc b/doc/src/demos/embeddeddialogs.qdoc index e80f76c..50ae6b6 100644 --- a/doc/src/demos/embeddeddialogs.qdoc +++ b/doc/src/demos/embeddeddialogs.qdoc @@ -29,7 +29,7 @@ \example demos/embeddeddialogs \title Embedded Dialogs - This example shows how to embed standard dialogs into + \brief The Embedded Dialogs demo shows how to embed standard dialogs into Graphics View. It also shows how you can customize the proxy class and add window shadows. diff --git a/doc/src/demos/embeddedsvgviewer.qdoc b/doc/src/demos/embeddedsvgviewer.qdoc index 044923a..063119f 100644 --- a/doc/src/demos/embeddedsvgviewer.qdoc +++ b/doc/src/demos/embeddedsvgviewer.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/embeddedsvgviewer \title Embedded SVG Viewer Demonstration + \brief The Embedded SVG Viewer demo shows Graphics View SVG rendering in an embedded context. + \image embeddedsvgviewer-demo.png */ diff --git a/doc/src/demos/flickable.qdoc b/doc/src/demos/flickable.qdoc index 540857b..4baea5b 100644 --- a/doc/src/demos/flickable.qdoc +++ b/doc/src/demos/flickable.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/flickable \title Flickable List Demonstration + \brief The Flickable List demo shows a flickable list in an embedded context. + \image flickable-demo.png */ diff --git a/doc/src/demos/flightinfo.qdoc b/doc/src/demos/flightinfo.qdoc index e812dbf..2942603 100644 --- a/doc/src/demos/flightinfo.qdoc +++ b/doc/src/demos/flightinfo.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/flightinfo \title Flight Info Demonstration + \brief The Flight Info demo shows requesting data from an external server in a mbile device context. + \image flightinfo-demo.png */ diff --git a/doc/src/demos/fluidlauncher.qdoc b/doc/src/demos/fluidlauncher.qdoc index 42623e8..2fe602a 100644 --- a/doc/src/demos/fluidlauncher.qdoc +++ b/doc/src/demos/fluidlauncher.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/fluidlauncher \title Fluid Launcher Demonstration + \brief The Fluid Launcher demo demonstrates an application launcher for mobile devices + \image fluidlauncher-demo.png */ diff --git a/doc/src/demos/glhypnotizer.qdoc b/doc/src/demos/glhypnotizer.qdoc index 468a4ac..0782e90 100644 --- a/doc/src/demos/glhypnotizer.qdoc +++ b/doc/src/demos/glhypnotizer.qdoc @@ -29,7 +29,7 @@ \example demos/glhypnotizer \title GL Hypnotizer - This demo shows how to use OpenGL from a seperate thread. + \brief The GL Hypnotizer demo shows how to use OpenGL from a seperate thread. \image glhypnotizer-demo.png diff --git a/doc/src/demos/gradients.qdoc b/doc/src/demos/gradients.qdoc index 1f29a4a..5c400a1 100644 --- a/doc/src/demos/gradients.qdoc +++ b/doc/src/demos/gradients.qdoc @@ -29,7 +29,7 @@ \example demos/gradients \title Gradients - In this demo we show the various types of gradients that can + \brief The Gradients demo shows the various types of gradients that can be used in Qt. \image gradients-demo.png diff --git a/doc/src/demos/guitartuner.qdoc b/doc/src/demos/guitartuner.qdoc index df15c04..8a1e875 100644 --- a/doc/src/demos/guitartuner.qdoc +++ b/doc/src/demos/guitartuner.qdoc @@ -27,16 +27,19 @@ /*! \page guitartuner_example.html - \title Guitar Tuner Example + \title Guitar Tuner Demonstration \example demos/mobile/guitartuner +\brief The Guitar Tuner demo demonstrates the audio-in and audio-out interfaces of +Qt Mobility Multimedia, and integrating Qt code in a Qt Quick UI. + The Guitar Tuner application can be used to tune guitar strings by analyzing the audio recorded by the device microphone. Guitar Tuner can be also used in the listening mode. It will then play the audio by the corresponding frequency, and the user can tune the guitar by ear. The application demonstrates the audio-in and the audio-out interfaces of \l{external: Mobility Multimedia}{Qt Mobility Multimedia} and integrating Qt -code to the Qt Quick UI. +code in a Qt Quick UI. The example is hosted in Projects Forum Nokia: https://projects.forum.nokia.com/guitartuner diff --git a/doc/src/demos/interview.qdoc b/doc/src/demos/interview.qdoc index fa40ed2..7050cc3 100644 --- a/doc/src/demos/interview.qdoc +++ b/doc/src/demos/interview.qdoc @@ -29,7 +29,7 @@ \example demos/interview \title Interview - The Interview demonstration explores the flexibility and scalability of the + \brief The Interview demonstration explores the flexibility and scalability of the model/view framework by presenting an infinitely deep data structure using a model and three different types of view. diff --git a/doc/src/demos/lightmaps.qdoc b/doc/src/demos/lightmaps.qdoc index a8594f9..11eb3c3 100644 --- a/doc/src/demos/lightmaps.qdoc +++ b/doc/src/demos/lightmaps.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/lightmaps \title Light Maps Demonstration + \brief The Light Maps demo shows graphics effects in an embedded context. + \image lightmaps-demo.png */ diff --git a/doc/src/demos/macmainwindow.qdoc b/doc/src/demos/macmainwindow.qdoc index 31c0230..aaed304 100644 --- a/doc/src/demos/macmainwindow.qdoc +++ b/doc/src/demos/macmainwindow.qdoc @@ -29,7 +29,7 @@ \example demos/macmainwindow \title Mac Main Window Demo - This demo shows how to create a main window that has the + \brief The Mac Main Window demo shows how to create a main window that has the same appearance as other Mac OS X applications such as Mail or iTunes. This includes customizing the item views and QSplitter and wrapping native widgets such as the search field. diff --git a/doc/src/demos/mainwindow.qdoc b/doc/src/demos/mainwindow.qdoc index dee7202..0bd084f 100644 --- a/doc/src/demos/mainwindow.qdoc +++ b/doc/src/demos/mainwindow.qdoc @@ -29,7 +29,7 @@ \example demos/mainwindow \title Main Window - The Main Window demonstration shows Qt's extensive support for tool bars, + \brief The Main Window demonstration shows Qt's extensive support for tool bars, dock windows, menus, and other standard application features. \image mainwindow-demo.png diff --git a/doc/src/demos/mediaplayer.qdoc b/doc/src/demos/mediaplayer.qdoc index 8f35ee5..227b346 100644 --- a/doc/src/demos/mediaplayer.qdoc +++ b/doc/src/demos/mediaplayer.qdoc @@ -29,7 +29,7 @@ \example demos/qmediaplayer \title Media Player - The Media Player demonstration shows how \l{Phonon Module}{Phonon} + \brief The Media Player demonstration shows how \l{Phonon Module}{Phonon} can be used in Qt applications to handle audio and video playback. \image qmediaplayer-demo.png diff --git a/doc/src/demos/mobiledemos.qdoc b/doc/src/demos/mobiledemos.qdoc index 2aaa258..6af10f6 100644 --- a/doc/src/demos/mobiledemos.qdoc +++ b/doc/src/demos/mobiledemos.qdoc @@ -30,8 +30,10 @@ \example demos/mobile/quickhit \title Quick Hit Demo - This demo shows how to use Mobility APIs to access device audio - capabilities. Uses the multimedia and systeminfo modules of + \brief The Quick Hit demo shows how to use Mobility APIs to access device audio + capabilities. + + The demo uses the multimedia and systeminfo modules of \l{external: Qt Mobility Manual}{Qt Mobility}. \note This demonstration requires QtMobility libraries. diff --git a/doc/src/demos/pathstroke.qdoc b/doc/src/demos/pathstroke.qdoc index 8e864e2..97ee8ab 100644 --- a/doc/src/demos/pathstroke.qdoc +++ b/doc/src/demos/pathstroke.qdoc @@ -29,7 +29,7 @@ \example demos/pathstroke \title Path Stroking - In this demo we show some of the various types of pens that can be + \brief This Path Stroking demo shows some of the various types of pens that can be used in Qt. \image pathstroke-demo.png diff --git a/doc/src/demos/qcamera.qdoc b/doc/src/demos/qcamera.qdoc index f41afd7..be3f667 100644 --- a/doc/src/demos/qcamera.qdoc +++ b/doc/src/demos/qcamera.qdoc @@ -27,10 +27,10 @@ /*! \page qcamera_example.html - \title QCamera Example + \title QCamera Demo \example demos/mobile/qcamera - This Qt C++ application demonstrates how to use Multimedia, Messaging and Contacts modules from \l{external: Qt Mobility Manual}{Qt Mobility}. + \brief The QCamera demo shows how to use Multimedia, Messaging and Contacts modules from Qt Mobility. \image qcameraexample.png diff --git a/doc/src/demos/qml-qtbubblelevel.qdoc b/doc/src/demos/qml-qtbubblelevel.qdoc index 052dd50..146f604 100644 --- a/doc/src/demos/qml-qtbubblelevel.qdoc +++ b/doc/src/demos/qml-qtbubblelevel.qdoc @@ -27,13 +27,15 @@ /*! \page qtbubblelevel_example.html - \title Qt Bubble Level Example + \title Qt Bubble Level Demo \example demos/mobile/qtbubblelevel -Qt Bubble Level is a simple application that uses -\l{external: Qt Mobility Manual}{Qt Mobility's} accelerometer APIs and hardware +\brief Qt Bubble Level is a simple application that uses +Qt Mobility's accelerometer APIs and hardware sensor information to calculate the inclination of the device and presents this -as atraditional bubble level. The application provides a calibration feature to +as atraditional bubble level. + +The application provides a calibration feature to handle any possible errors in accelerometer readings. The example is hosted in Projects Forum Nokia: https://projects.forum.nokia.com/qtbubblelevel diff --git a/doc/src/demos/qtdemo.qdoc b/doc/src/demos/qtdemo.qdoc index f4d3cbf..9ecb824 100644 --- a/doc/src/demos/qtdemo.qdoc +++ b/doc/src/demos/qtdemo.qdoc @@ -31,7 +31,7 @@ \ingroup qttools \keyword qtdemo - The Examples and Demos Launcher (\c qtdemo) allows the user to browse the + \brief The Examples and Demos Launcher (\c qtdemo) allows the user to browse the examples and demonstrations included with Qt, access the documentation associated with each of them, and launch them as separate applications. diff --git a/doc/src/demos/raycasting.qdoc b/doc/src/demos/raycasting.qdoc index 5c03e20..6517e97 100644 --- a/doc/src/demos/raycasting.qdoc +++ b/doc/src/demos/raycasting.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/raycasting \title Ray Casting Demonstration + \brief The Ray Casting demo shows how to use ray casting to build a mid-1990s style first-person game. + \image raycasting-demo.png */ diff --git a/doc/src/demos/spectrum.qdoc b/doc/src/demos/spectrum.qdoc index 7e98426..64eab09 100644 --- a/doc/src/demos/spectrum.qdoc +++ b/doc/src/demos/spectrum.qdoc @@ -29,7 +29,7 @@ \example demos/spectrum \title Spectrum Analyzer - The Spectrum Analyzer demo shows how the \l{QtMultimedia Module} can be + \brief The Spectrum Analyzer demo shows how the \l{QtMultimedia Module} can be used in Qt applications to capture and then play back an audio stream. \image spectrum-demo.png diff --git a/doc/src/demos/spreadsheet.qdoc b/doc/src/demos/spreadsheet.qdoc index 5c6b4df..3b74d8e 100644 --- a/doc/src/demos/spreadsheet.qdoc +++ b/doc/src/demos/spreadsheet.qdoc @@ -29,7 +29,7 @@ \example demos/spreadsheet \title Spreadsheet - The Spreadsheet demonstration shows how a table view can be used to create a + \brief The Spreadsheet demonstration shows how a table view can be used to create a simple spreadsheet application. Custom delegates are used to render different types of data in distinctive colors. diff --git a/doc/src/demos/sqlbrowser.qdoc b/doc/src/demos/sqlbrowser.qdoc index 53af037..b87d86f 100644 --- a/doc/src/demos/sqlbrowser.qdoc +++ b/doc/src/demos/sqlbrowser.qdoc @@ -29,7 +29,7 @@ \example demos/sqlbrowser \title SQL Browser - The SQL Browser demonstration shows how a data browser can be used to visualize + \brief The SQL Browser demonstration shows how a data browser can be used to visualize the results of SQL statements on a live database. \image sqlbrowser-demo.png diff --git a/doc/src/demos/styledemo.qdoc b/doc/src/demos/styledemo.qdoc index 415d284..d05d091 100644 --- a/doc/src/demos/styledemo.qdoc +++ b/doc/src/demos/styledemo.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/styledemo \title Embedded Styles Demonstration + \brief The Embedded Styles demo shows how to use Qt Style APIs in embedded contexts + \image styledemo-demo.png */ diff --git a/doc/src/demos/sub-attaq.qdoc b/doc/src/demos/sub-attaq.qdoc index 247d0d1..2874473 100644 --- a/doc/src/demos/sub-attaq.qdoc +++ b/doc/src/demos/sub-attaq.qdoc @@ -29,7 +29,7 @@ \example demos/sub-attaq \title Sub-Attaq - This demo shows Qt's ability to combine \l{The Animation Framework}{the animation framework} + \brief The Sub-Attaq demo shows Qt's ability to combine \l{The Animation Framework}{the animation framework} and \l{The State Machine Framework}{the state machine framework} to create a game. \image sub-attaq-demo.png diff --git a/doc/src/demos/textedit.qdoc b/doc/src/demos/textedit.qdoc index 8c50dba..f068593 100644 --- a/doc/src/demos/textedit.qdoc +++ b/doc/src/demos/textedit.qdoc @@ -29,7 +29,7 @@ \example demos/textedit \title Text Edit - The Text Edit demonstration shows Qt's rich text editing facilities in action, + \brief The Text Edit demonstration shows Qt's rich text editing facilities in action, providing an example document for you to experiment with. \image textedit-demo.png diff --git a/doc/src/demos/undo.qdoc b/doc/src/demos/undo.qdoc index 7b64371..78804c0 100644 --- a/doc/src/demos/undo.qdoc +++ b/doc/src/demos/undo.qdoc @@ -29,7 +29,7 @@ \example demos/undo \title Undo Framework - This demo shows Qt's undo framework in action. + \brief This demo shows Qt's undo framework in action. \image undodemo.png diff --git a/doc/src/demos/weatherinfo.qdoc b/doc/src/demos/weatherinfo.qdoc index 1f8a3e8..21b8fc8 100644 --- a/doc/src/demos/weatherinfo.qdoc +++ b/doc/src/demos/weatherinfo.qdoc @@ -29,5 +29,7 @@ \example demos/embedded/weatherinfo \title Weather Info Demonstration + \brief The Weather Info demo shows how to use XML files to build an embedded UI. + \image weatherinfo-demo.png */ diff --git a/doc/src/examples/2dpainting.qdoc b/doc/src/examples/2dpainting.qdoc index c4a2695..bce9958 100644 --- a/doc/src/examples/2dpainting.qdoc +++ b/doc/src/examples/2dpainting.qdoc @@ -29,7 +29,7 @@ \example opengl/2dpainting \title 2D Painting Example - The 2D Painting example shows how QPainter and QGLWidget can be used + \brief The 2D Painting example shows how QPainter and QGLWidget can be used together to display accelerated 2D graphics on supported hardware. \image 2dpainting-example.png diff --git a/doc/src/examples/activeqt/comapp.qdoc b/doc/src/examples/activeqt/comapp.qdoc index 22cec65..3c74b60 100644 --- a/doc/src/examples/activeqt/comapp.qdoc +++ b/doc/src/examples/activeqt/comapp.qdoc @@ -29,10 +29,12 @@ \example activeqt/comapp \title COM App Example (ActiveQt) - The COM App example shows how to use ActiveQt to develop a Qt - application that can be automated via COM. Different QObject - based classes are exposed as COM objects that communicate with the - GUI of the running Qt application. The APIs of those COM objects + \brief The COM App example shows how to use ActiveQt to develop a Qt + application that can be automated via COM. + + Different QObject based classes are exposed as COM objects that + communicate with the GUI of the running Qt application. + The APIs of those COM objects has been designed to resemble the APIs of standard COM applications; i.e. those from Microsoft Office. diff --git a/doc/src/examples/activeqt/dotnet.qdoc b/doc/src/examples/activeqt/dotnet.qdoc index 24b9cd1..31ca490 100644 --- a/doc/src/examples/activeqt/dotnet.qdoc +++ b/doc/src/examples/activeqt/dotnet.qdoc @@ -29,7 +29,7 @@ \page activeqt-dotnet.html \title Dot Net Example (ActiveQt) - The Dot Net example demonstrates how Qt objects can be used in a + \brief The Dot Net example demonstrates how Qt objects can be used in a .NET environment, and how .NET objects can be used in a Qt environment. diff --git a/doc/src/examples/activeqt/hierarchy.qdoc b/doc/src/examples/activeqt/hierarchy.qdoc index 50fb025..e4fa60f 100644 --- a/doc/src/examples/activeqt/hierarchy.qdoc +++ b/doc/src/examples/activeqt/hierarchy.qdoc @@ -36,7 +36,7 @@ \example activeqt/hierarchy \title Hierarchy Example (ActiveQt) - The Hierarchy example is shows how to write an in-process ActiveX + \brief The Hierarchy example is shows how to write an in-process ActiveX control. The control is a QWidget subclass with child widgets that are accessible as sub-types. diff --git a/doc/src/examples/activeqt/multiple.qdoc b/doc/src/examples/activeqt/multiple.qdoc index 96bb6f5..fb069a9 100644 --- a/doc/src/examples/activeqt/multiple.qdoc +++ b/doc/src/examples/activeqt/multiple.qdoc @@ -36,9 +36,10 @@ \example activeqt/multiple \title Multiple Example (ActiveQt) - The Multiple example demonstrates the implementation of a + \brief The Multiple example demonstrates the implementation of a QAxFactory to provide multiple ActiveX controls in a single in process ActiveX server using the \c QAXFACTORY_EXPORT() macro. + The ActiveX controls in this example are simple QWidget subclasses that reimplement QWidget::paintEvent(). diff --git a/doc/src/examples/activeqt/qutlook.qdoc b/doc/src/examples/activeqt/qutlook.qdoc index fe77fd5..82e3424 100644 --- a/doc/src/examples/activeqt/qutlook.qdoc +++ b/doc/src/examples/activeqt/qutlook.qdoc @@ -29,7 +29,7 @@ \example activeqt/qutlook \title Qutlook Example (ActiveQt) - The Qutlook example demonstrates the use of ActiveQt to automate + \brief The Qutlook example demonstrates the use of ActiveQt to automate Outlook. The example makes use of the \l dumpcpp tool to generate a C++ namespace for the type library describing the Outlook Object Model. diff --git a/doc/src/examples/activeqt/webbrowser.qdoc b/doc/src/examples/activeqt/webbrowser.qdoc index 7eca270..35e4524 100644 --- a/doc/src/examples/activeqt/webbrowser.qdoc +++ b/doc/src/examples/activeqt/webbrowser.qdoc @@ -29,7 +29,7 @@ \example activeqt/webbrowser \title Web Browser Example (ActiveQt) - The Web Browser example uses the Microsoft Web Browser + \brief The Web Browser example uses the Microsoft Web Browser ActiveX control to implement a fully functional Web Browser application. The user interface has been developed using the Qt Designer integration of the QAxWidget class. diff --git a/doc/src/examples/activeqt/wrapper.qdoc b/doc/src/examples/activeqt/wrapper.qdoc index caecae9..8c7755e 100644 --- a/doc/src/examples/activeqt/wrapper.qdoc +++ b/doc/src/examples/activeqt/wrapper.qdoc @@ -37,9 +37,11 @@ \example activeqt/wrapper \title Wrapper Example (ActiveQt) - The Wrapper example demonstrates how to export existing QWidget + \brief The Wrapper example demonstrates how to export existing QWidget classes as ActiveX controls, and the use of QAxFactory together - with the \c QAXFACTORY_EXPORT() macro. ActiveX controls in this + with the \c QAXFACTORY_EXPORT() macro. + + ActiveX controls in this example are the standard button classes QPushButton, QCheckBox and QRadioButton as provided by Qt. diff --git a/doc/src/examples/analogclock.qdoc b/doc/src/examples/analogclock.qdoc index 18dc479..3b12ebe 100644 --- a/doc/src/examples/analogclock.qdoc +++ b/doc/src/examples/analogclock.qdoc @@ -29,7 +29,7 @@ \example widgets/analogclock \title Analog Clock Example - The Analog Clock example shows how to draw the contents of a custom + \brief The Analog Clock example shows how to draw the contents of a custom widget. \image analogclock-example.png Screenshot of the Analog Clock example diff --git a/doc/src/examples/animatedtiles.qdoc b/doc/src/examples/animatedtiles.qdoc index f562829..8155c4a 100644 --- a/doc/src/examples/animatedtiles.qdoc +++ b/doc/src/examples/animatedtiles.qdoc @@ -29,7 +29,7 @@ \example animation/animatedtiles \title Animated Tiles Example - The Animated Tiles example animates items in a graphics scene. + \brief The Animated Tiles example animates items in a graphics scene. \image animatedtiles-example.png */ diff --git a/doc/src/examples/appchooser.qdoc b/doc/src/examples/appchooser.qdoc index 63cbb0e..64c5144 100644 --- a/doc/src/examples/appchooser.qdoc +++ b/doc/src/examples/appchooser.qdoc @@ -29,7 +29,7 @@ \example animation/appchooser \title Application Chooser Example - The Application Chooser example shows how to use the Qt state + \brief The Application Chooser example shows how to use the Qt state machine and the animation framework to select between applications. diff --git a/doc/src/examples/application.qdoc b/doc/src/examples/application.qdoc index 9e03bc4..5f7b9fe 100644 --- a/doc/src/examples/application.qdoc +++ b/doc/src/examples/application.qdoc @@ -29,7 +29,7 @@ \example mainwindows/application \title Application Example - The Application example shows how to implement a standard GUI + \brief The Application example shows how to implement a standard GUI application with menus, toolbars, and a status bar. The example itself is a simple text editor program built around QPlainTextEdit. diff --git a/doc/src/examples/applicationicon.qdoc b/doc/src/examples/applicationicon.qdoc index 87942e5..f3f222e 100644 --- a/doc/src/examples/applicationicon.qdoc +++ b/doc/src/examples/applicationicon.qdoc @@ -29,7 +29,8 @@ \group all-examples \title Application Icon Example - The example shows how to add an application icon to a mobile application. + \brief The Application Icon example shows how to add an application icon to a + mobile application. \image appicon_screenshot.png The icon on a Nokia XPressMusic 5800 diff --git a/doc/src/examples/arrowpad.qdoc b/doc/src/examples/arrowpad.qdoc index f3ba332..ef0bd27 100644 --- a/doc/src/examples/arrowpad.qdoc +++ b/doc/src/examples/arrowpad.qdoc @@ -29,7 +29,7 @@ \example linguist/arrowpad \title Arrow Pad Example - This example is a slightly more involved and introduces a key \e + \brief ThArrow Pad Linguist example is a slightly more involved and introduces a key \e {Qt Linguist} concept: "contexts". It also shows how to use two or more languages. diff --git a/doc/src/examples/audiodevices.qdoc b/doc/src/examples/audiodevices.qdoc index 7c95678..1690f34 100644 --- a/doc/src/examples/audiodevices.qdoc +++ b/doc/src/examples/audiodevices.qdoc @@ -29,7 +29,7 @@ \example multimedia/audiodevices \title Audio Devices Example - The Audio Devices example demonstrates the basic use of QAudioDeviceInfo class + \brief The Audio Devices example demonstrates the basic use of QAudioDeviceInfo class provided with Qt. \image audiodevices-example.png diff --git a/doc/src/examples/audioinput.qdoc b/doc/src/examples/audioinput.qdoc index 1b6d461..d5af63f 100644 --- a/doc/src/examples/audioinput.qdoc +++ b/doc/src/examples/audioinput.qdoc @@ -29,7 +29,7 @@ \example multimedia/audioinput \title AudioInput Example - The Audio Input example demonstrates the basic use of QAudioInput class + \brief The Audio Input example demonstrates the basic use of QAudioInput class provided with Qt. \image audioinput-example.png diff --git a/doc/src/examples/audiooutput.qdoc b/doc/src/examples/audiooutput.qdoc index 47a09fa..9362029 100644 --- a/doc/src/examples/audiooutput.qdoc +++ b/doc/src/examples/audiooutput.qdoc @@ -29,7 +29,7 @@ \example multimedia/audiooutput \title Audio Output Example - The Audio Output example demonstrates the basic use of the QAudioOutput class + \brief The Audio Output example demonstrates the basic use of the QAudioOutput class provided with Qt. \image audiooutput-example.png diff --git a/doc/src/examples/basicdrawing.qdoc b/doc/src/examples/basicdrawing.qdoc index fbc34e6..f18907c 100644 --- a/doc/src/examples/basicdrawing.qdoc +++ b/doc/src/examples/basicdrawing.qdoc @@ -29,7 +29,7 @@ \example painting/basicdrawing \title Basic Drawing Example - The Basic Drawing example shows how to display basic graphics + \brief The Basic Drawing example shows how to display basic graphics primitives in a variety of styles using the QPainter class. QPainter performs low-level painting on widgets and other paint diff --git a/doc/src/examples/basicgraphicslayouts.qdoc b/doc/src/examples/basicgraphicslayouts.qdoc index 2742870..27c9cb6 100644 --- a/doc/src/examples/basicgraphicslayouts.qdoc +++ b/doc/src/examples/basicgraphicslayouts.qdoc @@ -29,7 +29,7 @@ \example graphicsview/basicgraphicslayouts \title Basic Graphics Layouts Example - The Basic Graphics Layouts example shows how to use the layout classes + \brief The Basic Graphics Layouts example shows how to use the layout classes in QGraphicsView: QGraphicsLinearLayout and QGraphicsGridLayout. In addition to that it shows how to write your own custom layout item. @@ -161,4 +161,4 @@ \snippet examples/graphicsview/basicgraphicslayouts/layoutitem.cpp 5 -*/
\ No newline at end of file +*/ diff --git a/doc/src/examples/basiclayouts.qdoc b/doc/src/examples/basiclayouts.qdoc index a8c64f0..ade0b08 100644 --- a/doc/src/examples/basiclayouts.qdoc +++ b/doc/src/examples/basiclayouts.qdoc @@ -29,7 +29,7 @@ \example layouts/basiclayouts \title Basic Layouts Example - The Basic Layouts example shows how to use the standard layout + \brief The Basic Layouts example shows how to use the standard layout managers that are available in Qt: QBoxLayout, QGridLayout and QFormLayout. diff --git a/doc/src/examples/basicsortfiltermodel.qdoc b/doc/src/examples/basicsortfiltermodel.qdoc index dbe9f02..92c000e 100644 --- a/doc/src/examples/basicsortfiltermodel.qdoc +++ b/doc/src/examples/basicsortfiltermodel.qdoc @@ -29,7 +29,7 @@ \example itemviews/basicsortfiltermodel \title Basic Sort/Filter Model Example - The Basic Sort/Filter Model example illustrates how to use + \brief The Basic Sort/Filter Model example illustrates how to use QSortFilterProxyModel to perform basic sorting and filtering. \image basicsortfiltermodel-example.png Screenshot of the Basic Sort/Filter Model Example diff --git a/doc/src/examples/bearercloud.qdoc b/doc/src/examples/bearercloud.qdoc index 18a4ddf..f549eb4 100644 --- a/doc/src/examples/bearercloud.qdoc +++ b/doc/src/examples/bearercloud.qdoc @@ -29,7 +29,7 @@ \example network/bearercloud \title Bearer Cloud Example - The Bearer Cloud example shows how to use the Bearer Management API to monitor the + \brief The Bearer Cloud example shows how to use the Bearer Management API to monitor the connectivity state of the local device. \image bearercloud-example.png Screenshot of the Bearer Cloud example diff --git a/doc/src/examples/bearermonitor.qdoc b/doc/src/examples/bearermonitor.qdoc index a638d12..ec5d091 100644 --- a/doc/src/examples/bearermonitor.qdoc +++ b/doc/src/examples/bearermonitor.qdoc @@ -29,7 +29,7 @@ \example network/bearermonitor \title Bearer Monitor Example - The Bearer Monitor example shows how to use the Bearer Management API. + \brief The Bearer Monitor example shows how to use the Bearer Management API. \image bearermonitor-example.png Screenshot of the Bearer Monitor example */ diff --git a/doc/src/examples/blockingfortuneclient.qdoc b/doc/src/examples/blockingfortuneclient.qdoc index d35ed4c..5549ebb 100644 --- a/doc/src/examples/blockingfortuneclient.qdoc +++ b/doc/src/examples/blockingfortuneclient.qdoc @@ -29,7 +29,7 @@ \example network/blockingfortuneclient \title Blocking Fortune Client Example - The Blocking Fortune Client example shows how to create a client for a + \brief The Blocking Fortune Client example shows how to create a client for a network service using QTcpSocket's synchronous API in a non-GUI thread. \image blockingfortuneclient-example.png diff --git a/doc/src/examples/blurpicker.qdoc b/doc/src/examples/blurpicker.qdoc index 3a6d433..00c822d 100644 --- a/doc/src/examples/blurpicker.qdoc +++ b/doc/src/examples/blurpicker.qdoc @@ -29,5 +29,7 @@ \example effects/blurpicker \title Blur Picker Effect Example + \brief The Blur Picker Example shows the QGraphicsBlurEffect in action. + \image blurpickereffect-example.png */ diff --git a/doc/src/examples/borderlayout.qdoc b/doc/src/examples/borderlayout.qdoc index 94cd3d9..cf8a4fc 100644 --- a/doc/src/examples/borderlayout.qdoc +++ b/doc/src/examples/borderlayout.qdoc @@ -29,7 +29,7 @@ \example layouts/borderlayout \title Border Layout Example - The Border Layout example shows how to create a custom layout that arranges + \brief The Border Layout example shows how to create a custom layout that arranges child widgets according to a simple set of rules. \image borderlayout-example.png diff --git a/doc/src/examples/broadcastreceiver.qdoc b/doc/src/examples/broadcastreceiver.qdoc index 409b491..e716a74 100644 --- a/doc/src/examples/broadcastreceiver.qdoc +++ b/doc/src/examples/broadcastreceiver.qdoc @@ -29,7 +29,7 @@ \example network/broadcastreceiver \title Broadcast Receiver Example - The Broadcast Receiver example shows how to receive information that is broadcasted + \brief The Broadcast Receiver example shows how to receive information that is broadcasted over a local network. \image broadcastreceiver-example.png diff --git a/doc/src/examples/broadcastsender.qdoc b/doc/src/examples/broadcastsender.qdoc index 2cb0a13..a272e88 100644 --- a/doc/src/examples/broadcastsender.qdoc +++ b/doc/src/examples/broadcastsender.qdoc @@ -29,7 +29,7 @@ \example network/broadcastsender \title Broadcast Sender Example - The Broadcast Sender example shows how to broadcast information to multiple clients + \brief The Broadcast Sender example shows how to broadcast information to multiple clients on a local network. \image broadcastsender-example.png diff --git a/doc/src/examples/cachedtable.qdoc b/doc/src/examples/cachedtable.qdoc index 5a20329..7660dbf 100644 --- a/doc/src/examples/cachedtable.qdoc +++ b/doc/src/examples/cachedtable.qdoc @@ -29,7 +29,7 @@ \example sql/cachedtable \title Cached Table Example - The Cached Table example shows how a table view can be used to access a database, + \brief The Cached Table example shows how a table view can be used to access a database, caching any changes to the data until the user explicitly submits them using a push button. diff --git a/doc/src/examples/calculator.qdoc b/doc/src/examples/calculator.qdoc index c7dc013..7941698 100644 --- a/doc/src/examples/calculator.qdoc +++ b/doc/src/examples/calculator.qdoc @@ -29,7 +29,7 @@ \example widgets/calculator \title Calculator Example - The example shows how to use signals and slots to implement the + \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. diff --git a/doc/src/examples/calculatorbuilder.qdoc b/doc/src/examples/calculatorbuilder.qdoc index ac9db9f..97f6f06 100644 --- a/doc/src/examples/calculatorbuilder.qdoc +++ b/doc/src/examples/calculatorbuilder.qdoc @@ -29,7 +29,7 @@ \example designer/calculatorbuilder \title Calculator Builder Example - The Calculator Builder example shows how to create a user interface from + \brief The Calculator Builder example shows how to create a user interface from a \QD form at run-time, using the QUiLoader class. \image calculatorbuilder-example.png diff --git a/doc/src/examples/calculatorform.qdoc b/doc/src/examples/calculatorform.qdoc index e1025b6..945659f 100644 --- a/doc/src/examples/calculatorform.qdoc +++ b/doc/src/examples/calculatorform.qdoc @@ -29,9 +29,11 @@ \example designer/calculatorform \title Calculator Form Example - The Calculator Form Example shows how to use a form created with + \brief The Calculator Form Example shows how to use a form created with \QD in an application by using the user interface information from - a QWidget subclass. We use \l{Using a Designer UI File in Your Application} + a QWidget subclass. + + We use \l{Using a Designer UI File in Your Application} {uic's auto-connection} feature to automatically connect signals from widgets on the form to slots in our code. diff --git a/doc/src/examples/calendar.qdoc b/doc/src/examples/calendar.qdoc index 32bc547..2221e1f 100644 --- a/doc/src/examples/calendar.qdoc +++ b/doc/src/examples/calendar.qdoc @@ -29,7 +29,7 @@ \example richtext/calendar \title Calendar Example - The Calendar example shows how to create rich text content and display it using + \brief The Calendar example shows how to create rich text content and display it using a rich text editor. \image calendar-example.png diff --git a/doc/src/examples/calendarwidget.qdoc b/doc/src/examples/calendarwidget.qdoc index f72082a..ed3cd32 100644 --- a/doc/src/examples/calendarwidget.qdoc +++ b/doc/src/examples/calendarwidget.qdoc @@ -29,7 +29,7 @@ \title Calendar Widget Example \example widgets/calendarwidget - The Calendar Widget example shows use of \c QCalendarWidget. + \brief The Calendar Widget example shows use of \c QCalendarWidget. \image calendarwidgetexample.png diff --git a/doc/src/examples/capabilitiesexample.qdoc b/doc/src/examples/capabilitiesexample.qdoc index 636044b..c0c4f93 100644 --- a/doc/src/examples/capabilitiesexample.qdoc +++ b/doc/src/examples/capabilitiesexample.qdoc @@ -29,7 +29,7 @@ \example phonon/capabilities \title Capabilities Example - The Backend Capabilities example shows how to check which MIME + \brief The Backend Capabilities example shows how to check which MIME types, audio devices, and audio effects are available. \image capabilitiesexample.png diff --git a/doc/src/examples/charactermap.qdoc b/doc/src/examples/charactermap.qdoc index 285d6a4..fa82d7e 100644 --- a/doc/src/examples/charactermap.qdoc +++ b/doc/src/examples/charactermap.qdoc @@ -29,7 +29,7 @@ \example widgets/charactermap \title Character Map Example -The Character Map example shows how to create a custom widget that can +\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 diff --git a/doc/src/examples/chart.qdoc b/doc/src/examples/chart.qdoc index af82f1b..d18a8fa 100644 --- a/doc/src/examples/chart.qdoc +++ b/doc/src/examples/chart.qdoc @@ -29,7 +29,7 @@ \example itemviews/chart \title Chart Example - The Chart example shows how to create a custom view for the model/view framework. + \brief The Chart example shows how to create a custom view for the model/view framework. \image chart-example.png diff --git a/doc/src/examples/classwizard.qdoc b/doc/src/examples/classwizard.qdoc index 53d0936..d29b956 100644 --- a/doc/src/examples/classwizard.qdoc +++ b/doc/src/examples/classwizard.qdoc @@ -29,7 +29,7 @@ \example dialogs/classwizard \title Class Wizard Example - The License Wizard example shows how to implement linear + \brief The License Wizard example shows how to implement linear wizards using QWizard. \image classwizard.png Screenshot of the Class Wizard example diff --git a/doc/src/examples/codecs.qdoc b/doc/src/examples/codecs.qdoc index 91fb6a2..02248e9 100644 --- a/doc/src/examples/codecs.qdoc +++ b/doc/src/examples/codecs.qdoc @@ -29,7 +29,7 @@ \example tools/codecs \title Codecs Example - The Codecs example demonstrates the principles behind importing and exporting text + \brief The Codecs example demonstrates the principles behind importing and exporting text using codecs to ensure that characters are encoded properly, avoiding loss of data and retaining the correct symbols used in various scripts. diff --git a/doc/src/examples/codeeditor.qdoc b/doc/src/examples/codeeditor.qdoc index 1718d52..9935e88 100644 --- a/doc/src/examples/codeeditor.qdoc +++ b/doc/src/examples/codeeditor.qdoc @@ -29,7 +29,7 @@ \example widgets/codeeditor \title Code Editor Example - The Code Editor example shows how to create a simple editor that + \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 diff --git a/doc/src/examples/collidingmice-example.qdoc b/doc/src/examples/collidingmice-example.qdoc index 4bdd79d..e7c475a 100644 --- a/doc/src/examples/collidingmice-example.qdoc +++ b/doc/src/examples/collidingmice-example.qdoc @@ -29,7 +29,7 @@ \example graphicsview/collidingmice \title Colliding Mice Example - The Colliding Mice example shows how to use the Graphics View + \brief The Colliding Mice example shows how to use the Graphics View framework to implement animated items and detect collision between items. @@ -265,4 +265,4 @@ Doing the animation with a single timer connect to advance the scene ensures that all the mice are moved at one point and, more importantly, only one update is sent to the screen after all the mice have moved. -*/
\ No newline at end of file +*/ diff --git a/doc/src/examples/coloreditorfactory.qdoc b/doc/src/examples/coloreditorfactory.qdoc index 34060bd..e7c6e7d 100644 --- a/doc/src/examples/coloreditorfactory.qdoc +++ b/doc/src/examples/coloreditorfactory.qdoc @@ -29,8 +29,8 @@ \example itemviews/coloreditorfactory \title Color Editor Factory Example - This example shows how to create an editor that can be used by - a QItemDelegate. + \brief The Color Editor Factory example shows how to create an editor that + can be used by a QItemDelegate. \image coloreditorfactoryimage.png diff --git a/doc/src/examples/combowidgetmapper.qdoc b/doc/src/examples/combowidgetmapper.qdoc index e852f5e..61d69c1 100644 --- a/doc/src/examples/combowidgetmapper.qdoc +++ b/doc/src/examples/combowidgetmapper.qdoc @@ -29,7 +29,7 @@ \example itemviews/combowidgetmapper \title Combo Widget Mapper Example - The Combo Widget Mapper example shows how to use a custom delegate to + \brief The Combo Widget Mapper example shows how to use a custom delegate to map information from a model to specific widgets on a form. \image combowidgetmapper-example.png diff --git a/doc/src/examples/completer.qdoc b/doc/src/examples/completer.qdoc index 408de6b..298bbc4 100644 --- a/doc/src/examples/completer.qdoc +++ b/doc/src/examples/completer.qdoc @@ -29,7 +29,7 @@ \example tools/completer \title Completer Example - The Completer example shows how to provide string-completion facilities + \brief The Completer example shows how to provide string-completion facilities for an input widget based on data provided by a model. \image completer-example.png diff --git a/doc/src/examples/complexpingpong.qdoc b/doc/src/examples/complexpingpong.qdoc index 677353b..2013744 100644 --- a/doc/src/examples/complexpingpong.qdoc +++ b/doc/src/examples/complexpingpong.qdoc @@ -29,7 +29,7 @@ \example dbus/complexpingpong \title Complex Ping Pong Example - The Complex Ping Pong example improves on the \l{D-Bus Ping Pong Example} by providing + \brief The Complex Ping Pong example improves on the \l{D-Bus Ping Pong Example} by providing a more useful demonstration of D-Bus interfaces. \quotefile doc/src/snippets/complexpingpong-example.txt diff --git a/doc/src/examples/concentriccircles.qdoc b/doc/src/examples/concentriccircles.qdoc index 37c8f83..bfa24d9 100644 --- a/doc/src/examples/concentriccircles.qdoc +++ b/doc/src/examples/concentriccircles.qdoc @@ -29,7 +29,7 @@ \example painting/concentriccircles \title Concentric Circles Example - The Concentric Circles example shows the improved rendering + \brief The Concentric Circles example shows the improved rendering quality that can be obtained using floating point precision and anti-aliasing when drawing custom widgets. The example also shows how to do simple animations. diff --git a/doc/src/examples/configdialog.qdoc b/doc/src/examples/configdialog.qdoc index 166b25a..d83dbdb 100644 --- a/doc/src/examples/configdialog.qdoc +++ b/doc/src/examples/configdialog.qdoc @@ -29,7 +29,7 @@ \example dialogs/configdialog \title Config Dialog Example - The Config Dialog examples shows how a configuration dialog can be created by + \brief The Config Dialog examples shows how a configuration dialog can be created by using an icon view with a stacked widget. \image configdialog-example.png diff --git a/doc/src/examples/containerextension.qdoc b/doc/src/examples/containerextension.qdoc index ca7ef13..606da2d 100644 --- a/doc/src/examples/containerextension.qdoc +++ b/doc/src/examples/containerextension.qdoc @@ -29,7 +29,7 @@ \example designer/containerextension \title Container Extension Example - The Container Extension example shows how to create a custom + \brief The Container Extension example shows how to create a custom multi-page plugin for Qt Designer using the QDesignerContainerExtension class. diff --git a/doc/src/examples/context2d.qdoc b/doc/src/examples/context2d.qdoc index 729e56b..9d9d0c6 100644 --- a/doc/src/examples/context2d.qdoc +++ b/doc/src/examples/context2d.qdoc @@ -29,7 +29,7 @@ \example script/context2d \title Context2D Example - This Qt Script example is an implementation of the Context2D API. + \brief This Qt Script example is an implementation of the Context2D API. \image context2d-example.png diff --git a/doc/src/examples/contextsensitivehelp.qdoc b/doc/src/examples/contextsensitivehelp.qdoc index 42e4a11..32b59bc 100644 --- a/doc/src/examples/contextsensitivehelp.qdoc +++ b/doc/src/examples/contextsensitivehelp.qdoc @@ -29,5 +29,5 @@ \example help/contextsensitivehelp \title Context-Sensitive Help Example - This example shows how to use the services of the QHelpEngineCore class. + \brief The Context Sensitive Help example shows how to use the services of the QHelpEngineCore class. */ diff --git a/doc/src/examples/contiguouscache.qdoc b/doc/src/examples/contiguouscache.qdoc index d0b39e6..52e8b15 100644 --- a/doc/src/examples/contiguouscache.qdoc +++ b/doc/src/examples/contiguouscache.qdoc @@ -29,8 +29,10 @@ \example tools/contiguouscache \title Contiguous Cache Example - The Contiguous Cache example shows how to use QContiguousCache to manage memory usage for - very large models. In some environments memory is limited and, even when it + \brief The Contiguous Cache example shows how to use QContiguousCache to manage memory usage for + very large models. + + In some environments memory is limited and, even when it isn't, users still dislike an application using excessive memory. Using QContiguousCache to manage a list, rather than loading the entire list into memory, allows the application to limit the amount diff --git a/doc/src/examples/cube.qdoc b/doc/src/examples/cube.qdoc index e1fd172..e28d4b2 100644 --- a/doc/src/examples/cube.qdoc +++ b/doc/src/examples/cube.qdoc @@ -44,8 +44,10 @@ \group all-examples \title Cube OpenGL ES 2.0 example - The Cube OpenGL ES 2.0 example shows how to write mouse rotateable - textured 3D cube using OpenGL ES 2.0 with Qt. It shows how to handle + \brief The Cube OpenGL ES 2.0 example shows how to write mouse rotateable + textured 3D cube using OpenGL ES 2.0 with Qt. + + It shows how to handle polygon geometries efficiently and how to write simple vertex and fragment shader for programmable graphics pipeline. In addition it shows how to use quaternions for representing 3D object orientation. diff --git a/doc/src/examples/customcompleter.qdoc b/doc/src/examples/customcompleter.qdoc index f0d5698..27e2ea7 100644 --- a/doc/src/examples/customcompleter.qdoc +++ b/doc/src/examples/customcompleter.qdoc @@ -29,9 +29,9 @@ \example tools/customcompleter \title Custom Completer Example - The Custom Completer example shows how to provide string-completion - facilities for an input widget based on data provided by a model. The - completer pops up suggestions for possible words based on the first three + \brief The Custom Completer example shows how to provide string-completion + facilities for an input widget based on data provided by a model. + The completer pops up suggestions for possible words based on the first three characters input by the user and the user's choice of word is inserted into the \c TextEdit using QTextCursor. diff --git a/doc/src/examples/customsortfiltermodel.qdoc b/doc/src/examples/customsortfiltermodel.qdoc index e145e82..41f8b04 100644 --- a/doc/src/examples/customsortfiltermodel.qdoc +++ b/doc/src/examples/customsortfiltermodel.qdoc @@ -29,7 +29,7 @@ \example itemviews/customsortfiltermodel \title Custom Sort/Filter Model Example - The Custom Sort/Filter Model example illustrates how to subclass + \brief The Custom Sort/Filter Model example illustrates how to subclass QSortFilterProxyModel to perform advanced sorting and filtering. \image customsortfiltermodel-example.png Screenshot of the Custom Sort/Filter Model Example diff --git a/doc/src/examples/customtype.qdoc b/doc/src/examples/customtype.qdoc index b969354..8ff97f3 100644 --- a/doc/src/examples/customtype.qdoc +++ b/doc/src/examples/customtype.qdoc @@ -29,7 +29,7 @@ \example tools/customtype \title Custom Type Example - The Custom Type example shows how to integrate a custom type into Qt's + \brief The Custom Type example shows how to integrate a custom type into Qt's meta-object system. Contents: diff --git a/doc/src/examples/customtypesending.qdoc b/doc/src/examples/customtypesending.qdoc index fc6b793..4ffb40e 100644 --- a/doc/src/examples/customtypesending.qdoc +++ b/doc/src/examples/customtypesending.qdoc @@ -29,7 +29,7 @@ \example tools/customtypesending \title Custom Type Sending Example - The Custom Type Sending example shows how to use a custom type with signals + \brief The Custom Type Sending example shows how to use a custom type with signals and slots. \image customtypesending-example.png diff --git a/doc/src/examples/customwidgetplugin.qdoc b/doc/src/examples/customwidgetplugin.qdoc index dadfbaf..81277ce 100644 --- a/doc/src/examples/customwidgetplugin.qdoc +++ b/doc/src/examples/customwidgetplugin.qdoc @@ -29,7 +29,7 @@ \example designer/customwidgetplugin \title Custom Widget Plugin Example - The Custom Widget example shows how to create a custom widget plugin for \QD. + \brief The Custom Widget example shows how to create a custom widget plugin for \QD. \image customwidgetplugin-example.png diff --git a/doc/src/examples/dbscreen.qdoc b/doc/src/examples/dbscreen.qdoc index 7f6bb18..c2b88cd 100644 --- a/doc/src/examples/dbscreen.qdoc +++ b/doc/src/examples/dbscreen.qdoc @@ -29,7 +29,7 @@ \example qws/dbscreen \title Double Buffered Graphics Driver Example - The Double Buffered Graphics Driver example shows how to write your own + \brief The Double Buffered Graphics Driver example shows how to write your own double buffered graphics driver and add it to Qt for Embedded Linux. Similar to the \l{Accelerated Graphics Driver Example}, there are three steps diff --git a/doc/src/examples/dbus-chat.qdoc b/doc/src/examples/dbus-chat.qdoc index a435cc9..c00166d 100644 --- a/doc/src/examples/dbus-chat.qdoc +++ b/doc/src/examples/dbus-chat.qdoc @@ -29,7 +29,7 @@ \example dbus/dbus-chat \title D-Bus Chat Example - The D-Bus Chat example shows how to use D-Bus to communicate between two + \brief The D-Bus Chat example shows how to use D-Bus to communicate between two applications. \image dbus-chat-example.png diff --git a/doc/src/examples/dbus-listnames.qdoc b/doc/src/examples/dbus-listnames.qdoc index 3d359f7..9807c30 100644 --- a/doc/src/examples/dbus-listnames.qdoc +++ b/doc/src/examples/dbus-listnames.qdoc @@ -29,5 +29,5 @@ \example dbus/listnames \title D-Bus List Names Example - The D-Bus List Names examples shows how to query D-Bus for a list of service names. + \brief The D-Bus List Names examples shows how to query D-Bus for a list of service names. */ diff --git a/doc/src/examples/dbus-pingpong.qdoc b/doc/src/examples/dbus-pingpong.qdoc index dc0f50b..2463877 100644 --- a/doc/src/examples/dbus-pingpong.qdoc +++ b/doc/src/examples/dbus-pingpong.qdoc @@ -29,7 +29,7 @@ \example dbus/pingpong \title D-Bus Ping Pong Example - The D-Bus Ping Pong example provides a basic demonstration of D-Bus + \brief The D-Bus Ping Pong example provides a basic demonstration of D-Bus interfaces. \quotefile doc/src/snippets/dbus-pingpong-example.txt diff --git a/doc/src/examples/dbus-remotecontrolledcar.qdoc b/doc/src/examples/dbus-remotecontrolledcar.qdoc index 3f0af9a..7152e21 100644 --- a/doc/src/examples/dbus-remotecontrolledcar.qdoc +++ b/doc/src/examples/dbus-remotecontrolledcar.qdoc @@ -29,7 +29,7 @@ \example dbus/remotecontrolledcar \title D-Bus Remote Controlled Car Example - The Remote Controlled Car example shows how to use D-Bus to control one + \brief The Remote Controlled Car example shows how to use D-Bus to control one application using another. \image remotecontrolledcar-car-example.png diff --git a/doc/src/examples/defaultprototypes.qdoc b/doc/src/examples/defaultprototypes.qdoc index a6c79f0..493a3bb 100644 --- a/doc/src/examples/defaultprototypes.qdoc +++ b/doc/src/examples/defaultprototypes.qdoc @@ -29,7 +29,7 @@ \example script/defaultprototypes \title Default Prototypes Example - This Qt Script example shows how to use default prototypes + \brief The Default Prototypes QtScript example shows how to use default prototypes to make a non-QObject-based type scriptable. \image defaultprototypes-example.png diff --git a/doc/src/examples/delayedencoding.qdoc b/doc/src/examples/delayedencoding.qdoc index 8ac2c7f..d94b589 100644 --- a/doc/src/examples/delayedencoding.qdoc +++ b/doc/src/examples/delayedencoding.qdoc @@ -29,7 +29,7 @@ \example draganddrop/delayedencoding \title Delayed Encoding Example - The Delayed Encoding example shows how to delay preparing of data + \brief The Delayed Encoding example shows how to delay preparing of data for drag and drop operations until a drop target is found. \image delayedecoding-example.png diff --git a/doc/src/examples/diagramscene.qdoc b/doc/src/examples/diagramscene.qdoc index 7d3c0e6..c7b4bfe 100644 --- a/doc/src/examples/diagramscene.qdoc +++ b/doc/src/examples/diagramscene.qdoc @@ -29,12 +29,12 @@ \example graphicsview/diagramscene \title Diagram Scene Example - This example shows use of Qt's graphics framework. + \brief The Diagram Scene example is an application in which you can + create a flowchart diagram using the graphics view framework. \image diagramscene.png - The Diagram Scene example is an application in which you can - create a flowchart diagram. It is possible to add flowchart shapes + In this example it is possible to add flowchart shapes and text and connect the shapes by arrows as shown in the image above. The shapes, arrows, and text can be given different colors, and it is possible to change the font, style, and diff --git a/doc/src/examples/digitalclock.qdoc b/doc/src/examples/digitalclock.qdoc index acee4d6..90ee710 100644 --- a/doc/src/examples/digitalclock.qdoc +++ b/doc/src/examples/digitalclock.qdoc @@ -29,7 +29,7 @@ \example widgets/digitalclock \title Digital Clock Example - The Digital Clock example shows how to use QLCDNumber to display a + \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 diff --git a/doc/src/examples/dirview.qdoc b/doc/src/examples/dirview.qdoc index 6d2ce7a..6a45d9a 100644 --- a/doc/src/examples/dirview.qdoc +++ b/doc/src/examples/dirview.qdoc @@ -29,7 +29,7 @@ \example itemviews/dirview \title Dir View Example - The Dir View example shows a tree view onto the local filing system. It uses the + \brief The Dir View example shows a tree view onto the local filing system. It uses the QDirModel class to provide supply file and directory information. \image dirview-example.png diff --git a/doc/src/examples/dockwidgets.qdoc b/doc/src/examples/dockwidgets.qdoc index b46a286..c6cebcc 100644 --- a/doc/src/examples/dockwidgets.qdoc +++ b/doc/src/examples/dockwidgets.qdoc @@ -29,7 +29,7 @@ \example mainwindows/dockwidgets \title Dock Widgets Example - The Dock Widgets example shows how to add dock windows to an + \brief The Dock Widgets example shows how to add dock windows to an application. It also shows how to use Qt's rich text engine. \image dockwidgets-example.png Screenshot of the Dock Widgets example diff --git a/doc/src/examples/dombookmarks.qdoc b/doc/src/examples/dombookmarks.qdoc index 03e3ec6..e25766a 100644 --- a/doc/src/examples/dombookmarks.qdoc +++ b/doc/src/examples/dombookmarks.qdoc @@ -29,9 +29,10 @@ \example xml/dombookmarks \title DOM Bookmarks Example - The DOM Bookmarks example provides a reader for XML Bookmark Exchange Language (XBEL) - files that uses Qt's DOM-based XML API to read and parse the files. The SAX Bookmarks - example provides an alternative way to read this type of file. + \brief The DOM Bookmarks example provides a reader for XML Bookmark Exchange Language (XBEL) + files that uses Qt's DOM-based XML API to read and parse the files. + + The SAX Bookmarks example provides an alternative way to read this type of file. \image dombookmarks-example.png diff --git a/doc/src/examples/domtraversal.qdoc b/doc/src/examples/domtraversal.qdoc index d0456c4..657b0dd 100644 --- a/doc/src/examples/domtraversal.qdoc +++ b/doc/src/examples/domtraversal.qdoc @@ -29,7 +29,7 @@ \example webkit/domtraversal \title DOM Traversal Example - The DOM Traversal example shows how to use the QWebElement class to access + \brief The DOM Traversal example shows how to use the QWebElement class to access the structure of a Web page. \image webkit-domtraversal.png diff --git a/doc/src/examples/draganddroppuzzle.qdoc b/doc/src/examples/draganddroppuzzle.qdoc index e89c8fc..4bb1ccb 100644 --- a/doc/src/examples/draganddroppuzzle.qdoc +++ b/doc/src/examples/draganddroppuzzle.qdoc @@ -29,7 +29,7 @@ \example draganddrop/puzzle \title Drag and Drop Puzzle Example - The Drag and Drop Puzzle example demonstrates a way of using the drag and drop system with + \brief The Drag and Drop Puzzle example demonstrates a way of using the drag and drop system with item view widgets. \image draganddroppuzzle-example.png diff --git a/doc/src/examples/dragdroprobot.qdoc b/doc/src/examples/dragdroprobot.qdoc index 84d8af4..aba30ad 100644 --- a/doc/src/examples/dragdroprobot.qdoc +++ b/doc/src/examples/dragdroprobot.qdoc @@ -29,7 +29,7 @@ \example graphicsview/dragdroprobot \title Drag and Drop Robot Example - The Drag and Drop Robot example shows how to implement Drag and Drop in a + \brief The Drag and Drop Robot example shows how to implement Drag and Drop in a QGraphicsItem subclass, as well as how to animate items using Qt's \l{Animation Framework}. diff --git a/doc/src/examples/draggableicons.qdoc b/doc/src/examples/draggableicons.qdoc index 0337431..1484a60 100644 --- a/doc/src/examples/draggableicons.qdoc +++ b/doc/src/examples/draggableicons.qdoc @@ -29,7 +29,7 @@ \example draganddrop/draggableicons \title Draggable Icons Example - The Draggable Icons example shows how to drag and drop image data between widgets + \brief The Draggable Icons example shows how to drag and drop image data between widgets in the same application, and between different applications. \image draggableicons-example.png diff --git a/doc/src/examples/draggabletext.qdoc b/doc/src/examples/draggabletext.qdoc index 14d07b6..ae9cfb9 100644 --- a/doc/src/examples/draggabletext.qdoc +++ b/doc/src/examples/draggabletext.qdoc @@ -29,7 +29,7 @@ \example draganddrop/draggabletext \title Draggable Text Example - The Draggable Text example shows how to drag and drop textual data between widgets + \brief The Draggable Text example shows how to drag and drop textual data between widgets in the same application, and between different applications. \image draggabletext-example.png diff --git a/doc/src/examples/drilldown.qdoc b/doc/src/examples/drilldown.qdoc index 1903df6..d11a71f 100644 --- a/doc/src/examples/drilldown.qdoc +++ b/doc/src/examples/drilldown.qdoc @@ -29,7 +29,7 @@ \example sql/drilldown \title Drill Down Example - The Drill Down example shows how to read data from a database as + \brief The Drill Down example shows how to read data from a database as well as submit changes, using the QSqlRelationalTableModel and QDataWidgetMapper classes. diff --git a/doc/src/examples/dropsite.qdoc b/doc/src/examples/dropsite.qdoc index bf17427..815618a 100644 --- a/doc/src/examples/dropsite.qdoc +++ b/doc/src/examples/dropsite.qdoc @@ -29,7 +29,7 @@ \example draganddrop/dropsite \title Drop Site Example - The example shows how to distinguish the various MIME formats available + \brief The Drop Site example shows how to distinguish the various MIME formats available in a drag and drop operation. \image dropsite-example.png Screenshot of the Drop Site example diff --git a/doc/src/examples/dynamiclayouts.qdoc b/doc/src/examples/dynamiclayouts.qdoc index b8314e3..c93fc74 100644 --- a/doc/src/examples/dynamiclayouts.qdoc +++ b/doc/src/examples/dynamiclayouts.qdoc @@ -29,6 +29,6 @@ \example layouts/dynamiclayouts \title Dynamic Layouts Example - The Dynamic Layouts example shows how to move widgets around in + \brief The Dynamic Layouts example shows how to move widgets around in existing layouts. */ diff --git a/doc/src/examples/easing.qdoc b/doc/src/examples/easing.qdoc index 1a7657d..42f00f1 100644 --- a/doc/src/examples/easing.qdoc +++ b/doc/src/examples/easing.qdoc @@ -29,7 +29,7 @@ \example animation/easing \title Easing Curves Example - The Easing Curves example shows how to use easing curves to + \brief The Easing Curves example shows how to use easing curves to control the speed of an animation. \image easing-example.png diff --git a/doc/src/examples/echoplugin.qdoc b/doc/src/examples/echoplugin.qdoc index cadd485..c920c2b 100644 --- a/doc/src/examples/echoplugin.qdoc +++ b/doc/src/examples/echoplugin.qdoc @@ -29,7 +29,7 @@ \example tools/echoplugin \title Echo Plugin Example - This example shows how to create a Qt plugin. + \brief The Echo Plugin example shows how to create a Qt plugin. \image echopluginexample.png diff --git a/doc/src/examples/editabletreemodel.qdoc b/doc/src/examples/editabletreemodel.qdoc index 8be3037..00f20f6 100644 --- a/doc/src/examples/editabletreemodel.qdoc +++ b/doc/src/examples/editabletreemodel.qdoc @@ -29,8 +29,8 @@ \example itemviews/editabletreemodel \title Editable Tree Model Example - This example shows how to implement a simple item-based tree model that can - be used with other classes the model/view framework. + \brief The Editable Tree Model example shows how to implement a simple item-based tree model that can + be used with other classes in the model/view framework. \image itemviews-editabletreemodel.png diff --git a/doc/src/examples/elasticnodes.qdoc b/doc/src/examples/elasticnodes.qdoc index e5399b1..30ebc6f 100644 --- a/doc/src/examples/elasticnodes.qdoc +++ b/doc/src/examples/elasticnodes.qdoc @@ -29,8 +29,10 @@ \example graphicsview/elasticnodes \title Elastic Nodes Example - The Elastic Nodes example shows how to implement edges between nodes in a - graph, with basic interaction. You can click to drag a node around, and + \brief The Elastic Nodes example shows how to implement edges between nodes in a + graph, with basic interaction. + + You can click to drag a node around, and zoom in and out using the mouse wheel or the keyboard. Hitting the space bar will randomize the nodes. The example is also resolution independent; as you zoom in, the graphics remain crisp. diff --git a/doc/src/examples/elidedlabel.qdoc b/doc/src/examples/elidedlabel.qdoc index 5bfe0f8..9a5b476 100644 --- a/doc/src/examples/elidedlabel.qdoc +++ b/doc/src/examples/elidedlabel.qdoc @@ -30,7 +30,7 @@ \group all-examples \title Elided Label Example - This example creates a widget similar to QLabel, that elides the last + \brief The Elided Label example creates a widget similar to QLabel, that elides the last visible line, if the text is too long to fit the widget's geometry. \image elidedlabel-example.png Elided Label example on XPressMusic 5800 diff --git a/doc/src/examples/eventtransitions.qdoc b/doc/src/examples/eventtransitions.qdoc index c66e9c1..bc0503c 100644 --- a/doc/src/examples/eventtransitions.qdoc +++ b/doc/src/examples/eventtransitions.qdoc @@ -29,7 +29,7 @@ \example statemachine/eventtransitions \title Event Transitions Example - The Event Transitions example shows how to use event transitions, a + \brief The Event Transitions example shows how to use event transitions, a feature of \l{The State Machine Framework}. \snippet examples/statemachine/eventtransitions/main.cpp 0 diff --git a/doc/src/examples/extension.qdoc b/doc/src/examples/extension.qdoc index 41fddbb..69604ba 100644 --- a/doc/src/examples/extension.qdoc +++ b/doc/src/examples/extension.qdoc @@ -29,7 +29,7 @@ \example dialogs/extension \title Extension Example - The Extension example shows how to add an extension to a QDialog + \brief The Extension example shows how to add an extension to a QDialog using the QAbstractButton::toggled() signal and the QWidget::setVisible() slot. diff --git a/doc/src/examples/factorial.qdoc b/doc/src/examples/factorial.qdoc index a317189..483cd46 100644 --- a/doc/src/examples/factorial.qdoc +++ b/doc/src/examples/factorial.qdoc @@ -29,7 +29,7 @@ \example statemachine/factorial \title Factorial States Example - The Factorial States example shows how to use \l{The State Machine + \brief The Factorial States example shows how to use \l{The State Machine Framework} to calculate the factorial of an integer. The statechart for calculating the factorial looks as follows: diff --git a/doc/src/examples/fademessage.qdoc b/doc/src/examples/fademessage.qdoc index 7e07324..5abc19a 100644 --- a/doc/src/examples/fademessage.qdoc +++ b/doc/src/examples/fademessage.qdoc @@ -29,9 +29,8 @@ \example effects/fademessage \title Fade Message Effect Example - \div { style="text-align: center"} - \inlineimage fademessageeffect-example.png - \inlineimage fademessageeffect-example-faded.png - \enddiv - + \brief The Fade Message Example shows the QGraphicsColorizeEffect in action. + + \image fademessageeffect-example.png + \image fademessageeffect-example-faded.png */ diff --git a/doc/src/examples/fancybrowser.qdoc b/doc/src/examples/fancybrowser.qdoc index 327dfbd..8cae77e 100644 --- a/doc/src/examples/fancybrowser.qdoc +++ b/doc/src/examples/fancybrowser.qdoc @@ -29,7 +29,7 @@ \example webkit/fancybrowser \title Fancy Browser Example - The Fancy Browser example shows how to use jQuery with QtWebKit to + \brief The Fancy Browser example shows how to use jQuery with QtWebKit to create a web browser with special effects and content manipulation. diff --git a/doc/src/examples/fetchmore.qdoc b/doc/src/examples/fetchmore.qdoc index 9e64b0a..8774543 100644 --- a/doc/src/examples/fetchmore.qdoc +++ b/doc/src/examples/fetchmore.qdoc @@ -29,7 +29,7 @@ \example itemviews/fetchmore \title Fetch More Example - The Fetch More example shows how two add items to an item view + \brief The Fetch More example shows how two add items to an item view model on demand. \image fetchmore-example.png diff --git a/doc/src/examples/filetree.qdoc b/doc/src/examples/filetree.qdoc index ae691d8..5b1019a 100644 --- a/doc/src/examples/filetree.qdoc +++ b/doc/src/examples/filetree.qdoc @@ -29,7 +29,7 @@ \example xmlpatterns/filetree \title File System Example - This example shows how to use QtXmlPatterns for querying non-XML + \brief The File Tree example shows how to use QtXmlPatterns for querying non-XML data that is modeled to look like XML. \tableofcontents diff --git a/doc/src/examples/findfiles.qdoc b/doc/src/examples/findfiles.qdoc index 026d61f..df591b6 100644 --- a/doc/src/examples/findfiles.qdoc +++ b/doc/src/examples/findfiles.qdoc @@ -29,8 +29,10 @@ \example dialogs/findfiles \title Find Files Example - The Find Files example shows how to use QProgressDialog to provide - feedback on the progress of a slow operation. The example also + \brief The Find Files example shows how to use QProgressDialog to provide + feedback on the progress of a slow operation. + + The example also shows how to use QFileDialog to facilitate browsing, how to use QTextStream's streaming operators to read a file, and how to use QTableWidget to provide standard table display facilities for diff --git a/doc/src/examples/fingerpaint.qdoc b/doc/src/examples/fingerpaint.qdoc index 49078b6..659784c 100644 --- a/doc/src/examples/fingerpaint.qdoc +++ b/doc/src/examples/fingerpaint.qdoc @@ -29,7 +29,7 @@ \example touch/fingerpaint \title Finger Paint Example - The Finger Paint example shows the use of a touchscreen with a custom widget + \brief The Finger Paint example shows the use of a touchscreen with a custom widget to create a simple painting application. \image touch-fingerpaint-example.png diff --git a/doc/src/examples/flowlayout.qdoc b/doc/src/examples/flowlayout.qdoc index 194a733..7b35b67 100644 --- a/doc/src/examples/flowlayout.qdoc +++ b/doc/src/examples/flowlayout.qdoc @@ -29,7 +29,7 @@ \example layouts/flowlayout \title Flow Layout Example - The Flow Layout example demonstrates a custom layout that arranges child + \brief The Flow Layout example demonstrates a custom layout that arranges child widgets from left to right and top to bottom in a top-level widget. \image flowlayout-example.png Screenshot of the Flow Layout example diff --git a/doc/src/examples/fontsampler.qdoc b/doc/src/examples/fontsampler.qdoc index b3caa9f..6ebeab9 100644 --- a/doc/src/examples/fontsampler.qdoc +++ b/doc/src/examples/fontsampler.qdoc @@ -29,7 +29,7 @@ \example painting/fontsampler \title Font Sampler Example - The Font Sampler example shows how to preview and print multi-page documents. + \brief The Font Sampler example shows how to preview and print multi-page documents. \image fontsampler-example.png */ diff --git a/doc/src/examples/formextractor.qdoc b/doc/src/examples/formextractor.qdoc index 79f6d19..de050c5 100644 --- a/doc/src/examples/formextractor.qdoc +++ b/doc/src/examples/formextractor.qdoc @@ -29,7 +29,7 @@ \example webkit/formextractor \title Form Extractor Example - The Form Extractor example shows how to use QWebFrame with JavaScript to + \brief The Form Extractor example shows how to use QWebFrame with JavaScript to extract form data. \image formextractor-example.png diff --git a/doc/src/examples/fortuneclient.qdoc b/doc/src/examples/fortuneclient.qdoc index 0c74143..7837ee2 100644 --- a/doc/src/examples/fortuneclient.qdoc +++ b/doc/src/examples/fortuneclient.qdoc @@ -29,8 +29,10 @@ \example network/fortuneclient \title Fortune Client Example - The Fortune Client example shows how to create a client for a simple - network service using QTcpSocket. It is intended to be run alongside the + \brief The Fortune Client example shows how to create a client for a simple + network service using QTcpSocket. + + The example is intended to be run alongside the \l{network/fortuneserver}{Fortune Server} example or the \l{network/threadedfortuneserver}{Threaded Fortune Server} example. diff --git a/doc/src/examples/fortuneserver.qdoc b/doc/src/examples/fortuneserver.qdoc index 2fb7f25..5042479 100644 --- a/doc/src/examples/fortuneserver.qdoc +++ b/doc/src/examples/fortuneserver.qdoc @@ -29,8 +29,10 @@ \example network/fortuneserver \title Fortune Server Example - The Fortune Server example shows how to create a server for a simple - network service. It is intended to be run alongside the + \brief The Fortune Server example shows how to create a server for a simple + network service. + + The example is intended to be run alongside the \l{network/fortuneclient}{Fortune Client} example or the \l{network/blockingfortuneclient}{Blocking Fortune Client} example. diff --git a/doc/src/examples/framebufferobject.qdoc b/doc/src/examples/framebufferobject.qdoc index 12b1d5f..539b751 100644 --- a/doc/src/examples/framebufferobject.qdoc +++ b/doc/src/examples/framebufferobject.qdoc @@ -29,7 +29,7 @@ \example opengl/framebufferobject \title Framebuffer Object Example - The Framebuffer Object example demonstrates how to use the + \brief The Framebuffer Object example demonstrates how to use the QGLFramebufferObject class to render into an off-screen buffer and use the contents as a texture in a QGLWidget. diff --git a/doc/src/examples/framebufferobject2.qdoc b/doc/src/examples/framebufferobject2.qdoc index cbe8f3f..b77b495 100644 --- a/doc/src/examples/framebufferobject2.qdoc +++ b/doc/src/examples/framebufferobject2.qdoc @@ -29,7 +29,7 @@ \example opengl/framebufferobject2 \title Framebuffer Object 2 Example - The Framebuffer Object 2 example demonstrates how to use the + \brief The Framebuffer Object 2 example demonstrates how to use the QGLFramebufferObject class to render into an off-screen buffer and use the contents as a texture in a QGLWidget. diff --git a/doc/src/examples/fridgemagnets.qdoc b/doc/src/examples/fridgemagnets.qdoc index 8490801..689ed1f 100644 --- a/doc/src/examples/fridgemagnets.qdoc +++ b/doc/src/examples/fridgemagnets.qdoc @@ -29,7 +29,7 @@ \example draganddrop/fridgemagnets \title Fridge Magnets Example - The Fridge Magnets example shows how to supply more than one type + \brief The Fridge Magnets example shows how to supply more than one type of MIME-encoded data with a drag and drop operation. \image fridgemagnets-example.png diff --git a/doc/src/examples/frozencolumn.qdoc b/doc/src/examples/frozencolumn.qdoc index a21926b..9d0d938 100644 --- a/doc/src/examples/frozencolumn.qdoc +++ b/doc/src/examples/frozencolumn.qdoc @@ -29,7 +29,7 @@ \example itemviews/frozencolumn \title Frozen Column Example - This example demonstrates how to freeze a column within a QTableView. + \brief The Frozen Column example demonstrates how to freeze a column within a QTableView. \image frozencolumn-example.png "Screenshot of the example" diff --git a/doc/src/examples/ftp.qdoc b/doc/src/examples/ftp.qdoc index f0d64ef..57796f8 100644 --- a/doc/src/examples/ftp.qdoc +++ b/doc/src/examples/ftp.qdoc @@ -29,7 +29,7 @@ \example network/qftp \title FTP Example - The FTP example demonstrates a simple FTP client that can be used + \brief The FTP example demonstrates a simple FTP client that can be used to list the available files on an FTP server and download them. \image ftp-example.png diff --git a/doc/src/examples/globalVariables.qdoc b/doc/src/examples/globalVariables.qdoc index 70147d2..b03440d 100644 --- a/doc/src/examples/globalVariables.qdoc +++ b/doc/src/examples/globalVariables.qdoc @@ -29,7 +29,7 @@ \example xmlpatterns/xquery/globalVariables \title C++ Source Code Analyzer Example - This example uses XQuery and the \c xmlpatterns command line utility to + \brief The Global Variables example uses XQuery and the \c xmlpatterns command line utility to query C++ source code. \tableofcontents diff --git a/doc/src/examples/googlechat.qdoc b/doc/src/examples/googlechat.qdoc index e9118f1..34dbbf6 100644 --- a/doc/src/examples/googlechat.qdoc +++ b/doc/src/examples/googlechat.qdoc @@ -29,7 +29,7 @@ \example webkit/googlechat \title Google Chat Example - The Google Chat example shows how to use implement a simple Google Chat + \brief The Google Chat example shows how to use implement a simple Google Chat client with QtWebKit. \image googlechat-example.png diff --git a/doc/src/examples/googlesuggest.qdoc b/doc/src/examples/googlesuggest.qdoc index 743a624..8e5c1ca 100644 --- a/doc/src/examples/googlesuggest.qdoc +++ b/doc/src/examples/googlesuggest.qdoc @@ -29,7 +29,7 @@ \example network/googlesuggest \title Google Suggest Example - The Google Suggest example demonstrates how to use the QNetworkAccessManager + \brief The Google Suggest example demonstrates how to use the QNetworkAccessManager class to obtain a list of suggestions from the Google search engine as the user types into a QLineEdit. diff --git a/doc/src/examples/grabber.qdoc b/doc/src/examples/grabber.qdoc index 4b65848..27a89b9 100644 --- a/doc/src/examples/grabber.qdoc +++ b/doc/src/examples/grabber.qdoc @@ -29,7 +29,7 @@ \example opengl/grabber \title Grabber Example - The Grabber examples shows how to retrieve the contents of an OpenGL framebuffer. + \brief The Grabber examples shows how to retrieve the contents of an OpenGL framebuffer. \image grabber-example.png */ diff --git a/doc/src/examples/graphicsview-anchorlayout.qdoc b/doc/src/examples/graphicsview-anchorlayout.qdoc index 156cdb4..68c144a 100644 --- a/doc/src/examples/graphicsview-anchorlayout.qdoc +++ b/doc/src/examples/graphicsview-anchorlayout.qdoc @@ -29,6 +29,6 @@ \example graphicsview/anchorlayout \title Anchor Layout Example - The Anchor Layout example demonstrates the use of the QGraphicsAnchorLayout + \brief The Anchor Layout example demonstrates the use of the QGraphicsAnchorLayout class. */ diff --git a/doc/src/examples/graphicsview-flowlayout.qdoc b/doc/src/examples/graphicsview-flowlayout.qdoc index b0c04b8..42ea65f 100644 --- a/doc/src/examples/graphicsview-flowlayout.qdoc +++ b/doc/src/examples/graphicsview-flowlayout.qdoc @@ -29,7 +29,7 @@ \example graphicsview/flowlayout \title Graphics View Flow Layout Example - The Graphics View Flow Layout example shows the use of a flow layout + \brief The Graphics View Flow Layout example shows the use of a flow layout in a Graphics View widget. See the \l{Flow Layout Example} for a corresponding widget-based example. diff --git a/doc/src/examples/graphicsview-simpleanchorlayout.qdoc b/doc/src/examples/graphicsview-simpleanchorlayout.qdoc index 6f6ba5b..603ea50 100644 --- a/doc/src/examples/graphicsview-simpleanchorlayout.qdoc +++ b/doc/src/examples/graphicsview-simpleanchorlayout.qdoc @@ -29,6 +29,6 @@ \example graphicsview/simpleanchorlayout \title Simple Anchor Layout Example - The Simple Anchor Layout example shows the basic use of the + \brief The Simple Anchor Layout example shows the basic use of the QGraphicsAnchorLayout class. */ diff --git a/doc/src/examples/graphicsview-weatheranchorlayout.qdoc b/doc/src/examples/graphicsview-weatheranchorlayout.qdoc index 20173af..da2ee76 100644 --- a/doc/src/examples/graphicsview-weatheranchorlayout.qdoc +++ b/doc/src/examples/graphicsview-weatheranchorlayout.qdoc @@ -29,6 +29,6 @@ \example graphicsview/weatheranchorlayout \title Weather Anchor Layout Example - The Weather Anchor Layout example shows more complex use of the + \brief The Weather Anchor Layout example shows more complex use of the QGraphicsAnchorLayout class to create a real-world window layout. */ diff --git a/doc/src/examples/groupbox.qdoc b/doc/src/examples/groupbox.qdoc index a042437..02e8a9c 100644 --- a/doc/src/examples/groupbox.qdoc +++ b/doc/src/examples/groupbox.qdoc @@ -29,7 +29,7 @@ \example widgets/groupbox \title Group Box Example - The Group Box example shows how to use the different kinds of group + \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, diff --git a/doc/src/examples/hellogl.qdoc b/doc/src/examples/hellogl.qdoc index dbd672e..641a777 100644 --- a/doc/src/examples/hellogl.qdoc +++ b/doc/src/examples/hellogl.qdoc @@ -29,7 +29,7 @@ \example opengl/hellogl \title Hello GL Example - The Hello GL example demonstrates the basic use of the OpenGL-related classes + \brief The Hello GL example demonstrates the basic use of the OpenGL-related classes provided with Qt. \image hellogl-example.png diff --git a/doc/src/examples/hellogl_es.qdoc b/doc/src/examples/hellogl_es.qdoc index fdc7ab5..d57bb1d 100644 --- a/doc/src/examples/hellogl_es.qdoc +++ b/doc/src/examples/hellogl_es.qdoc @@ -29,7 +29,7 @@ \example opengl/hellogl_es \title Hello GL ES Example - The Hello GL ES example is the \l{Hello GL Example} ported to OpenGL ES. + \brief The Hello GL ES example is the \l{Hello GL Example} ported to OpenGL ES. It also included some effects from the OpenGL \l{Overpainting Example}. \image hellogl-es-example.png diff --git a/doc/src/examples/helloscript.qdoc b/doc/src/examples/helloscript.qdoc index 1c6ea85..745a327 100644 --- a/doc/src/examples/helloscript.qdoc +++ b/doc/src/examples/helloscript.qdoc @@ -29,9 +29,11 @@ \example script/helloscript \title Hello Script Example - The Hello Script example shows the basic use of Qt Script: How to embed + \brief The Hello Script example shows the basic use of Qt Script: How to embed a script engine into the application, how to evaluate a script, and how - to process the result of the evaluation. The example also shows how to + to process the result of the evaluation. + + The example also shows how to apply internationalization to scripts. \snippet examples/script/helloscript/main.cpp 0 diff --git a/doc/src/examples/hellotr.qdoc b/doc/src/examples/hellotr.qdoc index 4b7c4b7..c85a2ad 100644 --- a/doc/src/examples/hellotr.qdoc +++ b/doc/src/examples/hellotr.qdoc @@ -29,8 +29,9 @@ \example linguist/hellotr \title Hello tr() Example - This example is a small Hello World program with a Latin translation. The - screenshot below shows the English version. + \brief The Hello tr() example is a small Hello World program with a Latin translation. + + The screenshot below shows the English version. \image linguist-hellotr_en.png diff --git a/doc/src/examples/htmlinfo.qdoc b/doc/src/examples/htmlinfo.qdoc index 23365f1..e21e8b0 100644 --- a/doc/src/examples/htmlinfo.qdoc +++ b/doc/src/examples/htmlinfo.qdoc @@ -29,7 +29,7 @@ \example xml/htmlinfo \title XML HTML Info Example - The XML HTML Info example provides a simple command line utility that + \brief The XML HTML Info example provides a simple command line utility that scans the current directory for HTML files and prints statistics about them to standard out. diff --git a/doc/src/examples/http.qdoc b/doc/src/examples/http.qdoc index ab03683..4704be0 100644 --- a/doc/src/examples/http.qdoc +++ b/doc/src/examples/http.qdoc @@ -29,7 +29,7 @@ \example network/http \title HTTP Example - The HTTP example demonstrates a simple HTTP client that shows how to fetch files + \brief The HTTP example demonstrates a simple HTTP client that shows how to fetch files specified by URLs from remote hosts. \image http-example.png diff --git a/doc/src/examples/i18n.qdoc b/doc/src/examples/i18n.qdoc index 2ce47e1..392d2e2 100644 --- a/doc/src/examples/i18n.qdoc +++ b/doc/src/examples/i18n.qdoc @@ -29,8 +29,10 @@ \example tools/i18n \title I18N Example - The Internationalization (I18N) example demonstrates Qt's support for translated - text. Developers can write the initial application text in one language, and + \brief The Internationalization (I18N) example demonstrates Qt's support for translated + text. + + Developers can write the initial application text in one language, and translations can be provided later without any modifications to the code. \image i18n-example.png diff --git a/doc/src/examples/icons.qdoc b/doc/src/examples/icons.qdoc index 82ff994..3fa9952 100644 --- a/doc/src/examples/icons.qdoc +++ b/doc/src/examples/icons.qdoc @@ -29,8 +29,10 @@ \example widgets/icons \title Icons Example - The Icons example shows how QIcon can generate pixmaps reflecting - an icon's state, mode and size. These pixmaps are generated from + \brief 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. diff --git a/doc/src/examples/imagecomposition.qdoc b/doc/src/examples/imagecomposition.qdoc index cd08de4..8b95ded 100644 --- a/doc/src/examples/imagecomposition.qdoc +++ b/doc/src/examples/imagecomposition.qdoc @@ -29,7 +29,7 @@ \example painting/imagecomposition \title Image Composition Example - The Image Composition example lets the user combine images + \brief The Image Composition example lets the user combine images together using any composition mode supported by QPainter, described in detail in \l{QPainter#Composition Modes}{Composition Modes}. diff --git a/doc/src/examples/imagegestures.qdoc b/doc/src/examples/imagegestures.qdoc index 24a1276..2a8a282 100644 --- a/doc/src/examples/imagegestures.qdoc +++ b/doc/src/examples/imagegestures.qdoc @@ -29,7 +29,7 @@ \example gestures/imagegestures \title Image Gestures Example - This example shows how to enable gestures for a widget and use gesture input + \brief The Image Gestures example shows how to enable gestures for a widget and use gesture input to perform actions. We use two classes to create the user interface for the application: \c MainWidget diff --git a/doc/src/examples/imageviewer.qdoc b/doc/src/examples/imageviewer.qdoc index 49b3111..e915ef8 100644 --- a/doc/src/examples/imageviewer.qdoc +++ b/doc/src/examples/imageviewer.qdoc @@ -29,8 +29,10 @@ \example widgets/imageviewer \title Image Viewer Example - The example shows how to combine QLabel and QScrollArea to - display an image. QLabel is typically used for displaying text, + \brief The Image Viewer example shows how to combine QLabel and QScrollArea to + display an image. + + 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 diff --git a/doc/src/examples/inputpanel.qdoc b/doc/src/examples/inputpanel.qdoc index 54920f0..f001aee 100644 --- a/doc/src/examples/inputpanel.qdoc +++ b/doc/src/examples/inputpanel.qdoc @@ -29,7 +29,7 @@ \example tools/inputpanel \title Input Panel Example - The Input Panel example shows how to create an input panel that + \brief The Input Panel example shows how to create an input panel that can be used to input text into widgets using only the pointer and no keyboard. diff --git a/doc/src/examples/itemviewspuzzle.qdoc b/doc/src/examples/itemviewspuzzle.qdoc index 72e543b..22826ec 100644 --- a/doc/src/examples/itemviewspuzzle.qdoc +++ b/doc/src/examples/itemviewspuzzle.qdoc @@ -29,7 +29,7 @@ \example itemviews/puzzle \title Item Views Puzzle Example - The Puzzle example shows how to enable drag and drop with a custom model + \brief The Puzzle example shows how to enable drag and drop with a custom model to allow items to be transferred between a view and another widget. \image itemviewspuzzle-example.png diff --git a/doc/src/examples/licensewizard.qdoc b/doc/src/examples/licensewizard.qdoc index a58e029..e46ea32 100644 --- a/doc/src/examples/licensewizard.qdoc +++ b/doc/src/examples/licensewizard.qdoc @@ -29,7 +29,7 @@ \example dialogs/licensewizard \title License Wizard Example - The License Wizard example shows how to implement complex wizards in + \brief The License Wizard example shows how to implement complex wizards in Qt. \image licensewizard-example.png Screenshot of the License Wizard example diff --git a/doc/src/examples/lighting.qdoc b/doc/src/examples/lighting.qdoc index 815a42a..05c1e79 100644 --- a/doc/src/examples/lighting.qdoc +++ b/doc/src/examples/lighting.qdoc @@ -29,5 +29,7 @@ \example effects/lighting \title Lighting Effect Example + \brief The Lighting Effect Example shows the QGraphicsDropShadowEffect in action. + \image lightingeffect-example.png */ diff --git a/doc/src/examples/lineedits.qdoc b/doc/src/examples/lineedits.qdoc index 03b4f27..c187dfd 100644 --- a/doc/src/examples/lineedits.qdoc +++ b/doc/src/examples/lineedits.qdoc @@ -29,7 +29,7 @@ \example widgets/lineedits \title Line Edits Example - The Line Edits example demonstrates the many ways that QLineEdit can be used, and + \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. diff --git a/doc/src/examples/localfortuneclient.qdoc b/doc/src/examples/localfortuneclient.qdoc index 56ead19..b7ea65a 100644 --- a/doc/src/examples/localfortuneclient.qdoc +++ b/doc/src/examples/localfortuneclient.qdoc @@ -29,8 +29,10 @@ \example ipc/localfortuneclient \title Local Fortune Client Example - The Local Fortune Client example shows how to create a client for a simple - local service using QLocalSocket. It is intended to be run alongside the + \brief The Local Fortune Client example shows how to create a client for a simple + local service using QLocalSocket. + + The example is intended to be run alongside the \l{ipc/localfortuneserver}{Local Fortune Server} example. \image localfortuneclient-example.png Screenshot of the Local Fortune Client example diff --git a/doc/src/examples/localfortuneserver.qdoc b/doc/src/examples/localfortuneserver.qdoc index 7a26ff8..21c5feb 100644 --- a/doc/src/examples/localfortuneserver.qdoc +++ b/doc/src/examples/localfortuneserver.qdoc @@ -29,8 +29,10 @@ \example ipc/localfortuneserver \title Local Fortune Server Example - The Local Fortune Server example shows how to create a server for a simple - local service. It is intended to be run alongside the + \brief The Local Fortune Server example shows how to create a server for a simple + local service. + + The example is intended to be run alongside the \l{ipc/localfortuneclient}{Local Fortune Client} example \image localfortuneserver-example.png Screenshot of the Local Fortune Server example diff --git a/doc/src/examples/loopback.qdoc b/doc/src/examples/loopback.qdoc index a5d810a..9e87ace 100644 --- a/doc/src/examples/loopback.qdoc +++ b/doc/src/examples/loopback.qdoc @@ -29,7 +29,7 @@ \example network/loopback \title Loopback Example - The Loopback example shows how to communicate between simple clients and servers on a local + \brief The Loopback example shows how to communicate between simple clients and servers on a local host. \image loopback-example.png diff --git a/doc/src/examples/maemovibration.qdoc b/doc/src/examples/maemovibration.qdoc index de53ba4..58a8837 100644 --- a/doc/src/examples/maemovibration.qdoc +++ b/doc/src/examples/maemovibration.qdoc @@ -30,7 +30,7 @@ \group all-examples \title Maemo Vibration Example - The Maemo Vibration example shows how to tell the Maemo Mode Control Entity + \brief The Maemo Vibration example shows how to tell the Maemo Mode Control Entity (MCE) to vibrate a maemo device. The MCE is a system service on Maemo that, among other things, provides an diff --git a/doc/src/examples/mandelbrot.qdoc b/doc/src/examples/mandelbrot.qdoc index eb53e95..3e516e9 100644 --- a/doc/src/examples/mandelbrot.qdoc +++ b/doc/src/examples/mandelbrot.qdoc @@ -29,7 +29,7 @@ \example threads/mandelbrot \title Mandelbrot Example - The Mandelbrot example shows how to use a worker thread to + \brief The Mandelbrot example shows how to use a worker thread to perform heavy computations without blocking the main thread's event loop. diff --git a/doc/src/examples/masterdetail.qdoc b/doc/src/examples/masterdetail.qdoc index 16ddb3e..06bf228 100644 --- a/doc/src/examples/masterdetail.qdoc +++ b/doc/src/examples/masterdetail.qdoc @@ -29,8 +29,10 @@ \example sql/masterdetail \title Master Detail Example - The Master Detail Example shows how to present data from different - data sources in the same application. The album titles, and the + \brief The Master Detail Example shows how to present data from different + data sources in the same application. + + The album titles, and the corresponding artists and release dates, are kept in a database, while each album's tracks are stored in an XML file. diff --git a/doc/src/examples/mdi.qdoc b/doc/src/examples/mdi.qdoc index 4f64fa1..317a251 100644 --- a/doc/src/examples/mdi.qdoc +++ b/doc/src/examples/mdi.qdoc @@ -29,7 +29,7 @@ \example mainwindows/mdi \title MDI Example - The MDI example shows how to implement a Multiple Document Interface using Qt's + \brief The MDI example shows how to implement a Multiple Document Interface using Qt's QMdiArea class. \image mdi-example.png diff --git a/doc/src/examples/menus.qdoc b/doc/src/examples/menus.qdoc index 0a31ca8..f42aa64 100644 --- a/doc/src/examples/menus.qdoc +++ b/doc/src/examples/menus.qdoc @@ -29,7 +29,7 @@ \example mainwindows/menus \title Menus Example - The Menus example demonstrates how menus can be used in a main + \brief The Menus example demonstrates how menus can be used in a main window application. A menu widget can be either a pull-down menu in a menu bar or a diff --git a/doc/src/examples/mousecalibration.qdoc b/doc/src/examples/mousecalibration.qdoc index 590153b..b2f7939 100644 --- a/doc/src/examples/mousecalibration.qdoc +++ b/doc/src/examples/mousecalibration.qdoc @@ -29,7 +29,7 @@ \example qws/mousecalibration \title Mouse Calibration Example - The Mouse Calibration example demonstrates how to write a simple + \brief The Mouse Calibration example demonstrates how to write a simple program using the mechanisms provided by the QWSMouseHandler class to calibrate the mouse handler in \l{Qt for Embedded Linux}. diff --git a/doc/src/examples/moveblocks.qdoc b/doc/src/examples/moveblocks.qdoc index e5ce3be..5acaa47 100644 --- a/doc/src/examples/moveblocks.qdoc +++ b/doc/src/examples/moveblocks.qdoc @@ -29,7 +29,7 @@ \example animation/moveblocks \title Move Blocks Example - The Move Blocks example shows how to animate items in a + \brief The Move Blocks example shows how to animate items in a QGraphicsScene using a QStateMachine with a custom transition. \image moveblocks-example.png diff --git a/doc/src/examples/movie.qdoc b/doc/src/examples/movie.qdoc index bd5726c..4f31674 100644 --- a/doc/src/examples/movie.qdoc +++ b/doc/src/examples/movie.qdoc @@ -29,8 +29,10 @@ \example widgets/movie \title Movie Example - The Movie example demonstrates how to use QMovie and QLabel to - display animations. Now that Qt comes with the \l{Phonon multimedia + \brief The Movie example demonstrates how to use QMovie and QLabel to + display animations. + + Now that Qt comes with the \l{Phonon multimedia framework} {Phonon multimedia framework}, QMovie is mostly useful if one wants to play a simple animation without the added complexity of a multimedia framework to install and deploy. diff --git a/doc/src/examples/multicastreceiver.qdoc b/doc/src/examples/multicastreceiver.qdoc index 1a0f3b5..96a011f 100644 --- a/doc/src/examples/multicastreceiver.qdoc +++ b/doc/src/examples/multicastreceiver.qdoc @@ -29,7 +29,7 @@ \example network/multicastreceiver \title Multicast Receiver Example - The Multicast Receiever example shows how to receive information that is + \brief The Multicast Receiever example shows how to receive information that is sent to a multicast group. \image multicastreceiver-example.png diff --git a/doc/src/examples/multicastsender.qdoc b/doc/src/examples/multicastsender.qdoc index 55b3804..c5b7531 100644 --- a/doc/src/examples/multicastsender.qdoc +++ b/doc/src/examples/multicastsender.qdoc @@ -29,7 +29,7 @@ \example network/multicastsender \title Multicast Sender Example - The Multicast Sender example shows how to send information to multiple + \brief The Multicast Sender example shows how to send information to multiple clients in a multicast group. \image multicastsender-example.png diff --git a/doc/src/examples/multipleinheritance.qdoc b/doc/src/examples/multipleinheritance.qdoc index fa125f0..9c86950 100644 --- a/doc/src/examples/multipleinheritance.qdoc +++ b/doc/src/examples/multipleinheritance.qdoc @@ -29,7 +29,7 @@ \example uitools/multipleinheritance \title Multiple Inheritance Example - The Multiple Inheritance Example shows how to use a form created with \QD + \brief The Multiple Inheritance Example shows how to use a form created with \QD in an application by subclassing both QWidget and the user interface class, which is \c{Ui::CalculatorForm}. diff --git a/doc/src/examples/musicplayerexample.qdoc b/doc/src/examples/musicplayerexample.qdoc index 7cba674..13a7bba 100644 --- a/doc/src/examples/musicplayerexample.qdoc +++ b/doc/src/examples/musicplayerexample.qdoc @@ -29,8 +29,9 @@ \example phonon/qmusicplayer \title Music Player Example - The Music Player Example shows how to use Phonon - the multimedia + \brief The Music Player Example shows how to use Phonon - the multimedia framework that comes with Qt - to create a simple music player. + The player can play music files, and provides simple playback control, such as pausing, stopping, and resuming the music. diff --git a/doc/src/examples/network-chat.qdoc b/doc/src/examples/network-chat.qdoc index bd8288f..b91b9c0 100644 --- a/doc/src/examples/network-chat.qdoc +++ b/doc/src/examples/network-chat.qdoc @@ -29,7 +29,7 @@ \example network/network-chat \title Network Chat Example - The Network Chat example demonstrates a stateful peer-to-peer Chat client + \brief The Network Chat example demonstrates a stateful peer-to-peer Chat client that uses broadcasting with QUdpSocket and QNetworkInterface to discover its peers. diff --git a/doc/src/examples/network-download.qdoc b/doc/src/examples/network-download.qdoc index da86b2a..48dbe10 100644 --- a/doc/src/examples/network-download.qdoc +++ b/doc/src/examples/network-download.qdoc @@ -29,7 +29,7 @@ \example network/download \title Network Download Example - The Network Download example shows how to perform multiple downloads in + \brief The Network Download example shows how to perform multiple downloads in parallel using the QNetworkAccessManager class. This example is designed to be run from the command line. diff --git a/doc/src/examples/network-downloadmanager.qdoc b/doc/src/examples/network-downloadmanager.qdoc index 0fa8cda..501c469 100644 --- a/doc/src/examples/network-downloadmanager.qdoc +++ b/doc/src/examples/network-downloadmanager.qdoc @@ -29,7 +29,7 @@ \example network/downloadmanager \title Network Download Manager Example - The Network Download example shows how to implement a queue for multiple + \brief The Network Download example shows how to implement a queue for multiple downloads using the QNetworkAccessManager class. This example is designed to be run from the command line. diff --git a/doc/src/examples/openvg-star.qdoc b/doc/src/examples/openvg-star.qdoc index 67422ae..2b25dbc 100644 --- a/doc/src/examples/openvg-star.qdoc +++ b/doc/src/examples/openvg-star.qdoc @@ -29,5 +29,5 @@ \example openvg/star \title OpenVG Star Example - The OpenVG Star example demonstrates the use of Qt's OpenVG integration. + \brief The OpenVG Star example demonstrates the use of Qt's OpenVG integration. */ diff --git a/doc/src/examples/orderform.qdoc b/doc/src/examples/orderform.qdoc index ea93d86..8d61143 100644 --- a/doc/src/examples/orderform.qdoc +++ b/doc/src/examples/orderform.qdoc @@ -29,9 +29,10 @@ \example richtext/orderform \title Order Form Example - 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 - is extracted from a \c DetailsDialog object and displayed on a QTextEdit + \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 is extracted from a \c DetailsDialog object and displayed on a QTextEdit with a QTextCursor, using various formats. Each form generated is added to a QTabWidget for easy access. diff --git a/doc/src/examples/orientation.qdoc b/doc/src/examples/orientation.qdoc index f55a650..fc9f1c1 100644 --- a/doc/src/examples/orientation.qdoc +++ b/doc/src/examples/orientation.qdoc @@ -29,7 +29,7 @@ \group all-examples \title Orientation Example - The example shows a simple way to use different UIs depending on the screen + \brief The Orientation example shows a simple way to use different UIs depending on the screen orientation of a mobile device. \image orientation-landscape.png The UI in landscape mode diff --git a/doc/src/examples/overpainting.qdoc b/doc/src/examples/overpainting.qdoc index 12f9756..74001fc 100644 --- a/doc/src/examples/overpainting.qdoc +++ b/doc/src/examples/overpainting.qdoc @@ -29,7 +29,7 @@ \example opengl/overpainting \title Overpainting Example - The Overpainting example shows how QPainter can be used + \brief The Overpainting example shows how QPainter can be used to overpaint a scene rendered using OpenGL in a QGLWidget. \image overpainting-example.png diff --git a/doc/src/examples/padnavigator.qdoc b/doc/src/examples/padnavigator.qdoc index 0942c82..111beda 100644 --- a/doc/src/examples/padnavigator.qdoc +++ b/doc/src/examples/padnavigator.qdoc @@ -29,7 +29,7 @@ \example graphicsview/padnavigator \title Pad Navigator Example - The Pad Navigator Example shows how you can use Graphics View together with + \brief The Pad Navigator Example shows how you can use Graphics View together with embedded widgets and Qt's \l{State Machine Framework} to create a simple but useful, dynamic, animated user interface. diff --git a/doc/src/examples/painterpaths.qdoc b/doc/src/examples/painterpaths.qdoc index 2f740b8..04012eb 100644 --- a/doc/src/examples/painterpaths.qdoc +++ b/doc/src/examples/painterpaths.qdoc @@ -29,7 +29,7 @@ \example painting/painterpaths \title Painter Paths Example - The Painter Paths example shows how painter paths can be used to + \brief The Painter Paths example shows how painter paths can be used to build complex shapes for rendering. \image painterpaths-example.png diff --git a/doc/src/examples/pbuffers.qdoc b/doc/src/examples/pbuffers.qdoc index 0c496b4..1c31994 100644 --- a/doc/src/examples/pbuffers.qdoc +++ b/doc/src/examples/pbuffers.qdoc @@ -29,7 +29,7 @@ \example opengl/pbuffers \title Pixel Buffers Example - The Pixel Buffers example demonstrates how to use the + \brief The Pixel Buffers example demonstrates how to use the QGLPixelBuffer class to render into an off-screen buffer and use the contents as a dynamic texture in a QGLWidget. diff --git a/doc/src/examples/pbuffers2.qdoc b/doc/src/examples/pbuffers2.qdoc index 280f329..4827b86 100644 --- a/doc/src/examples/pbuffers2.qdoc +++ b/doc/src/examples/pbuffers2.qdoc @@ -29,7 +29,7 @@ \example opengl/pbuffers2 \title Pixel Buffers 2 Example - The Pixel Buffers 2 example demonstrates how to use the + \brief The Pixel Buffers 2 example demonstrates how to use the QGLPixelBuffer class to render into an off-screen buffer and use the contents as a dynamic texture in a QGLWidget. diff --git a/doc/src/examples/pinchzoom.qdoc b/doc/src/examples/pinchzoom.qdoc index 04a8bb4..540d54c 100644 --- a/doc/src/examples/pinchzoom.qdoc +++ b/doc/src/examples/pinchzoom.qdoc @@ -29,7 +29,7 @@ \example touch/pinchzoom \title Pinch Zoom Example - The Pinch Zoom example shows how to use low-level touch information + \brief The Pinch Zoom example shows how to use low-level touch information to recognize a gesture. \image touch-pinchzoom-example.png diff --git a/doc/src/examples/pingpong.qdoc b/doc/src/examples/pingpong.qdoc index c4a29a4..a90db94 100644 --- a/doc/src/examples/pingpong.qdoc +++ b/doc/src/examples/pingpong.qdoc @@ -29,7 +29,7 @@ \example statemachine/pingpong \title Ping Pong States Example - The Ping Pong States example shows how to use parallel states together + \brief The Ping Pong States example shows how to use parallel states together with custom events and transitions in \l{The State Machine Framework}. This example implements a statechart where two states communicate by diff --git a/doc/src/examples/pixelator.qdoc b/doc/src/examples/pixelator.qdoc index b6d1fd6..50e79da 100644 --- a/doc/src/examples/pixelator.qdoc +++ b/doc/src/examples/pixelator.qdoc @@ -29,7 +29,7 @@ \example itemviews/pixelator \title Pixelator Example - The Pixelator example shows how delegates can be used to customize the way that + \brief The Pixelator example shows how delegates can be used to customize the way that items are rendered in standard item views. \image pixelator-example.png diff --git a/doc/src/examples/plugandpaint.qdoc b/doc/src/examples/plugandpaint.qdoc index 2a9d286..960ec8c 100644 --- a/doc/src/examples/plugandpaint.qdoc +++ b/doc/src/examples/plugandpaint.qdoc @@ -29,7 +29,7 @@ \example tools/plugandpaint \title Plug & Paint Example - The Plug & Paint example demonstrates how to write Qt + \brief The Plug & Paint example demonstrates how to write Qt applications that can be extended through plugins. \image plugandpaint.png Screenshot of the Plug & Paint example diff --git a/doc/src/examples/portedasteroids.qdoc b/doc/src/examples/portedasteroids.qdoc index 06428bf..3fa0793 100644 --- a/doc/src/examples/portedasteroids.qdoc +++ b/doc/src/examples/portedasteroids.qdoc @@ -29,7 +29,7 @@ \example graphicsview/portedasteroids \title Ported Asteroids Example - The Ported Asteroids example is a port of the + \brief The Ported Asteroids example is a port of the Asteroids game, which was based on QCanvas, to the Graphics View framework. diff --git a/doc/src/examples/portedcanvas.qdoc b/doc/src/examples/portedcanvas.qdoc index 49824de..457d6b3 100644 --- a/doc/src/examples/portedcanvas.qdoc +++ b/doc/src/examples/portedcanvas.qdoc @@ -29,7 +29,7 @@ \example graphicsview/portedcanvas \title Ported Canvas Example - The Ported Canvas example is a port of the old + \brief The Ported Canvas example is a port of the old QCanvas example from Qt 3 to the Graphics View framework. \sa {Porting to Graphics View} diff --git a/doc/src/examples/previewer.qdoc b/doc/src/examples/previewer.qdoc index 2fe8d8d..128d3be 100644 --- a/doc/src/examples/previewer.qdoc +++ b/doc/src/examples/previewer.qdoc @@ -29,7 +29,7 @@ \example webkit/previewer \title Previewer Example - The Previewer example shows how to use QtWebKit's QWebView to preview + \brief The Previewer example shows how to use QtWebKit's QWebView to preview HTML data written in a QPlainTextEdit. \image previewer-example.png @@ -164,4 +164,4 @@ \snippet examples/webkit/previewer/main.cpp 0 -*/
\ No newline at end of file +*/ diff --git a/doc/src/examples/qml-calculator.qdoc b/doc/src/examples/qml-calculator.qdoc index 0624cb4..2e2cdc8 100644 --- a/doc/src/examples/qml-calculator.qdoc +++ b/doc/src/examples/qml-calculator.qdoc @@ -29,7 +29,7 @@ \title Calculator \example demos/declarative/calculator - This demo shows how to write a simple calculator application in QML and JavaScript. + \brief The Qt Quick Calculator demo shows how to write a simple calculator application in QML and JavaScript. \image qml-calculator-example.png */ diff --git a/doc/src/examples/qml-examples.qdoc b/doc/src/examples/qml-examples.qdoc index a910266..bde2ed7 100644 --- a/doc/src/examples/qml-examples.qdoc +++ b/doc/src/examples/qml-examples.qdoc @@ -29,7 +29,7 @@ \title Animation: Basics Example \example declarative/animation/basics - This example shows how to create and combine \l{QML Animation and Transitions}{animations} in QML. + \brief This example shows how to create and combine \l{QML Animation}{animations} in QML. \table \row @@ -38,6 +38,12 @@ \o color-animation.qml \endtable +/*! + \title Animation: Basics Property Animation Example + \example declarative/animation/basics/property-animation + + \brief This example shows how to create and combine \l{QML Animation}{animations} in QML. + \table \row \o \image qml-propertyanim-example.png @@ -50,7 +56,7 @@ \title Animation: Behavior Examples \example declarative/animation/behaviors - This example shows how to use QML behaviors. + \brief This example shows how to use QML behaviors. \image qml-behaviors-example.png */ @@ -59,7 +65,7 @@ \title Animation: Easing Example \example declarative/animation/easing - This example shows the different easing modes available for \l{QML Animation and Transitions}{animations}. + \brief This example shows the different easing modes available for \l{QML Animation}{animations}. \image qml-easing-example.png */ @@ -68,7 +74,7 @@ \title Animation: States Example \example declarative/animation/states - These examples show how to use \l{State}{states} and \l{Transition}{transitions}. + \brief These examples show how to use \l{States}{states} and \l{Transitions}{transitions}. The \c states.qml example shows how an item can change between states, and \c transitions.qml shows how these state changes can be animated. @@ -92,7 +98,7 @@ \title Image Elements: Border Image Example \example declarative/imageelements/borderimage - These examples show how to use the BorderImage element. + \brief These examples show how to use the BorderImage element. \table \row @@ -101,6 +107,12 @@ \o borderimage.qml \endtable +/*! + \title Image Elements: Shadows Image Example + \example declarative/imageelements/shadows + + \brief This example shows how to use the BorderImage element. + \table \row \o \image qml-borderimage-shadows-example.png @@ -113,7 +125,7 @@ \title Image Elements: Image Example \example declarative/imageelements/image - This example shows how to use the \l Image element and its \l{Image::fillMode}{fillModes}. + \brief This example shows how to use the \l Image element and its \l{Image::fillMode}{fillModes}. \image qml-image-example.png */ @@ -122,8 +134,8 @@ \page declarative-cppextensions-reference.html \title C++ Extensions: Reference examples - These examples show how QML can be extended from C++ in various ways. - + \brief These examples show how QML can be extended from C++ in various ways. + The code for these examples is used throughout the \l {Extending QML Functionalities using C++} reference documentation, which highlights the main principles demonstrated in each example. @@ -151,7 +163,7 @@ \title C++ Extensions: Plugins Example \example declarative/cppextensions/plugins - This example shows how to create a C++ plugin extension by subclassing QDeclarativeExtensionPlugin. + \brief This example shows how to create a C++ plugin extension by subclassing QDeclarativeExtensionPlugin. \image qml-plugins-example.png */ @@ -160,7 +172,7 @@ \title LayoutItem Example \example declarative/cppextensions/qgraphicslayouts/layoutitem - This example show how to use the LayoutItem element to integrate QML items into an existing + \brief This example show how to use the LayoutItem element to integrate QML items into an existing \l{Graphics View Framework}{Graphics View}-based application. \image qml-layoutitem-example.png @@ -169,7 +181,7 @@ \title QGraphicsGridLayout Example \example declarative/cppextensions/qgraphicslayouts/qgraphicsgridlayout - This example shows how to use QGraphicsGridLayout to lay out QML items. This is + \brief This example shows how to use QGraphicsGridLayout to lay out QML items. This is useful if you need to integrate Qt \l{Graphics View Framework}{Graphics View} layouts with QML. @@ -179,7 +191,7 @@ \title QGraphicsLinearLayout Example \example declarative/cppextensions/qgraphicslayouts/qgraphicslinearlayout - This example shows how to use QGraphicsLinearLayout to lay out QML items. This is + \brief This example shows how to use QGraphicsLinearLayout to lay out QML items. This is useful if you need to integrate Qt \l{Graphics View Framework}{Graphics View} layouts with QML. @@ -189,7 +201,7 @@ \title C++ Extensions: QGraphicsLayouts examples \page declarative-cppextensions-qgraphicslayouts.html - These examples show how to integrate \l{Graphics View Framework}{Graphics View} + \brief These examples show how to integrate \l{Graphics View Framework}{Graphics View} layout components with QML: \list @@ -206,7 +218,7 @@ \title C++ Extensions: QWidgets Example \example declarative/cppextensions/qwidgets - This example shows how to embed QWidget-based objects into QML using QGraphicsProxyWidget. + \brief This example shows how to embed QWidget-based objects into QML using QGraphicsProxyWidget. \image qml-qwidgets-example.png */ @@ -215,7 +227,7 @@ \title C++ Extensions: Image Provider Example \example declarative/cppextensions/imageprovider - This examples shows how to use QDeclarativeImageProvider to serve images + \brief This examples shows how to use QDeclarativeImageProvider to serve images to QML image elements. \image qml-imageprovider-example.png @@ -225,7 +237,7 @@ \title C++ Extensions: Network Access Manager Factory Example \example declarative/cppextensions/networkaccessmanagerfactory - This example shows how to use QDeclarativeNetworkAccessManagerFactory to create a QNetworkAccessManager + \brief This example shows how to use QDeclarativeNetworkAccessManagerFactory to create a QNetworkAccessManager with a proxy. */ @@ -234,7 +246,7 @@ \example declarative/i18n \ingroup internationalization - This example shows how to enable text translation in QML. + \brief This example shows how to enable text translation in QML. \image qml-i18n-example.png @@ -316,7 +328,7 @@ \title Positioners Example \example declarative/positioners - This example shows how to use the positioner elements such as \l Row, \l Column, + \brief This example shows how to use positioner elements such as \l Row, \l Column, \l Grid and \l Flow. \image qml-positioners-example.png @@ -326,7 +338,7 @@ \title Key Interaction: Focus Example \example declarative/keyinteraction/focus - This example shows how to handle keyboard input and focus in QML. + \brief This example shows how to handle keyboard input and focus in QML. \image qml-focus-example.png */ @@ -335,7 +347,7 @@ \title Models and Views: AbstractItemModel Example \example declarative/modelviews/abstractitemmodel - This example shows how to use a QAbstractItemModel subclass as a model in QML. + \brief This example shows how to use a QAbstractItemModel subclass as a model in QML. \image qml-abstractitemmodel-example.png */ @@ -344,7 +356,7 @@ \title Models and Views: GridView Example \example declarative/modelviews/gridview - This example shows how to use the GridView element. + \brief This example shows how to use the GridView element. \image qml-gridview-example.png */ @@ -353,7 +365,9 @@ \title Models and Views: ListView Example \example declarative/modelviews/listview - These examples show how to use the ListView element. + \brief This example shows how items can be dynamically added to + and removed from a ListModel, and how these list + modifications can be animated. \table \row @@ -362,6 +376,13 @@ \o dynamiclist.qml \endtable +/*! + \title Models and Views: Expanding Delegate ListView Example + \example declarative/modelviews/listview/expandingdelegates + + \brief This example shows how to create a dynamic delegate, which + expands when selected. + \table \row \o \image qml-listview-expandingdelegates-example.png @@ -369,6 +390,13 @@ \o expandingdelegates.qml \endtable +/*! + \title Models and Views: Highlight ListView Example + \example declarative/modelviews/listview/highlight + + \brief This example shows how to highlight one item + inside a ListView element. + \table \row \o \image qml-listview-highlight-example.png @@ -376,6 +404,13 @@ \o highlight.qml \endtable +/*! + \title Models and Views: Highlight Ranges ListView Example + \example declarative/modelviews/listview/highlightranges + + \brief This example shows how to highlight ranges within a + ListView element. + \table \row \o \image qml-listview-highlightranges-example.png @@ -383,6 +418,12 @@ \o highlightranges.qml \endtable +/*! + \title Models and Views: Sections ListView Example + \example declarative/modelviews/listview/sections + + \brief This example shows how to use the ListView element. + \table \row \o \image qml-listview-sections-example.png @@ -395,7 +436,7 @@ \title Models and Views: PathView Example \example declarative/modelviews/pathview - This example shows how to use the PathView element. + \brief This example shows how to use the PathView element. \image qml-pathview-example.png */ @@ -404,7 +445,7 @@ \title Models and Views: Object ListModel Example \example declarative/modelviews/objectlistmodel - This example shows how to use a QList<QObject*> as a model in QML. + \brief This example shows how to use a QList<QObject*> as a model in QML. \image qml-objectlistmodel-example.png */ @@ -413,7 +454,7 @@ \title Models and Views: Package Example \example declarative/modelviews/package - This example shows how to use the \l Package element. + \brief This example shows how to use the \l Package element. \image qml-package-example.png */ @@ -422,7 +463,7 @@ \title Models and Views: Parallax Example \example declarative/modelviews/parallax - This example shows how to combine and switch between views. + \brief This example shows how to combine and switch between views. \image qml-parallax-example.png */ @@ -431,7 +472,7 @@ \title Models and Views: String ListModel Example \example declarative/modelviews/stringlistmodel - This example shows how to use a QStringList as a model in QML. + \brief This example shows how to use a QStringList as a model in QML. \image qml-stringlistmodel-example.png */ @@ -440,7 +481,7 @@ \title Models and Views: VisualItemModel Example \example declarative/modelviews/visualitemmodel - This example shows how to use the VisualItemModel element. + \brief This example shows how to use the VisualItemModel element. \image qml-visualitemmodel-example.png */ @@ -449,7 +490,7 @@ \title Models and Views: WebView Example \example declarative/modelviews/webview - These examples show how to use the WebView element. + \brief These examples show how to use the WebView element. \table \row @@ -458,6 +499,12 @@ \o alert.qml \endtable +/*! + \title Models and Views: Autosize WebView Example + \example declarative/modelviews/webview/autosize + + \brief These examples show how to use the WebView element. + \table \row \o \image qml-webview-autosize-example.png @@ -465,6 +512,12 @@ \o autosize.qml \endtable +/*! + \title Models and Views: GoogleMaps WebView Example + \example declarative/modelviews/webview/googlemaps + + \brief These examples show how to use the WebView element. + \table \row \o \image qml-webview-googlemaps-example.png @@ -472,6 +525,12 @@ \o googlemaps.qml \endtable +/*! + \title Models and Views: Inline HTML WebView Example + \example declarative/modelviews/webview/inlinehtml + + \brief These examples show how to use the WebView element. + \table \row \o \image qml-webview-inlinehtml-example.png @@ -479,6 +538,12 @@ \o inlinehtml.qml \endtable +/*! + \title Models and Views: New Windows WebView Example + \example declarative/modelviews/webview/newwindows + + \brief These examples show how to use the WebView element. + \table \row \o \image qml-webview-newwindows-example.png @@ -492,22 +557,21 @@ \title Screen Orientation \example declarative/screenorientation - This example shows how to implement screen orientation support for your application. + \brief This example shows how to implement screen orientation support for your application. */ /*! \title SQL Local Storage Example \example declarative/sqllocalstorage - This example shows how to use the SQL Local Storage API in QML. + \brief This example shows how to use the SQL Local Storage API in QML. */ /*! \title Text: Fonts Example \example declarative/text/fonts - These examples show how to discover available fonts from QML and manipulate - text in various ways. + \brief These examples show how to discover available fonts from QML. \table \row @@ -516,6 +580,12 @@ \o availableFonts.qml \endtable +/*! + \title Text: Banner Fonts Example + \example declarative/text/fonts/banner + + \brief These example shows how to manipulate text in various ways. + \table \row \o \image qml-fonts-banner-example.png @@ -523,6 +593,12 @@ \o banner.qml \endtable +/*! + \title Text: Fonts Example + \example declarative/text/fonts/fonts + + \brief These examples shows how to display a text with multiple fonts. + \table \row \o \image qml-fonts-fonts-example.png @@ -530,6 +606,12 @@ \o fonts.qml \endtable +/*! + \title Text: Hello Fonts Example + \example declarative/text/fonts/hello + + \brief This example shows how to manipulate text in various ways. + \table \row \o \image qml-fonts-hello-example.png @@ -542,7 +624,7 @@ \title Text: Text Selection Example \example declarative/text/textselection - This example shows how text selection, copy and paste operations + \brief This example shows how text selection, copy and paste operations can be implemented on top of the TextEdit element. \image qml-textselection-example.png @@ -552,7 +634,7 @@ \title Threading: Threaded ListModel Example \example declarative/threading/threadedlistmodel - This example shows how to use a ListModel from multiple threads using + \brief This example shows how to use a ListModel from multiple threads using WorkerScript. */ @@ -560,15 +642,16 @@ \title Threading: WorkerScript Example \example declarative/threading/workerscript - This example shows how to use the WorkerScript element for threading in QML. + \brief This example shows how to use the WorkerScript element for threading in QML. */ /*! \title Toys: Clocks Example \example declarative/toys/clocks - This example displays a set of clocks with different times for different cities. - Each clock is created by combining \l Image elements with \l Rotation transforms + \brief This example displays a set of clocks with different times for different cities. + + Each clock is created by combining \l Image elements with \l Rotation transforms and \l SpringAnimation behaviors. \image qml-clocks-example.png @@ -578,7 +661,7 @@ \title Toys: Corkboards Example \example declarative/toys/corkboards - This example presents a flickable set of interactive corkboards. It is created + \brief This example presents a flickable set of interactive corkboards. It is created through a combination of elements like \l ListModel, \l Repeater and \l TextEdit together with rotation and scaling transforms, animation and mouse interaction. @@ -589,7 +672,7 @@ \title Toys: Dynamic Scene Example \example declarative/toys/dynamicscene - This example presents an interactive drag-and-drop scene. It demonstrates + \brief This example presents an interactive drag-and-drop scene. It demonstrates how to use QML's \l{Dynamic Object Creation} support to dynamically create and destroy objects. @@ -600,7 +683,7 @@ \title Toys: Tic-Tac-Toe Example \example declarative/toys/tic-tac-toe - This example presents a simple implementation of Tic Tac Toe. + \brief This example presents a simple implementation of Tic Tac Toe. \image qml-tic-tac-toe-example.png */ @@ -609,17 +692,24 @@ \title Toys: TV Tennis Example \example declarative/toys/tvtennis - This example shows how to use animation components such as \l SpringAnimation, + \brief This example shows how to use animation components such as \l SpringAnimation, \l SequentialAnimation and \l PropertyAction to create a game of TV tennis. \image qml-tvtennis-example.png */ /*! + \title Touch Interaction: Gestures Example + \example declarative/touchinteraction/gestures + + \brief This example shows how to use the GestureArea element. +*/ + +/*! \title Touch Interaction: MouseArea Example \example declarative/touchinteraction/mousearea - This example shows how to use the MouseArea element to access information + \brief This example shows how to use the MouseArea element to access information about mouse input. \image qml-mousearea-example.png @@ -629,7 +719,7 @@ \title UI Components: Dial Control Example \example declarative/ui-components/dialcontrol - This example shows how to create a dial-type control. It combines + \brief This example shows how to create a dial-type control. It combines \l Image elements with \l Rotation transforms and \l SpringAnimation behaviors to produce an interactive speedometer-type dial. @@ -641,7 +731,7 @@ \title UI Components: Flipable Example \example declarative/ui-components/flipable - This example shows how to use the \l Flipable element. + \brief This example shows how to use the \l Flipable element. \image qml-flipable-example.png */ @@ -650,7 +740,7 @@ \title UI Components: Progress Bars Example \example declarative/ui-components/progressbar - This example shows how to create a progress bar. + \brief This example shows how to create a progress bar. \image qml-progressbar-example.png */ @@ -659,7 +749,7 @@ \title UI Components: Scroll Bar Example \example declarative/ui-components/scrollbar - This example shows how to create scroll bars for a \l Flickable element + \brief This example shows how to create scroll bars for a \l Flickable element using the \l {Flickable::visibleArea.xPosition}{Flickable::visibleArea} properties. @@ -670,7 +760,7 @@ \title UI Components: Search Box Example \example declarative/ui-components/searchbox - This example shows how to combine TextInput, FocusScope and BorderImage + \brief This example shows how to combine TextInput, FocusScope and BorderImage elements to display multiple text input fields. \image qml-searchbox-example.png @@ -680,7 +770,7 @@ \title UI Components: Slide Switch Example \example declarative/ui-components/slideswitch - This example shows how to create a slide switch control. + \brief This example shows how to create a slide switch control. \image qml-slideswitch-example.png */ @@ -689,7 +779,7 @@ \title UI Components: Spinner Example \example declarative/ui-components/spinner - This example shows how to create a spinner-type component using the PathView element. + \brief This example shows how to create a spinner-type component using the PathView element. \image qml-spinner-example.png */ @@ -698,7 +788,7 @@ \title UI Components: Tab Widget Example \example declarative/ui-components/tabwidget - This example shows how to create a tab widget. It also demonstrates how + \brief This example shows how to create a tab widget. It also demonstrates how \l {Property aliases}{property aliases} and \l {Introduction to the QML Language#Default Properties}{default properties} can be used to collect and assemble the child items declared within an \l Item. @@ -710,7 +800,7 @@ \title XML: XMLHttpRequest Example \example declarative/xml/xmlhttprequest - This example shows how to use the \l XmlHttpRequest API in QML. + \brief This example shows how to use the \l XmlHttpRequest API in QML. \image qml-xmlhttprequest-example.png */ diff --git a/doc/src/examples/qml-extending.qdoc b/doc/src/examples/qml-extending.qdoc index 8dbbe7f..da7ab47 100644 --- a/doc/src/examples/qml-extending.qdoc +++ b/doc/src/examples/qml-extending.qdoc @@ -29,7 +29,8 @@ \example declarative/cppextensions/referenceexamples/adding \title Extending QML - Adding Types Example -The Adding Types Example shows how to add a new element type, \c Person, to QML. +\brief The Adding Types Example shows how to add a new element type, \c Person, to QML. + The \c Person type can be used from QML like this: \snippet examples/declarative/cppextensions/referenceexamples/adding/example.qml 0 diff --git a/doc/src/examples/qml-flickr.qdoc b/doc/src/examples/qml-flickr.qdoc index c23c0ba..65e8e0d 100644 --- a/doc/src/examples/qml-flickr.qdoc +++ b/doc/src/examples/qml-flickr.qdoc @@ -29,7 +29,7 @@ \title Flickr Mobile \example demos/declarative/flickr - This demo shows how to write a mobile Flickr browser application in QML. + \brief The Qt Quick Flickr Mobile demo shows how to write a mobile Flickr browser application in QML. \image qml-flickr-demo.png */ diff --git a/doc/src/examples/qml-folderlistmodel.qdoc b/doc/src/examples/qml-folderlistmodel.qdoc index ed92c9d..609be27 100644 --- a/doc/src/examples/qml-folderlistmodel.qdoc +++ b/doc/src/examples/qml-folderlistmodel.qdoc @@ -30,7 +30,9 @@ \title FolderListModel - a C++ model plugin \example src/imports/folderlistmodel -This plugin shows how to make a C++ model available to QML. It presents +\brief The FolderListModel plugin example shows how to make a C++ model available to QML. + +It presents a simple file list for a single folder (directory) and allows the presented folder to be changed. diff --git a/doc/src/examples/qml-minehunt.qdoc b/doc/src/examples/qml-minehunt.qdoc index ac13456..66c7dd3 100644 --- a/doc/src/examples/qml-minehunt.qdoc +++ b/doc/src/examples/qml-minehunt.qdoc @@ -29,7 +29,7 @@ \title Minehunt \example demos/declarative/minehunt - This demo shows how to create a simple Minehunt game, using QML for the + \brief The Qt Quick Minehunt demo shows how to create a simple Minehunt game, using QML for the UI and C++ for the game logic. \image qml-minehunt-demo.png diff --git a/doc/src/examples/qml-photoviewer.qdoc b/doc/src/examples/qml-photoviewer.qdoc index 5ecbf84..40b6372 100644 --- a/doc/src/examples/qml-photoviewer.qdoc +++ b/doc/src/examples/qml-photoviewer.qdoc @@ -29,7 +29,7 @@ \title Photo Viewer \example demos/declarative/photoviewer - This demo shows how to write a Flickr photo viewer application in QML. + \brief The Qt Quick Photo Viewer demo shows how to write a Flickr photo viewer application in QML. \image qml-photoviewer-demo.png */ diff --git a/doc/src/examples/qml-rssnews.qdoc b/doc/src/examples/qml-rssnews.qdoc index beea4d3..76df4e3 100644 --- a/doc/src/examples/qml-rssnews.qdoc +++ b/doc/src/examples/qml-rssnews.qdoc @@ -29,7 +29,7 @@ \title RSS News \example demos/declarative/rssnews - This demo shows how to write a RSS news reader in QML. + \brief The Qt Quick RSS News demo shows how to write a RSS news reader in QML. \image qml-rssnews-demo.png */ diff --git a/doc/src/examples/qml-samegame.qdoc b/doc/src/examples/qml-samegame.qdoc index 81a26a3..8b67a49 100644 --- a/doc/src/examples/qml-samegame.qdoc +++ b/doc/src/examples/qml-samegame.qdoc @@ -29,7 +29,7 @@ \title Same Game \example demos/declarative/samegame - This demo shows how to write a 'Same Game' game in QML, using Javascript + \brief The Qt Quick Same Game demo shows how to write a 'Same Game' game in QML, using Javascript for all the game logic. \image qml-samegame-demo.png diff --git a/doc/src/examples/qml-snake.qdoc b/doc/src/examples/qml-snake.qdoc index bce0e71..8a27711 100644 --- a/doc/src/examples/qml-snake.qdoc +++ b/doc/src/examples/qml-snake.qdoc @@ -29,7 +29,7 @@ \title Snake \example demos/declarative/snake - This demo shows how to write a Snake game in QML, controlled by the + \brief The Qt Quick Snake demo shows how to write a Snake game in QML, controlled by the keyboard as well as the mouse. \image qml-snake-demo.png diff --git a/doc/src/examples/qml-twitter.qdoc b/doc/src/examples/qml-twitter.qdoc index 3ebabb4..3334370 100644 --- a/doc/src/examples/qml-twitter.qdoc +++ b/doc/src/examples/qml-twitter.qdoc @@ -29,7 +29,7 @@ \title Twitter Mobile \example demos/declarative/twitter - This demo shows how to write a mobile Twitter search client in QML. Use it to + \brief The Qt Quick Twitter Mobile demo shows how to write a mobile Twitter search client in QML. Use it to see what people think about Qt Quick! \image qml-twitter-demo.png diff --git a/doc/src/examples/qml-webbrowser.qdoc b/doc/src/examples/qml-webbrowser.qdoc index 08416af..bdead7f 100644 --- a/doc/src/examples/qml-webbrowser.qdoc +++ b/doc/src/examples/qml-webbrowser.qdoc @@ -26,10 +26,10 @@ ****************************************************************************/ /*! - \title QML Web Browser + \title Qt Quick Web Browser \example demos/declarative/webbrowser - This demo shows how to write a simple web browser in QML by combining the + \brief The Qt Quick Web Browser demo shows how to write a simple web browser in QML by combining the WebView element with other components including scroll bars, \l Flickable views and TextInput fields. diff --git a/doc/src/examples/qobjectxmlmodel.qdoc b/doc/src/examples/qobjectxmlmodel.qdoc index a950f72..6f66e70 100644 --- a/doc/src/examples/qobjectxmlmodel.qdoc +++ b/doc/src/examples/qobjectxmlmodel.qdoc @@ -29,7 +29,7 @@ \example xmlpatterns/qobjectxmlmodel \title QObject XML Model Example - This example shows how to use QtXmlPatterns to query QObject trees + \brief The XML Model example shows how to use QtXmlPatterns to query QObject trees by modeling the non-XML data structure of a QObject tree to look like XML. diff --git a/doc/src/examples/qtconcurrent-imagescaling.qdoc b/doc/src/examples/qtconcurrent-imagescaling.qdoc index 1b3c6d6..15f2dab 100644 --- a/doc/src/examples/qtconcurrent-imagescaling.qdoc +++ b/doc/src/examples/qtconcurrent-imagescaling.qdoc @@ -29,6 +29,6 @@ \example qtconcurrent/imagescaling \title QtConcurrent Image Scaling Example - The QtConcurrent Map example shows how to use the asynchronous + \brief The QtConcurrent Image Scaling example shows how to use the asynchronous QtConcurrent API to load and scale a collection of images. */ diff --git a/doc/src/examples/qtconcurrent-map.qdoc b/doc/src/examples/qtconcurrent-map.qdoc index 76a6f13..6b22966 100644 --- a/doc/src/examples/qtconcurrent-map.qdoc +++ b/doc/src/examples/qtconcurrent-map.qdoc @@ -29,6 +29,6 @@ \example qtconcurrent/map \title QtConcurrent Map Example - The QtConcurrent Map example shows how to use the synchronous (blocking) + \brief The QtConcurrent Map example shows how to use the synchronous (blocking) QtConcurrent API to scale a collection of images. */ diff --git a/doc/src/examples/qtconcurrent-progressdialog.qdoc b/doc/src/examples/qtconcurrent-progressdialog.qdoc index 43e5fef..7f18b0f 100644 --- a/doc/src/examples/qtconcurrent-progressdialog.qdoc +++ b/doc/src/examples/qtconcurrent-progressdialog.qdoc @@ -29,7 +29,7 @@ \example qtconcurrent/progressdialog \title QtConcurrent Progress Dialog Example - The QtConcurrent Progress Dialog example shows how to use the + \brief The QtConcurrent Progress Dialog example shows how to use the QFutureWatcher class to monitor the progress of a long-running operation. \image qtconcurrent-progressdialog.png diff --git a/doc/src/examples/qtconcurrent-runfunction.qdoc b/doc/src/examples/qtconcurrent-runfunction.qdoc index c66ac11..7e73508 100644 --- a/doc/src/examples/qtconcurrent-runfunction.qdoc +++ b/doc/src/examples/qtconcurrent-runfunction.qdoc @@ -29,7 +29,7 @@ \example qtconcurrent/runfunction \title QtConcurrent Run Function Example - The QtConcurrent Run Function example shows how to apply concurrency to + \brief The QtConcurrent Run Function example shows how to apply concurrency to a standard function, using QFuture instances to retrieve return values at a later time. */ diff --git a/doc/src/examples/qtconcurrent-wordcount.qdoc b/doc/src/examples/qtconcurrent-wordcount.qdoc index 26e65be..5f87884 100644 --- a/doc/src/examples/qtconcurrent-wordcount.qdoc +++ b/doc/src/examples/qtconcurrent-wordcount.qdoc @@ -29,7 +29,7 @@ \example qtconcurrent/wordcount \title QtConcurrent Word Count Example - The QtConcurrent Word Count example demonstrates the use of the map-reduce + \brief The QtConcurrent Word Count example demonstrates the use of the map-reduce algorithm when applied to the problem of counting words in a collection of files. */ diff --git a/doc/src/examples/qtscriptcalculator.qdoc b/doc/src/examples/qtscriptcalculator.qdoc index ce925f3..109394d 100644 --- a/doc/src/examples/qtscriptcalculator.qdoc +++ b/doc/src/examples/qtscriptcalculator.qdoc @@ -29,7 +29,7 @@ \example script/calculator \title QtScript Calculator Example - In this simple QtScript example, we show how to implement the + \brief In the QtScript Calculator example, we show how to implement the functionality of a calculator widget. \image qtscript-calculator-example.png diff --git a/doc/src/examples/qtscriptcustomclass.qdoc b/doc/src/examples/qtscriptcustomclass.qdoc index b3d4535..21624a0 100644 --- a/doc/src/examples/qtscriptcustomclass.qdoc +++ b/doc/src/examples/qtscriptcustomclass.qdoc @@ -29,7 +29,7 @@ \example script/customclass \title Custom Script Class Example - The Custom Script Class example shows how to use QScriptClass and QScriptClassPropertyIterator + \brief The Custom Script Class example shows how to use QScriptClass and QScriptClassPropertyIterator to implement a custom script class. The script class we are going to implement is called \c{ByteArray}. It provides a wrapper around diff --git a/doc/src/examples/qtscripttetrix.qdoc b/doc/src/examples/qtscripttetrix.qdoc index 92a50bf..fe9632e 100644 --- a/doc/src/examples/qtscripttetrix.qdoc +++ b/doc/src/examples/qtscripttetrix.qdoc @@ -29,7 +29,7 @@ \example script/qstetrix \title Qt Script Tetrix Example - The QSTetrix example is a Qt Script version of the classic Tetrix game. + \brief The QSTetrix example is a Qt Script version of the classic Tetrix game. \image tetrix-example.png diff --git a/doc/src/examples/querymodel.qdoc b/doc/src/examples/querymodel.qdoc index 554ae21..9c523e7 100644 --- a/doc/src/examples/querymodel.qdoc +++ b/doc/src/examples/querymodel.qdoc @@ -29,7 +29,7 @@ \example sql/querymodel \title Query Model Example - The Query Model example shows how to make customized versions of + \brief The Query Model example shows how to make customized versions of data obtained from a SQL query, using a model that encapsulates the query and table views to display the results. diff --git a/doc/src/examples/queuedcustomtype.qdoc b/doc/src/examples/queuedcustomtype.qdoc index 85f6b07..4b1db01 100644 --- a/doc/src/examples/queuedcustomtype.qdoc +++ b/doc/src/examples/queuedcustomtype.qdoc @@ -29,7 +29,7 @@ \example threads/queuedcustomtype \title Queued Custom Type Example - The Queued Custom Type example shows how to send custom types between + \brief The Queued Custom Type example shows how to send custom types between threads with queued signals and slots. \image queuedcustomtype-example.png diff --git a/doc/src/examples/qxmlstreambookmarks.qdoc b/doc/src/examples/qxmlstreambookmarks.qdoc index ecb8fce..6d2a6f1 100644 --- a/doc/src/examples/qxmlstreambookmarks.qdoc +++ b/doc/src/examples/qxmlstreambookmarks.qdoc @@ -29,7 +29,7 @@ \example xml/streambookmarks \title QXmlStream Bookmarks Example - The QXmlStream Bookmarks example provides a reader for XML Bookmark + \brief The QXmlStream Bookmarks example provides a reader for XML Bookmark Exchange Language (XBEL) files using Qt's QXmlStreamReader class for reading, and QXmlStreamWriter class for writing the files. diff --git a/doc/src/examples/recentfiles.qdoc b/doc/src/examples/recentfiles.qdoc index 048df01..03c79c6 100644 --- a/doc/src/examples/recentfiles.qdoc +++ b/doc/src/examples/recentfiles.qdoc @@ -29,7 +29,7 @@ \example mainwindows/recentfiles \title Recent Files Example - The Recent Files example shows how a standard File menu can be extended to show + \brief The Recent Files example shows how a standard File menu can be extended to show the most recent files loaded by a main window application. \image recentfiles-example.png diff --git a/doc/src/examples/recipes.qdoc b/doc/src/examples/recipes.qdoc index d4128aa..c93e4dbe 100644 --- a/doc/src/examples/recipes.qdoc +++ b/doc/src/examples/recipes.qdoc @@ -29,7 +29,7 @@ \example xmlpatterns/recipes \title Recipes Example - The Recipes example shows how to use QtXmlPatterns to query XML data + \brief The Recipes example shows how to use QtXmlPatterns to query XML data loaded from a file. \tableofcontents diff --git a/doc/src/examples/regexp.qdoc b/doc/src/examples/regexp.qdoc index 7b97156..4fc07d6 100644 --- a/doc/src/examples/regexp.qdoc +++ b/doc/src/examples/regexp.qdoc @@ -29,7 +29,7 @@ \example tools/regexp \title Regular Expressions Example - The Regular Expressions (RegExp) example shows how regular expressions in Qt are + \brief The Regular Expressions (RegExp) example shows how regular expressions in Qt are applied to text by providing an environment in which new regular expressions can be created and tested on custom text strings. diff --git a/doc/src/examples/relationaltablemodel.qdoc b/doc/src/examples/relationaltablemodel.qdoc index f23c69c..1c2c473 100644 --- a/doc/src/examples/relationaltablemodel.qdoc +++ b/doc/src/examples/relationaltablemodel.qdoc @@ -29,7 +29,7 @@ \example sql/relationaltablemodel \title Relational Table Model Example - The Relational Table Model example shows how to use table views with a relational + \brief The Relational Table Model example shows how to use table views with a relational model to visualize the relations between items in a database. \image relationaltablemodel-example.png diff --git a/doc/src/examples/remotecontrol.qdoc b/doc/src/examples/remotecontrol.qdoc index c92c5e4..e1e60b0 100644 --- a/doc/src/examples/remotecontrol.qdoc +++ b/doc/src/examples/remotecontrol.qdoc @@ -29,6 +29,6 @@ \example help/remotecontrol \title Remote Control Example - This example shows how to use and control Qt Assistant + \brief The Remote Control example shows how to use and control Qt Assistant as a help viewer. -*/
\ No newline at end of file +*/ diff --git a/doc/src/examples/rogue.qdoc b/doc/src/examples/rogue.qdoc index e93886b..b872008 100644 --- a/doc/src/examples/rogue.qdoc +++ b/doc/src/examples/rogue.qdoc @@ -29,7 +29,7 @@ \example statemachine/rogue \title Rogue Example - The Rogue example shows how to use the Qt state machine for event + \brief The Rogue example shows how to use the Qt state machine for event handling. \image rogue-example.png diff --git a/doc/src/examples/rsslisting.qdoc b/doc/src/examples/rsslisting.qdoc index 9554842..7ad464f 100644 --- a/doc/src/examples/rsslisting.qdoc +++ b/doc/src/examples/rsslisting.qdoc @@ -29,7 +29,7 @@ \example xml/rsslisting \title RSS-Listing Example - The RSS-Listing example shows how to create a widget that displays news items + \brief The RSS-Listing example shows how to create a widget that displays news items from RDF news sources. \image rsslistingexample.png diff --git a/doc/src/examples/samplebuffers.qdoc b/doc/src/examples/samplebuffers.qdoc index c9d6438..422f96b 100644 --- a/doc/src/examples/samplebuffers.qdoc +++ b/doc/src/examples/samplebuffers.qdoc @@ -29,7 +29,7 @@ \example opengl/samplebuffers \title Sample Buffers Example - The Sample Buffers example demonstrates how to use and enable + \brief The Sample Buffers example demonstrates how to use and enable sample buffers in a QGLWidget. \image samplebuffers-example.png diff --git a/doc/src/examples/saxbookmarks.qdoc b/doc/src/examples/saxbookmarks.qdoc index e912372..089f2de 100644 --- a/doc/src/examples/saxbookmarks.qdoc +++ b/doc/src/examples/saxbookmarks.qdoc @@ -29,8 +29,10 @@ \example xml/saxbookmarks \title SAX Bookmarks Example - The SAX Bookmarks example provides a reader for XML Bookmark Exchange Language (XBEL) - files that uses Qt's SAX-based API to read and parse the files. The DOM Bookmarks + \brief The SAX Bookmarks example provides a reader for XML Bookmark Exchange Language (XBEL) + files that uses Qt's SAX-based API to read and parse the files. + + The DOM Bookmarks example provides an alternative way to read this type of file. \image saxbookmarks-example.png diff --git a/doc/src/examples/schema.qdoc b/doc/src/examples/schema.qdoc index 77ccaf5..0ba794b 100644 --- a/doc/src/examples/schema.qdoc +++ b/doc/src/examples/schema.qdoc @@ -29,7 +29,7 @@ \example xmlpatterns/schema \title XML Schema Validation Example - The XML Schema Validation example shows how to use QtXmlPatterns to + \brief The XML Schema Validation example shows how to use QtXmlPatterns to validate XML with a W3C XML Schema. \tableofcontents diff --git a/doc/src/examples/screenshot.qdoc b/doc/src/examples/screenshot.qdoc index bc87fdb..1d8505f 100644 --- a/doc/src/examples/screenshot.qdoc +++ b/doc/src/examples/screenshot.qdoc @@ -29,7 +29,7 @@ \example desktop/screenshot \title Screenshot Example - The Screenshot example shows how to take a screenshot of the + \brief The Screenshot example shows how to take a screenshot of the desktop using QApplication and QDesktopWidget. It also shows how to use QTimer to provide a single-shot timer, and how to reimplement the QWidget::resizeEvent() event handler to make sure diff --git a/doc/src/examples/scribble.qdoc b/doc/src/examples/scribble.qdoc index da9b0b6..56b678c 100644 --- a/doc/src/examples/scribble.qdoc +++ b/doc/src/examples/scribble.qdoc @@ -29,7 +29,7 @@ \example widgets/scribble \title Scribble Example - The Scribble example shows how to reimplement some of QWidget's + \brief The Scribble example shows how to reimplement some of QWidget's event handlers to receive the events generated for the application's widgets. diff --git a/doc/src/examples/script-marshal.qdoc b/doc/src/examples/script-marshal.qdoc index 90ff69b..852f9be 100644 --- a/doc/src/examples/script-marshal.qdoc +++ b/doc/src/examples/script-marshal.qdoc @@ -29,6 +29,6 @@ \example script/marshal \title Qt Script Marshalling Example - The Qt Script Marshalling example demonstrates the marshalling of value + \brief The Qt Script Marshalling example demonstrates the marshalling of value types between C++ and Qt Script. */ diff --git a/doc/src/examples/script-qscript.qdoc b/doc/src/examples/script-qscript.qdoc index 6c50c3f..d0c2841 100644 --- a/doc/src/examples/script-qscript.qdoc +++ b/doc/src/examples/script-qscript.qdoc @@ -29,6 +29,6 @@ \example script/qscript \title Qt Script Interpreter Example - The Qt Script Interpreter example shows how to create an interactive + \brief The Qt Script Interpreter example shows how to create an interactive interpreter for Qt Script. */ diff --git a/doc/src/examples/script-qsdbg.qdoc b/doc/src/examples/script-qsdbg.qdoc index 59ab10e..7e4f05c 100644 --- a/doc/src/examples/script-qsdbg.qdoc +++ b/doc/src/examples/script-qsdbg.qdoc @@ -29,6 +29,6 @@ \example script/qsdbg \title Qt Script Debugger Example - The Qt Script Debugger example shows how to enable the Qt Script debugger + \brief The Qt Script Debugger example shows how to enable the Qt Script debugger for command line debugging. */ diff --git a/doc/src/examples/sdi.qdoc b/doc/src/examples/sdi.qdoc index 5e3eb79..e975879 100644 --- a/doc/src/examples/sdi.qdoc +++ b/doc/src/examples/sdi.qdoc @@ -29,7 +29,7 @@ \example mainwindows/sdi \title SDI Example - The SDI example shows how to create a Single Document Interface. It uses a number of + \brief The SDI example shows how to create a Single Document Interface. It uses a number of top-level windows to display the contents of different text files. \image sdi-example.png diff --git a/doc/src/examples/securesocketclient.qdoc b/doc/src/examples/securesocketclient.qdoc index 30ba16a..655465c 100644 --- a/doc/src/examples/securesocketclient.qdoc +++ b/doc/src/examples/securesocketclient.qdoc @@ -29,7 +29,7 @@ \example network/securesocketclient \title Secure Socket Client Example - The Secure Socket Client example shows how to use QSslSocket to + \brief The Secure Socket Client example shows how to use QSslSocket to communicate over an encrypted (SSL) connection. It also demonstrates how to deal with authenticity problems, and how to display security and certificate information. diff --git a/doc/src/examples/semaphores.qdoc b/doc/src/examples/semaphores.qdoc index aeced47..3bbf028 100644 --- a/doc/src/examples/semaphores.qdoc +++ b/doc/src/examples/semaphores.qdoc @@ -29,7 +29,7 @@ \example threads/semaphores \title Semaphores Example - The Semaphores example shows how to use QSemaphore to control + \brief The Semaphores example shows how to use QSemaphore to control access to a circular buffer shared by a producer thread and a consumer thread. diff --git a/doc/src/examples/settingseditor.qdoc b/doc/src/examples/settingseditor.qdoc index a0fcc17..fc581fd 100644 --- a/doc/src/examples/settingseditor.qdoc +++ b/doc/src/examples/settingseditor.qdoc @@ -29,7 +29,7 @@ \example tools/settingseditor \title Settings Editor Example - The Settings Editor example shows how Qt's standard settings support is used in an + \brief The Settings Editor example shows how Qt's standard settings support is used in an application by providing an editor that enables the user to view the settings for installed applications, and modify those that can be edited. diff --git a/doc/src/examples/shapedclock.qdoc b/doc/src/examples/shapedclock.qdoc index e66b3ef..c46c5a7 100644 --- a/doc/src/examples/shapedclock.qdoc +++ b/doc/src/examples/shapedclock.qdoc @@ -29,7 +29,7 @@ \example widgets/shapedclock \title Shaped Clock Example - The Shaped Clock example shows how to apply a widget mask to a top-level + \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 diff --git a/doc/src/examples/sharedmemory.qdoc b/doc/src/examples/sharedmemory.qdoc index 2f4088b..c67d3f5 100644 --- a/doc/src/examples/sharedmemory.qdoc +++ b/doc/src/examples/sharedmemory.qdoc @@ -29,9 +29,10 @@ \example ipc/sharedmemory \title Shared Memory Example - The Shared Memory example shows how to use the QSharedMemory class - to implement inter-process communication using shared memory. To - build the example, run make. To run the example, start two instances + \brief The Shared Memory example shows how to use the QSharedMemory class + to implement inter-process communication using shared memory. + + To build the example, run make. To run the example, start two instances of the executable. The main() function creates an \l {QApplication} {application} and an instance of our example's Dialog class. The dialog is displayed and then control is passed to the application in diff --git a/doc/src/examples/simpledecoration.qdoc b/doc/src/examples/simpledecoration.qdoc index 3c02009..7b033a6 100644 --- a/doc/src/examples/simpledecoration.qdoc +++ b/doc/src/examples/simpledecoration.qdoc @@ -30,7 +30,7 @@ \title Simple Decoration Example \ingroup qt-embedded - The Simple Decoration example shows how to create a custom window decoration + \brief The Simple Decoration example shows how to create a custom window decoration for embedded applications. \image embedded-simpledecoration-example.png diff --git a/doc/src/examples/simpledommodel.qdoc b/doc/src/examples/simpledommodel.qdoc index b7fae91..2f7dd41 100644 --- a/doc/src/examples/simpledommodel.qdoc +++ b/doc/src/examples/simpledommodel.qdoc @@ -29,7 +29,7 @@ \example itemviews/simpledommodel \title Simple DOM Model Example - The Simple DOM Model example shows how an existing class can be adapted for use with + \brief The Simple DOM Model example shows how an existing class can be adapted for use with the model/view framework. \image simpledommodel-example.png diff --git a/doc/src/examples/simpleselector.qdoc b/doc/src/examples/simpleselector.qdoc index 4455c2b..28f9707 100644 --- a/doc/src/examples/simpleselector.qdoc +++ b/doc/src/examples/simpleselector.qdoc @@ -29,7 +29,7 @@ \example webkit/simpleselector \title Simple Selector Example - The Simple Selector example shows how to use QWebElement to access the + \brief The Simple Selector example shows how to use QWebElement to access the Document Object Model (DOM) in a Web page. \image webkit-simpleselector.png diff --git a/doc/src/examples/simpletextviewer.qdoc b/doc/src/examples/simpletextviewer.qdoc index bf44938..6bb1420 100644 --- a/doc/src/examples/simpletextviewer.qdoc +++ b/doc/src/examples/simpletextviewer.qdoc @@ -29,7 +29,7 @@ \example help/simpletextviewer \title Simple Text Viewer Example - The Simple Text Viewer example shows how to use \QA as a customized + \brief The Simple Text Viewer example shows how to use \QA as a customized help viewer for your application. This is done in two stages. Firstly, documentation is created and \QA diff --git a/doc/src/examples/simpletreemodel.qdoc b/doc/src/examples/simpletreemodel.qdoc index 00464b2..7989893 100644 --- a/doc/src/examples/simpletreemodel.qdoc +++ b/doc/src/examples/simpletreemodel.qdoc @@ -29,9 +29,10 @@ \example itemviews/simpletreemodel \title Simple Tree Model Example - The Simple Tree Model example shows how to create a basic, read-only - hierarchical model to use with Qt's standard view classes. For a - description of simple non-hierarchical list and table models, see the + \brief The Simple Tree Model example shows how to create a basic, read-only + hierarchical model to use with Qt's standard view classes. + + For a description of simple non-hierarchical list and table models, see the \l{Model/View Programming} overview. \image simpletreemodel-example.png diff --git a/doc/src/examples/simplewebplugin.qdoc b/doc/src/examples/simplewebplugin.qdoc index 4c95b58..185cc85 100644 --- a/doc/src/examples/simplewebplugin.qdoc +++ b/doc/src/examples/simplewebplugin.qdoc @@ -29,7 +29,7 @@ \example webkit/simplewebplugin \title Simple Web Plugin Example - The Simple Web Plugin example shows how to embed a regular Qt widget into a + \brief The Simple Web Plugin example shows how to embed a regular Qt widget into a Web page displayed using QWebView. \image webkit-simplewebplugin.png A table widget embedded in a Web page. diff --git a/doc/src/examples/simplewidgetmapper.qdoc b/doc/src/examples/simplewidgetmapper.qdoc index 60837fc..705da4b 100644 --- a/doc/src/examples/simplewidgetmapper.qdoc +++ b/doc/src/examples/simplewidgetmapper.qdoc @@ -29,7 +29,7 @@ \example itemviews/simplewidgetmapper \title Simple Widget Mapper Example - The Simple Widget Mapper example shows how to use a widget mapper to display + \brief The Simple Widget Mapper example shows how to use a widget mapper to display data from a model in a collection of widgets. \image simplewidgetmapper-example.png diff --git a/doc/src/examples/sipdialog.qdoc b/doc/src/examples/sipdialog.qdoc index 349ab18..ce78a9e 100644 --- a/doc/src/examples/sipdialog.qdoc +++ b/doc/src/examples/sipdialog.qdoc @@ -30,7 +30,7 @@ \title SIP Dialog Example \ingroup qtce - The SIP Dialog example shows how to create a dialog that is aware of + \brief The SIP Dialog example shows how to create a dialog that is aware of the Windows Mobile SIP (Software Input Panel) and reacts to it. \table diff --git a/doc/src/examples/sliders.qdoc b/doc/src/examples/sliders.qdoc index 7e47dcc..fc8af36 100644 --- a/doc/src/examples/sliders.qdoc +++ b/doc/src/examples/sliders.qdoc @@ -29,7 +29,7 @@ \example widgets/sliders \title Sliders Example - Qt provides three types of slider-like widgets: QSlider, + \brief Qt provides three types of slider-like widgets: QSlider, QScrollBar and QDial. They all inherit most of their functionality from QAbstractSlider, and can in theory replace each other in an application since the differences only concern diff --git a/doc/src/examples/spinboxdelegate.qdoc b/doc/src/examples/spinboxdelegate.qdoc index 50d5b9c..62f3ced 100644 --- a/doc/src/examples/spinboxdelegate.qdoc +++ b/doc/src/examples/spinboxdelegate.qdoc @@ -29,7 +29,7 @@ \example itemviews/spinboxdelegate \title Spin Box Delegate Example - The Spin Box Delegate example shows how to create an editor for a custom delegate in + \brief The Spin Box Delegate example shows how to create an editor for a custom delegate in the model/view framework by reusing a standard Qt editor widget. The model/view framework provides a standard delegate that is used by default diff --git a/doc/src/examples/spinboxes.qdoc b/doc/src/examples/spinboxes.qdoc index e87faf1..575d99d 100644 --- a/doc/src/examples/spinboxes.qdoc +++ b/doc/src/examples/spinboxes.qdoc @@ -29,7 +29,7 @@ \example widgets/spinboxes \title Spin Boxes Example - The Spin Boxes example shows how to use the many different types of spin boxes + \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. diff --git a/doc/src/examples/sqlwidgetmapper.qdoc b/doc/src/examples/sqlwidgetmapper.qdoc index cf1a158..453c811 100644 --- a/doc/src/examples/sqlwidgetmapper.qdoc +++ b/doc/src/examples/sqlwidgetmapper.qdoc @@ -29,7 +29,7 @@ \example sql/sqlwidgetmapper \title SQL Widget Mapper Example - The SQL Widget Mapper example shows how to use a map information from a + \brief The SQL Widget Mapper example shows how to use a map information from a database to widgets on a form. \image sql-widget-mapper.png diff --git a/doc/src/examples/standarddialogs.qdoc b/doc/src/examples/standarddialogs.qdoc index 92005b4..d187715 100644 --- a/doc/src/examples/standarddialogs.qdoc +++ b/doc/src/examples/standarddialogs.qdoc @@ -29,7 +29,7 @@ \example dialogs/standarddialogs \title Standard Dialogs Example - The Standard Dialogs example shows the standard dialogs that are provided by Qt. + \brief The Standard Dialogs example shows the standard dialogs that are provided by Qt. \image standarddialogs-example.png */ diff --git a/doc/src/examples/stardelegate.qdoc b/doc/src/examples/stardelegate.qdoc index ed3ae7e..b94935e 100644 --- a/doc/src/examples/stardelegate.qdoc +++ b/doc/src/examples/stardelegate.qdoc @@ -29,7 +29,7 @@ \example itemviews/stardelegate \title Star Delegate Example - The Star Delegate example shows how to create a delegate that + \brief The Star Delegate example shows how to create a delegate that can paint itself and that supports editing. \image stardelegate.png The Star Delegate Example diff --git a/doc/src/examples/states.qdoc b/doc/src/examples/states.qdoc index 815c969..284b4ec 100644 --- a/doc/src/examples/states.qdoc +++ b/doc/src/examples/states.qdoc @@ -29,7 +29,7 @@ \example animation/states \title States Example - The States example shows how to use the Qt state machine to play + \brief The States example shows how to use the Qt state machine to play animations. \image states-example.png diff --git a/doc/src/examples/stickman.qdoc b/doc/src/examples/stickman.qdoc index 8c35fe1..d980586 100644 --- a/doc/src/examples/stickman.qdoc +++ b/doc/src/examples/stickman.qdoc @@ -29,7 +29,7 @@ \example animation/stickman \title Stickman Example - The Stickman example shows how to animate transitions in a state machine to implement key frame + \brief The Stickman example shows how to animate transitions in a state machine to implement key frame animations. \image stickman-example.png diff --git a/doc/src/examples/styleplugin.qdoc b/doc/src/examples/styleplugin.qdoc index 59729c7..a38b8d7 100644 --- a/doc/src/examples/styleplugin.qdoc +++ b/doc/src/examples/styleplugin.qdoc @@ -29,7 +29,7 @@ \example tools/styleplugin \title Style Plugin Example - This example shows how to create a plugin that extends Qt with a new + \brief The Style Plugin example shows how to create a plugin that extends Qt with a new GUI look and feel. \image stylepluginexample.png diff --git a/doc/src/examples/styles.qdoc b/doc/src/examples/styles.qdoc index 5258c19..f9ac48c 100644 --- a/doc/src/examples/styles.qdoc +++ b/doc/src/examples/styles.qdoc @@ -29,7 +29,7 @@ \example widgets/styles \title Styles Example - The Styles example illustrates how to create custom widget + \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 diff --git a/doc/src/examples/stylesheet.qdoc b/doc/src/examples/stylesheet.qdoc index a82d0d1..edb684b 100644 --- a/doc/src/examples/stylesheet.qdoc +++ b/doc/src/examples/stylesheet.qdoc @@ -29,7 +29,7 @@ \example widgets/stylesheet \title Style Sheet Example - The Style Sheet Example shows how to use style sheets. + \brief The Style Sheet Example shows how to use style sheets with Qt. \image stylesheet-pagefold.png Screen Shot of the Pagefold style sheet */ diff --git a/doc/src/examples/svgalib.qdoc b/doc/src/examples/svgalib.qdoc index dbdad0f..a0320e7 100644 --- a/doc/src/examples/svgalib.qdoc +++ b/doc/src/examples/svgalib.qdoc @@ -29,9 +29,11 @@ \example qws/svgalib \title Accelerated Graphics Driver Example - The Accelerated Graphics Driver example shows how you can write + \brief The Accelerated Graphics Driver example shows how you can write your own accelerated graphics driver and \l {add your graphics - driver to Qt for Embedded Linux}. In \l{Qt for Embedded Linux}, + driver to Qt for Embedded Linux}. + + In \l{Qt for Embedded Linux}, painting is a pure software implementation and is normally performed in two steps: The clients render each window onto a corresponding surface diff --git a/doc/src/examples/svggenerator.qdoc b/doc/src/examples/svggenerator.qdoc index 1fce379..ed5ea77 100644 --- a/doc/src/examples/svggenerator.qdoc +++ b/doc/src/examples/svggenerator.qdoc @@ -29,7 +29,7 @@ \example painting/svggenerator \title SVG Generator Example - The SVG Generator example shows how to add SVG file export to applications. + \brief The SVG Generator example shows how to add SVG file export to applications. \image svggenerator-example.png diff --git a/doc/src/examples/svgviewer.qdoc b/doc/src/examples/svgviewer.qdoc index f393b08..93671b6 100644 --- a/doc/src/examples/svgviewer.qdoc +++ b/doc/src/examples/svgviewer.qdoc @@ -29,7 +29,7 @@ \example painting/svgviewer \title SVG Viewer Example - The SVG Viewer example shows how to add SVG viewing support to applications. + \brief The SVG Viewer example shows how to add SVG viewing support to applications. \image svgviewer-example.png diff --git a/doc/src/examples/symbianvibration.qdoc b/doc/src/examples/symbianvibration.qdoc index 76f79e5..a6a3d52 100644 --- a/doc/src/examples/symbianvibration.qdoc +++ b/doc/src/examples/symbianvibration.qdoc @@ -29,7 +29,7 @@ \group all-examples \title Symbian Vibration Example - The Symbian Vibrator example shows how to get fine-grained vibration + \brief The Symbian Vibrator example shows how to get fine-grained vibration control on Symbian devices. Native Symbian APIs have to be used to enable vibration, since QtMobility diff --git a/doc/src/examples/syntaxhighlighter.qdoc b/doc/src/examples/syntaxhighlighter.qdoc index 919d61c..13409dc 100644 --- a/doc/src/examples/syntaxhighlighter.qdoc +++ b/doc/src/examples/syntaxhighlighter.qdoc @@ -29,7 +29,7 @@ \example richtext/syntaxhighlighter \title Syntax Highlighter Example - The Syntax Highlighter example shows how to perform simple syntax + \brief The Syntax Highlighter example shows how to perform simple syntax highlighting by subclassing the QSyntaxHighlighter class. \image syntaxhighlighter-example.png diff --git a/doc/src/examples/systray.qdoc b/doc/src/examples/systray.qdoc index e072c9d..22f3779 100644 --- a/doc/src/examples/systray.qdoc +++ b/doc/src/examples/systray.qdoc @@ -29,8 +29,7 @@ \example desktop/systray \title System Tray Icon Example - - The System Tray Icon example shows how to add an icon with a menu + \brief The System Tray Icon example shows how to add an icon with a menu and popup messages to a desktop environment's system tray. \image systemtray-example.png Screenshot of the System Tray Icon. diff --git a/doc/src/examples/tabdialog.qdoc b/doc/src/examples/tabdialog.qdoc index b192645..d450783 100644 --- a/doc/src/examples/tabdialog.qdoc +++ b/doc/src/examples/tabdialog.qdoc @@ -29,7 +29,7 @@ \example dialogs/tabdialog \title Tab Dialog Example - The Tab Dialog example shows how to construct a tab dialog using the + \brief The Tab Dialog example shows how to construct a tab dialog using the QTabWidget class. Dialogs provide an efficient way for the application to communicate diff --git a/doc/src/examples/tablemodel.qdoc b/doc/src/examples/tablemodel.qdoc index bd81763..ad2d557 100644 --- a/doc/src/examples/tablemodel.qdoc +++ b/doc/src/examples/tablemodel.qdoc @@ -29,7 +29,7 @@ \example sql/tablemodel \title Table Model Example - The Table Model example shows how to use a specialized SQL table model with table + \brief The Table Model example shows how to use a specialized SQL table model with table views to edit information in a database. \image tablemodel-example.png diff --git a/doc/src/examples/tablet.qdoc b/doc/src/examples/tablet.qdoc index 8639ab6..8c29642 100644 --- a/doc/src/examples/tablet.qdoc +++ b/doc/src/examples/tablet.qdoc @@ -29,7 +29,7 @@ \example widgets/tablet \title Tablet Example - This example shows how to use a Wacom tablet in Qt applications. + \brief The Tablet example shows how to use a Wacom tablet in Qt applications. \image tabletexample.png diff --git a/doc/src/examples/taskmenuextension.qdoc b/doc/src/examples/taskmenuextension.qdoc index a5562eb..2414ae4 100644 --- a/doc/src/examples/taskmenuextension.qdoc +++ b/doc/src/examples/taskmenuextension.qdoc @@ -29,7 +29,7 @@ \example designer/taskmenuextension \title Task Menu Extension Example - The Task Menu Extension example shows how to create a custom + \brief The Task Menu Extension example shows how to create a custom widget plugin for \l {Qt Designer Manual}{\QD}, and how to to use the QDesignerTaskMenuExtension class to provide custom task menu entries associated with the plugin. diff --git a/doc/src/examples/tetrix.qdoc b/doc/src/examples/tetrix.qdoc index e37d2b6..92e9e28 100644 --- a/doc/src/examples/tetrix.qdoc +++ b/doc/src/examples/tetrix.qdoc @@ -29,7 +29,7 @@ \example widgets/tetrix \title Tetrix Example - The Tetrix example is a Qt version of the classic Tetrix game. + \brief The Tetrix example is a Qt version of the classic Tetrix game. \image tetrix-example.png diff --git a/doc/src/examples/textfinder.qdoc b/doc/src/examples/textfinder.qdoc index fc6d2ba..87947ac 100644 --- a/doc/src/examples/textfinder.qdoc +++ b/doc/src/examples/textfinder.qdoc @@ -29,8 +29,10 @@ \example uitools/textfinder \title Text Finder Example - The Text Finder example demonstrates how to dynamically process forms - using the QtUiTools module. Dynamic form processing enables a form to + \brief The Text Finder example demonstrates how to dynamically process forms + using the QtUiTools module. + + Dynamic form processing enables a form to be processed at run-time only by changing the UI file for the project. The program allows the user to look up a particular word within the contents of a text file. This text file is included in the project's diff --git a/doc/src/examples/textobject.qdoc b/doc/src/examples/textobject.qdoc index 30bf417..a108038 100644 --- a/doc/src/examples/textobject.qdoc +++ b/doc/src/examples/textobject.qdoc @@ -29,7 +29,7 @@ \example richtext/textobject \title Text Object Example - The Text Object example shows how to insert an SVG file into a + \brief The Text Object example shows how to insert an SVG file into a QTextDocument. \image textobject-example.png diff --git a/doc/src/examples/textures.qdoc b/doc/src/examples/textures.qdoc index 52bde78..09f6d9a 100644 --- a/doc/src/examples/textures.qdoc +++ b/doc/src/examples/textures.qdoc @@ -29,7 +29,7 @@ \example opengl/textures \title Textures Example - The Textures example demonstrates the use of Qt's image classes as textures in + \brief The Textures example demonstrates the use of Qt's image classes as textures in applications that use both OpenGL and Qt to display graphics. \image textures-example.png diff --git a/doc/src/examples/threadedfortuneserver.qdoc b/doc/src/examples/threadedfortuneserver.qdoc index 87da054..855d735 100644 --- a/doc/src/examples/threadedfortuneserver.qdoc +++ b/doc/src/examples/threadedfortuneserver.qdoc @@ -29,9 +29,11 @@ \example network/threadedfortuneserver \title Threaded Fortune Server Example - The Threaded Fortune Server example shows how to create a server for a + \brief The Threaded Fortune Server example shows how to create a server for a simple network service that uses threads to handle requests from different - clients. It is intended to be run alongside the Fortune Client example. + clients. + + The example is intended to be run alongside the Fortune Client example. \image threadedfortuneserver-example.png diff --git a/doc/src/examples/tooltips.qdoc b/doc/src/examples/tooltips.qdoc index 9786c40..4abdf99 100644 --- a/doc/src/examples/tooltips.qdoc +++ b/doc/src/examples/tooltips.qdoc @@ -29,7 +29,7 @@ \example widgets/tooltips \title Tool Tips Example - The Tool Tips example shows how to provide static and dynamic tool + \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 diff --git a/doc/src/examples/torrent.qdoc b/doc/src/examples/torrent.qdoc index 86c0b0c..9082441 100644 --- a/doc/src/examples/torrent.qdoc +++ b/doc/src/examples/torrent.qdoc @@ -29,7 +29,7 @@ \example network/torrent \title Torrent Example - The Torrent example is a functional BitTorrent client that + \brief The Torrent example is a functional BitTorrent client that illustrates how to write a complex TCP/IP application using Qt. \image torrent-example.png diff --git a/doc/src/examples/touch-dials.qdoc b/doc/src/examples/touch-dials.qdoc index f80e72e..008a7f2 100644 --- a/doc/src/examples/touch-dials.qdoc +++ b/doc/src/examples/touch-dials.qdoc @@ -29,7 +29,7 @@ \example touch/dials \title Touch Dials Example - The Touch Dials example shows how to apply touch to a set of + \brief The Touch Dials example shows how to apply touch to a set of standard Qt widgets. \image touch-dials-example.png diff --git a/doc/src/examples/touch-knobs.qdoc b/doc/src/examples/touch-knobs.qdoc index 44ff8a8..4abc64c 100644 --- a/doc/src/examples/touch-knobs.qdoc +++ b/doc/src/examples/touch-knobs.qdoc @@ -29,7 +29,7 @@ \example touch/knobs \title Touch Knobs Example - The Touch Knobs example shows how to create custom controls that + \brief The Touch Knobs example shows how to create custom controls that accept touch input. \image touch-knobs-example.png diff --git a/doc/src/examples/trafficinfo.qdoc b/doc/src/examples/trafficinfo.qdoc index dc12f37..b73f5ce 100644 --- a/doc/src/examples/trafficinfo.qdoc +++ b/doc/src/examples/trafficinfo.qdoc @@ -29,7 +29,7 @@ \example xmlpatterns/trafficinfo \title TrafficInfo Example - Shows how XQuery can be used extract information from WML documents provided by a WAP service. + \brief The Traffic Info example shows how XQuery can be used extract information from WML documents provided by a WAP service. \section1 Overview diff --git a/doc/src/examples/trafficlight.qdoc b/doc/src/examples/trafficlight.qdoc index 828195e..cf6bb19 100644 --- a/doc/src/examples/trafficlight.qdoc +++ b/doc/src/examples/trafficlight.qdoc @@ -29,7 +29,7 @@ \example statemachine/trafficlight \title Traffic Light Example - The Traffic Light example shows how to use \l{The State Machine Framework} + \brief The Traffic Light example shows how to use \l{The State Machine Framework} to implement the control flow of a traffic light. \image trafficlight-example.png diff --git a/doc/src/examples/transformations.qdoc b/doc/src/examples/transformations.qdoc index 26b558c..c4888f9 100644 --- a/doc/src/examples/transformations.qdoc +++ b/doc/src/examples/transformations.qdoc @@ -29,7 +29,7 @@ \example painting/transformations \title Transformations Example - The Transformations example shows how transformations influence + \brief The Transformations example shows how transformations influence the way that QPainter renders graphics primitives. In particular it shows how the order of transformations affect the result. diff --git a/doc/src/examples/treemodelcompleter.qdoc b/doc/src/examples/treemodelcompleter.qdoc index 4caba0d..94c363e 100644 --- a/doc/src/examples/treemodelcompleter.qdoc +++ b/doc/src/examples/treemodelcompleter.qdoc @@ -29,7 +29,7 @@ \example tools/treemodelcompleter \title Tree Model Completer Example - The Tree Model Completer example shows how to provide completion + \brief The Tree Model Completer example shows how to provide completion facilities for a hierarchical model, using a period as the separator to access Child, GrandChild and GrandGrandChild level objects. diff --git a/doc/src/examples/trivialwizard.qdoc b/doc/src/examples/trivialwizard.qdoc index e654a78..df8378f 100644 --- a/doc/src/examples/trivialwizard.qdoc +++ b/doc/src/examples/trivialwizard.qdoc @@ -29,7 +29,7 @@ \example dialogs/trivialwizard \title Trivial Wizard Example - The Trivial Wizard example illustrates how to create a linear three-page + \brief The Trivial Wizard example illustrates how to create a linear three-page registration wizard using three instances of QWizardPage and one instance of QWizard. diff --git a/doc/src/examples/trollprint.qdoc b/doc/src/examples/trollprint.qdoc index de6cc60..faa6405 100644 --- a/doc/src/examples/trollprint.qdoc +++ b/doc/src/examples/trollprint.qdoc @@ -29,7 +29,7 @@ \example linguist/trollprint \title Troll Print Example - Troll Print is an example application that lets the user choose + \brief Troll Print is an example application that lets the user choose printer settings. It comes in two versions: English and Portuguese. diff --git a/doc/src/examples/twowaybutton.qdoc b/doc/src/examples/twowaybutton.qdoc index b42615e..8e3f5a6 100644 --- a/doc/src/examples/twowaybutton.qdoc +++ b/doc/src/examples/twowaybutton.qdoc @@ -29,7 +29,7 @@ \example statemachine/twowaybutton \title Two-way Button Example - The Two-way button example shows how to use \l{The State Machine + \brief The Two-way button example shows how to use \l{The State Machine Framework} to implement a simple state machine that toggles the current state when a button is clicked. diff --git a/doc/src/examples/undoframework.qdoc b/doc/src/examples/undoframework.qdoc index 15372ec..2fdb4cf 100644 --- a/doc/src/examples/undoframework.qdoc +++ b/doc/src/examples/undoframework.qdoc @@ -29,7 +29,7 @@ \example tools/undoframework \title Undo Framework Example - This example shows how to implement undo/redo functionality + \brief The Undo Framework example shows how to implement undo/redo functionality with the Qt undo framework. \image undoframeworkexample.png The Undo Diagram Example diff --git a/doc/src/examples/videographicsitem.qdoc b/doc/src/examples/videographicsitem.qdoc index f52e043..76f54cb 100644 --- a/doc/src/examples/videographicsitem.qdoc +++ b/doc/src/examples/videographicsitem.qdoc @@ -29,7 +29,7 @@ \example multimedia/videographicsitem \title Video Graphics Item Example - The Video Graphics Item example shows how to implement a QGraphicsItem that displays video on a + \brief The Video Graphics Item example shows how to implement a QGraphicsItem that displays video on a graphics scene using QtMultimedia's QAbstractVideoSurface. \image video-videographicsitem.png diff --git a/doc/src/examples/videowidget.qdoc b/doc/src/examples/videowidget.qdoc index c9a87ce..d2dab10 100644 --- a/doc/src/examples/videowidget.qdoc +++ b/doc/src/examples/videowidget.qdoc @@ -29,7 +29,7 @@ \example multimedia/videowidget \title Video Widget Example - The Video Widget example shows how to implement a video widget using + \brief The Video Widget example shows how to implement a video widget using QtMultimedia's QAbstractVideoSurface \image video-videowidget.png diff --git a/doc/src/examples/waitconditions.qdoc b/doc/src/examples/waitconditions.qdoc index 0d0cd1b..f2f07c5 100644 --- a/doc/src/examples/waitconditions.qdoc +++ b/doc/src/examples/waitconditions.qdoc @@ -29,7 +29,7 @@ \example threads/waitconditions \title Wait Conditions Example - The Wait Conditions example shows how to use QWaitCondition and + \brief The Wait Conditions example shows how to use QWaitCondition and QMutex to control access to a circular buffer shared by a producer thread and a consumer thread. diff --git a/doc/src/examples/webftpclient.qdoc b/doc/src/examples/webftpclient.qdoc index c3d456d..47006f9 100644 --- a/doc/src/examples/webftpclient.qdoc +++ b/doc/src/examples/webftpclient.qdoc @@ -29,7 +29,7 @@ \example webkit/webftpclient \title Web FTP Client Example - The Web FTP Client example shows how to add support for a new protocol + \brief The Web FTP Client example shows how to add support for a new protocol to QtWebKit-based applications. \image webkit-webftpclient.png An FTP client displaying the contents of the ftp.qt.nokia.com site. diff --git a/doc/src/examples/webkit-bridge-imageanalyzer.qdoc b/doc/src/examples/webkit-bridge-imageanalyzer.qdoc index a736879..7383abc 100644 --- a/doc/src/examples/webkit-bridge-imageanalyzer.qdoc +++ b/doc/src/examples/webkit-bridge-imageanalyzer.qdoc @@ -30,12 +30,13 @@ \startpage {index.html}{Qt Reference Documentation} \title The Webkit Bridge Tutorial - Hybrid Client Application - In this example, we will show how to write a hybrid application using + \brief In this example, we will show how to write a hybrid application using \l{The QtWebKit Bridge}{QtWebKit Bridge}, which distinguishes itself from a thin client in that it performs heavy calculations on the client side in C++, like a native application, but presents nothing more than a \c QWebView for its -user interface, displaying web content written in HTML/JavaScript. The -application uses QtConcurrent to distribute its work across as many CPU cores as +user interface, displaying web content written in HTML/JavaScript. + +The application uses QtConcurrent to distribute its work across as many CPU cores as are available from the system, so it can process each image in parallel. For the full reference documentation of QtWebKit hybrid development, see diff --git a/doc/src/examples/webkit-framecapture.qdoc b/doc/src/examples/webkit-framecapture.qdoc index 2d80c6a..1f9fa9f 100644 --- a/doc/src/examples/webkit-framecapture.qdoc +++ b/doc/src/examples/webkit-framecapture.qdoc @@ -29,7 +29,7 @@ \example webkit/framecapture \title WebKit Frame Capture Example - The Frame Capture example shows how to use the WebKit browser engine to + \brief The Frame Capture example shows how to use the WebKit browser engine to obtain images of frames in a Web page. This example is designed to be run from the command line. Run the diff --git a/doc/src/examples/webplugin.qdoc b/doc/src/examples/webplugin.qdoc index dcf4fb5..c607bef 100644 --- a/doc/src/examples/webplugin.qdoc +++ b/doc/src/examples/webplugin.qdoc @@ -29,7 +29,7 @@ \example webkit/webplugin \title Web Plugin Example - The Web Plugin example shows how to communicate between a Qt widget + \brief The Web Plugin example shows how to communicate between a Qt widget embedded in a Web page and the page itself. \image webkit-webplugin.png A table widget embedded in a Web page. diff --git a/doc/src/examples/widgets-softkeys.qdoc b/doc/src/examples/widgets-softkeys.qdoc index 336aac8..1c66718 100644 --- a/doc/src/examples/widgets-softkeys.qdoc +++ b/doc/src/examples/widgets-softkeys.qdoc @@ -29,5 +29,5 @@ \example widgets/softkeys \title Soft Keys Example - The Soft Keys example shows how to use soft key input on the Symbian platform. + \brief The Soft Keys example shows how to use soft key input on the Symbian platform. */ diff --git a/doc/src/examples/widgets-validators.qdoc b/doc/src/examples/widgets-validators.qdoc index d6c229d..1984d9f 100644 --- a/doc/src/examples/widgets-validators.qdoc +++ b/doc/src/examples/widgets-validators.qdoc @@ -29,5 +29,5 @@ \example widgets/validators \title Validators Example - The Validators example shows the signal emission behavior of input validators. + \brief The Validators example shows the signal emission behavior of input validators. */ diff --git a/doc/src/examples/wiggly.qdoc b/doc/src/examples/wiggly.qdoc index 3685741..2bb3d64 100644 --- a/doc/src/examples/wiggly.qdoc +++ b/doc/src/examples/wiggly.qdoc @@ -29,7 +29,7 @@ \example widgets/wiggly \title Wiggly Example - The Wiggly example shows how to animate a widget using + \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. diff --git a/doc/src/examples/windowflags.qdoc b/doc/src/examples/windowflags.qdoc index e690c37..d701498 100644 --- a/doc/src/examples/windowflags.qdoc +++ b/doc/src/examples/windowflags.qdoc @@ -29,7 +29,7 @@ \example widgets/windowflags \title Window Flags Example - The Window Flags example shows how to use the window flags + \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 diff --git a/doc/src/examples/worldtimeclockbuilder.qdoc b/doc/src/examples/worldtimeclockbuilder.qdoc index e8999ea..cf6d062 100644 --- a/doc/src/examples/worldtimeclockbuilder.qdoc +++ b/doc/src/examples/worldtimeclockbuilder.qdoc @@ -29,7 +29,7 @@ \example designer/worldtimeclockbuilder \title World Time Clock Builder Example - The World Time Clock Builder example shows how forms created with Qt + \brief The World Time Clock Builder example shows how forms created with Qt Designer that contain custom widgets can be dynamically generated at run-time. diff --git a/doc/src/examples/worldtimeclockplugin.qdoc b/doc/src/examples/worldtimeclockplugin.qdoc index 7b88708..ee1d534 100644 --- a/doc/src/examples/worldtimeclockplugin.qdoc +++ b/doc/src/examples/worldtimeclockplugin.qdoc @@ -29,7 +29,7 @@ \example designer/worldtimeclockplugin \title World Time Clock Plugin Example - The World Time Clock Plugin example shows how to create a custom + \brief The World Time Clock Plugin example shows how to create a custom widget plugin for \QD that uses signals and slots. \image worldtimeclockplugin-example.png diff --git a/doc/src/examples/xmlstreamlint.qdoc b/doc/src/examples/xmlstreamlint.qdoc index 98bee62..0a31fb0 100644 --- a/doc/src/examples/xmlstreamlint.qdoc +++ b/doc/src/examples/xmlstreamlint.qdoc @@ -29,7 +29,7 @@ \example xml/xmlstreamlint \title XML Stream Lint Example - The XML Stream Lint example provides a simple command line utility that + \brief The XML Stream Lint example provides a simple command line utility that accepts a file name as its single argument and writes it to the standard output file. diff --git a/doc/src/platforms/platform-notes-rtos.qdoc b/doc/src/platforms/platform-notes-rtos.qdoc index 0b1265b..dd72016 100644 --- a/doc/src/platforms/platform-notes-rtos.qdoc +++ b/doc/src/platforms/platform-notes-rtos.qdoc @@ -313,7 +313,7 @@ ARM INTEGRITY target: \code - ./configure --hostprefix=$PWD -embedded integrity -xplatform unsupported/qws/integrity-arm-cxarm -static -qt-kbd-integrity -qt-mouse-integrity -no-mouse-linuxtp -no-mouse-pc -no-kbd-tty -qt-gfx-integrityfb -no-qt3support -no-gfx-linuxfb -no-glib -no-openssl -no-largefile -little-endian -arch integrity -prefix / -opensource -no-feature-QWS_MULTIPROCESS -no-feature-SHAREDMEMORY -no-feature-PROCESS -no-feature-SYSTEMSEMAPHORE -no-feature-PRINTER -no-feature-QWS_QPF2 -no-scripttools + ./configure --hostprefix=$PWD -embedded integrity -xplatform unsupported/qws/integrity-arm-cxarm -static -qt-kbd-integrity -qt-mouse-integrity -no-mouse-linuxtp -no-mouse-pc -no-kbd-tty -qt-gfx-integrityfb -no-qt3support -no-gfx-linuxfb -no-glib -no-openssl -no-largefile -little-endian -arch integrity -prefix / -opensource -no-feature-QWS_MULTIPROCESS -no-feature-SHAREDMEMORY -no-feature-PROCESS -no-feature-SYSTEMSEMAPHORE -no-feature-PRINTER -no-feature-QWS_QPF2 -no-libtiff -no-exceptions -no-scripttools \endcode \list @@ -326,6 +326,7 @@ \o \c{-no-qt3support} - required since the Qt3 support classes are not supported on INTEGRITY \o \c{-no-exceptions} - reduces the size of the library by disabling exception support \o \c{-no-openssl} - disable support for OpenSSL + \o \c(-no-libtiff} - disable support for libTIFF \o \c{-no-glib} - disable support for unavailable Glib \o \c{-no-largefile} - disable support for large (> 2TB) files \o \c{-no-scripttools} - disable support for QtScript tools @@ -346,7 +347,13 @@ of INTEGRITY_DIR and INTEGRITY_BSP in unsupported/qws/integrity-arm-cxarm/qmake.conf. If you do not do this, you will have to modify the resulting generated projects.gpj - \o GIF support is currently not enabled. + \o Compilation of native preprocessing tools (moc, rcc, uic) is not automatic. From + a Linux shell or a MingWin shell, you can run the following command to compile these tools : + \code + cd src/tools/bootstrap && make && cd ../rcc && make && cd ../moc && make && cd ../uic && make && cd ../../.. + \endcode + + \o GIF and TIFF support are currently not enabled. \o Default .int files are generated. You may want to modify the amount of heap assigned to each example by modifying the HeapSize declaration in the specific example .int file. diff --git a/doc/src/snippets/code/src_corelib_io_qsettings.cpp b/doc/src/snippets/code/src_corelib_io_qsettings.cpp index 5abb0e3..269aa44 100644 --- a/doc/src/snippets/code/src_corelib_io_qsettings.cpp +++ b/doc/src/snippets/code/src_corelib_io_qsettings.cpp @@ -314,3 +314,24 @@ int main(int argc, char *argv[]) ... } //! [29] + +//! [30] +QSettings settings(QApplication::applicationDirPath() + "/MySoft.conf"); +//! [30] + +//! [31] +#include <QSettings> +#include <QDesktopServices> +int main(int argc, char *argv[]) +{ +#ifdef Q_OS_SYMBIAN + // Use QDesktopServices:storageLocation as QApplication is not yet created + QSettings::setPath( + QSettings::NativeFormat, QSettings::UserScope, + QDesktopServices::storageLocation(QDesktopServices::DataLocation) + "/settings"); +#endif + QApplication app(argc, argv); + + ... +} +//! [31] diff --git a/doc/src/sql-programming/sql-driver.qdoc b/doc/src/sql-programming/sql-driver.qdoc index 40c7c6a..ed60e7f 100644 --- a/doc/src/sql-programming/sql-driver.qdoc +++ b/doc/src/sql-programming/sql-driver.qdoc @@ -60,6 +60,7 @@ \row \o \link #QPSQL QPSQL\endlink \o PostgreSQL (versions 7.3 and above) \row \o \link #QSQLITE2 QSQLITE2\endlink \o SQLite version 2 \row \o \link #QSQLITE QSQLITE\endlink \o SQLite version 3 + \row \o \link #QSYMSQL QSYMSQL\endlink \o SQLite version 3 for Symbian SQL Database \row \o \link #QTDS QTDS\endlink \o Sybase Adaptive Server \note obsolete from Qt 4.7 \endtable @@ -665,6 +666,106 @@ ship your own database plugin with your own SQLite library as illustrated above. Some versions of SQLite can be forced to write a specific file format by setting the \c{SQLITE_DEFAULT_FILE_FORMAT} define when building SQLite. + + \target QSYMSQL + \section2 QSYMSQL for SQLite (Version 3 and Above) with Symbian SQL Database + + \section3 General Information about QSYMSQL + + QSYMSQL driver enables clients to access the native Symbian database engine (“Symbian SQL”) + through the QtSQL API. + + The main difference to QSQLITE is that, with Symbian SQL database client can specify a + set of access control policies when creating a new database. It uses Symbian SQL security policy + definitions within open() call (security policy is defined with in the connection options parameters). + + Symbian RSqlSecurityPolicy class is a container for the security policies for a shared SQL database. + + The container can contain: + security policies that apply to the database. + security policies that apply to individual database objects, i.e. database tables. + + For the database, you use RSqlSecurityPolicy::SetDbPolicy() to apply a separate security policy to: + the database schema. + read activity on the database. + write activity on the database. + + For database tables, you use RSqlSecurityPolicy::SetPolicy() to apply a separate security policy to: + write activity on each named database table. + read activity on each named database table. + + More information about Symbian SQL and RSqlSecurityPolicy class reference about policy definitions, + can be found from Forum Nokia Library: http://library.developer.nokia.com/. + + +Example of setting Security Policy: + + Connection options hold definition for security policies and all parameters that does not contain "POLICY_" will be + passed to RSqlDatabase. Policy will be filled according to parsed values. + + Value in database wide parameters starts by definition which can be vendorId or secureId. These come directly from TSecurityPolicy class in Symbian. + + POLICY_DB_DEFAULT + Default security policy which will be used for the database and all database objects. POLICY_DB_DEFAULT must be + defined before any other policy definitions can be used. + POLICY_DB_READ + Read database security policy. An application with read database security policy can read from database. + POLICY_DB_WRITE: + Write database security policy. An application with write database security policy can write to database. + POLICY_DB_SCHEMA: + Schema database security policy. An application with schema database security policy can modify + the database schema, write to database, read from database. + + Format: + POLICY_DB_DEFAULT=cap1,cap2,cap3,cap4,cap5,cap6,cap7 (Up to 7 capabilities) + POLICY_DB_READ=cap1,cap2,cap3,cap4,cap5,cap6,cap7 (Up to 7 capabilities) + POLICY_DB_WRITE=vendorid,cap1,cap2,cap3 (Vendor ID and up to 3 capabilities) + POLICY_DB_SCHEMA=secureid,cap1,cap2,cap3 (Secure ID and up to 3 capabilities) + + Table policies does not support schema policy as database level does. + + Table specific parameters would be as: + POLICY_TABLE_WRITE=tablename,cap1,cap2,cap3,cap4,cap5,cap6,cap7 + POLICY_TABLE_READ=tablename,cap1,cap2,cap3,cap4,cap5,cap6,cap7 + + Vendor Id and Secure id format: + vid[0x12345678] (Hex) + sid[0x12345678] (Hex) + + Examples: + Setting default policy: + QSqlDatabase database = QSqlDatabase::addDatabase("QSYMSQL", "MyConnection"); + database.setConnectOptions("POLICY_DB_DEFAULT=ReadDeviceData"); + database.setDatabaseName("[12345678]myDatabase"); + bool ok = database.open(); + + Setting POLICY_DB_WRITE: + QSqlDatabase database = QSqlDatabase::addDatabase("QSYMSQL", "MyConnection"); + database.setConnectOptions("POLICY_DB_DEFAULT=None; POLICY_DB_WRITE=sid[0x12345678], WriteDeviceData"); + database.setDatabaseName("[12345678]myDatabase"); + bool ok = database.open(); + + FOREIGN KEY: + Enabling foreign key support from underlying SQLite + add: "foreign_keys = ON" to your connection options string. This will be passes to SQLite. + + Foreign key Example: + QSqlDatabase database = QSqlDatabase::addDatabase("QSYMSQL", "MyConnection"); + database.setDatabaseName("[12345678]myDatabase"); + database.setConnectOptions("foreign_keys = ON"); + bool ok = database.open(); + + \section3 How to Build the QSYMSQL Plugin + + Building QSYMSQL requires Symbian SDK. + + The build sequence is similar to the QSQLITE plugin with installing the plugin in the standard location. + + Build sequence: + + >cd sf\mw\qt\src\plugins\sqldrivers\symsql\ + >qmake + >sbs -c winscw_udeb|armv5_urel \target QIBASE \section2 QIBASE for Borland InterBase |