diff options
author | Bea Lam <bea.lam@nokia.com> | 2012-05-28 11:56:24 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-05-31 10:40:41 +0200 |
commit | 4c671c046e8140bfb8372aab2c38aabe82b102b0 (patch) | |
tree | 7a70a75a553dcc806372a6b43ea39da05191db8a /doc/src/examples/example-textballoons.qdoc | |
parent | 0c7669b241aae96fca97acae0b628e627d5bfc4e (diff) |
Fix doc snippets paths and parsing errors
qtqml.qdocconf and qtquick.qdocconf now refer to the correct
snippets and source directories.
Snippet paths in .qdoc and .cpp files have been updated to refer to
the new shortened path references, e.g. \snippet qml/file.cpp instead of
\snippet doc/src/snippets/qml/file.cpp.
This also deletes snippets from src/qml/doc/snippets that belonged under
src/quick/doc/snippets (and were already duplicated there anyway) and
restores some snippet files that shouldn't have been deleted.
Also fixes some inline snippets to use \code .. \endcode instead of
\qml .. \endqml as they contained javascript or partial QML
snippets that were causing parsing errors from qdoc.
There are still snippet errors arising from qmlintro.qdoc as the
qmlintro snippets directory that it refers to cannot be located.
There are also two references to a removed snippet identifier in
examples/qml/cppextensions/plugins/plugin.cpp that need to be fixed
in conjunction with the related docs in a later commit as the relevant
code has changed and the docs are now invalid.
Task-number: QTBUG-25721
Change-Id: I50c665245a74c140470c58a32546591d187dfe4b
Reviewed-by: Chris Adams <christopher.adams@nokia.com>
Diffstat (limited to 'doc/src/examples/example-textballoons.qdoc')
-rw-r--r-- | doc/src/examples/example-textballoons.qdoc | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/src/examples/example-textballoons.qdoc b/doc/src/examples/example-textballoons.qdoc index 299ceeb808..eeb88154b6 100644 --- a/doc/src/examples/example-textballoons.qdoc +++ b/doc/src/examples/example-textballoons.qdoc @@ -56,7 +56,7 @@ is the base class for all QPainter based items in the QML Scene Graph framework. - \snippet examples/declarative/painteditem/textballoons/textballoon.h 0 + \snippet examples/quick/painteditem/textballoons/textballoon.h 0 To implement a QQuickPaintedItem you must implement QQuickPaintedIem's pure virtual function \l {QQuickPaintedItem::}{paint()} which implements the @@ -67,13 +67,13 @@ We have to be sure to initialize the rightAligned property for a TextBalloon item. - \snippet examples/declarative/painteditem/textballoons/textballoon.cpp 0 + \snippet examples/quick/painteditem/textballoons/textballoon.cpp 0 Then we implement the \c paint() function which is automatically called by the Scenegraph framework to paint the contents of the item. The function paints the item in local coordinates. - \snippet examples/declarative/painteditem/textballoons/textballoon.cpp 1 + \snippet examples/quick/painteditem/textballoons/textballoon.cpp 1 We start with setting the pen and brush on the item to define the look of the item. After that we start drawing. Note that the \l {QQuickPaintedItem::}{boundingRect()} @@ -88,7 +88,7 @@ \section2 BalloonView - \snippet examples/declarative/painteditem/textballoons/textballoons.qml 0 + \snippet examples/quick/painteditem/textballoons/textballoons.qml 0 The balloonModel contains two elements at application start which will be displayed by the balloonView. The balloonView alernates the TextBalloon @@ -96,7 +96,7 @@ \section2 Controls - \snippet examples/declarative/painteditem/textballoons/textballoons.qml 1 + \snippet examples/quick/painteditem/textballoons/textballoons.qml 1 The controls part of the UI contains a rectangle with a MouseArea which changes color when the mouse hovers over it. This control 'button' adds |