diff options
| author | Topi Reinio <topi.reinio@digia.com> | 2015-03-16 15:09:28 +0100 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@digia.com> | 2015-03-17 10:43:55 +0000 |
| commit | 8d655cd2490e04727a74688544f5b152b3993fba (patch) | |
| tree | 67800f75aaf61b41ab4d884d3748df53d0bf3b72 /src | |
| parent | 424d707537f229340dab1ecc7d54db64cff4255f (diff) | |
Doc: Add skeleton documentation for the examples
Add a skeleton version of the example documentation for each example,
create a group page for them and link to it from the module landing
pages.
This allows browsing the example code from the docs and also enables
listing them in Qt Creator's Welcome mode.
Change-Id: I1ba16399b115bb8c5503bc91d2a8dee46417cd01
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
Diffstat (limited to 'src')
| -rw-r--r-- | src/core/doc/qt3dcore.qdocconf | 2 | ||||
| -rw-r--r-- | src/core/doc/src/qt3dcore-index.qdoc | 1 | ||||
| -rw-r--r-- | src/render/doc/qt3drender.qdocconf | 5 | ||||
| -rw-r--r-- | src/render/doc/src/qt3drender-index.qdoc | 16 |
4 files changed, 20 insertions, 4 deletions
diff --git a/src/core/doc/qt3dcore.qdocconf b/src/core/doc/qt3dcore.qdocconf index 66833ef97..a1a90a31b 100644 --- a/src/core/doc/qt3dcore.qdocconf +++ b/src/core/doc/qt3dcore.qdocconf @@ -26,7 +26,7 @@ qhp.Qt3DCore.subprojects.classes.sortPages = true tagfile = ../../../doc/qt3dcore/qt3dcore.tags -depends += qtcore qtqml qtquick qtdoc +depends += qtcore qtqml qtquick qtdoc qt3drender headerdirs += .. sourcedirs += .. diff --git a/src/core/doc/src/qt3dcore-index.qdoc b/src/core/doc/src/qt3dcore-index.qdoc index 4fc04112d..b17aa5474 100644 --- a/src/core/doc/src/qt3dcore-index.qdoc +++ b/src/core/doc/src/qt3dcore-index.qdoc @@ -58,6 +58,7 @@ \list \li \l {Qt3D Core C++ Classes} + \li \l {Qt3D Examples} \endlist */ diff --git a/src/render/doc/qt3drender.qdocconf b/src/render/doc/qt3drender.qdocconf index b36800a50..415f5d1ea 100644 --- a/src/render/doc/qt3drender.qdocconf +++ b/src/render/doc/qt3drender.qdocconf @@ -30,9 +30,8 @@ depends += qtcore qtqml qtquick qt3dcore qtdoc headerdirs += .. sourcedirs += .. -exampledirs += src/snippets - -#excludedirs += +exampledirs += ../../../examples/qt3d \ + src/snippets imagedirs += images diff --git a/src/render/doc/src/qt3drender-index.qdoc b/src/render/doc/src/qt3drender-index.qdoc index a29238f95..27a6356a3 100644 --- a/src/render/doc/src/qt3drender-index.qdoc +++ b/src/render/doc/src/qt3drender-index.qdoc @@ -57,5 +57,21 @@ \section1 Reference \list \li \l {Qt3D Render C++ Classes} + \li \l {Qt3D Examples} \endlist */ + +/*! + \page qt3d-examples.html + \ingroup all-examples + \title Qt3D Examples + \brief Examples that demostrate 2D and 3D rendering using Qt3D. + + The following examples demonstrate 2D and 3D rendering using Qt3D. + + \section1 QML Examples + \annotatedlist qt3d-examples-qml + + \section1 C++ Examples + \annotatedlist qt3d-examples-cpp +*/ |