summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2020-10-20 15:35:58 +0200
committerTopi Reinio <topi.reinio@qt.io>2020-10-20 17:23:05 +0200
commit36eb21c7805c36ebb499822721e06b413d637ec1 (patch)
treeb3eb5471f94aa9d462259ba4e6db85fc1a58aad2
parent1c4ca3b8d08ea15dd34a8aba0ec5052a1c471ff1 (diff)
qdoc: Add 'private signal' attribute for private signals
Change-Id: Ifa2682c8bc3864dfd11abbb475b064e74c105a52 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
-rw-r--r--src/qdoc/codemarker.cpp6
-rw-r--r--tests/auto/qdoc/generatedoutput/expected_output/properties-docbook/testqdoc-testderived.xml2
-rw-r--r--tests/auto/qdoc/generatedoutput/expected_output/properties/testqdoc-testderived.html2
3 files changed, 6 insertions, 4 deletions
diff --git a/src/qdoc/codemarker.cpp b/src/qdoc/codemarker.cpp
index 8f24f3c1e..da0dbc60c 100644
--- a/src/qdoc/codemarker.cpp
+++ b/src/qdoc/codemarker.cpp
@@ -179,9 +179,11 @@ QString CodeMarker::extraSynopsis(const Node *node, Section::Style style)
else if (func->access() == Access::Private)
extra << "private";
- if (func->isSignal())
+ if (func->isSignal()) {
+ if (func->parameters().isPrivateSignal())
+ extra << "private";
extra << "signal";
- else if (func->isSlot())
+ } else if (func->isSlot())
extra << "slot";
else if (func->isDefault())
extra << "default";
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/properties-docbook/testqdoc-testderived.xml b/tests/auto/qdoc/generatedoutput/expected_output/properties-docbook/testqdoc-testderived.xml
index fd9eeace9..8e76081d3 100644
--- a/tests/auto/qdoc/generatedoutput/expected_output/properties-docbook/testqdoc-testderived.xml
+++ b/tests/auto/qdoc/generatedoutput/expected_output/properties-docbook/testqdoc-testderived.xml
@@ -166,7 +166,7 @@
<db:section xml:id="member-function-documentation">
<db:title>Member Function Documentation</db:title>
<db:section xml:id="emitSomething">
-<db:title>[signal] TestDerived::void emitSomething()</db:title>
+<db:title>[private signal] TestDerived::void emitSomething()</db:title>
<db:methodsynopsis>
<db:void/>
<db:methodname>emitSomething</db:methodname>
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/properties/testqdoc-testderived.html b/tests/auto/qdoc/generatedoutput/expected_output/properties/testqdoc-testderived.html
index d2e10db59..a5f180f5a 100644
--- a/tests/auto/qdoc/generatedoutput/expected_output/properties/testqdoc-testderived.html
+++ b/tests/auto/qdoc/generatedoutput/expected_output/properties/testqdoc-testderived.html
@@ -130,7 +130,7 @@ target_link_libraries(mytarget PUBLIC Qt::QDocTest)</td></tr><tr><td class="memI
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$emitSomething[overload1]$$$emitSomething -->
-<h3 class="fn" id="emitSomething"><a name="emitSomething"></a><code>[signal] </code><span class="type">void</span> TestDerived::<span class="name">emitSomething</span>()</h3>
+<h3 class="fn" id="emitSomething"><a name="emitSomething"></a><code>[private signal] </code><span class="type">void</span> TestDerived::<span class="name">emitSomething</span>()</h3>
<p>Emitted when things happen.</p>
<p><b>Note: </b>This is a private signal. It can be used in signal connections but cannot be emitted by the user.</p>
<!-- @@@emitSomething -->