summaryrefslogtreecommitdiffstats
path: root/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
diff options
context:
space:
mode:
authorQt Forward Merge Bot <qt_forward_merge_bot@qt-project.org>2020-02-15 03:03:34 +0100
committerTopi Reinio <topi.reinio@qt.io>2020-02-18 00:08:50 +0100
commitfab885ac1b5e5d3c130c033e4a1234e985179486 (patch)
tree94bf9028ad4cc75559e34e2b526f15c600c47b6a /src/qdoc/doc/qdoc-manual-markupcmds.qdoc
parent4776efd26bf95d21b7cc3137ecc2d81a6ccd2b80 (diff)
Merge remote-tracking branch 'origin/5.14' into 5.15
Change-Id: I98eaf748fdfb34f32d187718459327b8eef9c54b Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/qdoc/doc/qdoc-manual-markupcmds.qdoc')
-rw-r--r--src/qdoc/doc/qdoc-manual-markupcmds.qdoc32
1 files changed, 24 insertions, 8 deletions
diff --git a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
index c21869ac6..386501cd3 100644
--- a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
+++ b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
@@ -3655,16 +3655,16 @@
The command is useful when some snippet of commands or text is to
be used in multiple places in the documentation. Use the \\include
command wherever you want to insert a snippet into the documentation.
- The file containing the snippet to include must be located under the
- path(s) listed in the \l{sourcedirs-variable}{sourcedirs} QDoc
- configuration variable. It can be either any source file parsed
- by QDoc (or even the same one where \\include command is used), or
- any other text file. To store snippets in a separate file that is
- not meant to be parsed by QDoc, use a file extension that is not
- listed in \l {sources.fileextensions-variable}{sources.fileextensions};
+ The file containing the snippet to include, must be located under the
+ path(s) listed in the \l{sourcedirs-variable}{sourcedirs} or
+ \l{exampledirs-variable}{exampledirs} QDoc configuration variable.
+ It can be either any source file parsed by QDoc (or even the same one
+ where \\include command is used), or any other text file. To store
+ snippets in a separate file that is not meant to be parsed by QDoc,
+ use a file extension that is not listed in
+ \l{sources.fileextensions-variable}{sources.fileextensions};
for example, \c .qdocinc.
-
The command can have either one or two arguments. The first
argument is always a file name. The contents of the file must be
QDoc input, in other words, a sequence of QDoc commands and text, but
@@ -3778,6 +3778,22 @@
This would result in the following tags: \e {tutorial,basic,hello,world}.
Common words such as \e example are ignored.
+ \b {Example Install Paths}
+
+ The \\meta command combined with an argument \c installpath specifies the
+ location of an installed example. This value overrides the one that is set
+ using the \c examplesinstallpath configuration variable.
+
+ \badcode
+ / *!
+ \example helloworld
+ \title Hello World Example
+ \meta {installpath} {tutorials}
+ * /
+ \endcode
+
+ See also \l {examplesinstallpath}.
+
\target noautolist-command
\section1 \\noautolist