From 70ec38e5242e72b25c0df085b9e87acdbdc2e0d2 Mon Sep 17 00:00:00 2001
From: Topi Reinio <topi.reinio@qt.io>
Date: Wed, 17 Jun 2020 13:23:55 +0200
Subject: qdoc: DocBook generator: Stop generating empty synopsis for shared
 nodes

Shared comment nodes must be skipped when generating DocBook synopsis
to avoid incorrect output and documentation warnings.

Fixes: QTBUG-82874
Change-Id: I8f9e4b0e921053dcd603a2f515eb59a6f42b4c84
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
(cherry picked from commit dbc3ea8150aebe8b4964c533c2f6faecfc01f816)
---
 src/qdoc/docbookgenerator.cpp                                      | 5 +++--
 .../qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml | 7 -------
 2 files changed, 3 insertions(+), 9 deletions(-)

diff --git a/src/qdoc/docbookgenerator.cpp b/src/qdoc/docbookgenerator.cpp
index 7e671e7d0..0ca480c87 100644
--- a/src/qdoc/docbookgenerator.cpp
+++ b/src/qdoc/docbookgenerator.cpp
@@ -2552,8 +2552,9 @@ void DocBookGenerator::generateDocBookSynopsis(const Node *node)
     if (config->getBool(CONFIG_DOCBOOKEXTENSIONS))
         return;
 
-    // Nothing to export in some cases.
-    if (node->isGroup() || node->isGroup() || node->isPropertyGroup() || node->isModule()
+    // Nothing to export in some cases. Note that isSharedCommentNode() returns
+    // true also for QML property groups.
+    if (node->isGroup() || node->isGroup() || node->isSharedCommentNode() || node->isModule()
         || node->isJsModule() || node->isQmlModule() || node->isPageNode())
         return;
 
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml b/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml
index 768e4d8f1..9c3d61096 100644
--- a/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml
+++ b/tests/auto/qdoc/generatedoutput/expected_output/docbook/testqdoc-test.xml
@@ -50,13 +50,6 @@
 <db:section xml:id="overload">
 <db:title>[protected] Test::void overload()</db:title>
 <db:bridgehead renderas="sect2" xml:id="overload-1">[protected] Test::void overload(bool <db:emphasis>b</db:emphasis>)</db:bridgehead>
-<db:synopsis>
-
-<db:synopsisinfo db:role="access">public</db:synopsisinfo>
-<db:synopsisinfo db:role="status">active</db:synopsisinfo>
-<db:synopsisinfo db:role="threadsafeness">unspecified</db:synopsisinfo>
-<db:synopsisinfo db:role="module">TestCPP</db:synopsisinfo>
-</db:synopsis>
 <db:para>Overloads that share a documentation comment, optionally taking a parameter <db:code role="parameter">b</db:code>.</db:para>
 <db:para>This function was introduced in Test 1.2.</db:para>
 </db:section>
-- 
cgit v1.2.3