summaryrefslogtreecommitdiffstats
path: root/src/qdoc
diff options
context:
space:
mode:
authorQt Forward Merge Bot <qt_forward_merge_bot@qt-project.org>2018-06-12 03:00:44 +0200
committerQt Forward Merge Bot <qt_forward_merge_bot@qt-project.org>2018-06-12 03:00:44 +0200
commit22265a4b0da495f88d407bb970573433f1a7f8f5 (patch)
tree1b5026b9e5205fe8787f5117ca3efac6c16e4667 /src/qdoc
parent23a3cd9143fd11678456aa54820bb9fb5cca25ca (diff)
parentd40265937d6fbd58be4ffd9fe78989506b4089fb (diff)
Merge remote-tracking branch 'origin/5.11' into dev
Diffstat (limited to 'src/qdoc')
-rw-r--r--src/qdoc/htmlgenerator.cpp15
-rw-r--r--src/qdoc/htmlgenerator.h2
2 files changed, 12 insertions, 5 deletions
diff --git a/src/qdoc/htmlgenerator.cpp b/src/qdoc/htmlgenerator.cpp
index 63e05118d..baec5c23b 100644
--- a/src/qdoc/htmlgenerator.cpp
+++ b/src/qdoc/htmlgenerator.cpp
@@ -1684,8 +1684,9 @@ void HtmlGenerator::generateDocumentNode(DocumentNode* dn, CodeMarker* marker)
subTitleSize,
dn,
marker);
-
- if (dn->docSubtype() == Node::HeaderFile) {
+ if (dn->isExample()) {
+ generateBrief(dn, marker, 0, false);
+ } else if (dn->docSubtype() == Node::HeaderFile) {
// Generate brief text and status for modules.
generateBrief(dn, marker);
generateStatus(dn, marker);
@@ -2362,10 +2363,15 @@ void HtmlGenerator::generateQmlRequisites(QmlTypeNode *qcn, CodeMarker *marker)
}
void HtmlGenerator::generateBrief(const Node *node, CodeMarker *marker,
- const Node *relative)
+ const Node *relative, bool addLink)
{
Text brief = node->doc().briefText();
+
if (!brief.isEmpty()) {
+ if (!brief.lastAtom()->string().endsWith('.')) {
+ brief << Atom(Atom::String, ".");
+ node->doc().location().warning(tr("'\\brief' statement does not end with a full stop."));
+ }
generateExtractionMark(node, BriefMark);
out() << "<p>";
generateText(brief, node, marker);
@@ -2374,8 +2380,9 @@ void HtmlGenerator::generateBrief(const Node *node, CodeMarker *marker,
out() << " <a href=\"#";
else
out() << " <a href=\"" << linkForNode(node, relative) << '#';
- out() << registerRef("details") << "\">More...</a></p>\n";
+ if (addLink)
+ out() << registerRef("details") << "\">More...</a></p>\n";
generateExtractionMark(node, EndMark);
}
diff --git a/src/qdoc/htmlgenerator.h b/src/qdoc/htmlgenerator.h
index 0743f7ebb..4ad85653f 100644
--- a/src/qdoc/htmlgenerator.h
+++ b/src/qdoc/htmlgenerator.h
@@ -124,7 +124,7 @@ private:
CodeMarker *marker);
void generateBrief(const Node *node,
CodeMarker *marker,
- const Node *relative = 0);
+ const Node *relative = 0, bool addLink=true);
void generateIncludes(const Aggregate *inner, CodeMarker *marker);
void generateTableOfContents(const Node *node,
CodeMarker *marker,