summaryrefslogtreecommitdiffstats
path: root/src/tools
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2014-07-11 17:08:05 +0200
committerJerome Pasion <jerome.pasion@digia.com>2014-07-14 17:18:19 +0200
commitd4cd55daa24d8e183db7f60f8a8e452432808ea9 (patch)
tree73a619d3bea02e7f2b7ebae979d1f86a13044a18 /src/tools
parent3f47becec0e9fb7ed8a0bdaf1062b9d5b642cb6a (diff)
QDoc: Prevent QDoc from outputting the brief for example pages.
Example pages' \brief do not form a complete sentence. The example pages have proper introductions and descriptions, unlike API pages which do use the brief information to summarize. Change-Id: I11f1362cd05e3cf90ae8e1c3a07d2584737fd89c Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src/tools')
-rw-r--r--src/tools/qdoc/htmlgenerator.cpp3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/tools/qdoc/htmlgenerator.cpp b/src/tools/qdoc/htmlgenerator.cpp
index 34f2600118..8e50857258 100644
--- a/src/tools/qdoc/htmlgenerator.cpp
+++ b/src/tools/qdoc/htmlgenerator.cpp
@@ -342,7 +342,8 @@ int HtmlGenerator::generateAtom(const Atom *atom, const Node *relative, CodeMark
case Atom::BaseName:
break;
case Atom::BriefLeft:
- if (relative->isQmlBasicType() || (relative->isDocNode() && !relative->isExample())) {
+ //do not output the brief for QML basic types and doc nodes (including examples).
+ if (relative->isQmlBasicType() || relative->isDocNode()) {
skipAhead = skipAtoms(atom, Atom::BriefRight);
break;
}