diff options
author | Martin Smith <martin.smith@digia.com> | 2015-07-06 15:31:45 +0200 |
---|---|---|
committer | Martin Smith <martin.smith@digia.com> | 2015-07-10 18:01:38 +0000 |
commit | 19751d368a5cb1de0487015c6a3ebf7677894181 (patch) | |
tree | 089099d0c8897a2ca166d9f7cb239e70ac2af5ae /src/tools/qdoc/node.h | |
parent | a6b0ac266cb2f9fd0d5e5d648d8133ed639e6676 (diff) |
qdoc: Add the noautolist command to qdoc
This update adds the \noautolist command to qdoc.
This command can be used in the qdoc comment for
a \module or \qmlmodule to tell qdoc not to write
the automatic annotated list of C++ classes or
QML types to the HTML page because the documenter
has listed them manually. The qdoc manual is also
updated to include the \noautolist command.
Change-Id: I2eac5ceebfcd83a41bca7384b3da038fffbe6e66
Task-number: QTBUG-46821
Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src/tools/qdoc/node.h')
-rw-r--r-- | src/tools/qdoc/node.h | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/src/tools/qdoc/node.h b/src/tools/qdoc/node.h index f852e480a6..27edfd1156 100644 --- a/src/tools/qdoc/node.h +++ b/src/tools/qdoc/node.h @@ -255,6 +255,7 @@ public: virtual QString element() const { return QString(); } virtual Tree* tree() const; virtual void findChildren(const QString& , NodeList& nodes) const { nodes.clear(); } + virtual void setNoAutoList(bool ) { } bool isIndexNode() const { return indexNodeFlag_; } NodeType type() const { return (NodeType) nodeType_; } virtual DocSubtype docSubtype() const { return NoSubtype; } @@ -1096,7 +1097,8 @@ class CollectionNode : public Aggregate CollectionNode(NodeType type, Aggregate* parent, const QString& name, - Genus genus) : Aggregate(type, parent, name), seen_(false) + Genus genus) + : Aggregate(type, parent, name), seen_(false), noAutoList_(false) { setPageType(Node::OverviewPage); setGenus(genus); @@ -1139,9 +1141,12 @@ class CollectionNode : public Aggregate void markSeen() { seen_ = true; } void markNotSeen() { seen_ = false; } + bool noAutoList() const { return noAutoList_; } + virtual void setNoAutoList(bool b) Q_DECL_OVERRIDE { noAutoList_ = b; } private: bool seen_; + bool noAutoList_; QString title_; QString subtitle_; NodeList members_; |