summaryrefslogtreecommitdiffstats
path: root/src/qdoc/doc/qdoc-manual-topiccmds.qdoc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2017-07-03 15:48:50 +0200
committerTopi Reiniƶ <topi.reinio@qt.io>2017-07-04 08:36:07 +0000
commitf74df71c48e5878de8eb44ee107aeed42385eff6 (patch)
treec27df82cffe34e767d7595bd12728f42cb2045cd /src/qdoc/doc/qdoc-manual-topiccmds.qdoc
parentebb7a33ed90264a6b82c7978b58ce71b5c7cf042 (diff)
qdoc: Further improve example file listing
Fix a bug where '\generatelist examplefiles' with no second parameter produced an empty list, instead of listing all files. Also, no longer restrict the searching of example image files to the images/ subdirectory. All images under a project directory are now listed, except those under doc/images. Minor fixes to related QDoc documentation. Change-Id: Id4516ba2feb98466a0e893a85f85118e3d21eae2 Reviewed-by: Martin Smith <martin.smith@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Diffstat (limited to 'src/qdoc/doc/qdoc-manual-topiccmds.qdoc')
-rw-r--r--src/qdoc/doc/qdoc-manual-topiccmds.qdoc16
1 files changed, 10 insertions, 6 deletions
diff --git a/src/qdoc/doc/qdoc-manual-topiccmds.qdoc b/src/qdoc/doc/qdoc-manual-topiccmds.qdoc
index 9fd97457d..53fe85684 100644
--- a/src/qdoc/doc/qdoc-manual-topiccmds.qdoc
+++ b/src/qdoc/doc/qdoc-manual-topiccmds.qdoc
@@ -360,13 +360,13 @@
\section1 \\example
The \\example command is for documenting an example. The argument
- is the example's path relative to omne of the paths listed in the
+ is the example's path relative to one of the paths listed in the
\l {exampledirs-variable} {exampledirs} variable in the QDoc
configuration file.
- The documentation page will be output to \c {path-to-example}.html.
- QDoc will add a list of all the example's source files at the top
- of the page.
+ The documentation page will be output to \c {modulename-path-to-example}.html.
+ QDoc will add a list of all the example's source and images files at the end
+ of the page, unless \l {noautolist-command}{\\noautolist} command is used.
For example, if \l {exampledirs-variable} {exampledirs} contains
\c $QTDIR/examples/widgets/imageviewer, then
@@ -391,6 +391,9 @@
<center><h1>Image Viewer Example</h1></center>
\endraw
+ The example shows how to combine QLabel and QScrollArea
+ to display an image.
+
Files:
\list
\li \l{http://doc.qt.io/qt-5/qtwidgets-widgets-imageviewer-imageviewer-cpp.html}
@@ -401,12 +404,13 @@
{widgets/imageviewer/main.cpp}
\endlist
- The example shows how to combine QLabel and QScrollArea
- to display an image.
...
\endquotation
+ \b {See also:} \l {generatelist-command}{\\generatelist examplefiles},
+ \l {noautolist-command}{\\noautolist}
+
\target externalpage-command
\section1 \\externalpage