Fix doc snippets paths and parsing errors
authorBea Lam <bea.lam@nokia.com>
Mon, 28 May 2012 01:56:24 +0000 (11:56 +1000)
committerQt by Nokia <qt-info@nokia.com>
Thu, 31 May 2012 08:40:41 +0000 (10:40 +0200)
commit4c671c046e8140bfb8372aab2c38aabe82b102b0
tree7a70a75a553dcc806372a6b43ea39da05191db8a
parent0c7669b241aae96fca97acae0b628e627d5bfc4e
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>
186 files changed:
doc/src/examples/advtutorial.qdoc
doc/src/examples/dynamicview-tutorial.qdoc
doc/src/examples/example-slideswitch.qdoc
doc/src/examples/example-textballoons.qdoc
examples/tutorials/ui-components/dialcontrol/dialcontrol.qml
src/imports/folderlistmodel/qquickfolderlistmodel.cpp
src/imports/localstorage/plugin.cpp
src/imports/xmllistmodel/qqmlxmllistmodel.cpp
src/qml/doc/qtqml.qdocconf
src/qml/doc/snippets/qml/DynamicText.qml [new file with mode: 0644]
src/qml/doc/snippets/qml/anchorchanges.qml [deleted file]
src/qml/doc/snippets/qml/animatedimage.qml [deleted file]
src/qml/doc/snippets/qml/borderimage/borderimage-scaled.qml [deleted file]
src/qml/doc/snippets/qml/borderimage/borderimage-tiled.qml [deleted file]
src/qml/doc/snippets/qml/borderimage/normal-image.qml [deleted file]
src/qml/doc/snippets/qml/column/column-transitions.qml [deleted file]
src/qml/doc/snippets/qml/column/vertical-positioner.qml [deleted file]
src/qml/doc/snippets/qml/drag.qml [deleted file]
src/qml/doc/snippets/qml/flickableScrollbar.qml [deleted file]
src/qml/doc/snippets/qml/flipable/flipable.qml [deleted file]
src/qml/doc/snippets/qml/flow.qml [deleted file]
src/qml/doc/snippets/qml/gradient.qml [deleted file]
src/qml/doc/snippets/qml/grid/grid.qml [deleted file]
src/qml/doc/snippets/qml/gridview/ContactModel.qml [deleted file]
src/qml/doc/snippets/qml/gridview/gridview.qml [deleted file]
src/qml/doc/snippets/qml/keynavigation.qml [deleted file]
src/qml/doc/snippets/qml/keys/keys-handler.qml [deleted file]
src/qml/doc/snippets/qml/keys/keys-pressed.qml [deleted file]
src/qml/doc/snippets/qml/layoutmirroring.qml [deleted file]
src/qml/doc/snippets/qml/listmodel/listelements.qml [moved from src/qml/doc/snippets/qml/qml-data-models/listelements.qml with 100% similarity]
src/qml/doc/snippets/qml/listmodel/listmodel-modify.qml [moved from src/qml/doc/snippets/qml/listmodel-modify.qml with 100% similarity]
src/qml/doc/snippets/qml/listmodel/listmodel-nested.qml [moved from src/qml/doc/snippets/qml/listmodel-nested.qml with 100% similarity]
src/qml/doc/snippets/qml/listmodel/listmodel-simple.qml [moved from src/qml/doc/snippets/qml/listmodel-simple.qml with 100% similarity]
src/qml/doc/snippets/qml/listmodel/listmodel.qml [moved from src/qml/doc/snippets/qml/listmodel.qml with 100% similarity]
src/qml/doc/snippets/qml/listview/ContactModel.qml [deleted file]
src/qml/doc/snippets/qml/listview/listview.qml [deleted file]
src/qml/doc/snippets/qml/loader/KeyReader.qml [deleted file]
src/qml/doc/snippets/qml/loader/MyItem.qml [deleted file]
src/qml/doc/snippets/qml/loader/connections.qml [deleted file]
src/qml/doc/snippets/qml/loader/focus.qml [deleted file]
src/qml/doc/snippets/qml/loader/simple.qml [deleted file]
src/qml/doc/snippets/qml/loader/sizeitem.qml [deleted file]
src/qml/doc/snippets/qml/loader/sizeloader.qml [deleted file]
src/qml/doc/snippets/qml/mousearea/mousearea.qml [deleted file]
src/qml/doc/snippets/qml/mousearea/mouseareadragfilter.qml [deleted file]
src/qml/doc/snippets/qml/multipointtoucharea/multipointtoucharea.qml [deleted file]
src/qml/doc/snippets/qml/parentanimation.qml [deleted file]
src/qml/doc/snippets/qml/path/arcradius.qml [deleted file]
src/qml/doc/snippets/qml/path/basiccurve.qml [deleted file]
src/qml/doc/snippets/qml/path/largearc.qml [deleted file]
src/qml/doc/snippets/qml/pathinterpolator.qml [deleted file]
src/qml/doc/snippets/qml/pathview/ContactModel.qml [deleted file]
src/qml/doc/snippets/qml/pathview/pathattributes.qml [deleted file]
src/qml/doc/snippets/qml/pathview/pathview.qml [deleted file]
src/qml/doc/snippets/qml/propertyaction-sequential.qml [deleted file]
src/qml/doc/snippets/qml/propertyaction.qml [deleted file]
src/qml/doc/snippets/qml/propertyanimation.qml [deleted file]
src/qml/doc/snippets/qml/propertychanges.qml [deleted file]
src/qml/doc/snippets/qml/qtBinding.1.qml [moved from src/qml/doc/snippets/qml/sequentialanimation.qml with 87% similarity]
src/qml/doc/snippets/qml/qtBinding.2.qml [moved from src/qml/doc/snippets/qml/anchoranimation.qml with 81% similarity]
src/qml/doc/snippets/qml/qtBinding.3.qml [moved from src/qml/doc/snippets/qml/parentchange.qml with 79% similarity]
src/qml/doc/snippets/qml/qtBinding.4.qml [moved from src/qml/doc/snippets/qml/parallelanimation.qml with 87% similarity]
src/qml/doc/snippets/qml/qtbinding/resources/example.qrc [new file with mode: 0644]
src/qml/doc/snippets/qml/qtbinding/resources/resources.pro [new file with mode: 0644]
src/qml/doc/snippets/qml/rectangle/rectangle-colors.qml [deleted file]
src/qml/doc/snippets/qml/rectangle/rectangle-gradient.qml [deleted file]
src/qml/doc/snippets/qml/repeaters/repeater.qml [deleted file]
src/qml/doc/snippets/qml/righttoleft.qml [deleted file]
src/qml/doc/snippets/qml/righttoleft/Child.qml [deleted file]
src/qml/doc/snippets/qml/rotationanimation.qml [deleted file]
src/qml/doc/snippets/qml/row/row.qml [deleted file]
src/qml/doc/snippets/qml/smoothedanimation.qml [deleted file]
src/qml/doc/snippets/qml/springanimation.qml [deleted file]
src/qml/doc/snippets/qml/state-when.qml [deleted file]
src/qml/doc/snippets/qml/state.qml [deleted file]
src/qml/doc/snippets/qml/states/statechangescript.qml [deleted file]
src/qml/doc/snippets/qml/text/onLinkActivated.qml [deleted file]
src/qml/doc/snippets/qml/transition-from-to-modified.qml [deleted file]
src/qml/doc/snippets/qml/transition-from-to.qml [deleted file]
src/qml/doc/snippets/qml/transition-reversible.qml [deleted file]
src/qml/doc/snippets/qml/transition.qml [deleted file]
src/qml/doc/snippets/qml/transitions-list.qml [deleted file]
src/qml/doc/snippets/qml/visualdatagroup.qml [deleted file]
src/qml/doc/snippets/qml/visualdatamodel_rootindex/main.cpp [deleted file]
src/qml/doc/snippets/qml/visualdatamodel_rootindex/view.qml [deleted file]
src/qml/doc/snippets/qml/workerscript/script.js [new file with mode: 0644]
src/qml/doc/snippets/qml/workerscript/workerscript.qml [moved from src/qml/doc/snippets/qml/workerscript.qml with 100% similarity]
src/qml/doc/src/bindings/c++models.qdoc
src/qml/doc/src/bindings/properties-methods-signals.qdoc
src/qml/doc/src/bindings/qmlplugins.qdoc
src/qml/doc/src/bindings/qmltypes.qdoc
src/qml/doc/src/bindings/qtbinding.qdoc
src/qml/doc/src/debugging.qdoc
src/qml/doc/src/engine/qmlengine.qdoc
src/qml/doc/src/engine/qtjavascript.qdoc
src/qml/doc/src/qml/basictypes.qdoc
src/qml/doc/src/qml/codingconventions.qdoc
src/qml/doc/src/qml/dynamicobjects.qdoc
src/qml/doc/src/qml/javascriptblocks.qdoc
src/qml/doc/src/qml/network.qdoc
src/qml/doc/src/qml/propertybinding.qdoc
src/qml/doc/src/qml/qmlcomponents.qdoc
src/qml/doc/src/qml/qmldocument.qdoc
src/qml/doc/src/qml/qmllanguage-modules.qdoc
src/qml/doc/src/qml/qmllanguage-signal-handler.qdoc
src/qml/doc/src/qmlsyntax.qdoc
src/qml/doc/src/tutorials/extending-tutorial.qdoc
src/qml/qml/ftw/qintrusivelist.cpp
src/qml/qml/qqmlcomponent.cpp
src/qml/qml/qqmlengine.cpp
src/qml/qml/qqmlextensionplugin.cpp
src/qml/qml/qquicklistmodel.cpp
src/qml/qml/qquickworkerscript.cpp
src/qml/qml/v8/qjsengine.cpp
src/qml/qml/v8/qjsvalue.cpp
src/qml/qml/v8/qjsvalueiterator.cpp
src/qml/qml/v8/qqmlbuiltinfunctions.cpp
src/quick/doc/qtquick.qdocconf
src/quick/doc/snippets/qml/animatedimage.qml
src/quick/doc/snippets/qml/qml-extending-types/components/Button.qml [moved from src/qml/doc/snippets/qml/rectangle/rectangle.qml with 92% similarity]
src/quick/doc/snippets/qml/qml-extending-types/components/application.qml [new file with mode: 0644]
src/quick/doc/snippets/qml/qml-extending-types/methods/app.qml [moved from src/qml/doc/snippets/qml/behavior.qml with 94% similarity]
src/quick/doc/snippets/qml/qml-extending-types/properties/ImageViewer.qml [moved from src/qml/doc/snippets/qml/flickable.qml with 93% similarity]
src/quick/doc/snippets/qml/qml-extending-types/properties/alias-override.qml [moved from src/qml/doc/snippets/qml/numberanimation.qml with 96% similarity]
src/quick/doc/snippets/qml/qml-extending-types/properties/alias.qml [moved from src/qml/doc/snippets/qml/image.qml with 93% similarity]
src/quick/doc/snippets/qml/qml-extending-types/properties/alias/ImageViewer.qml [moved from src/qml/doc/snippets/qml/path/basicarc.qml with 93% similarity]
src/quick/doc/snippets/qml/qml-extending-types/properties/alias/application.qml [new file with mode: 0644]
src/quick/doc/snippets/qml/qml-extending-types/properties/application.qml [moved from src/qml/doc/snippets/qml/path/arcdirection.qml with 94% similarity]
src/quick/doc/snippets/qml/qml-extending-types/properties/property-signals.qml [new file with mode: 0644]
src/quick/doc/snippets/qml/qml-extending-types/signals/Button.qml [moved from src/qml/doc/snippets/qml/rectangle/rect-border-width.qml with 92% similarity]
src/quick/doc/snippets/qml/qml-extending-types/signals/basic.qml [new file with mode: 0644]
src/quick/doc/snippets/qml/qml-extending-types/signals/connectdynamic.qml [moved from src/qml/doc/snippets/qml/visualdatamodel.qml with 83% similarity]
src/quick/doc/snippets/qml/qml-extending-types/signals/connectslots.qml [moved from src/qml/doc/snippets/qml/systempalette.qml with 90% similarity]
src/quick/doc/snippets/qml/qml-extending-types/signals/no-parameters.qml [moved from src/qml/doc/snippets/qml/coloranimation.qml with 95% similarity]
src/quick/doc/snippets/qml/qml-extending-types/signals/parameters.qml [new file with mode: 0644]
src/quick/doc/snippets/qml/texteditor.qml [moved from src/qml/doc/snippets/qml/rotation.qml with 73% similarity]
src/quick/doc/src/animation.qdoc
src/quick/doc/src/focus.qdoc
src/quick/doc/src/localstorage/localstorage.qdoc
src/quick/doc/src/modelview.qdoc
src/quick/doc/src/mouseevents.qdoc
src/quick/doc/src/positioners.qdoc
src/quick/doc/src/qmlintro.qdoc
src/quick/doc/src/qmltexthandling.qdoc
src/quick/doc/src/qtquick-intro.qdoc
src/quick/doc/src/righttoleft.qdoc
src/quick/doc/src/states.qdoc
src/quick/doc/src/writingcomponents.qdoc
src/quick/items/qquickaccessibleattached.cpp
src/quick/items/qquickanimatedimage.cpp
src/quick/items/qquickborderimage.cpp
src/quick/items/qquickdrag.cpp
src/quick/items/qquickflickable.cpp
src/quick/items/qquickflipable.cpp
src/quick/items/qquickgridview.cpp
src/quick/items/qquickimage.cpp
src/quick/items/qquickitem.cpp
src/quick/items/qquickitemanimation.cpp
src/quick/items/qquickitemviewtransition.cpp
src/quick/items/qquicklistview.cpp
src/quick/items/qquickloader.cpp
src/quick/items/qquickmousearea.cpp
src/quick/items/qquickmultipointtoucharea.cpp
src/quick/items/qquickpathview.cpp
src/quick/items/qquickpositioners.cpp
src/quick/items/qquickrectangle.cpp
src/quick/items/qquickrepeater.cpp
src/quick/items/qquickstateoperations.cpp
src/quick/items/qquicktext.cpp
src/quick/items/qquicktextedit.cpp
src/quick/items/qquickvisualdatamodel.cpp
src/quick/util/qquickanimation.cpp
src/quick/util/qquickbehavior.cpp
src/quick/util/qquickbind.cpp
src/quick/util/qquickimageprovider.cpp
src/quick/util/qquickpackage.cpp
src/quick/util/qquickpath.cpp
src/quick/util/qquickpathinterpolator.cpp
src/quick/util/qquickpropertychanges.cpp
src/quick/util/qquicksmoothedanimation.cpp
src/quick/util/qquickspringanimation.cpp
src/quick/util/qquickstate.cpp
src/quick/util/qquickstatechangescript.cpp
src/quick/util/qquicksystempalette.cpp
src/quick/util/qquicktransition.cpp
tests/auto/quick/examples/tst_examples.cpp