1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

QDoc: Prevent QDoc from outputting the brief for example pages.

Browse Source 
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>
This commit is contained in:
Jerome Pasion 2014-07-11 17:08:05 +02:00
parent 3f47becec0
commit d4cd55daa2
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/tools/qdoc/htmlgenerator.cpp
View File

@ -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;
}