qdoc: Fix issues with processing of \brief statements

- Add \brief statements to example documentation pages, but without the
  'More...' link.
- Check whether a \brief ends in a full stop. If it doesn't, add one
  and generate a warning.

Task-number: QTBUG-60623
Change-Id: Ic1287ab173b7e46573d928fd6e1df8514f5f881d
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Martin Smith <martin.smith@qt.io>

2 files changed, 12 insertions, 5 deletions

diff --git a/src/qdoc/htmlgenerator.cpp b/src/qdoc/htmlgenerator.cpp
index 60ed94981..43ea57403 100644
--- a/src/qdoc/htmlgenerator.cpp
+++ b/src/qdoc/htmlgenerator.cpp
@@ -1749,8 +1749,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);
@@ -2436,10 +2437,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);
@@ -2448,8 +2454,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 37d6f47ae..c7f5bcdea 100644
--- a/src/qdoc/htmlgenerator.h
+++ b/src/qdoc/htmlgenerator.h
@@ -143,7 +143,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,