summaryrefslogtreecommitdiffstats
path: root/tests
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2019-09-10 10:29:48 +0200
committerTopi Reiniƶ <topi.reinio@qt.io>2019-09-30 14:03:39 +0000
commit272488dbc0534aade4caeb446bb562fcbe74bb01 (patch)
treed112f2f019eebd7a78b3630824e6c19aa77576df /tests
parentbe8ffa4e910a3413bd3df907d8e15514691a0342 (diff)
qdoc: generatedoutput autotest: Test more C++ -related commands
Improve the coverage of C++ test with the following cases: * \macro taking an argument * A non-related member (above macro) associated with a class * \inheaderfile command * \since command Fix incorrect expected output since fixing the bug mentioned in the task number. Task-number: QTBUG-77960 Change-Id: I6010cab9ab0a86a1897a38a397b8d7ba8155f95a Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'tests')
-rw-r--r--tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html14
-rw-r--r--tests/auto/qdoc/generatedoutput/expected_output/testqdoc.html2
-rw-r--r--tests/auto/qdoc/generatedoutput/testcpp.cpp8
-rw-r--r--tests/auto/qdoc/generatedoutput/testcpp.h1
4 files changed, 24 insertions, 1 deletions
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html
index f0ef69491..0c7aa847d 100644
--- a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html
+++ b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html
@@ -13,6 +13,7 @@
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
+<li class="level1"><a href="#macros">Macros</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
@@ -33,6 +34,11 @@
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#inlineFunction">inlineFunction</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#someFunction">someFunction</a></b>(int <i>v</i>)</td></tr>
</table></div>
+<a name="macros"></a>
+<h2 id="macros">Macros</h2>
+<div class="table"><table class="alignedsummary">
+<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#QDOCTEST_MACRO2">QDOCTEST_MACRO2</a></b>(<i>x</i>)</td></tr>
+</table></div>
<a name="details"></a>
<!-- $$$Test-description -->
<div class="descr">
@@ -50,5 +56,13 @@
<p>Function that takes a parameter <i>v</i>. Also returns the value of <i>v</i>.</p>
<!-- @@@someFunction -->
</div>
+<div class="macros">
+<h2>Macro Documentation</h2>
+<!-- $$$QDOCTEST_MACRO2[overload1]$$$QDOCTEST_MACRO2 -->
+<h3 class="fn" id="QDOCTEST_MACRO2"><a name="QDOCTEST_MACRO2"></a><span class="name">QDOCTEST_MACRO2</span>(<i>x</i>)</h3>
+<p>A macro with argument <i>x</i>.</p>
+<p>This function was introduced in Test 1.1.</p>
+<!-- @@@QDOCTEST_MACRO2 -->
+</div>
</body>
</html>
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc.html b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc.html
index 055b859b5..e4c681ceb 100644
--- a/tests/auto/qdoc/generatedoutput/expected_output/testqdoc.html
+++ b/tests/auto/qdoc/generatedoutput/expected_output/testqdoc.html
@@ -23,7 +23,7 @@
<p>A namespace. <a href="#details">More...</a></p>
<!-- @@@TestQDoc -->
<div class="table"><table class="alignedsummary">
-<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;TestQDoc&gt;</span>
+<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;TestCPP&gt;</span>
</td></tr></table></div><ul>
</ul>
<a name="classes"></a>
diff --git a/tests/auto/qdoc/generatedoutput/testcpp.cpp b/tests/auto/qdoc/generatedoutput/testcpp.cpp
index 12698c9d6..1e1e271fc 100644
--- a/tests/auto/qdoc/generatedoutput/testcpp.cpp
+++ b/tests/auto/qdoc/generatedoutput/testcpp.cpp
@@ -37,6 +37,7 @@ namespace TestQDoc {
/*!
\namespace TestQDoc
+ \inheaderfile TestCPP
\inmodule TestCPP
\brief A namespace.
@@ -56,6 +57,13 @@ namespace TestQDoc {
*/
/*!
+ \macro QDOCTEST_MACRO2(x)
+ \relates TestQDoc::Test
+ \since Test 1.1
+ \brief A macro with argument \a x.
+*/
+
+/*!
Function that takes a parameter \a v.
Also returns the value of \a v.
*/
diff --git a/tests/auto/qdoc/generatedoutput/testcpp.h b/tests/auto/qdoc/generatedoutput/testcpp.h
index 46355711c..057d9683a 100644
--- a/tests/auto/qdoc/generatedoutput/testcpp.h
+++ b/tests/auto/qdoc/generatedoutput/testcpp.h
@@ -27,6 +27,7 @@
****************************************************************************/
#pragma once
#define QDOCTEST_MACRO test
+#define QDOCTEST_MACRO2(x) (x) < 0 ? 0 : (x))
namespace TestQDoc {