summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@digia.com>2013-10-30 11:55:53 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-11-01 14:52:47 +0100
commit45b10ee02af53b712feacdce1d5c86af5a4079ad (patch)
treeeb8e28f185feed9e634e67a984e3ab9306658e54
parent0b152831ccee309f020435ab0737af6c73362dec (diff)
qdoc: Don't output docs for internal things
This update to the Generator base class prevents qdoc from writing an html file for anything that is marked \internal if the user has not set the showinternal flag. Task-number: QTBUG-34269 Change-Id: Ia60109d4568447501370bb9d4c1344a48f9b6113 Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Nico Vertriest <nico.vertriest@digia.com>
-rw-r--r--src/tools/qdoc/generator.cpp4
-rw-r--r--src/tools/qdoc/generator.h1
2 files changed, 5 insertions, 0 deletions
diff --git a/src/tools/qdoc/generator.cpp b/src/tools/qdoc/generator.cpp
index e6c5ae9062..357e013360 100644
--- a/src/tools/qdoc/generator.cpp
+++ b/src/tools/qdoc/generator.cpp
@@ -136,6 +136,7 @@ Generator::Generator()
inSectionHeading_(false),
inTableHeader_(false),
threeColumnEnumValueTable_(true),
+ showInternal_(false),
numTableRows_(0)
{
qdb_ = QDocDatabase::qdocDB();
@@ -964,6 +965,8 @@ void Generator::generateInnerNode(InnerNode* node)
return;
if (node->isIndexNode())
return;
+ if (node->isInternal() && !showInternal_)
+ return;
if (node->type() == Node::Document) {
DocNode* docNode = static_cast<DocNode*>(node);
@@ -1666,6 +1669,7 @@ void Generator::augmentImageDirs(QSet<QString>& moreImageDirs)
void Generator::initializeGenerator(const Config& config)
{
config_ = &config;
+ showInternal_ = config.getBool(CONFIG_SHOWINTERNAL);
}
bool Generator::matchAhead(const Atom *atom, Atom::Type expectedAtomType)
diff --git a/src/tools/qdoc/generator.h b/src/tools/qdoc/generator.h
index 52d73e8dea..b464014308 100644
--- a/src/tools/qdoc/generator.h
+++ b/src/tools/qdoc/generator.h
@@ -239,6 +239,7 @@ private:
bool inSectionHeading_;
bool inTableHeader_;
bool threeColumnEnumValueTable_;
+ bool showInternal_;
int numTableRows_;
QString link_;
QString sectionNumber_;