summaryrefslogtreecommitdiffstats
path: root/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2015-06-09 10:59:10 +0200
committerTopi Reiniƶ <topi.reinio@digia.com>2015-07-24 10:36:03 +0000
commit7a85be3371b9022815fdb208ee05cb3d302b9cb7 (patch)
tree8c44355c29fa229b365bdeda0286e197bd031e81 /src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc
parent80dbdf0de3bfe5f0710a1c37932ef81cbdb5fbff (diff)
qdoc: Improve searching of collection nodes
QDocDatabase provided a way to search for a collection node in the primary tree only. This was insufficient for use cases where we want to list groups, C++ classes or QML types in other modules using the \generatelist or \annotatedlist commands. This commit does the following changes: - Add a function to find a collection node across all trees, use it for generating output for the list commands and generating C++ class/QML/JS type requisite tables. - Modify the code for \generatelist command to accept 'qmltypesbymodule' and 'jstypesbymodule' as parameters. - Modify constness of some functions to enable above changes. Change-Id: I3dbdadfd224754db4bdc1602a5ffab9d46c51f00 Reviewed-by: Martin Smith <martin.smith@digia.com>
Diffstat (limited to 'src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc')
-rw-r--r--src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc
index 01eee0486c..b4ed391301 100644
--- a/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc
+++ b/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc
@@ -3452,6 +3452,20 @@
with the \l {inmodule-command} {\\inmodule} command in its \\class
comment.
+ \section2 \c qmltypesbymodule
+
+ Similar to \c classesbymodule argument, but used for listing the
+ QML types from the QML module specified with the second argument.
+
+ \note Support for this argument was introduced in QDoc 5.6.
+
+ \section2 \c jstypesbymodule
+
+ Similar to \c classesbymodule argument, but used for listing the
+ JavaScript types from the module specified with the second argument.
+
+ \note Support for this argument was introduced in QDoc 5.6.
+
\section2 \c compatclasses
The \c compatclasses argument generates a list in alphabetical