From: Casper van Donderen Date: Fri, 1 Jul 2011 12:59:19 +0000 (+0200) Subject: Update the documentation after moving examples. X-Git-Tag: qt-v5.0.0-alpha1~4068 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=1631be8176d51ae67cdf1627c3fdf459e2e0937b;p=profile%2Fivi%2Fqtbase.git Update the documentation after moving examples. Change-Id: I7aa52785979df9eddd7b91e62abd0ef10adc74b7 Reviewed-on: http://codereview.qt.nokia.com/1031 Reviewed-by: Qt Sanity Bot Reviewed-by: David Boddie --- diff --git a/doc/src/demos/interview.qdoc b/doc/src/examples/interview.qdoc similarity index 90% rename from doc/src/demos/interview.qdoc rename to doc/src/examples/interview.qdoc index fa40ed2..0be40fd 100644 --- a/doc/src/demos/interview.qdoc +++ b/doc/src/examples/interview.qdoc @@ -26,10 +26,10 @@ ****************************************************************************/ /*! - \example demos/interview + \example itemviews/interview \title Interview - The Interview demonstration explores the flexibility and scalability of the + The Interview example 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/macmainwindow.qdoc b/doc/src/examples/macmainwindow.qdoc similarity index 84% rename from doc/src/demos/macmainwindow.qdoc rename to doc/src/examples/macmainwindow.qdoc index 31c0230..d245398 100644 --- a/doc/src/demos/macmainwindow.qdoc +++ b/doc/src/examples/macmainwindow.qdoc @@ -26,17 +26,17 @@ ****************************************************************************/ /*! - \example demos/macmainwindow - \title Mac Main Window Demo + \example mainwindows/macmainwindow + \title Mac Main Window Example - This demo shows how to create a main window that has the + This example 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. \image macmainwindow.png - See \c{$QTDIR/demos/macmainwindow} for the source code. + See \c{$QTDIR/examples/mainwindows/macmainwindow} for the source code. */ diff --git a/doc/src/demos/mainwindow.qdoc b/doc/src/examples/mainwindow.qdoc similarity index 90% rename from doc/src/demos/mainwindow.qdoc rename to doc/src/examples/mainwindow.qdoc index dee7202..ef9d128 100644 --- a/doc/src/demos/mainwindow.qdoc +++ b/doc/src/examples/mainwindow.qdoc @@ -26,10 +26,10 @@ ****************************************************************************/ /*! - \example demos/mainwindow + \example mainwindows/mainwindow \title Main Window - The Main Window demonstration shows Qt's extensive support for tool bars, + The Main Window example 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/pathstroke.qdoc b/doc/src/examples/pathstroke.qdoc similarity index 92% rename from doc/src/demos/pathstroke.qdoc rename to doc/src/examples/pathstroke.qdoc index 8e864e2..b433a42 100644 --- a/doc/src/demos/pathstroke.qdoc +++ b/doc/src/examples/pathstroke.qdoc @@ -26,10 +26,10 @@ ****************************************************************************/ /*! - \example demos/pathstroke + \example painting/pathstroke \title Path Stroking - In this demo we show some of the various types of pens that can be + In this example we show some of the various types of pens that can be used in Qt. \image pathstroke-demo.png diff --git a/doc/src/demos/spreadsheet.qdoc b/doc/src/examples/spreadsheet.qdoc similarity index 90% rename from doc/src/demos/spreadsheet.qdoc rename to doc/src/examples/spreadsheet.qdoc index 5c6b4df..8bcecc9 100644 --- a/doc/src/demos/spreadsheet.qdoc +++ b/doc/src/examples/spreadsheet.qdoc @@ -26,10 +26,10 @@ ****************************************************************************/ /*! - \example demos/spreadsheet + \example itemviews/spreadsheet \title Spreadsheet - The Spreadsheet demonstration shows how a table view can be used to create a + The Spreadsheet example 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/examples/sqlbrowser.qdoc similarity index 89% rename from doc/src/demos/sqlbrowser.qdoc rename to doc/src/examples/sqlbrowser.qdoc index 53af037..f7ec795 100644 --- a/doc/src/demos/sqlbrowser.qdoc +++ b/doc/src/examples/sqlbrowser.qdoc @@ -26,10 +26,10 @@ ****************************************************************************/ /*! - \example demos/sqlbrowser + \example sql/sqlbrowser \title SQL Browser - The SQL Browser demonstration shows how a data browser can be used to visualize + The SQL Browser example 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/sub-attaq.qdoc b/doc/src/examples/sub-attaq.qdoc similarity index 90% rename from doc/src/demos/sub-attaq.qdoc rename to doc/src/examples/sub-attaq.qdoc index 247d0d1..0c8e587 100644 --- a/doc/src/demos/sub-attaq.qdoc +++ b/doc/src/examples/sub-attaq.qdoc @@ -26,10 +26,10 @@ ****************************************************************************/ /*! - \example demos/sub-attaq + \example animation/sub-attaq \title Sub-Attaq - This demo shows Qt's ability to combine \l{The Animation Framework}{the animation framework} + This example 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/examples/textedit.qdoc similarity index 89% rename from doc/src/demos/textedit.qdoc rename to doc/src/examples/textedit.qdoc index 8c50dba..1a1171d 100644 --- a/doc/src/demos/textedit.qdoc +++ b/doc/src/examples/textedit.qdoc @@ -26,10 +26,10 @@ ****************************************************************************/ /*! - \example demos/textedit + \example richtext/textedit \title Text Edit - The Text Edit demonstration shows Qt's rich text editing facilities in action, + The Text Edit example 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/examples/undo.qdoc similarity index 94% rename from doc/src/demos/undo.qdoc rename to doc/src/examples/undo.qdoc index 7b64371..29c320a 100644 --- a/doc/src/demos/undo.qdoc +++ b/doc/src/examples/undo.qdoc @@ -26,10 +26,10 @@ ****************************************************************************/ /*! - \example demos/undo + \example tools/undo \title Undo Framework - This demo shows Qt's undo framework in action. + This example shows Qt's undo framework in action. \image undodemo.png diff --git a/src/gui/painting/qpainter.cpp b/src/gui/painting/qpainter.cpp index d5a0dd7..6a4c7db 100644 --- a/src/gui/painting/qpainter.cpp +++ b/src/gui/painting/qpainter.cpp @@ -1123,7 +1123,7 @@ void QPainterPrivate::updateState(QPainterState *newState) shows how to use advanced vector techniques to draw text using a QPainterPath, the \l {painting/gradients}{Gradients} example which shows the different types of gradients that are available in Qt, and the \l - {demos/pathstroke}{Path Stroking} demo which shows Qt's built-in + {painting/pathstroke}{Path Stroking} example which shows Qt's built-in dash patterns and shows how custom patterns can be used to extend the range of available patterns. @@ -1131,7 +1131,7 @@ void QPainterPrivate::updateState(QPainterState *newState) \header \o \l {painting/deform}{Vector Deformation} \o \l {painting/gradients}{Gradients} - \o \l {demos/pathstroke}{Path Stroking} + \o \l {painting/pathstroke}{Path Stroking} \row \o \inlineimage qpainter-vectordeformation.png \o \inlineimage qpainter-gradients.png diff --git a/src/gui/painting/qpen.cpp b/src/gui/painting/qpen.cpp index cc652d8..7185f0d 100644 --- a/src/gui/painting/qpen.cpp +++ b/src/gui/painting/qpen.cpp @@ -214,14 +214,14 @@ typedef QPenPrivate QPenData; \table 100% \row \o \inlineimage qpen-demo.png - \o \bold {\l {demos/pathstroke}{The Path Stroking Demo}} + \o \bold {\l {painting/pathstroke}{The Path Stroking Example}} - The Path Stroking demo shows Qt's built-in dash patterns and shows + The Path Stroking example shows Qt's built-in dash patterns and shows how custom patterns can be used to extend the range of available patterns. \endtable - \sa QPainter, QBrush, {demos/pathstroke}{Path Stroking Demo}, + \sa QPainter, QBrush, {painting/pathstroke}{Path Stroking Example}, {Scribble Example} */ diff --git a/src/gui/widgets/qmaccocoaviewcontainer_mac.mm b/src/gui/widgets/qmaccocoaviewcontainer_mac.mm index 92b8fb7..5bb7a3b 100644 --- a/src/gui/widgets/qmaccocoaviewcontainer_mac.mm +++ b/src/gui/widgets/qmaccocoaviewcontainer_mac.mm @@ -84,7 +84,7 @@ developer to provide the autorelease pool. The following is a snippet of subclassing QMacCocoaViewContainer to wrap a NSSearchField. - \snippet demos/macmainwindow/macmainwindow.mm 0 + \snippet examples/mainwindows/macmainwindow/macmainwindow.mm 0 */ diff --git a/tests/auto/guiapplauncher/demos.txt b/tests/auto/guiapplauncher/demos.txt index 7790897..e69de29 100644 --- a/tests/auto/guiapplauncher/demos.txt +++ b/tests/auto/guiapplauncher/demos.txt @@ -1,7 +0,0 @@ -"Interview Demo", "demos/interview", "interview", 0, -1 -"Mainwindow Demo", "demos/mainwindow", "mainwindow", 0, -1 -"PathStroke Demo", "demos/pathstroke", "pathstroke", 0, -1 -"Spreadsheet Demo", "demos/spreadsheet", "spreadsheet", 0, -1 -"Sub-Attac Demo", "demos/sub-attaq", "sub-attaq", 0, -1 -"TextEdit Demo", "demos/textedit", "textedit", 0, -1 -"Undo Demo", "demos/undo", "undo", 0, -1 diff --git a/tests/auto/guiapplauncher/examples.txt b/tests/auto/guiapplauncher/examples.txt index 08de59f..65993fa 100644 --- a/tests/auto/guiapplauncher/examples.txt +++ b/tests/auto/guiapplauncher/examples.txt @@ -4,6 +4,7 @@ "animation/moveblocks Example", "examples/animation/moveblocks", "moveblocks", 10, -1 "animation/states Example", "examples/animation/states", "states", 10, -1 "animation/stickman Example", "examples/animation/stickman", "stickman", 10, -1 +"animation/sub-attaq Example", "examples/animation/sub-attaq", "sub-attaq", 0, -1 "designer/calculatorbuilder Example", "examples/designer/calculatorbuilder", "calculatorbuilder", 10, -1 "dialogs/standarddialogs Example", "examples/dialogs/standarddialogs", "standarddialogs", 10, -1 "draganddrop/dropsite Example", "examples/draganddrop/dropsite", "dropsite", 10, -1 @@ -36,12 +37,14 @@ "itemviews/editabletreemodel Example", "examples/itemviews/editabletreemodel", "editabletreemodel", 0, -1 "itemviews/fetchmore Example", "examples/itemviews/fetchmore", "fetchmore", 10, -1 "itemviews/frozencolumn Example", "examples/itemviews/frozencolumn", "frozencolumn", 10, -1 +"itemviews/interview Example", "examples/itemviews/interview", "interview", 0, -1 "itemviews/pixelator Example", "examples/itemviews/pixelator", "pixelator", 10, -1 "itemviews/puzzle Example", "examples/itemviews/puzzle", "puzzle", 10, -1 "itemviews/simpledommodel Example", "examples/itemviews/simpledommodel", "simpledommodel", 10, -1 "itemviews/simpletreemodel Example", "examples/itemviews/simpletreemodel", "simpletreemodel", 10, -1 "itemviews/simplewidgetmapper Example", "examples/itemviews/simplewidgetmapper", "simplewidgetmapper", 10, -1 "itemviews/spinboxdelegate Example", "examples/itemviews/spinboxdelegate", "spinboxdelegate", 0, -1 +"itemviews/spreadsheet Example", "examples/itemviews/spreadsheet", "spreadsheet", 0, -1 "itemviews/stardelegate Example", "examples/itemviews/stardelegate", "stardelegate", 10, -1 "layouts/basiclayouts Example", "examples/layouts/basiclayouts", "basiclayouts", 0, -1 "layouts/borderlayout Example", "examples/layouts/borderlayout", "borderlayout", 10, -1 @@ -49,6 +52,7 @@ "layouts/flowlayout Example", "examples/layouts/flowlayout", "flowlayout", 10, -1 "mainwindows/application Example", "examples/mainwindows/application", "application", 6, -1 "mainwindows/dockwidgets Example", "examples/mainwindows/dockwidgets", "dockwidgets", 0, -1 +"mainwindows/mainwindow Example", "examples/mainwindows/mainwindow", "mainwindow", 0, -1 "mainwindows/mdi Example", "examples/mainwindows/mdi", "mdi", 0, -1 "mainwindows/menus Example", "examples/mainwindows/menus", "menus", 10, -1 "mainwindows/recentfiles Example", "examples/mainwindows/recentfiles", "recentfiles", 10, -1 @@ -72,17 +76,20 @@ "painting/gradients Example", "examples/painting/gradients", "gradients", 0, -1 "painting/imagecomposition Example", "examples/painting/imagecomposition", "imagecomposition", 10, -1 "painting/painterpaths Example", "examples/painting/painterpaths", "painterpaths", 10, -1 +"painting/pathstroke Example", "examples/painting/pathstroke", "pathstroke", 0, -1 "painting/transformations Example", "examples/painting/transformations", "transformations", 0, -1 "qtconcurrent/imagescaling Example", "examples/qtconcurrent/imagescaling", "imagescaling", 10, -1 "richtext/calendar Example", "examples/richtext/calendar", "calendar", 0, -1 "richtext/orderform Example", "examples/richtext/orderform", "orderform", 10, -1 "richtext/syntaxhighlighter Example", "examples/richtext/syntaxhighlighter", "syntaxhighlighter", 0, -1 +"richtext/textedit Example", "examples/richtext/textedit", "textedit", 0, -1 "richtext/textobject Example", "examples/richtext/textobject", "textobject", 10, -1 "sql/books Example", "examples/sql/books", "books", 0, -1 "statemachine/eventtransitions Example", "examples/statemachine/eventtransitions", "eventtransitions", 10, -1 "statemachine/rogue Example", "examples/statemachine/rogue", "rogue", 10, -1 "statemachine/trafficlight Example", "examples/statemachine/trafficlight", "trafficlight", 0, -1 "statemachine/twowaybutton Example", "examples/statemachine/twowaybutton", "twowaybutton", 10, -1 +"tools/undo Example", "examples/tools/undo", "undo", 0, -1 "tutorials/addressbook/part7 Example", "examples/tutorials/addressbook/part7", "part7", 0, -1 "widgets/analogclock Example", "examples/widgets/analogclock", "analogclock", 6, -1 "widgets/calculator Example", "examples/widgets/calculator", "calculator", 6, -1