diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2020-01-27 23:45:59 +0100 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2020-01-29 09:44:36 +0100 |
| commit | cd50765264adac52dc7ace48b0f339c0b13f76fc (patch) | |
| tree | 8b79acbe5dc312776119e67da31a1fbe7c949cf1 /src/qdoc/doc/qtgui-qdocconf.qdoc | |
| parent | 5eae325fcb4140155fe97ee0dff6101e4a2db444 (diff) | |
| download | qttools-cd50765264adac52dc7ace48b0f339c0b13f76fc.tar.gz | |
qdoc: Allow per-example override of install path
The 'examplesinstallpath' configuration variable assumes that all
examples - once installed - are located under a common root path.
Add a parameter 'installpath', recognized by the \meta command,
which can be used for setting the install path for specified
examples.
Improve the test for examples-manifest.xml to cover the \meta
command usage.
Task-number: QTBUG-81360
Change-Id: Ibb525a48958005fb3a589ef2d9d212091829231f
Reviewed-by: Levon Sargsyan <levon.sargsyan@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/qdoc/doc/qtgui-qdocconf.qdoc')
| -rw-r--r-- | src/qdoc/doc/qtgui-qdocconf.qdoc | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/src/qdoc/doc/qtgui-qdocconf.qdoc b/src/qdoc/doc/qtgui-qdocconf.qdoc index eaed76c67..4161c2917 100644 --- a/src/qdoc/doc/qtgui-qdocconf.qdoc +++ b/src/qdoc/doc/qtgui-qdocconf.qdoc @@ -137,7 +137,7 @@ to content listed in the index. \note QDoc omits this value when the -installdir argument is specified when running QDoc. -\keyword examplesinstallpath +\target examplesinstallpath \badcode examplesinstallpath = gui @@ -150,7 +150,11 @@ installed in the \e gui directory under the parent examples directory \note The examplepath variable has to match the example directory specified in \c exampledirs. -\b {See also}: \l {exampledirs}. +\note It is possible to override the \c exampleinstallpath for a specific + \l {example-command}{\\example} using the \l {meta-command}{\\meta} + command. + +\b {See also}: \l {exampledirs} and \l {meta-command}{\\meta}. \badcode qhp.projects = QtGui |