Skip to content
GitLab
Commit 8107d604 authored by Levon Sargsyan's avatar Levon Sargsyan Committed by Paul Wicking
Browse files

Add new test data for htmlFromCpp test-point 


This change introduces several data updates for the test htmlFromCpp,
that will help us prevent possible regressions in the future.

Enhancements include:
1. CPP function with default arguments.
2. Usage of \qtvariable to produce appropriate qmake instructions.
3. Obsolete and deprecated members.

Change-Id: I9e1d346b43f515f649004d180d1ddead67df97b4
Reviewed-by: default avatarPaul Wicking <paul.wicking@qt.io>
parent a7fc802e
dev 5.14 5.14.0 5.14.1 5.14.2 5.15 5.15.0 5.15.1 5.15.2 6.0 6.0.0 6.1 6.1.0 6.1.1 6.1.2 6.1.3 6.2 6.2.0 6.2.1 6.2.2 wip/cmake v5.15.0-alpha1 v5.14.1 v5.14.0 v5.14.0-rc2 v5.14.0-rc1 v5.14.0-beta3 v5.14.0-beta2
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 89 additions and 2 deletions
tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test-members.html
+ 1
− 0
View file @ 8107d604
......@@ -14,6 +14,7 @@
<ul>
<li class="fn"><span class="name"><b><a href="testqdoc-test.html#inlineFunction">inlineFunction</a></b></span>()</li>
<li class="fn"><span class="name"><b><a href="testqdoc-test.html#someFunction">someFunction</a></b></span>(int ) : int</li>
<li class="fn"><span class="name"><b><a href="testqdoc-test.html#someFunctionDefaultArg">someFunctionDefaultArg</a></b></span>(int , bool )</li>
</ul>
</body>
</html>
tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test-obsolete.html 0 → 100644
+ 37
− 0
View file @ 8107d604
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- testcpp.cpp -->
<title>Obsolete Members for Test | TestCPP</title>
</head>
<body>
<li>Test</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Obsolete Members for Test</h1>
<p><b>The following members of class <a href="testqdoc-test.html">Test</a> are obsolete.</b> They are provided to keep old source code working. We strongly advise against using them in new code.</p>
<h2>Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> <code>(obsolete) </code>void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test-obsolete.html#anotherObsoleteMember">anotherObsoleteMember</a></b>()</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> <code>(obsolete) </code>void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test-obsolete.html#deprecatedMember">deprecatedMember</a></b>()</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> <code>(obsolete) </code>void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test-obsolete.html#obsoleteMember">obsoleteMember</a></b>()</td></tr>
</table></div>
<h2>Member Function Documentation</h2>
<!-- $$$anotherObsoleteMember[overload1]$$$anotherObsoleteMember -->
<h3 class="fn" id="anotherObsoleteMember"><a name="anotherObsoleteMember"></a><span class="type">void</span> Test::<span class="name">anotherObsoleteMember</span>()</h3>
<p>This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.</p>
<p>Use <a href="testqdoc-test-obsolete.html#obsoleteMember">obsoleteMember</a>() instead.</p>
<!-- @@@anotherObsoleteMember -->
<!-- $$$deprecatedMember[overload1]$$$deprecatedMember -->
<h3 class="fn" id="deprecatedMember"><a name="deprecatedMember"></a><span class="type">void</span> Test::<span class="name">deprecatedMember</span>()</h3>
<p>This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.</p>
<p>Use <a href="testqdoc-test.html#someFunction">someFunction</a>() instead.</p>
<!-- @@@deprecatedMember -->
<!-- $$$obsoleteMember[overload1]$$$obsoleteMember -->
<h3 class="fn" id="obsoleteMember"><a name="obsoleteMember"></a><span class="type">void</span> Test::<span class="name">obsoleteMember</span>()</h3>
<p>This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.</p>
<p>Use <a href="testqdoc-test.html#someFunction">someFunction</a>() instead.</p>
<!-- @@@obsoleteMember -->
</body>
</html>
tests/auto/qdoc/generatedoutput/expected_output/testqdoc-test.html
+ 7
− 1
View file @ 8107d604
......@@ -25,14 +25,16 @@
<!-- @@@Test -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;Test&gt;</span>
</td></tr></table></div><ul>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr></table></div><ul>
<li><a href="testqdoc-test-members.html">List of all members, including inherited members</a></li>
<li><a href="testqdoc-test-obsolete.html">Obsolete members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<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>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#someFunctionDefaultArg">someFunctionDefaultArg</a></b>(int <i>i</i>, bool <i>b</i> = false)</td></tr>
</table></div>
<a name="macros"></a>
<h2 id="macros">Macros</h2>
......@@ -55,6 +57,10 @@
<h3 class="fn" id="someFunction"><a name="someFunction"></a><span class="type">int</span> Test::<span class="name">someFunction</span>(<span class="type">int</span> <i>v</i>)</h3>
<p>Function that takes a parameter <i>v</i>. Also returns the value of <i>v</i>.</p>
<!-- @@@someFunction -->
<!-- $$$someFunctionDefaultArg[overload1]$$$someFunctionDefaultArgintbool -->
<h3 class="fn" id="someFunctionDefaultArg"><a name="someFunctionDefaultArg"></a><span class="type">void</span> Test::<span class="name">someFunctionDefaultArg</span>(<span class="type">int</span> <i>i</i>, <span class="type">bool</span> <i>b</i> = false)</h3>
<p>Function that takes a parameter <i>i</i> and <i>b</i>.</p>
<!-- @@@someFunctionDefaultArg -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
......
tests/auto/qdoc/generatedoutput/expected_output/testqdoc.html
+ 1
− 1
View file @ 8107d604
......@@ -24,7 +24,7 @@
<!-- @@@TestQDoc -->
<div class="table"><table class="alignedsummary">
<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>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr></table></div><ul>
</ul>
<a name="classes"></a>
<h2 id="classes">Classes</h2>
......
tests/auto/qdoc/generatedoutput/testcpp.cpp
+ 39
− 0
View file @ 8107d604
......@@ -31,6 +31,7 @@ namespace TestQDoc {
/*!
\module TestCPP
\qtvariable testcpp
\title QDoc Test C++ Classes
\brief A test module page.
*/
......@@ -63,6 +64,44 @@ namespace TestQDoc {
\brief A macro with argument \a x.
*/
/*!
\deprecated
Use someFunction() instead.
*/
void Test::deprecatedMember()
{
return;
}
/*!
\obsolete
Use someFunction() instead.
*/
void Test::obsoleteMember()
{
return;
}
/*!
\obsolete
Use obsoleteMember() instead.
*/
void Test::anotherObsoleteMember()
{
return;
}
/*!
Function that takes a parameter \a i and \a b.
*/
void Test::someFunctionDefaultArg(int i, bool b = false)
{
return;
}
/*!
Function that takes a parameter \a v.
Also returns the value of \a v.
......
tests/auto/qdoc/generatedoutput/testcpp.h
+ 4
− 0
View file @ 8107d604
......@@ -34,6 +34,10 @@ namespace TestQDoc {
class Test {
public:
int someFunction(int v);
void someFunctionDefaultArg(int i, bool b);
void obsoleteMember();
void anotherObsoleteMember();
void deprecatedMember();
inline void inlineFunction() {};
};
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment