summaryrefslogtreecommitdiff
path: root/src/qdoc/qdocindexfiles.cpp
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2020-01-23 23:42:18 +0100
committerTopi Reinio <topi.reinio@qt.io>2020-01-24 12:18:36 +0100
commit11e62fb056a715075b034a63e248d980bc88b29d (patch)
treee04385e278b93b8a44e6d3bb8a7a43dc7f87d91a /src/qdoc/qdocindexfiles.cpp
parentc0431f14b665a2d56ed7a064ba15e39f29905d77 (diff)
downloadqttools-11e62fb056a715075b034a63e248d980bc88b29d.tar.gz
qdoc: Ensure that \dontdocument works as expected
Class nodes marked with \dontdocument are not supposed to be seen in the generated documentation. They already did not generate an output page, but they still appeared as base classes in 'Inherits' information as well as class listings, resulting in broken links. Remove these nodes from all relevant lists. Handle Node::DontDocument status in the .index files, and add a test to cover \dontdocument usage. Fixes: QTBUG-81468 Change-Id: I933817ff0ebf372cfa493a5ea824b682e0b1b160 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/qdoc/qdocindexfiles.cpp')
-rw-r--r--src/qdoc/qdocindexfiles.cpp4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/qdoc/qdocindexfiles.cpp b/src/qdoc/qdocindexfiles.cpp
index c68d675ea..6a09571dd 100644
--- a/src/qdoc/qdocindexfiles.cpp
+++ b/src/qdoc/qdocindexfiles.cpp
@@ -587,6 +587,8 @@ void QDocIndexFiles::readIndexSection(QXmlStreamReader &reader, Node *current,
node->setStatus(Node::Active);
else if (status == QLatin1String("internal"))
node->setStatus(Node::Internal);
+ else if (status == QLatin1String("ignored"))
+ node->setStatus(Node::DontDocument);
else
node->setStatus(Node::Active);
@@ -737,6 +739,8 @@ static const QString getStatusString(Node::Status t)
return QLatin1String("active");
case Node::Internal:
return QLatin1String("internal");
+ case Node::DontDocument:
+ return QLatin1String("ignored");
default:
break;
}