aboutsummaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2017-07-04 15:26:25 +0200
committerVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2017-07-05 08:09:23 +0000
commit6f5a061b5c7a116dff3466a10c50d69f606ae350 (patch)
treec13143c263eb1ed80fad2aa764e0b6f9aa5152b3 /examples
parentf1186db27f95b9a90744d0f9920fe33b497d0774 (diff)
Doc: List the corresponding source files and images under each chapter
In a tutorial such as this, listing all the example files and images at once towards end of it is confusing. Qdoc enables to turn off the auto-generated list and explicitly list the files wherever necessary. Change-Id: Ifbb258af5ad35bd2df976eb793a14fd5873ceed9 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: J-P Nurmi <jpnurmi@qt.io>
Diffstat (limited to 'examples')
-rw-r--r--examples/quickcontrols2/chattutorial/doc/src/qtquickcontrols2-chattutorial.qdoc15
1 files changed, 15 insertions, 0 deletions
diff --git a/examples/quickcontrols2/chattutorial/doc/src/qtquickcontrols2-chattutorial.qdoc b/examples/quickcontrols2/chattutorial/doc/src/qtquickcontrols2-chattutorial.qdoc
index ef3978b3..173403ac 100644
--- a/examples/quickcontrols2/chattutorial/doc/src/qtquickcontrols2-chattutorial.qdoc
+++ b/examples/quickcontrols2/chattutorial/doc/src/qtquickcontrols2-chattutorial.qdoc
@@ -216,6 +216,9 @@ Now we can build and run the application:
\borderedimage qtquickcontrols2-chattutorial-chapter1.png
+\noautolist
+\generatelist examplefiles .*chapter1.*
+
\section1 Chapter 2: Lists
In this chapter, we'll explain how to create a list of interactive items using
@@ -290,6 +293,9 @@ vertical space.
\borderedimage qtquickcontrols2-chattutorial-chapter2.png
+\generatelist examplefiles .*(chapter2|shared).*
+\generatelist exampleimages .*shared.*(Einstein|Hemingway|Gude)\.png
+
\section1 Chapter 3: Navigation
In this chapter, you'll learn how to use \l StackView to navigate between pages
@@ -514,6 +520,9 @@ Finally, the button is only enabled when there is actually a message to send.
\borderedimage qtquickcontrols2-chattutorial-chapter3.gif
+\generatelist examplefiles .*(chapter3|shared).*
+\generatelist exampleimages .*shared.*(Einstein|Hemingway|Gude)\.png
+
\section1 Chapter 4: Models
In chapter 4, we'll take you through the process of creating both read-only and
@@ -730,6 +739,9 @@ text field to make way for future input.
\borderedimage qtquickcontrols2-chattutorial-chapter4.gif
+\generatelist examplefiles .*(chapter4|shared).*
+\generatelist exampleimages
+
\section1 Chapter 5: Styling
Styles in Qt Quick Controls 2 are designed to work on any platform. In this
@@ -856,6 +868,9 @@ After building and running the application, you should see these results:
\borderedimage qtquickcontrols2-chattutorial-chapter5-contacts-universal-dark.png
\borderedimage qtquickcontrols2-chattutorial-chapter5-conversations-universal-dark.png
+\generatelist examplefiles .*(chapter5|shared).*
+\generatelist exampleimages
+
\section1 Summary
In this tutorial, we've taken you through the following steps of writing a