summaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorPaul Wicking <paul.wicking@qt.io>2018-09-27 16:07:34 +0200
committerPaul Wicking <paul.wicking@qt.io>2018-10-01 10:01:00 +0000
commit91bde278ea2e883b4a46cafb1afc1781c71c1590 (patch)
treeead666ba943561e27fe7147ddf163b320d674f7f /examples
parente8b01250fdbef269379df8c2481c9482317e8220 (diff)
Doc: Fix QDoc warnings
Change-Id: I19545953bde10d4ccc2f37843dcda2569dc77df4 Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'examples')
-rw-r--r--examples/quick/tableview/gameoflife/doc/src/gameoflife.qdoc2
-rw-r--r--examples/quick/tableview/pixelator/doc/src/pixelator.qdoc24
2 files changed, 13 insertions, 13 deletions
diff --git a/examples/quick/tableview/gameoflife/doc/src/gameoflife.qdoc b/examples/quick/tableview/gameoflife/doc/src/gameoflife.qdoc
index b2391d43ba..069513636a 100644
--- a/examples/quick/tableview/gameoflife/doc/src/gameoflife.qdoc
+++ b/examples/quick/tableview/gameoflife/doc/src/gameoflife.qdoc
@@ -26,7 +26,7 @@
****************************************************************************/
/*!
\title Qt Quick TableView examples - Conway’s Game of Life
- \example gameoflife
+ \example tableview/gameoflife
\brief The \e{Conway’s Game of Life} example shows how the QML TableView
type can be used to display a C++ model that the user can pan around.
diff --git a/examples/quick/tableview/pixelator/doc/src/pixelator.qdoc b/examples/quick/tableview/pixelator/doc/src/pixelator.qdoc
index 4f8d519060..9e199a5347 100644
--- a/examples/quick/tableview/pixelator/doc/src/pixelator.qdoc
+++ b/examples/quick/tableview/pixelator/doc/src/pixelator.qdoc
@@ -26,7 +26,7 @@
****************************************************************************/
/*!
\title Qt Quick TableViews examples - Pixelator
- \example pixelator
+ \example tableview/pixelator
\brief The Pixelator example shows how a QML TableView and a delegate
can be used for custom table models.
@@ -35,36 +35,36 @@
\include examples-run.qdocinc
- \snippet pixelator/imagemodel.h model
+ \snippet tableview/pixelator/imagemodel.h model
We only require a simple, read-only table model. Thus, we need to implement
functions to indicate the dimensions of the image and supply data to the
TableView.
- We use the \l{Qt property system}{Qt Property System} and a source property
+ We use the \l{The Property System}{Qt Property System} and a source property
as \c QString to set the path of the image.
- \snippet pixelator/imagemodel.cpp setsource
+ \snippet tableview/pixelator/imagemodel.cpp setsource
Here we load the image when the source path is set.
When the source path has changed, we need to call \c beginResetModel() before.
After the image has been loaded, we need to call \c endResetModel().
- \snippet pixelator/imagemodel.cpp rowcolcount
+ \snippet tableview/pixelator/imagemodel.cpp rowcolcount
The row and column count is set to image height and width, respectively.
- \snippet pixelator/imagemodel.cpp data
+ \snippet tableview/pixelator/imagemodel.cpp data
This overloaded function allows us to access the pixel data from the image.
When we call this function with the display role, we return the pixel's
gray value.
- \snippet pixelator/main.cpp registertype
+ \snippet tableview/pixelator/main.cpp registertype
We need to register our model in the QML type system to be able to use it
from the QML side.
- \snippet pixelator/main.qml pixelcomponent
+ \snippet tableview/pixelator/main.qml pixelcomponent
Each pixel in the \c TableView is displayed via a delegate component.
It contains an item that has an implicit height and width defining the
@@ -72,22 +72,22 @@
It also has a property for the gray value of the pixel that is retrieved
from the model.
- \snippet pixelator/main.qml rectshape
+ \snippet tableview/pixelator/main.qml rectshape
Inside the \c Item, there is a rounded \c Rectangle with the size and
radius according to the pixel's gray value.
- \snippet pixelator/main.qml interaction
+ \snippet tableview/pixelator/main.qml interaction
For a little bit of interaction, we place a \c MouseArea inside the \c Item
and change the Rectangle's color on mouse over.
- \snippet pixelator/main.qml animation
+ \snippet tableview/pixelator/main.qml animation
The \c Rectangle also has a short color animation to fade between the
colors when it is changed.
- \snippet pixelator/main.qml tableview
+ \snippet tableview/pixelator/main.qml tableview
The \c TableView spans over the whole window and has an instance of our
custom \c ImageModel attached.