qdoc: Improve example file listing

At the end of \example documentation page, qdoc lists all the files
that are part of the example project. This commit does the
following improvements:

  - Sort the example files based on path name
  - Introduce '\generatelist examplefiles [regexp]', which
    lists the files (optionally, only those that match regexp)
    at the specified location.
  - Enable \noautolist for example pages, to skip generating the
    the file list at the end.

Change-Id: Ic9ae70f9f7de166d314ae489a7bab9a935949fc3
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>

1 files changed, 28 insertions, 0 deletions

diff --git a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
index 24dc7158a..4e4641ecb 100644
--- a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
+++ b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
@@ -3544,6 +3544,30 @@
     A support class is identified in the \\class comment with the \l
     {compat-command} {\\compat} command.
 
+    \section2 \c {examplefiles [regular_expression]}
+
+    The \c examplefiles argument lists the files that are part of
+    an example project. The optional second argument is a regular
+    expression; if provided, only the files whose path matches with
+    the regular expression are listed.
+
+    The \c examplefiles argument can be only used within example
+    documentation (see \l {example-command}{\\example}), and is
+    typically used together with the \l {noautolist-command}{\\noautolist}
+    command.
+
+    \section2 \c {exampleimages [regular_expression]}
+
+    The \c exampleimages argument lists the images that are part of
+    an example project. The optional second argument is a regular
+    expression; if provided, only the image files whose path matches
+    with the regular expression are listed.
+
+    The \c exampleimages argument can be only used within example
+    documentation (see \l {example-command}{\\example}), and is
+    typically used together with the \l {noautolist-command}{\\noautolist}
+    command.
+
     \section2 \c functionindex
 
     The \c functionindex argument provides a complete alphabetical
@@ -3953,6 +3977,10 @@
 
     This command was introduced in QDoc 5.6.
 
+    Since Qt 5.10, this command can be applied also to \l{example-command}
+    {\\example} documentation, where it causes the automatically generated
+    list of files and images belonging to an example project to be omitted.
+
     \target omit-command
     \section1 \\omit