Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Remove the usage of deprecated qdoc macros.
QDoc now has support for Doxygen style commands for italics, bold
and list items. This change applies that change in QDoc to the
actual documentation.

Task-number: QTBUG-24578
Change-Id: I62d203f21df63a95ee236e578b10418fd9680707
Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
  • Loading branch information
Casper van Donderen authored and Qt by Nokia committed Mar 13, 2012
1 parent ada9dd4 commit c291eff
Show file tree
Hide file tree
Showing 112 changed files with 1,929 additions and 1,929 deletions.
36 changes: 18 additions & 18 deletions doc/src/examples/advtutorial.qdoc
Expand Up @@ -36,7 +36,7 @@ This tutorial walks step-by-step through the creation of a full application usin
It assumes that you already know the basics of QML (for example, from reading the
\l{QML Tutorial}{simple tutorial}).

In this tutorial we write a game, \i {Same Game}, based on the Same Game application
In this tutorial we write a game, \e {Same Game}, based on the Same Game application
included in the declarative \c examples directory, which looks like this:

\image declarative-samegame.png
Expand All @@ -53,10 +53,10 @@ control QML elements.
Tutorial chapters:

\list 1
\o \l {declarative/tutorials/samegame/samegame1}{Creating the Game Canvas and Blocks}
\o \l {declarative/tutorials/samegame/samegame2}{Populating the Game Canvas}
\o \l {declarative/tutorials/samegame/samegame3}{Implementing the Game Logic}
\o \l {declarative/tutorials/samegame/samegame4}{Finishing Touches}
\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}
\endlist

All the code in this tutorial can be found in Qt's \c examples/declarative/tutorials/samegame
Expand Down Expand Up @@ -168,18 +168,18 @@ and moves the new block to its position on the game canvas. This involves severa

\list

\o \l {QML:Qt::createComponent()}{Qt.createComponent()} is called to
\li \l {QML:Qt::createComponent()}{Qt.createComponent()} is called to
generate an element from \c Block.qml. If the component is ready,
we can call \c createObject() to create an instance of the \c Block
item.

\o If \c createObject() returned null (i.e. if there was an error
\li If \c createObject() returned null (i.e. if there was an error
while loading the object), print the error information.

\o Place the block in its position on the board and set its width and
\li Place the block in its position on the board and set its width and
height. Also, store it in the blocks array for future reference.

\o Finally, print error information to the console if the component
\li Finally, print error information to the console if the component
could not be loaded for some reason (for example, if the file is
missing).

Expand Down Expand Up @@ -228,11 +228,11 @@ until it is won or lost.
To do this, we have added the following functions to \c samegame.js:

\list
\o \c{handleClick(x,y)}
\o \c{floodFill(xIdx,yIdx,type)}
\o \c{shuffleDown()}
\o \c{victoryCheck()}
\o \c{floodMoveCheck(xIdx, yIdx, type)}
\li \c{handleClick(x,y)}
\li \c{floodFill(xIdx,yIdx,type)}
\li \c{shuffleDown()}
\li \c{victoryCheck()}
\li \c{floodMoveCheck(xIdx, yIdx, type)}
\endlist

As this is a tutorial about QML, not game design, we will only discuss \c handleClick() and \c victoryCheck() below since they interface directly with the QML elements. Note that although the game logic here is written in JavaScript, it could have been written in C++ and then exposed to QML.
Expand Down Expand Up @@ -459,10 +459,10 @@ makes it very easy to fetch and display XML based data such as RSS in a QML appl
By following this tutorial you've seen how you can write a fully functional application in QML:

\list
\o Build your application with \l {{QML Elements}}{QML elements}
\o Add application logic \l{JavaScript Expressions in QML}{with JavaScript code}
\o Add animations with \l {Behavior}{Behaviors} and \l{QML States}{states}
\o Store persistent application data using, for example, the \l{Offline Storage API} or \l XMLHttpRequest
\li Build your application with \l {{QML Elements}}{QML elements}
\li Add application logic \l{JavaScript Expressions in QML}{with JavaScript code}
\li Add animations with \l {Behavior}{Behaviors} and \l{QML States}{states}
\li Store persistent application data using, for example, the \l{Offline Storage API} or \l XMLHttpRequest
\endlist

There is so much more to learn about QML that we haven't been able to cover in this tutorial. Check out all the
Expand Down
8 changes: 4 additions & 4 deletions doc/src/examples/dynamicview-tutorial.qdoc
Expand Up @@ -39,10 +39,10 @@ data to dynamically sort all items in a view.
Tutorial chapters:

\list 1
\o \l {declarative/tutorials/dynamicview/dynamicview1}{A Simple ListView and Delegate}
\o \l {declarative/tutorials/dynamicview/dynamicview2}{Dragging View Items}
\o \l {declarative/tutorials/dynamicview/dynamicview3}{Moving Dragged Items}
\o \l {declarative/tutorials/dynamicview/dynamicview4}{Sorting Items}
\li \l {declarative/tutorials/dynamicview/dynamicview1}{A Simple ListView and Delegate}
\li \l {declarative/tutorials/dynamicview/dynamicview2}{Dragging View Items}
\li \l {declarative/tutorials/dynamicview/dynamicview3}{Moving Dragged Items}
\li \l {declarative/tutorials/dynamicview/dynamicview4}{Sorting Items}
\endlist

All the code in this tutorial can be found in Qt's \c examples/declarative/tutorials/dynamicview
Expand Down
20 changes: 10 additions & 10 deletions doc/src/examples/example-slideswitch.qdoc
Expand Up @@ -37,12 +37,12 @@ The code for this example can be found in the \c examples/declarative/ui-compone
The elements that compose the switch are:

\list
\o a \c on property (the interface to interact with the switch),
\o two images (the background image and the knob),
\o two mouse regions for user interation (on the background image and on the knob),
\o two states (a \i on state and a \i off state),
\o two functions or slots to react to the user interation (\c toggle() and \c dorelease()),
\o and a transition that describe how to go from one state to the other.
\li a \c on property (the interface to interact with the switch),
\li two images (the background image and the knob),
\li two mouse regions for user interation (on the background image and on the knob),
\li two states (an \e on state and an \e off state),
\li two functions or slots to react to the user interation (\c toggle() and \c dorelease()),
\li and a transition that describe how to go from one state to the other.
\endlist

\section1 Switch.qml
Expand Down Expand Up @@ -93,8 +93,8 @@ in the \c dorelease() function that is called in the \c onReleased property.

We define the two states of the switch:
\list
\o In the \i on state the knob is on the right (\c x position is 78) and the \c on property is \c true.
\o In the \i off state the knob is on the left (\c x position is 1) and the \c on property is \c false.
\li In the \e on state the knob is on the right (\c x position is 78) and the \c on property is \c true.
\li In the \e off state the knob is on the left (\c x position is 1) and the \c on property is \c false.
\endlist

For more information on states see \l{qmlstates}{QML States}.
Expand All @@ -106,13 +106,13 @@ We add two JavaScript functions to our switch:
\snippet examples/declarative/ui-components/slideswitch/content/Switch.qml 2

This first function is called when the background image or the knob are clicked. We simply want the switch to toggle between the two
states (\i on and \i off).
states (\e on and \e off).


\snippet examples/declarative/ui-components/slideswitch/content/Switch.qml 3

This second function is called when the knob is released and we want to make sure that the knob does not end up between states
(neither \i on nor \i off). If it is the case call the \c toggle() function otherwise we do nothing.
(neither \e on nor \e off). If it is the case call the \c toggle() function otherwise we do nothing.

For more information on scripts see \l{JavaScript Expressions in QML}.

Expand Down

0 comments on commit c291eff

Please sign in to comment.