Commit 68967cba authored by Levon Sargsyan's avatar Levon Sargsyan
Browse files

Add new input data to test \reimp command


The purpose of this change is to test the documentation that is
generated for comments that use QDoc's \reimp command.
This is done by adding a new virtual method to the Test class,
and a new inherited class that implements it.

Change-Id: If2367362475cc3daf31004dec43e8e15076acfb5
Reviewed-by: default avatarLevon Sargsyan <levon.sargsyan@qt.io>
Reviewed-by: default avatarTopi Reiniö <topi.reinio@qt.io>
Reviewed-by: default avatarPaul Wicking <paul.wicking@qt.io>
parent a3908f4a
Branches
Tags
No related merge requests found
Showing with 112 additions and 1 deletion
......@@ -31,6 +31,7 @@
<h2 id="classes">Classes</h2>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="testqdoc-test.html">TestQDoc::Test</a></p></td><td class="tblDescr"><p>A class in a namespace</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="testqdoc-testderived.html">TestQDoc::TestDerived</a></p></td><td class="tblDescr"><p>A derived class in a namespace</p></td></tr>
</table></div>
<!-- $$$TestCPP-description -->
<a name="details"></a>
......
......@@ -15,6 +15,7 @@
<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>
<li class="fn"><span class="name"><b><a href="testqdoc-test.html#virtualFun">virtualFun</a></b></span>()</li>
</ul>
</body>
</html>
......@@ -25,7 +25,8 @@
<!-- @@@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><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr></table></div><ul>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="testqdoc-testderived.html">TestQDoc::TestDerived</a></p>
</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>
......@@ -35,6 +36,7 @@
<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>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#virtualFun">virtualFun</a></b>()</td></tr>
</table></div>
<a name="macros"></a>
<h2 id="macros">Macros</h2>
......@@ -61,6 +63,10 @@
<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 -->
<!-- $$$virtualFun[overload1]$$$virtualFun -->
<h3 class="fn" id="virtualFun"><a name="virtualFun"></a><code>[virtual] </code><span class="type">void</span> Test::<span class="name">virtualFun</span>()</h3>
<p>Function that must be reimplemented.</p>
<!-- @@@virtualFun -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
......
<?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>List of All Members for TestDerived | TestCPP</title>
</head>
<body>
<li>TestDerived</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">List of All Members for TestDerived</h1>
<p>This is the complete list of members for <a href="testqdoc-testderived.html">TestQDoc::TestDerived</a>, including inherited members.</p>
<ul>
<li class="fn"><span class="name"><b><a href="testqdoc-test.html#QDOCTEST_MACRO2">QDOCTEST_MACRO2</a></b></span>()</li>
<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>
<li class="fn"><span class="name"><b><a href="testqdoc-testderived.html#virtualFun">virtualFun</a></b></span>()</li>
</ul>
</body>
</html>
<?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>TestDerived Class | TestCPP</title>
</head>
<body>
<li>TestDerived</li>
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#reimplemented-public-functions">Reimplemented Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">TestDerived Class</h1>
<span class="small-subtitle">(<a href="testqdoc-testderived.html">TestQDoc::TestDerived</a>)<br/></span>
<!-- $$$TestDerived-brief -->
<p>A derived class in a namespace. <a href="#details">More...</a></p>
<!-- @@@TestDerived -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;TestDerived&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="testqdoc-test.html">TestQDoc::Test</a></td></tr></table></div><ul>
<li><a href="testqdoc-testderived-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="reimplemented-public-functions"></a>
<h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#virtualFun">virtualFun</a></b>() override</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$TestDerived-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@TestDerived -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$virtualFun[overload1]$$$virtualFun -->
<h3 class="fn" id="virtualFun"><a name="virtualFun"></a><code>[override virtual] </code><span class="type">void</span> TestDerived::<span class="name">virtualFun</span>()</h3>
<p>Reimplements: <a href="testqdoc-test.html#virtualFun">Test::virtualFun</a>().</p>
<!-- @@@virtualFun -->
</div>
</body>
</html>
......@@ -30,6 +30,7 @@
<h2 id="classes">Classes</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html">Test</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html">TestDerived</a></b></td></tr>
</table></div>
<a name="macros"></a>
<h2 id="macros">Macros</h2>
......@@ -50,6 +51,9 @@
<h3> class <a href="testqdoc-test.html">Test</a></h3><!-- $$$Test-brief -->
<p>A class in a namespace. <a href="testqdoc-test.html#details">More...</a></p>
<!-- @@@Test -->
<h3> class <a href="testqdoc-testderived.html">TestDerived</a></h3><!-- $$$TestDerived-brief -->
<p>A derived class in a namespace. <a href="testqdoc-testderived.html#details">More...</a></p>
<!-- @@@TestDerived -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
......
......@@ -52,6 +52,12 @@ namespace TestQDoc {
\brief A class in a namespace.
*/
/*!
\class TestQDoc::TestDerived
\inmodule TestCPP
\brief A derived class in a namespace.
*/
/*!
\macro QDOCTEST_MACRO
\relates TestQDoc
......@@ -117,4 +123,20 @@ int Test::someFunction(int v)
\brief An inline function, documented using the \CMDFN QDoc command.
*/
/*!
Function that must be reimplemented.
*/
void Test::virtualFun()
{
return;
}
/*!
\reimp
*/
void TestDerived::virtualFun()
{
return;
}
} // namespace TestQDoc
......@@ -39,6 +39,12 @@ public:
void anotherObsoleteMember();
void deprecatedMember();
inline void inlineFunction() {};
virtual void virtualFun();
};
class TestDerived : public Test {
public:
void virtualFun() override;
};
} // namespace TestQDoc
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