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>

1 files changed, 37 insertions, 37 deletions

diff --git a/doc/src/examples/advtutorial.qdoc b/doc/src/examples/advtutorial.qdoc
index fb5134ddf4..bcf819aef1 100644
--- a/doc/src/examples/advtutorial.qdoc
+++ b/doc/src/examples/advtutorial.qdoc
@@ -53,13 +53,13 @@ control QML elements.
 Tutorial chapters:
 
 \list 1
-\li \l {declarative/tutorials/samegame/samegame1}{Creating the Game Canvas and Blocks}
-\li \l {declarative/tutorials/samegame/samegame2}{Populating the Game Canvas}
-\li \l {declarative/tutorials/samegame/samegame3}{Implementing the Game Logic}
-\li \l {declarative/tutorials/samegame/samegame4}{Finishing Touches}
+\li \l {examples/tutorials/samegame/samegame1}{Creating the Game Canvas and Blocks}
+\li \l {examples/tutorials/samegame/samegame2}{Populating the Game Canvas}
+\li \l {examples/tutorials/samegame/samegame3}{Implementing the Game Logic}
+\li \l {examples/tutorials/samegame/samegame4}{Finishing Touches}
 \endlist
 
-All the code in this tutorial can be found in Qt's \c examples/declarative/tutorials/samegame
+All the code in this tutorial can be found in Qt's \c examples/examples/tutorials/samegame
 directory.
 */
 
@@ -71,7 +71,7 @@ directory.
 \previouspage QML Advanced Tutorial
 \nextpage QML Advanced Tutorial 2 - Populating the Game Canvas
 
-\example declarative/tutorials/samegame/samegame1
+\example examples/tutorials/samegame/samegame1
 
 \section2 Creating the application screen
 
@@ -83,7 +83,7 @@ To begin with, we create our Same Game application with a main screen like this:
 
 This is defined by the main application file, \c samegame.qml, which looks like this:
 
-\snippet declarative/tutorials/samegame/samegame1/samegame.qml 0
+\snippet examples/tutorials/samegame/samegame1/samegame.qml 0
 
 This gives you a basic game window that includes the main canvas for the
 blocks, a "New Game" button and a score display.
@@ -101,7 +101,7 @@ The \c Button item in the code above is defined in a separate component file nam
 To create a functional button, we use the QML elements \l Text and \l MouseArea inside a \l Rectangle.
 Here is the \c Button.qml code:
 
-\snippet declarative/tutorials/samegame/samegame1/Button.qml 0
+\snippet examples/tutorials/samegame/samegame1/Button.qml 0
 
 This essentially defines a rectangle that contains text and can be clicked. The \l MouseArea
 has an \c onClicked() handler that is implemented to emit the \c clicked() signal of the
@@ -111,7 +111,7 @@ In Same Game, the screen is filled with small blocks when the game begins.
 Each block is just an item that contains an image. The block
 code is defined in a separate \c Block.qml file:
 
-\snippet declarative/tutorials/samegame/samegame1/Block.qml 0
+\snippet examples/tutorials/samegame/samegame1/Block.qml 0
 
 At the moment, the block doesn't do anything; it is just an image. As the
 tutorial progresses we will animate and give behaviors to the blocks.
@@ -141,7 +141,7 @@ elements to get started. Next, we will populate the game canvas with some blocks
 \previouspage QML Advanced Tutorial 1 - Creating the Game Canvas and Blocks
 \nextpage QML Advanced Tutorial 3 - Implementing the Game Logic
 
-\example declarative/tutorials/samegame/samegame2
+\example examples/tutorials/samegame/samegame2
 
 \section2 Generating the blocks in JavaScript
 
@@ -156,7 +156,7 @@ create the blocks in JavaScript.
 Here is the JavaScript code for generating the blocks, contained in a new
 file, \c samegame.js. The code is explained below.
 
-\snippet declarative/tutorials/samegame/samegame2/samegame.js 0
+\snippet examples/tutorials/samegame/samegame2/samegame.js 0
 
 The \c startNewGame() function deletes the blocks created in the previous game and
 calculates the number of rows and columns of blocks required to fill the game window for the new game.
@@ -192,14 +192,14 @@ Now we need to call the JavaScript code in \c samegame.js from our QML files.
 To do this, we add this line to \c samegame.qml which imports
 the JavaScript file as a \l{Modules#QML Modules}{module}:
 
-\snippet declarative/tutorials/samegame/samegame2/samegame.qml 2
+\snippet examples/tutorials/samegame/samegame2/samegame.qml 2
 
 This allows us to refer to any functions within \c samegame.js using "SameGame"
 as a prefix: for example, \c SameGame.startNewGame() or \c SameGame.createBlock().
 This means we can now connect the New Game button's \c onClicked handler to the \c startNewGame()
 function, like this:
 
-\snippet declarative/tutorials/samegame/samegame2/samegame.qml 1
+\snippet examples/tutorials/samegame/samegame2/samegame.qml 1
 
 So, when you click the New Game button, \c startNewGame() is called and generates a field of blocks, like this:
 
@@ -217,7 +217,7 @@ Now, we have a screen of blocks, and we can begin to add the game mechanics.
 \previouspage QML Advanced Tutorial 2 - Populating the Game Canvas
 \nextpage QML Advanced Tutorial 4 - Finishing Touches
 
-\example declarative/tutorials/samegame/samegame3
+\example examples/tutorials/samegame/samegame3
 
 \section2 Making a playable game
 
@@ -241,7 +241,7 @@ As this is a tutorial about QML, not game design, we will only discuss \c handle
 
 To make it easier for the JavaScript code to interface with the QML elements, we have added an Item called \c gameCanvas to \c samegame.qml. It replaces the background as the item which contains the blocks. It also accepts mouse input from the user.  Here is the item code:
 
-\snippet declarative/tutorials/samegame/samegame3/samegame.qml 1
+\snippet examples/tutorials/samegame/samegame3/samegame.qml 1
 
 The \c gameCanvas item is the exact size of the board, and has a \c score property and a \l MouseArea to handle mouse clicks.
 The blocks are now created as its children, and its dimensions are used to determine the board size so that
@@ -251,7 +251,7 @@ Note that it can still be accessed from the script.
 
 When clicked, the \l MouseArea calls \c{handleClick()} in \c samegame.js, which determines whether the player's click should cause any blocks to be removed, and updates \c gameCanvas.score with the current score if necessary. Here is the \c handleClick() function:
 
-\snippet declarative/tutorials/samegame/samegame3/samegame.js 1
+\snippet examples/tutorials/samegame/samegame3/samegame.js 1
 
 Note that if \c score was a global variable in the \c{samegame.js} file you would not be able to bind to it. You can only bind to QML properties.
 
@@ -259,17 +259,17 @@ Note that if \c score was a global variable in the \c{samegame.js} file you woul
 
 When the player clicks a block and triggers \c handleClick(), \c handleClick() also calls \c victoryCheck() to update the score and to check whether the player has completed the game. Here is the \c victoryCheck() code:
 
-\snippet declarative/tutorials/samegame/samegame3/samegame.js 2
+\snippet examples/tutorials/samegame/samegame3/samegame.js 2
 
 This updates the \c gameCanvas.score value and displays a "Game Over" dialog if the game is finished.
 
 The Game Over dialog is created using a \c Dialog element that is defined in \c Dialog.qml. Here is the \c Dialog.qml code. Notice how it is designed to be usable imperatively from the script file, via the functions and signals:
 
-\snippet declarative/tutorials/samegame/samegame3/Dialog.qml 0
+\snippet examples/tutorials/samegame/samegame3/Dialog.qml 0
 
 And this is how it is used in the main \c samegame.qml file:
 
-\snippet declarative/tutorials/samegame/samegame3/samegame.qml 2
+\snippet examples/tutorials/samegame/samegame3/samegame.qml 2
 
 We give the dialog a \l {Item::z}{z} value of 100 to ensure it is displayed on top of our other components. The default \c z value for an item is 0.
 
@@ -278,7 +278,7 @@ We give the dialog a \l {Item::z}{z} value of 100 to ensure it is displayed on t
 
 It's not much fun to play Same Game if all the blocks are the same color, so we've modified the \c createBlock() function in \c samegame.js to randomly create a different type of block (for either red, green or blue) each time it is called. \c Block.qml has also changed so that each block contains a different image depending on its type:
 
-\snippet declarative/tutorials/samegame/samegame3/Block.qml 0
+\snippet examples/tutorials/samegame/samegame3/Block.qml 0
 
 
 \section2 A working game
@@ -290,7 +290,7 @@ Here is a screenshot of what has been accomplished so far:
 
 This is what \c samegame.qml looks like now:
 
-\snippet declarative/tutorials/samegame/samegame3/samegame.qml 0
+\snippet examples/tutorials/samegame/samegame3/samegame.qml 0
 
 The game works, but it's a little boring right now. Where are the smooth animated transitions? Where are the high scores?
 If you were a QML expert you could have written these in the first iteration, but in this tutorial they've been saved
@@ -305,7 +305,7 @@ until the next chapter - where your application becomes alive!
 \contentspage QML Advanced Tutorial
 \previouspage QML Advanced Tutorial 3 - Implementing the Game Logic
 
-\example declarative/tutorials/samegame/samegame4
+\example examples/tutorials/samegame/samegame4
 
 \section2 Adding some flair
 
@@ -324,7 +324,7 @@ In \c BoomBlock.qml, we apply a \l SpringAnimation behavior to the \c x and \c y
 block will follow and animate its movement in a spring-like fashion towards the specified position (whose
 values will be set by \c samegame.js).Here is the code added to \c BoomBlock.qml:
 
-\snippet declarative/tutorials/samegame/samegame4/content/BoomBlock.qml 1
+\snippet examples/tutorials/samegame/samegame4/content/BoomBlock.qml 1
 
 The \c spring and \c damping values can be changed to modify the spring-like effect of the animation.
 
@@ -341,7 +341,7 @@ animate the opacity value so that it gradually fades in and out, instead of abru
 visible and invisible. To do this, we'll apply a \l Behavior on the \c opacity property of the \c Image
 element in \c BoomBlock.qml:
 
-\snippet declarative/tutorials/samegame/samegame4/content/BoomBlock.qml 2
+\snippet examples/tutorials/samegame/samegame4/content/BoomBlock.qml 2
 
 Note the \c{opacity: 0} which means the block is transparent when it is first created. We could set the opacity
 in \c samegame.js when we create and destroy the blocks,
@@ -367,14 +367,14 @@ To fade out, we set \c dying to true instead of setting opacity to 0 when a bloc
 Finally, we'll add a cool-looking particle effect to the blocks when they are destroyed. To do this, we first add a \l Particles element in
 \c BoomBlock.qml, like so:
 
-\snippet declarative/tutorials/samegame/samegame4/content/BoomBlock.qml 3
+\snippet examples/tutorials/samegame/samegame4/content/BoomBlock.qml 3
 
 To fully understand this you should read the \l Particles documentation, but it's important to note that \c emissionRate is set
 to zero so that particles are not emitted normally.
 Also, we extend the \c dying State, which creates a burst of particles by calling the \c burst() method on the particles element. The code for the states now look
 like this:
 
-\snippet declarative/tutorials/samegame/samegame4/content/BoomBlock.qml 4
+\snippet examples/tutorials/samegame/samegame4/content/BoomBlock.qml 4
 
 Now the game is beautifully animated, with subtle (or not-so-subtle) animations added for all of the
 player's actions. The end result is shown below, with a different set of images to demonstrate basic theming:
@@ -391,32 +391,32 @@ To do this, we will show a dialog when the game is over to request the player's
 This requires a few changes to \c Dialog.qml. In addition to a \c Text element, it now has a
 \c TextInput child item for receiving keyboard text input:
 
-\snippet declarative/tutorials/samegame/samegame4/content/Dialog.qml 0
+\snippet examples/tutorials/samegame/samegame4/content/Dialog.qml 0
 \dots 4
-\snippet declarative/tutorials/samegame/samegame4/content/Dialog.qml 2
+\snippet examples/tutorials/samegame/samegame4/content/Dialog.qml 2
 \dots 4
-\snippet declarative/tutorials/samegame/samegame4/content/Dialog.qml 3
+\snippet examples/tutorials/samegame/samegame4/content/Dialog.qml 3
 
 We'll also add a \c showWithInput() function. The text input will only be visible if this function
 is called instead of \c show(). When the dialog is closed, it emits a \c closed() signal, and
 other elements can retrieve the text entered by the user through an \c inputText property:
 
-\snippet declarative/tutorials/samegame/samegame4/content/Dialog.qml 0
-\snippet declarative/tutorials/samegame/samegame4/content/Dialog.qml 1
+\snippet examples/tutorials/samegame/samegame4/content/Dialog.qml 0
+\snippet examples/tutorials/samegame/samegame4/content/Dialog.qml 1
 \dots 4
-\snippet declarative/tutorials/samegame/samegame4/content/Dialog.qml 3
+\snippet examples/tutorials/samegame/samegame4/content/Dialog.qml 3
 
 Now the dialog can be used in \c samegame.qml:
 
-\snippet declarative/tutorials/samegame/samegame4/samegame.qml 0
+\snippet examples/tutorials/samegame/samegame4/samegame.qml 0
 
 When the dialog emits the \c closed signal, we call the new \c saveHighScore() function in \c samegame.js, which stores the high score locally in an SQL database and also send the score to an online database if possible.
 
 The \c nameInputDialog is activated in the \c victoryCheck() function in \c samegame.js:
 
-\snippet declarative/tutorials/samegame/samegame4/content/samegame.js 3
+\snippet examples/tutorials/samegame/samegame4/content/samegame.js 3
 \dots 4
-\snippet declarative/tutorials/samegame/samegame4/content/samegame.js 4
+\snippet examples/tutorials/samegame/samegame4/content/samegame.js 4
 
 \section3 Storing high scores offline
 
@@ -424,7 +424,7 @@ Now we need to implement the functionality to actually save the High Scores tabl
 
 Here is the \c saveHighScore() function in \c samegame.js:
 
-\snippet declarative/tutorials/samegame/samegame4/content/samegame.js 2
+\snippet examples/tutorials/samegame/samegame4/content/samegame.js 2
 
 First we call \c sendHighScore() (explained in the section below) if it is possible to send the high scores to an online database.
 
@@ -443,7 +443,7 @@ If the player entered their name we can send the data to the web service us
 
 If the player enters a name, we send the data to the service using this code in \c samegame.js:
 
-\snippet declarative/tutorials/samegame/samegame4/content/samegame.js 1
+\snippet examples/tutorials/samegame/samegame4/content/samegame.js 1
 
 The \l XMLHttpRequest in this code is the same as the \c XMLHttpRequest() as you'll find in standard browser JavaScript, and can be used in the same way to dynamically get XML
 or QML from the web service to display the high scores. We don't worry about the response in this case - we just post the high