diff options
Diffstat (limited to 'src/qdoc/qdoc/tests/generatedoutput')
90 files changed, 4253 insertions, 0 deletions
diff --git a/src/qdoc/qdoc/tests/generatedoutput/CMakeLists.txt b/src/qdoc/qdoc/tests/generatedoutput/CMakeLists.txt new file mode 100644 index 000000000..1dea3ae59 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/CMakeLists.txt @@ -0,0 +1,46 @@ +# Copyright (C) 2022 The Qt Company Ltd. +# SPDX-License-Identifier: BSD-3-Clause + +# It's mostly manually written. + +##################################################################### +## tst_generatedOutput Test: +##################################################################### + +if(NOT QT_BUILD_STANDALONE_TESTS AND NOT QT_BUILDING_QT) + cmake_minimum_required(VERSION 3.16) + project(tst_generatedOutput LANGUAGES CXX) + find_package(Qt6BuildInternals REQUIRED COMPONENTS STANDALONE_TEST) +endif() + +qt_internal_add_test(tst_generatedOutput + SOURCES + ${CMAKE_CURRENT_LIST_DIR}/tst_generatedoutput.cpp +) + +# Write relevant Qt include path to a file, to be read in by QDoc +set(config_subfolder "") +get_cmake_property(is_multi_config GENERATOR_IS_MULTI_CONFIG) +if(is_multi_config) + set(config_subfolder "$<CONFIG>/") +endif() +set(includepathsfile "${CMAKE_CURRENT_BINARY_DIR}/${config_subfolder}qdocincludepaths.inc") +set(framework_path "\n") + +find_package(Qt6 COMPONENTS Core REQUIRED) +if(Qt6Core_FOUND) + get_target_property(include_paths Qt6::Core INTERFACE_INCLUDE_DIRECTORIES) +endif() + +while(include_paths) + list(POP_BACK include_paths inc_path) + if(inc_path MATCHES "(.+)/QtCore\.framework$") + string(APPEND framework_path "-F${CMAKE_MATCH_1}") + break() + endif() +endwhile() + +set (include_paths "$<TARGET_PROPERTY:tst_generatedOutput,INCLUDE_DIRECTORIES>") +file(GENERATE OUTPUT ${includepathsfile} CONTENT "-I$<JOIN:${include_paths},\n-I>${framework_path}") + +add_dependencies(tst_generatedOutput Qt::qdoc) diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/autolinking.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/autolinking.html new file mode 100644 index 000000000..ac04c33cd --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/autolinking.html @@ -0,0 +1,36 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- classlists.qdoc --> + <title>Autolinking | TestCPP</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#testqdoc">TestQDoc</a></li> +<li class="level1"><a href="#someprop">someProp</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">Autolinking</h1> +<!-- $$$autolinking.html-description --> +<div class="descr" id="details"> +<h2 id="testqdoc">TestQDoc</h2> +<p>The string <a href="testqdoc.html" translate="no">TestQDoc</a> links to the C++ namespace unless linking explicitly, <a href="autolinking.html#testqdoc">like this</a>, or <a href="testqdoc.html" translate="no">this</a>. Also,</p> +<p>Autolinks:</p> +<ul> +<li><a href="testqdoc-testderived.html" translate="no">TestQDoc::TestDerived</a></li> +</ul> +<p>Explicit links:</p> +<ul> +<li><a href="testqdoc-testderived.html" translate="no">TestQDoc::TestDerived</a></li> +<li><a href="obsolete-classes.html#testqdoc">Obsolete Classes#TestQDoc</a></li> +</ul> +<h2 id="someprop">someProp</h2> +</div> +<!-- @@@autolinking.html --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/cpptypes.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/cpptypes.html new file mode 100644 index 000000000..8d91afd76 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/cpptypes.html @@ -0,0 +1,25 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- classlists.qdoc --> + <title>Test C++ Types | TestCPP</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">Test C++ Types</h1> +<!-- $$$cpptypes-description --> +<div class="descr" id="details"> +<ul> +<li translate="no"><a href="testqdoc-test.html">TestQDoc::Test</a></li> +<li translate="no"><a href="testqdoc-test.html#QDOCTEST_MACRO2">TestQDoc::Test::QDOCTEST_MACRO2</a></li> +<li translate="no"><a href="testqdoc-test.html#operator-eq">TestQDoc::Test::operator=()</a></li> +<li translate="no"><a href="testqdoc-test.html#someFunctionDefaultArg">TestQDoc::Test::someFunctionDefaultArg()</a></li> +</ul> +</div> +<!-- @@@cpptypes --> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="testqdoc-test.html">TestQDoc::Test</a></p></td><td class="tblDescr"><p>A class in a namespace</p></td></tr> +</table></div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/crossmodule/crossmodule/all-namespaces.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/crossmodule/crossmodule/all-namespaces.html new file mode 100644 index 000000000..8d23c2aef --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/crossmodule/crossmodule/all-namespaces.html @@ -0,0 +1,20 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- namespaces.qdoc --> + <title>Namespaces | CrossModule</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">Namespaces</h1> +<!-- $$$all-namespaces.html-description --> +<div class="descr" id="details"> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="crossmoduleref.html">CrossModuleRef</a></p></td><td class="tblDescr"><p>Namespace that has documented functions in multiple modules</p></td></tr> +<tr class="even topAlign"><td class="tblName" translate="no"><p><a href="testqdoc.html">TestQDoc</a></p></td><td class="tblDescr"><p>A namespace</p></td></tr> +</table></div> +</div> +<!-- @@@all-namespaces.html --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/crossmodule/crossmodule/testtype-members.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/crossmodule/crossmodule/testtype-members.html new file mode 100644 index 000000000..0cb92b933 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/crossmodule/crossmodule/testtype-members.html @@ -0,0 +1,37 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testtype.cpp --> + <meta name="description" content="A class inheriting another class that lives in an external doc module."> + <title>List of All Members for TestType | CrossModule</title> +</head> +<body> +<li>TestType</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for TestType</h1> +<p>This is the complete list of members for <a href="testtype.html">TestType</a>, including inherited members.</p> +<div class="table"><table class="propsummary" translate="no"> +<tr><td class="topAlign"><ul> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#DerivedType-typedef" translate="no">DerivedType</a></b></span></li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#NotTypedef-typedef" translate="no">NotTypedef</a></b></span></li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#SomeType-typedef" translate="no">SomeType</a></b></span></li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#funcPtr" translate="no">funcPtr</a></b></span>(bool, const char *) : void (*)(bool)</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#inlineFunction" translate="no">inlineFunction</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#methodWithEmDashInItsDocs" translate="no">methodWithEmDashInItsDocs</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#methodWithEnDashInItsDocs" translate="no">methodWithEnDashInItsDocs</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testtype.html#nothing" translate="no">nothing</a></b></span>()</li> +</ul></td><td class="topAlign"><ul> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#overload" translate="no">overload</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#overload-1" translate="no">overload</a></b></span>(bool)</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#someFunction" translate="no">someFunction</a></b></span>(int, int) : int</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#someFunctionDefaultArg" translate="no">someFunctionDefaultArg</a></b></span>(int, bool) const</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#someValue" translate="no">someValue</a></b></span>() : TestQDoc::TestDerived::NotTypedef</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#virtualFun" translate="no">virtualFun</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#virtualFun" translate="no">virtualFun</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#operator-eq" translate="no">operator=</a></b></span>(TestQDoc::Test &&) : TestQDoc::Test &</li> +</ul> +</td></tr> +</table></div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/crossmodule/crossmodule/testtype.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/crossmodule/crossmodule/testtype.html new file mode 100644 index 000000000..ed8bfc96c --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/crossmodule/crossmodule/testtype.html @@ -0,0 +1,67 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testtype.cpp --> + <meta name="description" content="A class inheriting another class that lives in an external doc module."> + <title>TestType Class | CrossModule</title> +</head> +<body> +<li>TestType</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#public-functions">Public Functions</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +<li class="level2"><a href="#linking">Linking</a></li> +<li class="level2"><a href="#generated-lists">Generated Lists</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">TestType Class</h1> +<!-- $$$TestType-brief --> +<p>A class inheriting another class that lives in an external doc module. <a href="#details">More...</a></p> +<!-- @@@TestType --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <TestType></span></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="testqdoc-testderived.html" translate="no">TestQDoc::TestDerived</a></td></tr> +</table></div> +<ul> +<li><a href="testtype-members.html">List of all members, including inherited members</a></li> +</ul> +<h2 id="public-functions">Public Functions</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testtype.html#nothing" translate="no">nothing</a></b>()</td></tr> +</table></div> +<!-- $$$TestType-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +<h3 id="linking">Linking</h3> +<p>These links go to the parent class:</p> +<ul> +<li><a href="testqdoc-testderived.html" translate="no">TestQDoc::TestDerived</a></li> +<li><a href="testqdoc-test.html" translate="no">Test</a> class <a href="testqdoc.html#usage" translate="no">Usage</a>.</li> +<li><a href="testqdoc.html#QDOCTEST_MACRO" translate="no">QDOCTEST_MACRO</a></li> +<li>DontLinkToMe</li> +</ul> +<h3 id="generated-lists">Generated Lists</h3> +<p>This is an annotated list of entries in a group: <div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><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" translate="no"><p><a href="testqdoc-test.html#QDOCTEST_MACRO2">TestQDoc::Test::QDOCTEST_MACRO2</a></p></td><td class="tblDescr"><p>A macro with argument x</p></td></tr> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="testqdoc-test.html#operator-eq">TestQDoc::Test::operator=()</a></p></td></tr> +<tr class="even topAlign"><td class="tblName" translate="no"><p><a href="testqdoc-test.html#someFunctionDefaultArg">TestQDoc::Test::someFunctionDefaultArg()</a></p></td></tr> +</table></div> +</p> +</div> +<p><b>See also </b><a href="testqdoc-test.html#someFunction" translate="no">someFunction</a>().</p> +<!-- @@@TestType --> +<div class="func"> +<h2>Member Function Documentation</h2> +<!-- $$$nothing[overload1]$$$nothing --> +<h3 class="fn" translate="no" id="nothing"><span class="type">void</span> TestType::<span class="name">nothing</span>()</h3> +<p>Nothing to see here.</p> +<!-- @@@nothing --> +</div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/crossmodule/crossmoduleref-sub-crossmodule.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/crossmodule/crossmoduleref-sub-crossmodule.html new file mode 100644 index 000000000..7d40a92d6 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/crossmodule/crossmoduleref-sub-crossmodule.html @@ -0,0 +1,30 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>CrossModuleRef Namespace | CrossModule</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#functions">Functions</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">CrossModuleRef Namespace</h1> +<p>The CrossModuleRef namespace includes the following elements from module CrossModule. The full namespace is documented in module TestCPP<a href="crossmoduleref.html" translate="no"> here.</a></p> +<h2 id="functions">Functions</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="crossmoduleref-sub-crossmodule.html#documentMeToo" translate="no">documentMeToo</a></b>()</td></tr> +</table></div> +<div class="func"> +<h2>Function Documentation</h2> +<!-- $$$documentMeToo[overload1]$$$documentMeToo --> +<h3 class="fn" translate="no" id="documentMeToo"><span class="type">void</span> CrossModuleRef::<span class="name">documentMeToo</span>()</h3> +<p>Function under a namespace that's documented elsewhere.</p> +<!-- @@@documentMeToo --> +</div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/crossmodule/testtype-members.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/crossmodule/testtype-members.html new file mode 100644 index 000000000..0cb92b933 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/crossmodule/testtype-members.html @@ -0,0 +1,37 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testtype.cpp --> + <meta name="description" content="A class inheriting another class that lives in an external doc module."> + <title>List of All Members for TestType | CrossModule</title> +</head> +<body> +<li>TestType</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for TestType</h1> +<p>This is the complete list of members for <a href="testtype.html">TestType</a>, including inherited members.</p> +<div class="table"><table class="propsummary" translate="no"> +<tr><td class="topAlign"><ul> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#DerivedType-typedef" translate="no">DerivedType</a></b></span></li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#NotTypedef-typedef" translate="no">NotTypedef</a></b></span></li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#SomeType-typedef" translate="no">SomeType</a></b></span></li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#funcPtr" translate="no">funcPtr</a></b></span>(bool, const char *) : void (*)(bool)</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#inlineFunction" translate="no">inlineFunction</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#methodWithEmDashInItsDocs" translate="no">methodWithEmDashInItsDocs</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#methodWithEnDashInItsDocs" translate="no">methodWithEnDashInItsDocs</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testtype.html#nothing" translate="no">nothing</a></b></span>()</li> +</ul></td><td class="topAlign"><ul> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#overload" translate="no">overload</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#overload-1" translate="no">overload</a></b></span>(bool)</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#someFunction" translate="no">someFunction</a></b></span>(int, int) : int</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#someFunctionDefaultArg" translate="no">someFunctionDefaultArg</a></b></span>(int, bool) const</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#someValue" translate="no">someValue</a></b></span>() : TestQDoc::TestDerived::NotTypedef</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#virtualFun" translate="no">virtualFun</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#virtualFun" translate="no">virtualFun</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#operator-eq" translate="no">operator=</a></b></span>(TestQDoc::Test &&) : TestQDoc::Test &</li> +</ul> +</td></tr> +</table></div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/crossmodule/testtype.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/crossmodule/testtype.html new file mode 100644 index 000000000..ed8bfc96c --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/crossmodule/testtype.html @@ -0,0 +1,67 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testtype.cpp --> + <meta name="description" content="A class inheriting another class that lives in an external doc module."> + <title>TestType Class | CrossModule</title> +</head> +<body> +<li>TestType</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#public-functions">Public Functions</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +<li class="level2"><a href="#linking">Linking</a></li> +<li class="level2"><a href="#generated-lists">Generated Lists</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">TestType Class</h1> +<!-- $$$TestType-brief --> +<p>A class inheriting another class that lives in an external doc module. <a href="#details">More...</a></p> +<!-- @@@TestType --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <TestType></span></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="testqdoc-testderived.html" translate="no">TestQDoc::TestDerived</a></td></tr> +</table></div> +<ul> +<li><a href="testtype-members.html">List of all members, including inherited members</a></li> +</ul> +<h2 id="public-functions">Public Functions</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testtype.html#nothing" translate="no">nothing</a></b>()</td></tr> +</table></div> +<!-- $$$TestType-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +<h3 id="linking">Linking</h3> +<p>These links go to the parent class:</p> +<ul> +<li><a href="testqdoc-testderived.html" translate="no">TestQDoc::TestDerived</a></li> +<li><a href="testqdoc-test.html" translate="no">Test</a> class <a href="testqdoc.html#usage" translate="no">Usage</a>.</li> +<li><a href="testqdoc.html#QDOCTEST_MACRO" translate="no">QDOCTEST_MACRO</a></li> +<li>DontLinkToMe</li> +</ul> +<h3 id="generated-lists">Generated Lists</h3> +<p>This is an annotated list of entries in a group: <div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><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" translate="no"><p><a href="testqdoc-test.html#QDOCTEST_MACRO2">TestQDoc::Test::QDOCTEST_MACRO2</a></p></td><td class="tblDescr"><p>A macro with argument x</p></td></tr> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="testqdoc-test.html#operator-eq">TestQDoc::Test::operator=()</a></p></td></tr> +<tr class="even topAlign"><td class="tblName" translate="no"><p><a href="testqdoc-test.html#someFunctionDefaultArg">TestQDoc::Test::someFunctionDefaultArg()</a></p></td></tr> +</table></div> +</p> +</div> +<p><b>See also </b><a href="testqdoc-test.html#someFunction" translate="no">someFunction</a>().</p> +<!-- @@@TestType --> +<div class="func"> +<h2>Member Function Documentation</h2> +<!-- $$$nothing[overload1]$$$nothing --> +<h3 class="fn" translate="no" id="nothing"><span class="type">void</span> TestType::<span class="name">nothing</span>()</h3> +<p>Nothing to see here.</p> +<!-- @@@nothing --> +</div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/includefromexampledirs/index.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/includefromexampledirs/index.html new file mode 100644 index 000000000..0d984f60d --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/includefromexampledirs/index.html @@ -0,0 +1,27 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- includefromparent.qdoc --> + <title>doc index | Test</title> +</head> +<body> +<h1 class="title">doc index</h1> +<!-- $$$index.html-description --> +<div class="descr" id="details"> +<h2 id="c-classes">C++ Classes</h2> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><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" translate="no"><p><a href="testqdoc-testderived.html">TestQDoc::TestDerived</a></p></td><td class="tblDescr"><p>A class in a namespace, derived from Test</p></td></tr> +</table></div> +<h2 id="qml-types">QML Types</h2> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="qml-qdoc-test-abstractparent.html">AbstractParent</a></p></td><td class="tblDescr"><p>Abstract base QML type</p></td></tr> +<tr class="even topAlign"><td class="tblName" translate="no"><p><a href="qml-qdoc-test-child.html">Child</a></p></td><td class="tblDescr"><p>A Child inheriting its parent</p></td></tr> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="qml-int.html">int</a></p></td><td class="tblDescr"><p>An integer value type</p></td></tr> +</table></div> +<p>Test include file that is part of the sourcedirs.</p> +</div> +<!-- @@@index.html --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-abstractparent-members.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-abstractparent-members.html new file mode 100644 index 000000000..beb7792f7 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-abstractparent-members.html @@ -0,0 +1,20 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- includefromparent.qdoc --> + <meta name="description" content="Abstract base QML type."> + <title>List of All Members for AbstractParent | Test</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li>AbstractParent</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for AbstractParent</h1> +<p>This is the complete list of members for <a href="qml-qdoc-test-abstractparent.html">AbstractParent</a>, including inherited members.</p> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-abstractparent.html#children-prop" translate="no">children</a></b> : list<Child> [default]</li> +<li class="fn" translate="no">void <b><a href="qml-qdoc-test-abstractparent.html#rear-method" translate="no">rear</a></b>(Child <i>child</i>)</li> +</ul> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-abstractparent.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-abstractparent.html new file mode 100644 index 000000000..6d6d47838 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/includefromexampledirs/qml-qdoc-test-abstractparent.html @@ -0,0 +1,68 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- includefromparent.qdoc --> + <meta name="description" content="Abstract base QML type."> + <title>AbstractParent QML Type | Test</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li>AbstractParent</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#properties">Properties</a></li> +<li class="level1"><a href="#methods">Methods</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" translate="no">AbstractParent QML Type</h1> +<!-- $$$AbstractParent-brief --> +<p>Abstract base QML type. <a href="#details">More...</a></p> +<!-- @@@AbstractParent --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QDoc.Test 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qdoc-test-child.html" translate="no">Child</a></p> +</td></tr></table></div><ul> +<li><a href="qml-qdoc-test-abstractparent-members.html">List of all members, including inherited members</a></li> +</ul> +<h2 id="properties">Properties</h2> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-abstractparent.html#children-prop" translate="no">children</a></b> : list<Child></li> +</ul> +<h2 id="methods">Methods</h2> +<ul> +<li class="fn" translate="no">void <b><a href="qml-qdoc-test-abstractparent.html#rear-method" translate="no">rear</a></b>(Child <i>child</i>)</li> +</ul> +<!-- $$$AbstractParent-description --> +<h2 id="details">Detailed Description</h2> +<p>Test include file that is part of the sourcedirs.</p> +<!-- @@@AbstractParent --> +<h2>Property Documentation</h2> +<!-- $$$children --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="children-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">children</span> : <span class="type">list</span><<span class="type"><a href="qml-qdoc-test-child.html" translate="no">Child</a></span>> <code class="details extra" translate="no">[default]</code></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Children of the type.</p> +<p>Test include file that is part of the sourcedirs.</p> +</div></div><!-- @@@children --> +<br/> +<h2>Method Documentation</h2> +<!-- $$$rear[overload1]$$$rearChild --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="odd" id="rear-method"> +<td class="tblQmlFuncNode"><p> +<span class="type">void</span> <span class="name">rear</span>(<span class="type"><a href="qml-qdoc-test-child.html" translate="no">Child</a></span> <i>child</i>)</p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Do some abstract parenting on <i translate="no">child</i>.</p> +<p>Test include file that is part of the sourcedirs.</p> +</div></div><!-- @@@rear --> +<br/> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/index-linking.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/index-linking.html new file mode 100644 index 000000000..694a3f061 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/index-linking.html @@ -0,0 +1,37 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- linking.qdoc --> + <title>Linking | IndexLinking</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#qml-properties">QML properties</a></li> +<li class="level1"><a href="#auto-linking-to-types-in-code-snippets">Auto-linking to types in code snippets</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">Linking</h1> +<!-- $$$index-linking.html-description --> +<div class="descr" id="details"> +<h2 id="qml-properties">QML properties</h2> +<ol class="A" type="A"><li>Property group: <a href="https://doc.qt.io/QmlPropertyGroups/qml-qdoc-test-parent.html#group-prop" translate="no">Parent::group</a>.</li> +<li>Property in a group: <a href="https://doc.qt.io/QmlPropertyGroups/qml-qdoc-test-parent.html#group.c-prop" translate="no">QDoc.Test::Parent::group.c</a>.</li> +</ol> +<h2 id="auto-linking-to-types-in-code-snippets">Auto-linking to types in code snippets</h2> +<pre class="qml" translate="no">import QtQuick + +<span class="type"><a href="https://doc.qt.io/QmlPropertyGroups/qml-uicomponents-progressbar.html" translate="no">ProgressBar</a></span> { + <span class="comment">// Linking to int value type</span> + property <span class="type"><a href="https://doc.qt.io/QmlPropertyGroups/qml-int.html" translate="no">int</a></span> <span class="name">progress</span>: <span class="number">0</span> +}</pre> +<pre class="cpp" translate="no"><span class="comment">// 'int' should not link anywhere in C++ code</span> +<span class="type">int</span> main() { <span class="type">int</span> x{<span class="number">0</span>}; <span class="keyword">return</span> x; }</pre> +</div> +<!-- @@@index-linking.html --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/noautolist-docbook/qdoc-test-qmlmodule.xml b/src/qdoc/qdoc/tests/generatedoutput/expected_output/noautolist-docbook/qdoc-test-qmlmodule.xml new file mode 100644 index 000000000..73a5f9653 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/noautolist-docbook/qdoc-test-qmlmodule.xml @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>QDoc.Test QML Module</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>QML Types for the Test module.</db:para> +<db:para><db:emphasis role="bold">This module is under development and is subject to change.</db:emphasis></db:para> +<db:para>This module was introduced in Qt 1.1.</db:para> +</db:abstract> +</db:info> +<db:para><db:emphasis role="bold">This module is under development and is subject to change.</db:emphasis></db:para> +<db:para>This module was introduced in Qt 1.1.</db:para> +<db:anchor xml:id="details"/> +</db:article> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/noautolist-docbook/test-componentset-example.xml b/src/qdoc/qdoc/tests/generatedoutput/expected_output/noautolist-docbook/test-componentset-example.xml new file mode 100644 index 000000000..609b7cec9 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/noautolist-docbook/test-componentset-example.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>QML Documentation Example</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>Example for documenting QML types.</db:para> +</db:abstract> +</db:info> +<db:para>This example demonstrates one of the ways to document QML types. It also generates a warning about a missing example image, on purpose.</db:para> +<db:para>In particular, there are sample types that are documented with QDoc commands comments. There are documentation comments for the QML types and their public interfaces. The types are grouped into a module, the <db:link xlink:href="uicomponents-qmlmodule.xml">UI Components</db:link> module.</db:para> +<db:para>The uicomponents.qdoc file generates the overview page for the <db:link xlink:href="uicomponents-qmlmodule.xml">UI Components</db:link> module page.</db:para> +<db:para>The generated documentation is available in the <db:link xlink:href="uicomponents-qmlmodule.xml">UI Components</db:link> module.</db:para> +<db:section xml:id="qml-class"> +<db:title>QML Class</db:title> +<db:para>The QML types use the \qmltype to document the type. In addition, they have the \inmodule command in order for QDoc to associate them to the <db:code>UIComponents</db:code> module.</db:para> +<db:para>QDoc uses the \brief command to place a basic description when listing the types.</db:para> +</db:section> +<db:section xml:id="properties-signals-handlers-and-methods"> +<db:title>Properties, Signals, Handlers, and Methods</db:title> +<db:para>The types have their properties, signals, handlers, and methods defined in their respective QML files. QDoc associates the properties and methods to the types, therefore, you only need to place the documentation above the property, method, or signal.</db:para> +<db:para>To document the type of a <db:emphasis>property alias</db:emphasis>, you must use the \qmlproperty command to specify the data type.</db:para> +<db:programlisting language="cpp">\qmlproperty int anAliasedProperty +An aliased property of type int. +</db:programlisting> +<db:section xml:id="internal-documentation"> +<db:title>Internal Documentation</db:title> +<db:para>You may declare that a documentation is for internal use by placing the \internal command after the beginning QDoc comment <db:code>/*</db:code>. QDoc will prevent the internal documentation from appearing in the public API.</db:para> +<db:para>If you wish to omit certain parts of the documentation, you may use the \omit and \endomit command.</db:para> +</db:section> +</db:section> +<db:section xml:id="qml-types-with-c-implementation"> +<db:title>QML Types with C++ Implementation</db:title> +<db:para>This example only demonstrates the documentation for types in QML files, but the regular QML commands may be placed inside C++ classes to define the public API of the QML type.</db:para> +</db:section> +</db:article> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/noautolist-docbook/testcpp-module.xml b/src/qdoc/qdoc/tests/generatedoutput/expected_output/noautolist-docbook/testcpp-module.xml new file mode 100644 index 000000000..3217c0d94 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/noautolist-docbook/testcpp-module.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>QDoc Test C++ Classes</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>A test module page.</db:para> +<db:para>This module was introduced in Qt 2.0.</db:para> +</db:abstract> +</db:info> +<db:para>A test module page.</db:para> +<db:para>This module was introduced in Qt 2.0.</db:para> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +<db:note> +<db:para>This is just a test. /* Look, Ma! {I'm made of arguments!} */</db:para> +</db:note> +<db:section xml:id="linking-to-function-like-things"> +<db:title>Linking to function-like things</db:title> +<db:itemizedlist> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-test.xml#someFunctionDefaultArg">someFunctionDefaultArg</db:link>()</db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-test.xml#QDOCTEST_MACRO2">QDOCTEST_MACRO2</db:link>()</db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-test.xml#QDOCTEST_MACRO2">QDOCTEST_MACRO2</db:link>(int &x)</db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="testcpp-module.xml#section">section()</db:link></db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="testcpp-module.xml#section">section() is a section title</db:link></db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="testqdoc-test.xml#Test">open( parenthesis</db:link></db:para> +</db:listitem> +<db:listitem> +<db:para><db:link xlink:href="https://en.cppreference.com/w/cpp/utility/move">C++11 added std::move(T&& t)</db:link></db:para> +</db:listitem> +</db:itemizedlist> +<db:section xml:id="section"> +<db:title>section()</db:title> +</db:section> +</db:section> +</db:section> +</db:article> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/noautolist/qdoc-test-qmlmodule.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/noautolist/qdoc-test-qmlmodule.html new file mode 100644 index 000000000..23c56acef --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/noautolist/qdoc-test-qmlmodule.html @@ -0,0 +1,19 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- type.cpp --> + <meta name="description" content="QML Types for the Test module."> + <title>QDoc.Test QML Module | Test</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">QDoc.Test QML Module</h1> +<p><b>This module is under development and is subject to change.</b></p> +<p>This module was introduced in Qt 1.1.</p> +<!-- $$$QDoc.Test-description --> +<div class="descr" id="details"> +</div> +<!-- @@@QDoc.Test --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/noautolist/test-componentset-example.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/noautolist/test-componentset-example.html new file mode 100644 index 000000000..a6d63699b --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/noautolist/test-componentset-example.html @@ -0,0 +1,47 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- examples.qdoc --> + <meta name="description" content="Example for documenting QML types."> + <title>QML Documentation Example | Test</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#qml-class">QML Class</a></li> +<li class="level1"><a href="#properties-signals-handlers-and-methods">Properties, Signals, Handlers, and Methods</a></li> +<li class="level2"><a href="#internal-documentation">Internal Documentation</a></li> +<li class="level1"><a href="#qml-types-with-c-implementation">QML Types with C++ Implementation</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">QML Documentation Example</h1> +<!-- $$$componentset-brief --> +<p>Example for documenting QML types.</p> +<!-- @@@componentset --> +<!-- $$$componentset-description --> +<div class="descr" id="details"> +<p>This example demonstrates one of the ways to document QML types. It also generates a warning about a missing example image, on purpose.</p> +<p>In particular, there are sample types that are documented with QDoc commands comments. There are documentation comments for the QML types and their public interfaces. The types are grouped into a module, the <a href="uicomponents-qmlmodule.html" translate="no">UI Components</a> module.</p> +<p>The uicomponents.qdoc file generates the overview page for the <a href="uicomponents-qmlmodule.html" translate="no">UI Components</a> module page.</p> +<p>The generated documentation is available in the <a href="uicomponents-qmlmodule.html" translate="no">UI Components</a> module.</p> +<h4 id="qml-class">QML Class</h4> +<p>The QML types use the \qmltype to document the type. In addition, they have the \inmodule command in order for QDoc to associate them to the <code translate="no">UIComponents</code> module.</p> +<p>QDoc uses the \brief command to place a basic description when listing the types.</p> +<h4 id="properties-signals-handlers-and-methods">Properties, Signals, Handlers, and Methods</h4> +<p>The types have their properties, signals, handlers, and methods defined in their respective QML files. QDoc associates the properties and methods to the types, therefore, you only need to place the documentation above the property, method, or signal.</p> +<p>To document the type of a <i>property alias</i>, you must use the \qmlproperty command to specify the data type.</p> +<pre class="cpp" translate="no">\qmlproperty <span class="type">int</span> anAliasedProperty +An aliased property of type <span class="type">int</span><span class="operator">.</span></pre> +<h5 id="internal-documentation">Internal Documentation</h5> +<p>You may declare that a documentation is for internal use by placing the \internal command after the beginning QDoc comment <code translate="no">/*</code>. QDoc will prevent the internal documentation from appearing in the public API.</p> +<p>If you wish to omit certain parts of the documentation, you may use the \omit and \endomit command.</p> +<h4 id="qml-types-with-c-implementation">QML Types with C++ Implementation</h4> +<p>This example only demonstrates the documentation for types in QML files, but the regular QML commands may be placed inside C++ classes to define the public API of the QML type.</p> +</div> +<!-- @@@componentset --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/noautolist/testcpp-module.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/noautolist/testcpp-module.html new file mode 100644 index 000000000..6b58461da --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/noautolist/testcpp-module.html @@ -0,0 +1,45 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A test module page."> + <title>QDoc Test C++ Classes | Test</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#details">Detailed Description</a></li> +<li class="level2"><a href="#linking-to-function-like-things">Linking to function-like things</a></li> +<li class="level3"><a href="#section">section()</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">QDoc Test C++ Classes</h1> +<!-- $$$TestCPP-brief --> +<p>A test module page. <a href="#details">More...</a></p> +<!-- @@@TestCPP --> +<p>This module was introduced in Qt 2.0.</p> +<!-- $$$TestCPP-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +<div class="admonition note"> +<p><b>Note: </b>This is just a test. /* Look, Ma! {I'm made of arguments!} */</p> +</div> +<h3 id="linking-to-function-like-things">Linking to function-like things</h3> +<ul> +<li><a href="testqdoc-test.html#someFunctionDefaultArg" translate="no">someFunctionDefaultArg</a>()</li> +<li><a href="testqdoc-test.html#QDOCTEST_MACRO2" translate="no">QDOCTEST_MACRO2</a>()</li> +<li><a href="testqdoc-test.html#QDOCTEST_MACRO2" translate="no">QDOCTEST_MACRO2</a>(int &x)</li> +<li><a href="testcpp-module.html#section" translate="no">section()</a></li> +<li><a href="testcpp-module.html#section" translate="no">section() is a section title</a></li> +<li><a href="testqdoc-test.html#Test" translate="no">open( parenthesis</a></li> +<li><a href="https://en.cppreference.com/w/cpp/utility/move">C++11 added std::move(T&& t)</a></li> +</ul> +<h4 id="section">section()</h4> +</div> +<!-- @@@TestCPP --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/obsolete-classes.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/obsolete-classes.html new file mode 100644 index 000000000..01198c82d --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/obsolete-classes.html @@ -0,0 +1,32 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- classlists.qdoc --> + <title>Obsolete Classes | TestCPP</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#classes-with-obsolete-members">Classes with obsolete members</a></li> +<li class="level2"><a href="#testqdoc">TestQDoc</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">Obsolete Classes</h1> +<!-- $$$obsolete-classes.html-description --> +<div class="descr" id="details"> +<h2 id="classes-with-obsolete-members">Classes with obsolete members</h2> +<div class="flowListDiv" translate="no"> +<dl class="flowList odd"><dt class="alphaChar"><b>T</b></dt> +<dd><a href="testqdoc-test-obsolete.html">Test</a> (<a href="testqdoc.html">TestQDoc</a>)</dd> +<dd><a href="testqdoc-testderived-obsolete.html">TestDerived</a> (<a href="testqdoc.html">TestQDoc</a>)</dd> +</dl> +</div> +<h3 id="testqdoc">TestQDoc</h3> +</div> +<!-- @@@obsolete-classes.html --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/qml-linkmodule-grandchild-members.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/qml-linkmodule-grandchild-members.html new file mode 100644 index 000000000..7bec0458b --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/qml-linkmodule-grandchild-members.html @@ -0,0 +1,26 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- linking.qdoc --> + <title>List of All Members for GrandChild | IndexLinking</title> +</head> +<body> +<li><a href="linkmodule-qmlmodule.html" translate="no">LinkModule</a></li> +<li>GrandChild</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for GrandChild</h1> +<p>This is the complete list of members for <a href="qml-linkmodule-grandchild.html">GrandChild</a>, including inherited members.</p> +<p>The following members are inherited from <a href="https://doc.qt.io/QmlPropertyGroups/qml-qdoc-test-anotherchild.html">AnotherChild</a>.</p> +<ul> +<li class="fn" translate="no"><b><a href="https://doc.qt.io/QmlPropertyGroups/qml-qdoc-test-anotherchild.html#name-prop" translate="no">name</a></b> : string</li> +</ul> +<p>The following members are inherited from <a href="https://doc.qt.io/QmlPropertyGroups/qml-qdoc-test-parent.html">Parent</a>.</p> +<ul> +<li class="fn" translate="no"><b><a href="https://doc.qt.io/QmlPropertyGroups/qml-qdoc-test-parent.html#group-prop" translate="no">group</a></b> : </li> +<li class="fn" translate="no"><b><a href="https://doc.qt.io/QmlPropertyGroups/qml-qdoc-test-parent.html#group.a-prop" translate="no">group.a</a></b> : int</li> +<li class="fn" translate="no"><b><a href="https://doc.qt.io/QmlPropertyGroups/qml-qdoc-test-parent.html#group.b-prop" translate="no">group.b</a></b> : int</li> +<li class="fn" translate="no"><b><a href="https://doc.qt.io/QmlPropertyGroups/qml-qdoc-test-parent.html#group.c-prop" translate="no">group.c</a></b> : int <code class="summary extra" translate="no">(since 2.0)</code></li> +</ul> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/qmlpropertygroups-docbook/qml-qdoc-test-parent.xml b/src/qdoc/qdoc/tests/generatedoutput/expected_output/qmlpropertygroups-docbook/qml-qdoc-test-parent.xml new file mode 100644 index 000000000..e223892b1 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/qmlpropertygroups-docbook/qml-qdoc-test-parent.xml @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>Parent QML Type</db:title> +<db:productname>QmlPropertyGroups</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>Base QML type.</db:para> +<db:para>This type was introduced in Qt 1.1.</db:para> +</db:abstract> +</db:info> +<db:variablelist> +<db:varlistentry> +<db:term>Import Statement</db:term> +<db:listitem> +<db:para>import QDoc.Test 1.1</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Since:</db:term> +<db:listitem> +<db:para>Qt 1.1</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Inherited By:</db:term> +<db:listitem> +<db:para><db:link xlink:href="qml-qdoc-test-anotherchild.xml" xlink:role="">AnotherChild</db:link></db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +</db:section> +<db:section xml:id="property-documentation"> +<db:title>Property Documentation</db:title> +<db:section xml:id="group-prop"> +<db:title>group group</db:title> +<db:bridgehead renderas="sect2" xml:id="group.a-prop">group.a : int</db:bridgehead> +<db:bridgehead renderas="sect2" xml:id="group.b-prop">[read-only] group.b : int</db:bridgehead> +<db:bridgehead renderas="sect2" xml:id="group.c-prop">[since 2.0] group.c : int</db:bridgehead> +<db:para>Property group.</db:para> +</db:section> +</db:section> +</db:article> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/qmlpropertygroups/qml-qdoc-test-anotherchild-members.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/qmlpropertygroups/qml-qdoc-test-anotherchild-members.html new file mode 100644 index 000000000..a52f5e194 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/qmlpropertygroups/qml-qdoc-test-anotherchild-members.html @@ -0,0 +1,28 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- parent.qdoc --> + <meta name="description" content="Just another child inheriting a parent."> + <title>List of All Members for AnotherChild | QmlPropertyGroups</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li>AnotherChild</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for AnotherChild</h1> +<p>This is the complete list of members for <a href="qml-qdoc-test-anotherchild.html">AnotherChild</a>, including inherited members.</p> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-anotherchild.html#name-prop" translate="no">name</a></b> : string</li> +</ul> +<p>The following members are inherited from <a href="qml-qdoc-test-parent.html">Parent</a>.</p> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-parent.html#group-prop" translate="no">group</a></b><ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-parent.html#group.a-prop" translate="no">group.a</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-parent.html#group.b-prop" translate="no">group.b</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-parent.html#group.c-prop" translate="no">group.c</a></b> : int <code class="summary extra" translate="no">(since 2.0)</code></li> +</ul> +</li> +</ul> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/qmlpropertygroups/qml-qdoc-test-parent.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/qmlpropertygroups/qml-qdoc-test-parent.html new file mode 100644 index 000000000..200dd572a --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/qmlpropertygroups/qml-qdoc-test-parent.html @@ -0,0 +1,61 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- parent.qdoc --> + <meta name="description" content="Base QML type."> + <title>Parent QML Type | QmlPropertyGroups</title> +</head> +<body> +<li><a href="qdoc-test-qmlmodule.html" translate="no">Types</a></li> +<li>Parent</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#properties">Properties</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" translate="no">Parent QML Type</h1> +<!-- $$$Parent-brief --> +<p>Base QML type. <a href="#details">More...</a></p> +<!-- @@@Parent --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QDoc.Test 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qdoc-test-anotherchild.html" translate="no">AnotherChild</a></p> +</td></tr></table></div><ul> +<li><a href="qml-qdoc-test-parent-members.html">List of all members, including inherited members</a></li> +</ul> +<h2 id="properties">Properties</h2> +<ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-parent.html#group-prop" translate="no">group</a></b><ul> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-parent.html#group.a-prop" translate="no">group.a</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-parent.html#group.b-prop" translate="no">group.b</a></b> : int</li> +<li class="fn" translate="no"><b><a href="qml-qdoc-test-parent.html#group.c-prop" translate="no">group.c</a></b> : int <code class="summary extra" translate="no">(since 2.0)</code></li> +</ul> +</li> +</ul> +<!-- $$$Parent-description --> +<h2 id="details">Detailed Description</h2> +<!-- @@@Parent --> +<h2>Property Documentation</h2> +<!-- $$$group --> +<div class="qmlitem"><div class="qmlproto" translate="no"> +<div class="table"><table class="qmlname"> +<tr valign="top" class="even" id="group-prop"><th class="centerAlign"><p><b>group group</b></p></th></tr> +<tr valign="top" class="odd" id="group.a-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">group.a</span> : <span class="type"><a href="qml-int.html" translate="no">int</a></span></p></td></tr> +<tr valign="top" class="odd" id="group.b-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">group.b</span> : <span class="type"><a href="qml-int.html" translate="no">int</a></span> <code class="details extra" translate="no">[read-only]</code></p></td></tr> +<tr valign="top" class="odd" id="group.c-prop"> +<td class="tblQmlPropNode"><p> +<span class="name">group.c</span> : <span class="type"><a href="qml-int.html" translate="no">int</a></span> <code class="details extra" translate="no">[since 2.0]</code></p></td></tr> +</table></div></div> +<div class="qmldoc"><p>Property group.</p> +</div></div><!-- @@@group --> +<br/> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp-module.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp-module.html new file mode 100644 index 000000000..83ab5b175 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp-module.html @@ -0,0 +1,57 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A test module page."> + <title>QDoc Test C++ Classes | TestCPP</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#namespaces">Namespaces</a></li> +<li class="level1"><a href="#classes">Classes</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +<li class="level2"><a href="#linking-to-function-like-things">Linking to function-like things</a></li> +<li class="level3"><a href="#section">section()</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">QDoc Test C++ Classes</h1> +<!-- $$$TestCPP-brief --> +<p>A test module page. <a href="#details">More...</a></p> +<!-- @@@TestCPP --> +<p>This module was introduced in Qt 2.0.</p> +<h2 id="namespaces">Namespaces</h2> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="crossmoduleref.html">CrossModuleRef</a></p></td><td class="tblDescr"><p>Namespace that has documented functions in multiple modules</p></td></tr> +<tr class="even topAlign"><td class="tblName" translate="no"><p><a href="testqdoc.html">TestQDoc</a></p></td><td class="tblDescr"><p>A namespace</p></td></tr> +</table></div> +<h2 id="classes">Classes</h2> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><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" translate="no"><p><a href="testqdoc-testderived.html">TestQDoc::TestDerived</a></p></td><td class="tblDescr"><p>A class in a namespace, derived from Test</p></td></tr> +</table></div> +<!-- $$$TestCPP-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +<div class="admonition note"> +<p><b>Note: </b>This is just a test. /* Look, Ma! {I'm made of arguments!} */</p> +</div> +<h3 id="linking-to-function-like-things">Linking to function-like things</h3> +<ul> +<li><a href="testqdoc-test.html#someFunctionDefaultArg" translate="no">someFunctionDefaultArg</a>()</li> +<li><a href="testqdoc-test.html#QDOCTEST_MACRO2" translate="no">QDOCTEST_MACRO2</a>()</li> +<li><a href="testqdoc-test.html#QDOCTEST_MACRO2" translate="no">QDOCTEST_MACRO2</a>(int &x)</li> +<li><a href="testcpp-module.html#section" translate="no">section()</a></li> +<li><a href="testcpp-module.html#section" translate="no">section() is a section title</a></li> +<li><a href="testqdoc-test.html#Test" translate="no">open( parenthesis</a></li> +<li><a href="https://en.cppreference.com/w/cpp/utility/move">C++11 added std::move(T&& t)</a></li> +</ul> +<h4 id="section">section()</h4> +</div> +<!-- @@@TestCPP --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp.index b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp.index new file mode 100644 index 000000000..9dcb763a8 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp.index @@ -0,0 +1,79 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE QDOCINDEX> +<INDEX url="" title="TestCPP Reference Documentation" version="" project="TestCPP"> + <namespace name="" status="active" access="public" module="testcpp"> + <function name="QDOCTEST_MACRO" href="testqdoc.html#QDOCTEST_MACRO" status="active" access="public" documented="true" related="0" meta="macrowithoutparams" signature="QDOCTEST_MACRO"/> + <function name="QDOCTEST_MACRO2" href="testqdoc-test.html#QDOCTEST_MACRO2" status="active" access="public" documented="true" related="1" since="Test 1.1" meta="macrowithparams" brief="A macro with argument x" signature="QDOCTEST_MACRO2(int &x)" groups="testgroup"> + <parameter type="int &" name="x" default=""/> + </function> + <page name="autolinking.html" href="autolinking.html" status="active" location="classlists.qdoc" documented="true" subtype="page" title="Autolinking" fulltitle="Autolinking" subtitle=""> + <contents name="testqdoc" title="TestQDoc" level="1"/> + <contents name="someprop" title="someProp" level="1"/> + </page> + <namespace name="CrossModuleRef" href="crossmoduleref.html" status="active" access="public" location="testcpp.h" since="3.0" documented="true" module="TestCPP" brief="Namespace that has documented functions in multiple modules"> + <function name="documentMe" fullname="CrossModuleRef::documentMe" href="crossmoduleref.html#documentMe" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void documentMe()"/> + </namespace> + <class name="DontLinkToMe" href="dontlinktome.html" status="ignored" access="public" location="testcpp.h" since="2.0" documented="true" module="TestCPP" brief="Class that does not generate documentation"/> + <page name="obsolete-classes.html" href="obsolete-classes.html" status="active" location="classlists.qdoc" documented="true" subtype="page" title="Obsolete Classes" fulltitle="Obsolete Classes" subtitle=""> + <contents name="classes-with-obsolete-members" title="Classes with obsolete members" level="1"/> + <contents name="testqdoc" title="TestQDoc" level="2"/> + </page> + <namespace name="TestQDoc" href="testqdoc.html" status="active" access="public" location="testcpp.h" since="2.0" documented="true" module="TestCPP" brief="A namespace"> + <contents name="usage" title="Usage" level="1"/> + <function name="QDOCTEST_MACRO" href="testqdoc.html#QDOCTEST_MACRO" status="active" access="public" documented="true" related="0" meta="macrowithoutparams" signature="QDOCTEST_MACRO"/> + <class threadsafety="reentrant" name="Test" fullname="TestQDoc::Test" href="testqdoc-test.html" status="active" access="public" location="testcpp.h" since="2.0" documented="true" groups="cpptypes,testgroup" module="TestCPP" brief="A class in a namespace"> + <function name="QDOCTEST_MACRO2" href="testqdoc-test.html#QDOCTEST_MACRO2" status="active" access="public" documented="true" related="1" since="Test 1.1" meta="macrowithparams" brief="A macro with argument x" signature="QDOCTEST_MACRO2(int &x)" groups="testgroup"> + <parameter type="int &" name="x" default=""/> + </function> + <function name="Test" fullname="TestQDoc::Test::Test" href="testqdoc-test.html#Test" status="active" access="public" documented="true" meta="constructor" noexcept="true" signature="Test()"/> + <function name="anotherObsoleteMember" fullname="TestQDoc::Test::anotherObsoleteMember" href="testqdoc-test-obsolete.html#anotherObsoleteMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void anotherObsoleteMember()"/> + <function name="deprecatedMember" fullname="TestQDoc::Test::deprecatedMember" href="testqdoc-test-obsolete.html#deprecatedMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void deprecatedMember()"/> + <function name="funcPtr" fullname="TestQDoc::Test::funcPtr" href="testqdoc-test.html#funcPtr" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void (*)(bool)" signature="void (*)(bool) funcPtr(bool b, const char *s)"> + <parameter type="bool" name="b" default=""/> + <parameter type="const char *" name="s" default=""/> + </function> + <function name="inlineFunction" fullname="TestQDoc::Test::inlineFunction" href="testqdoc-test.html#inlineFunction" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" brief="An inline function, documented using the \fn QDoc command" signature="void inlineFunction()"/> + <function name="methodWithEmDashInItsDocs" fullname="TestQDoc::Test::methodWithEmDashInItsDocs" href="testqdoc-test.html#methodWithEmDashInItsDocs" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void methodWithEmDashInItsDocs()"/> + <function name="methodWithEnDashInItsDocs" fullname="TestQDoc::Test::methodWithEnDashInItsDocs" href="testqdoc-test.html#methodWithEnDashInItsDocs" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void methodWithEnDashInItsDocs()"/> + <function name="obsoleteMember" fullname="TestQDoc::Test::obsoleteMember" href="testqdoc-test-obsolete.html#obsoleteMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="void" signature="void obsoleteMember()"/> + <function name="operator++" fullname="TestQDoc::Test::operator++" href="testqdoc-test-obsolete.html#operator-2b-2b" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="TestQDoc::Test &" signature="TestQDoc::Test & operator++()"/> + <function name="operator--" fullname="TestQDoc::Test::operator--" href="testqdoc-test-obsolete.html#operator--" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" type="TestQDoc::Test &" signature="TestQDoc::Test & operator--()"/> + <function name="operator=" fullname="TestQDoc::Test::operator=" href="testqdoc-test.html#operator-eq" status="active" access="public" documented="true" meta="move-assign" noexcept="true" type="TestQDoc::Test &" signature="TestQDoc::Test & operator=(TestQDoc::Test &&other)" groups="testgroup"> + <parameter type="TestQDoc::Test &&" name="other" default=""/> + </function> + <function name="operator==" href="testqdoc-test.html#operator-eq-eq" status="active" access="public" location="testcpp.h" documented="true" related="2" meta="plain" type="bool" signature="bool operator==(const TestQDoc::Test &lhs, const TestQDoc::Test &rhs)"> + <parameter type="const TestQDoc::Test &" name="lhs" default=""/> + <parameter type="const TestQDoc::Test &" name="rhs" default=""/> + </function> + <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload" status="active" access="protected" location="testcpp.h" documented="true" meta="plain" type="void" signature="void overload()"/> + <function name="overload" fullname="TestQDoc::Test::overload" href="testqdoc-test.html#overload-1" status="active" access="protected" location="testcpp.h" documented="true" since="Test 1.2" meta="plain" overload="true" overload-number="1" type="void" signature="void overload(bool b)"> + <parameter type="bool" name="b" default=""/> + </function> + <function name="someFunction" fullname="TestQDoc::Test::someFunction" href="testqdoc-test.html#someFunction" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="int" signature="int someFunction(int, int v)"> + <parameter type="int" name="" default=""/> + <parameter type="int" name="v" default="0"/> + </function> + <function name="someFunctionDefaultArg" fullname="TestQDoc::Test::someFunctionDefaultArg" href="testqdoc-test.html#someFunctionDefaultArg" threadsafety="non-reentrant" status="active" access="public" location="testcpp.h" documented="true" meta="plain" const="true" type="void" signature="void someFunctionDefaultArg(int i, bool b) const" groups="testgroup"> + <parameter type="int" name="i" default=""/> + <parameter type="bool" name="b" default="false"/> + </function> + <function name="virtualFun" fullname="TestQDoc::Test::virtualFun" href="testqdoc-test.html#virtualFun" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="virtual" type="void" signature="void virtualFun()"/> + <typedef name="SomeType" fullname="TestQDoc::Test::SomeType" href="testqdoc-test.html#SomeType-typedef" status="active" access="public" location="testcpp.h" documented="true"/> + </class> + <class name="TestDerived" fullname="TestQDoc::TestDerived" href="testqdoc-testderived.html" status="active" access="public" location="testcpp.h" since="2.0" documented="true" bases="TestQDoc::Test" module="TestCPP" brief="A class in a namespace, derived from Test"> + <function name="someValue" fullname="TestQDoc::TestDerived::someValue" href="testqdoc-testderived.html#someValue" status="active" access="public" location="testcpp.h" documented="true" meta="plain" type="TestQDoc::TestDerived::NotTypedef" signature="TestQDoc::TestDerived::NotTypedef someValue()"/> + <function name="staticObsoleteMember" fullname="TestQDoc::TestDerived::staticObsoleteMember" href="testqdoc-testderived-obsolete.html#staticObsoleteMember" status="deprecated" access="public" location="testcpp.h" documented="true" meta="plain" static="true" type="void" signature="void staticObsoleteMember()"/> + <function name="virtualFun" fullname="TestQDoc::TestDerived::virtualFun" href="testqdoc-testderived.html#virtualFun" status="active" access="public" location="testcpp.h" documented="true" meta="plain" virtual="virtual" override="true" type="void" signature="void virtualFun() override"/> + <typedef name="DerivedType" fullname="TestQDoc::TestDerived::DerivedType" href="testqdoc-testderived.html#DerivedType-typedef" status="active" access="public" location="testcpp.h" documented="true" aliasedtype="Test::SomeType"/> + <typedef name="NotTypedef" fullname="TestQDoc::TestDerived::NotTypedef" href="testqdoc-testderived.html#NotTypedef-typedef" status="active" access="public" location="testcpp.h" documented="true" aliasedtype="int"/> + </class> + </namespace> + <page name="https://doc.qt.io/qt/17-qdoc-commands-thread.html#reentrant-command" href="https://doc.qt.io/qt/17-qdoc-commands-thread.html#reentrant-command" status="active" location="classlists.qdoc" documented="true" subtype="externalpage" title="reentrant" fulltitle="reentrant" subtitle=""/> + <group name="cpptypes" href="cpptypes.html" status="active" location="classlists.qdoc" documented="true" seen="true" title="Test C++ Types"/> + <group name="testgroup" href="testgroup.html" status="internal" seen="false" title=""/> + <module name="TestCPP" href="testcpp-module.html" status="active" since="2.0" documented="true" seen="true" title="QDoc Test C++ Classes" brief="A test module page"> + <contents name="linking-to-function-like-things" title="Linking to function-like things" level="1"/> + <contents name="section" title="section()" level="2"/> + </module> + </namespace> +</INDEX> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp/crossmoduleref.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp/crossmoduleref.html new file mode 100644 index 000000000..2d073e237 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp/crossmoduleref.html @@ -0,0 +1,48 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="Namespace that has documented functions in multiple modules."> + <title>CrossModuleRef Namespace | TestCPP</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#functions">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" translate="no">CrossModuleRef Namespace</h1> +<!-- $$$CrossModuleRef-brief --> +<p>Namespace that has documented functions in multiple modules. <a href="#details">More...</a></p> +<!-- @@@CrossModuleRef --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <CrossModuleRef></span></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> CMake:</td><td class="memItemRight bottomAlign"> find_package(Qt6 REQUIRED COMPONENTS QDocTest) <br/> +target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 3.0</td></tr> +</table></div> +<h2 id="functions">Functions</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="crossmoduleref.html#documentMe" translate="no">documentMe</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="crossmoduleref-sub-crossmodule.html#documentMeToo" translate="no">documentMeToo</a></b>()</td></tr> +</table></div> +<!-- $$$CrossModuleRef-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +</div> +<!-- @@@CrossModuleRef --> +<div class="func"> +<h2>Function Documentation</h2> +<!-- $$$documentMe[overload1]$$$documentMe --> +<h3 class="fn" translate="no" id="documentMe"><span class="type">void</span> CrossModuleRef::<span class="name">documentMe</span>()</h3> +<p>Document me!</p> +<!-- @@@documentMe --> +</div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp/testcpp-module.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp/testcpp-module.html new file mode 100644 index 000000000..83ab5b175 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp/testcpp-module.html @@ -0,0 +1,57 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A test module page."> + <title>QDoc Test C++ Classes | TestCPP</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#namespaces">Namespaces</a></li> +<li class="level1"><a href="#classes">Classes</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +<li class="level2"><a href="#linking-to-function-like-things">Linking to function-like things</a></li> +<li class="level3"><a href="#section">section()</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">QDoc Test C++ Classes</h1> +<!-- $$$TestCPP-brief --> +<p>A test module page. <a href="#details">More...</a></p> +<!-- @@@TestCPP --> +<p>This module was introduced in Qt 2.0.</p> +<h2 id="namespaces">Namespaces</h2> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="crossmoduleref.html">CrossModuleRef</a></p></td><td class="tblDescr"><p>Namespace that has documented functions in multiple modules</p></td></tr> +<tr class="even topAlign"><td class="tblName" translate="no"><p><a href="testqdoc.html">TestQDoc</a></p></td><td class="tblDescr"><p>A namespace</p></td></tr> +</table></div> +<h2 id="classes">Classes</h2> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><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" translate="no"><p><a href="testqdoc-testderived.html">TestQDoc::TestDerived</a></p></td><td class="tblDescr"><p>A class in a namespace, derived from Test</p></td></tr> +</table></div> +<!-- $$$TestCPP-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +<div class="admonition note"> +<p><b>Note: </b>This is just a test. /* Look, Ma! {I'm made of arguments!} */</p> +</div> +<h3 id="linking-to-function-like-things">Linking to function-like things</h3> +<ul> +<li><a href="testqdoc-test.html#someFunctionDefaultArg" translate="no">someFunctionDefaultArg</a>()</li> +<li><a href="testqdoc-test.html#QDOCTEST_MACRO2" translate="no">QDOCTEST_MACRO2</a>()</li> +<li><a href="testqdoc-test.html#QDOCTEST_MACRO2" translate="no">QDOCTEST_MACRO2</a>(int &x)</li> +<li><a href="testcpp-module.html#section" translate="no">section()</a></li> +<li><a href="testcpp-module.html#section" translate="no">section() is a section title</a></li> +<li><a href="testqdoc-test.html#Test" translate="no">open( parenthesis</a></li> +<li><a href="https://en.cppreference.com/w/cpp/utility/move">C++11 added std::move(T&& t)</a></li> +</ul> +<h4 id="section">section()</h4> +</div> +<!-- @@@TestCPP --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp/testqdoc-test-members.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp/testqdoc-test-members.html new file mode 100644 index 000000000..6749f2332 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp/testqdoc-test-members.html @@ -0,0 +1,30 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A class in a namespace."> + <title>List of All Members for Test | TestCPP</title> +</head> +<body> +<li><a href="testcpp-module.html" translate="no">C++ Classes</a></li> +<li>Test</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for Test</h1> +<p>This is the complete list of members for <a href="testqdoc-test.html">TestQDoc::Test</a>, including inherited members.</p> +<ul> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#SomeType-typedef" translate="no">SomeType</a></b></span></li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#Test" translate="no">Test</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#funcPtr" translate="no">funcPtr</a></b></span>(bool, const char *) : void (*)(bool)</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#inlineFunction" translate="no">inlineFunction</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#methodWithEmDashInItsDocs" translate="no">methodWithEmDashInItsDocs</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#methodWithEnDashInItsDocs" translate="no">methodWithEnDashInItsDocs</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#overload" translate="no">overload</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#overload-1" translate="no">overload</a></b></span>(bool)</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#someFunction" translate="no">someFunction</a></b></span>(int, int) : int</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#someFunctionDefaultArg" translate="no">someFunctionDefaultArg</a></b></span>(int, bool) const</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#virtualFun" translate="no">virtualFun</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#operator-eq" translate="no">operator=</a></b></span>(TestQDoc::Test &&) : TestQDoc::Test &</li> +</ul> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp/testqdoc-test.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp/testqdoc-test.html new file mode 100644 index 000000000..028339088 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp/testqdoc-test.html @@ -0,0 +1,162 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A class in a namespace."> + <title>Test Class | TestCPP</title> +</head> +<body> +<li><a href="testcpp-module.html" translate="no">C++ Classes</a></li> +<li>Test</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#public-types">Public Types</a></li> +<li class="level1"><a href="#public-functions">Public Functions</a></li> +<li class="level1"><a href="#protected-functions">Protected Functions</a></li> +<li class="level1"><a href="#related-non-members">Related Non-Members</a></li> +<li class="level1"><a href="#macros">Macros</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" translate="no">Test Class</h1> +<span class="small-subtitle" translate="no">class <a href="testqdoc.html" translate="no">TestQDoc</a>::Test</span> +<!-- $$$Test-brief --> +<p>A class in a namespace. <a href="#details">More...</a></p> +<!-- @@@Test --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <Test></span></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> CMake:</td><td class="memItemRight bottomAlign"> find_package(Qt6 REQUIRED COMPONENTS QDocTest) <br/> +target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 2.0</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="testqdoc-testderived.html" translate="no">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">Deprecated members</a></li> +<li>Test is part of <a href="cpptypes.html">Test C++ Types</a>.</li> +</ul> +<p><b>Note:</b> All functions in this class are <a href="https://doc.qt.io/qt/17-qdoc-commands-thread.html#reentrant-command">reentrant</a> with the following exceptions:</p> +<ul> +<li><a href="testqdoc-test.html#someFunctionDefaultArg" translate="no">someFunctionDefaultArg</a>(int i, bool b) const</li> +</ul> +<h2 id="public-types">Public Types</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#SomeType-typedef" translate="no">SomeType</a></b></td></tr> +</table></div> +<h2 id="public-functions">Public Functions</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#Test" translate="no">Test</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void (*)(bool) </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#funcPtr" translate="no">funcPtr</a></b>(bool <i>b</i>, const char *<i>s</i>)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#inlineFunction" translate="no">inlineFunction</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#methodWithEmDashInItsDocs" translate="no">methodWithEmDashInItsDocs</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#methodWithEnDashInItsDocs" translate="no">methodWithEnDashInItsDocs</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#someFunction" translate="no">someFunction</a></b>(int, int <i>v</i> = 0)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#someFunctionDefaultArg" translate="no">someFunctionDefaultArg</a></b>(int <i>i</i>, bool <i>b</i> = false) const</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#virtualFun" translate="no">virtualFun</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> TestQDoc::Test &</td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#operator-eq" translate="no">operator=</a></b>(TestQDoc::Test &&<i>other</i>)</td></tr> +</table></div> +<h2 id="protected-functions">Protected Functions</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#overload" translate="no">overload</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> <code class="summary extra" translate="no">(since Test 1.2)</code> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#overload-1" translate="no">overload</a></b>(bool <i>b</i>)</td></tr> +</table></div> +<h2 id="related-non-members">Related Non-Members</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#operator-eq-eq" translate="no">operator==</a></b>(const TestQDoc::Test &<i>lhs</i>, const TestQDoc::Test &<i>rhs</i>)</td></tr> +</table></div> +<h2 id="macros">Macros</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> <code class="summary extra" translate="no">(since Test 1.1)</code> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#QDOCTEST_MACRO2" translate="no">QDOCTEST_MACRO2</a></b>(int &<i>x</i>)</td></tr> +</table></div> +<!-- $$$Test-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +</div> +<!-- @@@Test --> +<div class="types"> +<h2>Member Type Documentation</h2> +<!-- $$$SomeType --> +<h3 class="fn" translate="no" id="SomeType-typedef">Test::<span class="name">SomeType</span></h3> +<p>A typedef.</p> +<!-- @@@SomeType --> +</div> +<div class="func"> +<h2>Member Function Documentation</h2> +<!-- $$$ --> +<div class="fngroup"> +<h3 class="fn fngroupitem" translate="no" id="overload"><code class="details extra" translate="no">[protected]</code> <span class="type">void</span> Test::<span class="name">overload</span>()</h3><h3 class="fn fngroupitem" translate="no" id="overload-1"><code class="details extra" translate="no">[protected, since Test 1.2]</code> <span class="type">void</span> Test::<span class="name">overload</span>(<span class="type">bool</span> <i>b</i>)</h3></div> +<p>Overloads that share a documentation comment, optionally taking a parameter <i translate="no">b</i>.</p> +<!-- @@@ --> +<!-- $$$Test[overload1]$$$Test --> +<h3 class="fn" translate="no" id="Test"><code class="details extra" translate="no">[noexcept default]</code> Test::<span class="name">Test</span>()</h3> +<p>Default constructor.</p> +<!-- @@@Test --> +<!-- $$$funcPtr[overload1]$$$funcPtrboolconstchar* --> +<h3 class="fn" translate="no" id="funcPtr"><span class="type">void</span> (*)(<span class="type">bool</span>) Test::<span class="name">funcPtr</span>(<span class="type">bool</span> <i>b</i>, const <span class="type">char</span> *<i>s</i>)</h3> +<p>Returns a pointer to a function that takes a boolean. Uses <i translate="no">b</i> and <i translate="no">s</i>.</p> +<!-- @@@funcPtr --> +<!-- $$$inlineFunction[overload1]$$$inlineFunction --> +<h3 class="fn" translate="no" id="inlineFunction"><span class="type">void</span> Test::<span class="name">inlineFunction</span>()</h3> +<p>An inline function, documented using the \fn QDoc command.</p> +<!-- @@@inlineFunction --> +<!-- $$$methodWithEmDashInItsDocs[overload1]$$$methodWithEmDashInItsDocs --> +<h3 class="fn" translate="no" id="methodWithEmDashInItsDocs"><span class="type">void</span> Test::<span class="name">methodWithEmDashInItsDocs</span>()</h3> +<p>This method has em dashes in its documentation—as you'll find represented by <code translate="no">---</code> in the sources—here and there. The important bit to note is that when passed e.g. to the \c command, the three hyphens are processed as input to the command and not replaced by an em dash.</p> +<p>-----------------------------------------------------------------------</p> +<p>People can still add a bunch of dashes, though, without QDoc replacing them all with a series of em dashes.</p> +<p>—You can also start a new paragraph with an em dash, if you want to.</p> +<p><b>See also </b><a href="testqdoc-test.html#methodWithEnDashInItsDocs" translate="no">methodWithEnDashInItsDocs</a>.</p> +<!-- @@@methodWithEmDashInItsDocs --> +<!-- $$$methodWithEnDashInItsDocs[overload1]$$$methodWithEnDashInItsDocs --> +<h3 class="fn" translate="no" id="methodWithEnDashInItsDocs"><span class="type">void</span> Test::<span class="name">methodWithEnDashInItsDocs</span>()</h3> +<p>This method has en dashes in its documentation – as you'll find represented by <code translate="no">--</code> in the sources – here and there. The important bit to note is that when passed e.g. to the \c command, the two hyphens are processed as input to the command and not replaced by an en dash. This also applies to code blocks, where otherwise, the decrement operator would get completely borked:</p> +<pre class="cpp" translate="no"><span class="keyword">for</span> (<span class="type">int</span> i <span class="operator">=</span> <span class="number">42</span>; i <span class="operator">></span> <span class="number">0</span>; <span class="operator">-</span><span class="operator">-</span>i) + <span class="comment">// Do something cool during countdown.</span></pre> +<p>...as it would be silly if this would output –i instead of <code translate="no">--i</code>.</p> +<p>-----------------------------------------------------------------------</p> +<p>It still allows people to add a bunch of dashes, though, without replacing them all with a series of en dashes. Of course, they might want to use the \hr command instead, like this:</p> +<hr /> +<p>– You can also start a new paragraph with an en dash, if you want to.</p> +<p><b>See also </b>methodWithEnDashInItsDocs.</p> +<!-- @@@methodWithEnDashInItsDocs --> +<!-- $$$someFunction[overload1]$$$someFunctionintint --> +<h3 class="fn" translate="no" id="someFunction"><span class="type">int</span> Test::<span class="name">someFunction</span>(<span class="type">int</span>, <span class="type">int</span> <i>v</i> = 0)</h3> +<p>Function that takes a parameter <i translate="no">v</i>. Also returns the value of <i translate="no">v</i>.</p> +<!-- @@@someFunction --> +<!-- $$$someFunctionDefaultArg[overload1]$$$someFunctionDefaultArgintbool --> +<h3 class="fn" translate="no" id="someFunctionDefaultArg"><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) const</h3> +<p>Function that takes a parameter <i translate="no">i</i> and <i translate="no">b</i>.</p> +<p><b>Warning:</b> This function is not <a href="https://doc.qt.io/qt/17-qdoc-commands-thread.html#reentrant-command">reentrant</a>.</p> +<!-- @@@someFunctionDefaultArg --> +<!-- $$$virtualFun[overload1]$$$virtualFun --> +<h3 class="fn" translate="no" id="virtualFun"><code class="details extra" translate="no">[virtual]</code> <span class="type">void</span> Test::<span class="name">virtualFun</span>()</h3> +<p>Function that must be reimplemented.</p> +<!-- @@@virtualFun --> +<!-- $$$operator=[overload1]$$$operator=TestQDoc::Test&& --> +<h3 class="fn" translate="no" id="operator-eq"><code class="details extra" translate="no">[noexcept default]</code> <span class="type"><a href="testqdoc-test.html" translate="no">TestQDoc::Test</a></span> &Test::<span class="name">operator=</span>(<span class="type"><a href="testqdoc-test.html" translate="no">TestQDoc::Test</a></span> &&<i>other</i>)</h3> +<p>Move-assigns <i translate="no">other</i>.</p> +<!-- @@@operator= --> +</div> +<div class="relnonmem"> +<h2>Related Non-Members</h2> +<!-- $$$operator==[overload1]$$$operator==constTestQDoc::Test&constTestQDoc::Test& --> +<h3 class="fn" translate="no" id="operator-eq-eq"><span class="type">bool</span> <span class="name">operator==</span>(const <span class="type"><a href="testqdoc-test.html" translate="no">TestQDoc::Test</a></span> &<i>lhs</i>, const <span class="type"><a href="testqdoc-test.html" translate="no">TestQDoc::Test</a></span> &<i>rhs</i>)</h3> +<p>Returns true if <i translate="no">lhs</i> and <i translate="no">rhs</i> are equal.</p> +<!-- @@@operator== --> +</div> +<div class="macros"> +<h2>Macro Documentation</h2> +<!-- $$$QDOCTEST_MACRO2[overload1]$$$QDOCTEST_MACRO2int& --> +<h3 class="fn" translate="no" id="QDOCTEST_MACRO2"><code class="details extra" translate="no">[since Test 1.1]</code> <span class="name">QDOCTEST_MACRO2</span>(<span class="type">int</span> &<i>x</i>)</h3> +<p>A macro with argument <i translate="no">x</i>.</p> +<p>This macro was introduced in Test 1.1.</p> +<!-- @@@QDOCTEST_MACRO2 --> +</div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp/testqdoc.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp/testqdoc.html new file mode 100644 index 000000000..425c7b396 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testcpp/testqdoc.html @@ -0,0 +1,64 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A namespace."> + <title>TestQDoc Namespace | TestCPP</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#classes">Classes</a></li> +<li class="level1"><a href="#macros">Macros</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +<li class="level2"><a href="#usage">Usage</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">TestQDoc Namespace</h1> +<!-- $$$TestQDoc-brief --> +<p>A namespace. <a href="#details">More...</a></p> +<!-- @@@TestQDoc --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <TestCPP></span></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> CMake:</td><td class="memItemRight bottomAlign"> find_package(Qt6 REQUIRED COMPONENTS QDocTest) <br/> +target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 2.0</td></tr> +</table></div> +<h2 id="classes">Classes</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> <code class="summary extra" translate="no">(since 2.0)</code> class </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html" translate="no">Test</a></b></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> <code class="summary extra" translate="no">(since 2.0)</code> class </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html" translate="no">TestDerived</a></b></td></tr> +</table></div> +<h2 id="macros">Macros</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc.html#QDOCTEST_MACRO" translate="no">QDOCTEST_MACRO</a></b></td></tr> +</table></div> +<!-- $$$TestQDoc-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +<h3 id="usage">Usage</h3> +<p>This namespace is for testing QDoc output.</p> +</div> +<!-- @@@TestQDoc --> +<div class="classes"> +<h2>Classes</h2> +<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 class in a namespace, derived from <a href="testqdoc-test.html" translate="no">Test</a>. <a href="testqdoc-testderived.html#details">More...</a></p> +<!-- @@@TestDerived --> +</div> +<div class="macros"> +<h2>Macro Documentation</h2> +<!-- $$$QDOCTEST_MACRO[overload1]$$$QDOCTEST_MACRO --> +<h3 class="fn" translate="no" id="QDOCTEST_MACRO"><span class="name">QDOCTEST_MACRO</span></h3> +<!-- @@@QDOCTEST_MACRO --> +</div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-test-members.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-test-members.html new file mode 100644 index 000000000..6749f2332 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-test-members.html @@ -0,0 +1,30 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A class in a namespace."> + <title>List of All Members for Test | TestCPP</title> +</head> +<body> +<li><a href="testcpp-module.html" translate="no">C++ Classes</a></li> +<li>Test</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">List of All Members for Test</h1> +<p>This is the complete list of members for <a href="testqdoc-test.html">TestQDoc::Test</a>, including inherited members.</p> +<ul> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#SomeType-typedef" translate="no">SomeType</a></b></span></li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#Test" translate="no">Test</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#funcPtr" translate="no">funcPtr</a></b></span>(bool, const char *) : void (*)(bool)</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#inlineFunction" translate="no">inlineFunction</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#methodWithEmDashInItsDocs" translate="no">methodWithEmDashInItsDocs</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#methodWithEnDashInItsDocs" translate="no">methodWithEnDashInItsDocs</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#overload" translate="no">overload</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#overload-1" translate="no">overload</a></b></span>(bool)</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#someFunction" translate="no">someFunction</a></b></span>(int, int) : int</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#someFunctionDefaultArg" translate="no">someFunctionDefaultArg</a></b></span>(int, bool) const</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#virtualFun" translate="no">virtualFun</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#operator-eq" translate="no">operator=</a></b></span>(TestQDoc::Test &&) : TestQDoc::Test &</li> +</ul> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-test-obsolete.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-test-obsolete.html new file mode 100644 index 000000000..2b5192da1 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-test-obsolete.html @@ -0,0 +1,45 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A class in a namespace."> + <title>Obsolete Members for Test | TestCPP</title> +</head> +<body> +<li><a href="testcpp-module.html" translate="no">C++ Classes</a></li> +<li>Test</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">Obsolete Members for Test</h1> +<p><b>The following members of class <a href="testqdoc-test.html" translate="no">Test</a> are deprecated.</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" translate="no"> +<tr><td class="memItemLeft topAlign rightAlign"> <code class="summary extra" translate="no">(deprecated)</code> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test-obsolete.html#anotherObsoleteMember" translate="no">anotherObsoleteMember</a></b>()</td></tr> +<tr><td class="memItemLeft topAlign rightAlign"> <code class="summary extra" translate="no">(deprecated in 6.0)</code> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test-obsolete.html#deprecatedMember" translate="no">deprecatedMember</a></b>()</td></tr> +<tr><td class="memItemLeft topAlign rightAlign"> <code class="summary extra" translate="no">(deprecated)</code> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test-obsolete.html#obsoleteMember" translate="no">obsoleteMember</a></b>()</td></tr> +<tr><td class="memItemLeft topAlign rightAlign"> <code class="summary extra" translate="no">(deprecated)</code> TestQDoc::Test &</td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test-obsolete.html#operator-2b-2b" translate="no">operator++</a></b>()</td></tr> +<tr><td class="memItemLeft topAlign rightAlign"> <code class="summary extra" translate="no">(deprecated)</code> TestQDoc::Test &</td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test-obsolete.html#operator--" translate="no">operator--</a></b>()</td></tr> +</table></div> +<h2>Member Function Documentation</h2> +<!-- $$$ --> +<div class="fngroup"> +<h3 class="fn fngroupitem" translate="no" id="operator-2b-2b"><code class="details extra" translate="no">[deprecated]</code> <span class="type"><a href="testqdoc-test.html" translate="no">TestQDoc::Test</a></span> &Test::<span class="name">operator++</span>()</h3><h3 class="fn fngroupitem" translate="no" id="operator--"><code class="details extra" translate="no">[deprecated]</code> <span class="type"><a href="testqdoc-test.html" translate="no">TestQDoc::Test</a></span> &Test::<span class="name">operator--</span>()</h3></div> +<p>This function is deprecated. We strongly advise against using it in new code.</p> +<!-- @@@ --> +<!-- $$$anotherObsoleteMember[overload1]$$$anotherObsoleteMember --> +<h3 class="fn" translate="no" id="anotherObsoleteMember"><code class="details extra" translate="no">[deprecated]</code> <span class="type">void</span> Test::<span class="name">anotherObsoleteMember</span>()</h3> +<p>This function is deprecated. We strongly advise against using it in new code.</p> +<p>Use <a href="testqdoc-test-obsolete.html#obsoleteMember" translate="no">obsoleteMember</a>() instead.</p> +<!-- @@@anotherObsoleteMember --> +<!-- $$$deprecatedMember[overload1]$$$deprecatedMember --> +<h3 class="fn" translate="no" id="deprecatedMember"><code class="details extra" translate="no">[deprecated in 6.0]</code> <span class="type">void</span> Test::<span class="name">deprecatedMember</span>()</h3> +<p>This function is deprecated since 6.0. We strongly advise against using it in new code.</p> +<p>Use <a href="testqdoc-test.html#someFunction" translate="no">someFunction</a>() instead.</p> +<!-- @@@deprecatedMember --> +<!-- $$$obsoleteMember[overload1]$$$obsoleteMember --> +<h3 class="fn" translate="no" id="obsoleteMember"><code class="details extra" translate="no">[deprecated]</code> <span class="type">void</span> Test::<span class="name">obsoleteMember</span>()</h3> +<p>This function is deprecated. We strongly advise against using it in new code.</p> +<p>Use <a href="testqdoc-test.html#someFunction" translate="no">someFunction</a>() instead.</p> +<!-- @@@obsoleteMember --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-test.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-test.html new file mode 100644 index 000000000..028339088 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-test.html @@ -0,0 +1,162 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A class in a namespace."> + <title>Test Class | TestCPP</title> +</head> +<body> +<li><a href="testcpp-module.html" translate="no">C++ Classes</a></li> +<li>Test</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#public-types">Public Types</a></li> +<li class="level1"><a href="#public-functions">Public Functions</a></li> +<li class="level1"><a href="#protected-functions">Protected Functions</a></li> +<li class="level1"><a href="#related-non-members">Related Non-Members</a></li> +<li class="level1"><a href="#macros">Macros</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" translate="no">Test Class</h1> +<span class="small-subtitle" translate="no">class <a href="testqdoc.html" translate="no">TestQDoc</a>::Test</span> +<!-- $$$Test-brief --> +<p>A class in a namespace. <a href="#details">More...</a></p> +<!-- @@@Test --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <Test></span></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> CMake:</td><td class="memItemRight bottomAlign"> find_package(Qt6 REQUIRED COMPONENTS QDocTest) <br/> +target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 2.0</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="testqdoc-testderived.html" translate="no">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">Deprecated members</a></li> +<li>Test is part of <a href="cpptypes.html">Test C++ Types</a>.</li> +</ul> +<p><b>Note:</b> All functions in this class are <a href="https://doc.qt.io/qt/17-qdoc-commands-thread.html#reentrant-command">reentrant</a> with the following exceptions:</p> +<ul> +<li><a href="testqdoc-test.html#someFunctionDefaultArg" translate="no">someFunctionDefaultArg</a>(int i, bool b) const</li> +</ul> +<h2 id="public-types">Public Types</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#SomeType-typedef" translate="no">SomeType</a></b></td></tr> +</table></div> +<h2 id="public-functions">Public Functions</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#Test" translate="no">Test</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void (*)(bool) </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#funcPtr" translate="no">funcPtr</a></b>(bool <i>b</i>, const char *<i>s</i>)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#inlineFunction" translate="no">inlineFunction</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#methodWithEmDashInItsDocs" translate="no">methodWithEmDashInItsDocs</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#methodWithEnDashInItsDocs" translate="no">methodWithEnDashInItsDocs</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#someFunction" translate="no">someFunction</a></b>(int, int <i>v</i> = 0)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#someFunctionDefaultArg" translate="no">someFunctionDefaultArg</a></b>(int <i>i</i>, bool <i>b</i> = false) const</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#virtualFun" translate="no">virtualFun</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> TestQDoc::Test &</td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#operator-eq" translate="no">operator=</a></b>(TestQDoc::Test &&<i>other</i>)</td></tr> +</table></div> +<h2 id="protected-functions">Protected Functions</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#overload" translate="no">overload</a></b>()</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> <code class="summary extra" translate="no">(since Test 1.2)</code> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#overload-1" translate="no">overload</a></b>(bool <i>b</i>)</td></tr> +</table></div> +<h2 id="related-non-members">Related Non-Members</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#operator-eq-eq" translate="no">operator==</a></b>(const TestQDoc::Test &<i>lhs</i>, const TestQDoc::Test &<i>rhs</i>)</td></tr> +</table></div> +<h2 id="macros">Macros</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> <code class="summary extra" translate="no">(since Test 1.1)</code> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html#QDOCTEST_MACRO2" translate="no">QDOCTEST_MACRO2</a></b>(int &<i>x</i>)</td></tr> +</table></div> +<!-- $$$Test-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +</div> +<!-- @@@Test --> +<div class="types"> +<h2>Member Type Documentation</h2> +<!-- $$$SomeType --> +<h3 class="fn" translate="no" id="SomeType-typedef">Test::<span class="name">SomeType</span></h3> +<p>A typedef.</p> +<!-- @@@SomeType --> +</div> +<div class="func"> +<h2>Member Function Documentation</h2> +<!-- $$$ --> +<div class="fngroup"> +<h3 class="fn fngroupitem" translate="no" id="overload"><code class="details extra" translate="no">[protected]</code> <span class="type">void</span> Test::<span class="name">overload</span>()</h3><h3 class="fn fngroupitem" translate="no" id="overload-1"><code class="details extra" translate="no">[protected, since Test 1.2]</code> <span class="type">void</span> Test::<span class="name">overload</span>(<span class="type">bool</span> <i>b</i>)</h3></div> +<p>Overloads that share a documentation comment, optionally taking a parameter <i translate="no">b</i>.</p> +<!-- @@@ --> +<!-- $$$Test[overload1]$$$Test --> +<h3 class="fn" translate="no" id="Test"><code class="details extra" translate="no">[noexcept default]</code> Test::<span class="name">Test</span>()</h3> +<p>Default constructor.</p> +<!-- @@@Test --> +<!-- $$$funcPtr[overload1]$$$funcPtrboolconstchar* --> +<h3 class="fn" translate="no" id="funcPtr"><span class="type">void</span> (*)(<span class="type">bool</span>) Test::<span class="name">funcPtr</span>(<span class="type">bool</span> <i>b</i>, const <span class="type">char</span> *<i>s</i>)</h3> +<p>Returns a pointer to a function that takes a boolean. Uses <i translate="no">b</i> and <i translate="no">s</i>.</p> +<!-- @@@funcPtr --> +<!-- $$$inlineFunction[overload1]$$$inlineFunction --> +<h3 class="fn" translate="no" id="inlineFunction"><span class="type">void</span> Test::<span class="name">inlineFunction</span>()</h3> +<p>An inline function, documented using the \fn QDoc command.</p> +<!-- @@@inlineFunction --> +<!-- $$$methodWithEmDashInItsDocs[overload1]$$$methodWithEmDashInItsDocs --> +<h3 class="fn" translate="no" id="methodWithEmDashInItsDocs"><span class="type">void</span> Test::<span class="name">methodWithEmDashInItsDocs</span>()</h3> +<p>This method has em dashes in its documentation—as you'll find represented by <code translate="no">---</code> in the sources—here and there. The important bit to note is that when passed e.g. to the \c command, the three hyphens are processed as input to the command and not replaced by an em dash.</p> +<p>-----------------------------------------------------------------------</p> +<p>People can still add a bunch of dashes, though, without QDoc replacing them all with a series of em dashes.</p> +<p>—You can also start a new paragraph with an em dash, if you want to.</p> +<p><b>See also </b><a href="testqdoc-test.html#methodWithEnDashInItsDocs" translate="no">methodWithEnDashInItsDocs</a>.</p> +<!-- @@@methodWithEmDashInItsDocs --> +<!-- $$$methodWithEnDashInItsDocs[overload1]$$$methodWithEnDashInItsDocs --> +<h3 class="fn" translate="no" id="methodWithEnDashInItsDocs"><span class="type">void</span> Test::<span class="name">methodWithEnDashInItsDocs</span>()</h3> +<p>This method has en dashes in its documentation – as you'll find represented by <code translate="no">--</code> in the sources – here and there. The important bit to note is that when passed e.g. to the \c command, the two hyphens are processed as input to the command and not replaced by an en dash. This also applies to code blocks, where otherwise, the decrement operator would get completely borked:</p> +<pre class="cpp" translate="no"><span class="keyword">for</span> (<span class="type">int</span> i <span class="operator">=</span> <span class="number">42</span>; i <span class="operator">></span> <span class="number">0</span>; <span class="operator">-</span><span class="operator">-</span>i) + <span class="comment">// Do something cool during countdown.</span></pre> +<p>...as it would be silly if this would output –i instead of <code translate="no">--i</code>.</p> +<p>-----------------------------------------------------------------------</p> +<p>It still allows people to add a bunch of dashes, though, without replacing them all with a series of en dashes. Of course, they might want to use the \hr command instead, like this:</p> +<hr /> +<p>– You can also start a new paragraph with an en dash, if you want to.</p> +<p><b>See also </b>methodWithEnDashInItsDocs.</p> +<!-- @@@methodWithEnDashInItsDocs --> +<!-- $$$someFunction[overload1]$$$someFunctionintint --> +<h3 class="fn" translate="no" id="someFunction"><span class="type">int</span> Test::<span class="name">someFunction</span>(<span class="type">int</span>, <span class="type">int</span> <i>v</i> = 0)</h3> +<p>Function that takes a parameter <i translate="no">v</i>. Also returns the value of <i translate="no">v</i>.</p> +<!-- @@@someFunction --> +<!-- $$$someFunctionDefaultArg[overload1]$$$someFunctionDefaultArgintbool --> +<h3 class="fn" translate="no" id="someFunctionDefaultArg"><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) const</h3> +<p>Function that takes a parameter <i translate="no">i</i> and <i translate="no">b</i>.</p> +<p><b>Warning:</b> This function is not <a href="https://doc.qt.io/qt/17-qdoc-commands-thread.html#reentrant-command">reentrant</a>.</p> +<!-- @@@someFunctionDefaultArg --> +<!-- $$$virtualFun[overload1]$$$virtualFun --> +<h3 class="fn" translate="no" id="virtualFun"><code class="details extra" translate="no">[virtual]</code> <span class="type">void</span> Test::<span class="name">virtualFun</span>()</h3> +<p>Function that must be reimplemented.</p> +<!-- @@@virtualFun --> +<!-- $$$operator=[overload1]$$$operator=TestQDoc::Test&& --> +<h3 class="fn" translate="no" id="operator-eq"><code class="details extra" translate="no">[noexcept default]</code> <span class="type"><a href="testqdoc-test.html" translate="no">TestQDoc::Test</a></span> &Test::<span class="name">operator=</span>(<span class="type"><a href="testqdoc-test.html" translate="no">TestQDoc::Test</a></span> &&<i>other</i>)</h3> +<p>Move-assigns <i translate="no">other</i>.</p> +<!-- @@@operator= --> +</div> +<div class="relnonmem"> +<h2>Related Non-Members</h2> +<!-- $$$operator==[overload1]$$$operator==constTestQDoc::Test&constTestQDoc::Test& --> +<h3 class="fn" translate="no" id="operator-eq-eq"><span class="type">bool</span> <span class="name">operator==</span>(const <span class="type"><a href="testqdoc-test.html" translate="no">TestQDoc::Test</a></span> &<i>lhs</i>, const <span class="type"><a href="testqdoc-test.html" translate="no">TestQDoc::Test</a></span> &<i>rhs</i>)</h3> +<p>Returns true if <i translate="no">lhs</i> and <i translate="no">rhs</i> are equal.</p> +<!-- @@@operator== --> +</div> +<div class="macros"> +<h2>Macro Documentation</h2> +<!-- $$$QDOCTEST_MACRO2[overload1]$$$QDOCTEST_MACRO2int& --> +<h3 class="fn" translate="no" id="QDOCTEST_MACRO2"><code class="details extra" translate="no">[since Test 1.1]</code> <span class="name">QDOCTEST_MACRO2</span>(<span class="type">int</span> &<i>x</i>)</h3> +<p>A macro with argument <i translate="no">x</i>.</p> +<p>This macro was introduced in Test 1.1.</p> +<!-- @@@QDOCTEST_MACRO2 --> +</div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-testderived-members.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-testderived-members.html new file mode 100644 index 000000000..df89becd0 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-testderived-members.html @@ -0,0 +1,33 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A class in a namespace, derived from Test."> + <title>List of All Members for TestDerived | TestCPP</title> +</head> +<body> +<li><a href="testcpp-module.html" translate="no">C++ Classes</a></li> +<li>TestDerived</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">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" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#DerivedType-typedef" translate="no">DerivedType</a></b></span></li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#NotTypedef-typedef" translate="no">NotTypedef</a></b></span></li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#SomeType-typedef" translate="no">SomeType</a></b></span></li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#funcPtr" translate="no">funcPtr</a></b></span>(bool, const char *) : void (*)(bool)</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#inlineFunction" translate="no">inlineFunction</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#methodWithEmDashInItsDocs" translate="no">methodWithEmDashInItsDocs</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#methodWithEnDashInItsDocs" translate="no">methodWithEnDashInItsDocs</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#overload" translate="no">overload</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#overload-1" translate="no">overload</a></b></span>(bool)</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#someFunction" translate="no">someFunction</a></b></span>(int, int) : int</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#someFunctionDefaultArg" translate="no">someFunctionDefaultArg</a></b></span>(int, bool) const</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#someValue" translate="no">someValue</a></b></span>() : TestQDoc::TestDerived::NotTypedef</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-testderived.html#virtualFun" translate="no">virtualFun</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#virtualFun" translate="no">virtualFun</a></b></span>()</li> +<li class="fn" translate="no"><span class="name"><b><a href="testqdoc-test.html#operator-eq" translate="no">operator=</a></b></span>(TestQDoc::Test &&) : TestQDoc::Test &</li> +</ul> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-testderived-obsolete.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-testderived-obsolete.html new file mode 100644 index 000000000..42b536e09 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-testderived-obsolete.html @@ -0,0 +1,26 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A class in a namespace, derived from Test."> + <title>Obsolete Members for TestDerived | TestCPP</title> +</head> +<body> +<li><a href="testcpp-module.html" translate="no">C++ Classes</a></li> +<li>TestDerived</li> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">Obsolete Members for TestDerived</h1> +<p><b>The following members of class <a href="testqdoc-testderived.html" translate="no">TestDerived</a> are deprecated.</b> They are provided to keep old source code working. We strongly advise against using them in new code.</p> +<h2>Static Public Members</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft topAlign rightAlign"> <code class="summary extra" translate="no">(deprecated)</code> void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived-obsolete.html#staticObsoleteMember" translate="no">staticObsoleteMember</a></b>()</td></tr> +</table></div> +<h2>Member Function Documentation</h2> +<!-- $$$staticObsoleteMember[overload1]$$$staticObsoleteMember --> +<h3 class="fn" translate="no" id="staticObsoleteMember"><code class="details extra" translate="no">[static, deprecated]</code> <span class="type">void</span> TestDerived::<span class="name">staticObsoleteMember</span>()</h3> +<p>This function is deprecated. We strongly advise against using it in new code.</p> +<p>Static obsolete method.</p> +<!-- @@@staticObsoleteMember --> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-testderived.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-testderived.html new file mode 100644 index 000000000..04f789abb --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-testderived.html @@ -0,0 +1,81 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A class in a namespace, derived from Test."> + <title>TestDerived Class | TestCPP</title> +</head> +<body> +<li><a href="testcpp-module.html" translate="no">C++ Classes</a></li> +<li>TestDerived</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#public-types">Public Types</a></li> +<li class="level1"><a href="#public-functions">Public Functions</a></li> +<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" translate="no">TestDerived Class</h1> +<span class="small-subtitle" translate="no">class <a href="testqdoc.html" translate="no">TestQDoc</a>::TestDerived</span> +<!-- $$$TestDerived-brief --> +<p>A class in a namespace, derived from <a href="testqdoc-test.html" translate="no">Test</a>. <a href="#details">More...</a></p> +<!-- @@@TestDerived --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <TestDerived></span></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> CMake:</td><td class="memItemRight bottomAlign"> find_package(Qt6 REQUIRED COMPONENTS QDocTest) <br/> +target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 2.0</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="testqdoc-test.html" translate="no">TestQDoc::Test</a></td></tr> +</table></div> +<ul> +<li><a href="testqdoc-testderived-members.html">List of all members, including inherited members</a></li> +<li><a href="testqdoc-testderived-obsolete.html">Deprecated members</a></li> +</ul> +<h2 id="public-types">Public Types</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#DerivedType-typedef" translate="no">DerivedType</a></b></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#NotTypedef-typedef" translate="no">NotTypedef</a></b></td></tr> +</table></div> +<h2 id="public-functions">Public Functions</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> TestQDoc::TestDerived::NotTypedef </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#someValue" translate="no">someValue</a></b>()</td></tr> +</table></div> +<h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html#virtualFun" translate="no">virtualFun</a></b>() override</td></tr> +</table></div> +<!-- $$$TestDerived-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +</div> +<!-- @@@TestDerived --> +<div class="types"> +<h2>Member Type Documentation</h2> +<!-- $$$DerivedType --> +<h3 class="fn" translate="no" id="DerivedType-typedef"><code class="details extra" translate="no">[alias]</code> TestDerived::<span class="name">DerivedType</span></h3> +<p>An aliased typedef.</p> +<!-- @@@DerivedType --> +<!-- $$$NotTypedef --> +<h3 class="fn" translate="no" id="NotTypedef-typedef"><code class="details extra" translate="no">[alias]</code> TestDerived::<span class="name">NotTypedef</span></h3> +<p>I'm an alias, not a typedef.</p> +<!-- @@@NotTypedef --> +</div> +<div class="func"> +<h2>Member Function Documentation</h2> +<!-- $$$someValue[overload1]$$$someValue --> +<h3 class="fn" translate="no" id="someValue"><span class="type"><a href="testqdoc-testderived.html#NotTypedef-typedef" translate="no">TestQDoc::TestDerived::NotTypedef</a></span> TestDerived::<span class="name">someValue</span>()</h3> +<p>Returns a value using an aliases type.</p> +<!-- @@@someValue --> +<!-- $$$virtualFun[overload1]$$$virtualFun --> +<h3 class="fn" translate="no" id="virtualFun"><code class="details extra" translate="no">[override virtual]</code> <span class="type">void</span> TestDerived::<span class="name">virtualFun</span>()</h3> +<p>Reimplements: <a href="testqdoc-test.html#virtualFun" translate="no">Test::virtualFun</a>().</p> +<!-- @@@virtualFun --> +</div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc.html b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc.html new file mode 100644 index 000000000..425c7b396 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc.html @@ -0,0 +1,64 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testcpp.cpp --> + <meta name="description" content="A namespace."> + <title>TestQDoc Namespace | TestCPP</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#classes">Classes</a></li> +<li class="level1"><a href="#macros">Macros</a></li> +<li class="level1"><a href="#details">Detailed Description</a></li> +<li class="level2"><a href="#usage">Usage</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no">TestQDoc Namespace</h1> +<!-- $$$TestQDoc-brief --> +<p>A namespace. <a href="#details">More...</a></p> +<!-- @@@TestQDoc --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <TestCPP></span></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> CMake:</td><td class="memItemRight bottomAlign"> find_package(Qt6 REQUIRED COMPONENTS QDocTest) <br/> +target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += testcpp</td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 2.0</td></tr> +</table></div> +<h2 id="classes">Classes</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> <code class="summary extra" translate="no">(since 2.0)</code> class </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-test.html" translate="no">Test</a></b></td></tr> +<tr><td class="memItemLeft rightAlign topAlign"> <code class="summary extra" translate="no">(since 2.0)</code> class </td><td class="memItemRight bottomAlign"><b><a href="testqdoc-testderived.html" translate="no">TestDerived</a></b></td></tr> +</table></div> +<h2 id="macros">Macros</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="testqdoc.html#QDOCTEST_MACRO" translate="no">QDOCTEST_MACRO</a></b></td></tr> +</table></div> +<!-- $$$TestQDoc-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +<h3 id="usage">Usage</h3> +<p>This namespace is for testing QDoc output.</p> +</div> +<!-- @@@TestQDoc --> +<div class="classes"> +<h2>Classes</h2> +<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 class in a namespace, derived from <a href="testqdoc-test.html" translate="no">Test</a>. <a href="testqdoc-testderived.html#details">More...</a></p> +<!-- @@@TestDerived --> +</div> +<div class="macros"> +<h2>Macro Documentation</h2> +<!-- $$$QDOCTEST_MACRO[overload1]$$$QDOCTEST_MACRO --> +<h3 class="fn" translate="no" id="QDOCTEST_MACRO"><span class="name">QDOCTEST_MACRO</span></h3> +<!-- @@@QDOCTEST_MACRO --> +</div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/configs/noautolist.qdocconf b/src/qdoc/qdoc/tests/generatedoutput/testdata/configs/noautolist.qdocconf new file mode 100644 index 000000000..ad3b402ea --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/configs/noautolist.qdocconf @@ -0,0 +1,64 @@ +sources.fileextensions = "*.qml *.cpp *.qdoc" +headers.fileextensions = "*.h" + +# images +imagedirs = ../images + +# zero warning policy +warninglimit = 0 +warninglimit.enabled = true + +# don't write host system-specific paths to index files +locationinfo = false + +includepaths += -I../testcpp + +headers = ../testcpp/testcpp.h +sources = ../testcpp/testcpp.cpp \ + ../testcpp/classlists.qdoc + +macro.CMDFN = \\\\fn +macro.nothing = \\dontdocument () +macro.testnoautolist = \\if defined(test_noautolist)\n\\noautolist\n\\endif + +navigation.cppclassespage = "QDoc Test C++ Classes" + +moduleheader = TestCPP + +project = Test +description = "A test project for QDoc build artifacts" +outputdir = ./html + +exampledirs = ../qml + +headerdirs += ../ +sourcedirs += ../qml + +# Exclude source files from other tests' subdirs +excludedirs = ../bug80259 + +examples.fileextensions = "*.qml *.cpp" + +macro.begincomment = "\\c{/*}" +macro.QDocTestVer = "1.1" + +navigation.qmltypespage = "QDoc.Test QML Module" +navigation.qmltypestitle = "Types" +warninglimit += 1 + +manifestmeta.examplecategories = "Application Examples" \ + "Desktop" \ + "Mobile" \ + "Embedded" +defines += test_noautolist + +outputformats = HTML DocBook + +HTML.nosubdirs = true +DocBook.nosubdirs = true +HTML.outputsubdir = noautolist +DocBook.outputsubdir = noautolist-docbook + +# TODO: DocBook generator has trouble handling shared comment nodes +# - allow two warnings related to these +warninglimit = 2 diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/configs/testcpp.qdocconf b/src/qdoc/qdoc/tests/generatedoutput/testdata/configs/testcpp.qdocconf new file mode 100644 index 000000000..1d4ce57a6 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/configs/testcpp.qdocconf @@ -0,0 +1,31 @@ +sources.fileextensions = "*.qml *.cpp *.qdoc" +headers.fileextensions = "*.h" + +# images +imagedirs = ../images + +# zero warning policy +warninglimit = 0 +warninglimit.enabled = true + +# don't write host system-specific paths to index files +locationinfo = false + +# By default, use -outputdir directly, no subdir. +# outputsubdir '.' matches the root of expected_output/ +HTML.nosubdirs = true +HTML.outputsubdir = . + +project = TestCPP +includepaths += -I../testcpp + +headers = ../testcpp/testcpp.h +sources = ../testcpp/testcpp.cpp \ + ../testcpp/classlists.qdoc +exampledirs = ../testcpp/snippets + +macro.CMDFN = \\\\fn +macro.nothing = \\dontdocument () +macro.testnoautolist = \\if defined(test_noautolist)\n\\noautolist\n\\endif + +navigation.cppclassespage = "QDoc Test C++ Classes" diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/configs/testcpp_singleexec.qdocconf b/src/qdoc/qdoc/tests/generatedoutput/testdata/configs/testcpp_singleexec.qdocconf new file mode 100644 index 000000000..e9b72b75d --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/configs/testcpp_singleexec.qdocconf @@ -0,0 +1,32 @@ +sources.fileextensions = "*.qml *.cpp *.qdoc" +headers.fileextensions = "*.h" + +# images +imagedirs = ../images + +# zero warning policy +warninglimit = 0 +warninglimit.enabled = true + +# don't write host system-specific paths to index files +locationinfo = false + +# By default, use -outputdir directly, no subdir. +# outputsubdir '.' matches the root of expected_output/ +HTML.nosubdirs = true +HTML.outputsubdir = . + +project = TestCPP +includepaths += -I../testcpp + +headers = ../testcpp/testcpp.h +sources = ../testcpp/testcpp.cpp \ + ../testcpp/classlists.qdoc +exampledirs = ../testcpp/snippets + +macro.CMDFN = \\\\fn +macro.nothing = \\dontdocument () +macro.testnoautolist = \\if defined(test_noautolist)\n\\noautolist\n\\endif + +navigation.cppclassespage = "QDoc Test C++ Classes" + diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/crossmodule/CrossModule b/src/qdoc/qdoc/tests/generatedoutput/testdata/crossmodule/CrossModule new file mode 100644 index 000000000..50bea93ab --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/crossmodule/CrossModule @@ -0,0 +1,2 @@ +#include "../testcpp/TestCPP" +#include "testtype.h" diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/crossmodule/crossmodule.qdocconf b/src/qdoc/qdoc/tests/generatedoutput/testdata/crossmodule/crossmodule.qdocconf new file mode 100644 index 000000000..404981136 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/crossmodule/crossmodule.qdocconf @@ -0,0 +1,26 @@ +project = CrossModule +includepaths += -I. + +depends = testcpp + +headers = testtype.h +sources = testtype.cpp + +HTML.nosubdirs = true +HTML.outputsubdir = crossmodule + +defines += test_crossmodule + +sources.fileextensions = "*.qml *.cpp *.qdoc" +headers.fileextensions = "*.h" + +# images +imagedirs = ../images + +# zero warning policy +warninglimit = 0 +warninglimit.enabled = true + +# don't write host system-specific paths to index files +locationinfo = false + diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/crossmodule/crossmodule_singleexec.qdocconf b/src/qdoc/qdoc/tests/generatedoutput/testdata/crossmodule/crossmodule_singleexec.qdocconf new file mode 100644 index 000000000..1040bb5ad --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/crossmodule/crossmodule_singleexec.qdocconf @@ -0,0 +1,6 @@ +include(crossmodule.qdocconf) + +sources += namespaces.qdoc + +HTML.nosubdirs = true +HTML.outputsubdir = crossmodule diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/crossmodule/namespaces.qdoc b/src/qdoc/qdoc/tests/generatedoutput/testdata/crossmodule/namespaces.qdoc new file mode 100644 index 000000000..3732008ac --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/crossmodule/namespaces.qdoc @@ -0,0 +1,9 @@ +// Copyright (C) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +/*! + \page all-namespaces.html + \title Namespaces + + \generatelist namespaces +*/ diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/crossmodule/testtype.cpp b/src/qdoc/qdoc/tests/generatedoutput/testdata/crossmodule/testtype.cpp new file mode 100644 index 000000000..d7557da73 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/crossmodule/testtype.cpp @@ -0,0 +1,45 @@ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only +#include "testtype.h" + +/*! + \module CrossModule +*/ + +/*! + Function under a namespace that's documented elsewhere. +*/ +void CrossModuleRef::documentMeToo() +{ +} + +/*! + \class TestType + \inmodule CrossModule + \brief A class inheriting another class that lives in an external doc + module. + + \section1 Linking + + These links go to the parent class: + \list + \li \l {TestQDoc::TestDerived} + \li \l {TestQDoc::}{Test} class \l Usage. + \li QDOCTEST_MACRO + \li DontLinkToMe + \endlist + + \section1 Generated Lists + + This is an annotated list of entries in a group: + \annotatedlist testgroup + + \sa {TestQDoc::Test::}{someFunction()} +*/ + +/*! + Nothing to see here. +*/ +void TestType::nothing() +{ +} diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/crossmodule/testtype.h b/src/qdoc/qdoc/tests/generatedoutput/testdata/crossmodule/testtype.h new file mode 100644 index 000000000..b6b0d446f --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/crossmodule/testtype.h @@ -0,0 +1,16 @@ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only +#pragma once + +#include "../testcpp/testcpp.h" + +namespace CrossModuleRef { + void documentMeToo(); +} + +class TestType : public TestQDoc::TestDerived +{ +public: + TestType() {} + void nothing() {} +}; diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/dontdocument/TestCPP b/src/qdoc/qdoc/tests/generatedoutput/testdata/dontdocument/TestCPP new file mode 100644 index 000000000..7291e6d8f --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/dontdocument/TestCPP @@ -0,0 +1,2 @@ +#include "../TestCPP" +#include "dont.h" diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/dontdocument/dontdocument.qdocconf b/src/qdoc/qdoc/tests/generatedoutput/testdata/dontdocument/dontdocument.qdocconf new file mode 100644 index 000000000..605c68b88 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/dontdocument/dontdocument.qdocconf @@ -0,0 +1,46 @@ +sources.fileextensions = "*.qml *.cpp *.qdoc" +headers.fileextensions = "*.h" + +# images +imagedirs = ../images + +# zero warning policy +warninglimit = 0 +warninglimit.enabled = true + +# don't write host system-specific paths to index files +locationinfo = false + +project = TestCPP +includepaths += -I../testcpp + +headers = ../testcpp/testcpp.h +sources = ../testcpp/testcpp.cpp \ + ../testcpp/classlists.qdoc +exampledirs = ../testcpp/snippets + +macro.CMDFN = \\\\fn +macro.nothing = \\dontdocument () +macro.testnoautolist = \\if defined(test_noautolist)\n\\noautolist\n\\endif + +navigation.cppclassespage = "QDoc Test C++ Classes" + +headers += dont.h +sources += dont.cpp test.qdoc + +qhp.projects = DontDocument + +qhp.DontDocument.file = dontdocument.qhp +qhp.DontDocument.namespace = org.qt-project.dontdocument.001 +qhp.DontDocument.virtualFolder = test +qhp.DontDocument.indexTitle = QDoc Test C++ Classes +qhp.DontDocument.indexRoot = + +qhp.DontDocument.subprojects = classes +qhp.DontDocument.subprojects.classes.title = Classes +qhp.DontDocument.subprojects.classes.indexTitle = QDoc Test C++ Classes +qhp.DontDocument.subprojects.classes.selectors = class +qhp.DontDocument.subprojects.classes.sortPages = true + +HTML.nosubdirs = true +HTML.outputsubdir = dontdocument diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/demo/demo.cpp b/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/demo/demo.cpp new file mode 100644 index 000000000..a5e983503 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/demo/demo.cpp @@ -0,0 +1,11 @@ +// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +bool isOverThousand(int n) +{ +//! [integer literal with separator] + if (n > 1'000) + return true; +//! [integer literal with separator] + return false; +} diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/demo/demo.pro b/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/demo/demo.pro new file mode 100644 index 000000000..dbe8ff3c0 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/demo/demo.pro @@ -0,0 +1,2 @@ +TEMPLATE = aux +message("Nothing to see here.") diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/demo/doc/src/demo.qdoc b/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/demo/doc/src/demo.qdoc new file mode 100644 index 000000000..d06e34ca2 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/demo/doc/src/demo.qdoc @@ -0,0 +1,11 @@ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +/*! + \example demos/demo + \title Demo + \image leonardo-da-vinci.png + //! Icon made by Smashicons from www.flaticon.com + + \snippet demos/demo/demo.cpp integer literal with separator +*/ diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/demo/dontxclude/CMakeLists.txt b/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/demo/dontxclude/CMakeLists.txt new file mode 100644 index 000000000..d29157aad --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/demo/dontxclude/CMakeLists.txt @@ -0,0 +1,2 @@ +cmake_minimum_required(VERSION 3.16) +project (DONTXCLUDEDIRS_QDOCTEST) diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/demo/excludes/CMakeLists.txt b/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/demo/excludes/CMakeLists.txt new file mode 100644 index 000000000..09b447642 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/demo/excludes/CMakeLists.txt @@ -0,0 +1,2 @@ +cmake_minimum_required(VERSION 3.16) +project (EXCLUDEDIR_QDOCTEST) diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/hidden/doc/src/hidden.qdoc b/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/hidden/doc/src/hidden.qdoc new file mode 100644 index 000000000..9001e3d96 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/hidden/doc/src/hidden.qdoc @@ -0,0 +1,11 @@ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +/*! + \example demos/hidden + \title Hidden Demo + \meta tag broken + \brief Tagged 'broken', does not appear in examples-manifest.xml. + + Also missing an image, but that's OK as it's broken anyway. +*/ diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/hidden/hidden.pro b/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/hidden/hidden.pro new file mode 100644 index 000000000..dbe8ff3c0 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/examples/demos/hidden/hidden.pro @@ -0,0 +1,2 @@ +TEMPLATE = aux +message("Nothing to see here.") diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/images/01.png b/src/qdoc/qdoc/tests/generatedoutput/testdata/images/01.png Binary files differnew file mode 100644 index 000000000..d73ab969b --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/images/01.png diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/images/leonardo-da-vinci.png b/src/qdoc/qdoc/tests/generatedoutput/testdata/images/leonardo-da-vinci.png Binary files differnew file mode 100644 index 000000000..854acb4ca --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/images/leonardo-da-vinci.png diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/includefromexampledirs/excludes/anotherindex.qdoc b/src/qdoc/qdoc/tests/generatedoutput/testdata/includefromexampledirs/excludes/anotherindex.qdoc new file mode 100644 index 000000000..f8436416f --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/includefromexampledirs/excludes/anotherindex.qdoc @@ -0,0 +1,14 @@ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +/*! +//! exampledirs-include + \page index.html + \title doc index + + \section1 C++ Classes + \generatelist {classesbymodule TestCPP} + \section1 QML Types + \annotatedlist qmltypes +//! exampledirs-include +*/ diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/includefromexampledirs/excludes/parentinclude.qdoc b/src/qdoc/qdoc/tests/generatedoutput/testdata/includefromexampledirs/excludes/parentinclude.qdoc new file mode 100644 index 000000000..4409fba8f --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/includefromexampledirs/excludes/parentinclude.qdoc @@ -0,0 +1,28 @@ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +/*! +//! abstract-type + \qmltype AbstractParent + \inqmlmodule QDoc.Test + \ingroup qmltypes + \qmlabstract + \brief Abstract base QML type. +//! abstract-type +*/ + +/*! + //! --- Observe the indented snippet tag: + //! children-qmlproperty + \qmlproperty list<Child> AbstractParent::children + \qmldefault + \brief Children of the type. + //! children-qmlproperty +*/ + +/*! +//! rear-qmlmethod + \qmlmethod void AbstractParent::rear(Child child) + \brief Do some abstract parenting on \a child. +//! rear-qmlmethod +*/ diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/includefromexampledirs/includefromexampledirs.qdocconf b/src/qdoc/qdoc/tests/generatedoutput/testdata/includefromexampledirs/includefromexampledirs.qdocconf new file mode 100644 index 000000000..abbfabb87 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/includefromexampledirs/includefromexampledirs.qdocconf @@ -0,0 +1,64 @@ +sources.fileextensions = "*.qml *.cpp *.qdoc" +headers.fileextensions = "*.h" + +# images +imagedirs = ../images + +# zero warning policy +warninglimit = 0 +warninglimit.enabled = true + +# don't write host system-specific paths to index files +locationinfo = false + +includepaths += -I../testcpp + +headers = ../testcpp/testcpp.h +sources = ../testcpp/testcpp.cpp \ + ../testcpp/classlists.qdoc + +macro.CMDFN = \\\\fn +macro.nothing = \\dontdocument () +macro.testnoautolist = \\if defined(test_noautolist)\n\\noautolist\n\\endif + +navigation.cppclassespage = "QDoc Test C++ Classes" + +moduleheader = TestCPP + +project = Test +description = "A test project for QDoc build artifacts" +outputdir = ./html + +exampledirs = ../qml + +headerdirs += ../ +sourcedirs += ../qml + +# Exclude source files from other tests' subdirs +excludedirs = ../bug80259 + +examples.fileextensions = "*.qml *.cpp" + +macro.begincomment = "\\c{/*}" +macro.QDocTestVer = "1.1" + +navigation.qmltypespage = "QDoc.Test QML Module" +navigation.qmltypestitle = "Types" +warninglimit += 1 + +manifestmeta.examplecategories = "Application Examples" \ + "Desktop" \ + "Mobile" \ + "Embedded" + +sourcedirs += src + +excludedirs += excludes \ + ../qml/componentset + +excludefiles += ../qml/parent.qdoc + +exampledirs += excludes + +HTML.nosubdirs = true +HTML.outputsubdir = includefromexampledirs diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/includefromexampledirs/src/includefromparent.qdoc b/src/qdoc/qdoc/tests/generatedoutput/testdata/includefromexampledirs/src/includefromparent.qdoc new file mode 100644 index 000000000..a7ac5454b --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/includefromexampledirs/src/includefromparent.qdoc @@ -0,0 +1,41 @@ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +/*! +\include anotherindex.qdoc exampledirs-include + +\include parent.qdocinc +*/ + +/*! +\include parentinclude.qdoc abstract-type + +\include parent.qdocinc +*/ + +/*! +\include parentinclude.qdoc children-qmlproperty + +\include parent.qdocinc +*/ + +/*! +\include parentinclude.qdoc rear-qmlmethod + +\include parent.qdocinc +*/ + +/*! + \qmltype Child + \inqmlmodule QDoc.Test + \ingroup qmltypes + \inherits AbstractParent + \brief A Child inheriting its parent. +*/ + +/*! + \qmlvaluetype int + \inqmlmodule QDoc.Test + \ingroup qmltypes + \brief An integer value type. +*/ diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/includefromexampledirs/src/parent.qdocinc b/src/qdoc/qdoc/tests/generatedoutput/testdata/includefromexampledirs/src/parent.qdocinc new file mode 100644 index 000000000..307c39dbd --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/includefromexampledirs/src/parent.qdocinc @@ -0,0 +1 @@ +Test include file that is part of the sourcedirs. diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/indexlinking/indexlinking.qdocconf b/src/qdoc/qdoc/tests/generatedoutput/testdata/indexlinking/indexlinking.qdocconf new file mode 100644 index 000000000..f2c1967de --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/indexlinking/indexlinking.qdocconf @@ -0,0 +1,29 @@ +# test linking to entities loaded from index +project = IndexLinking + +# Use a URL different from what the dependency below uses, +# to avoid linking with relative paths. See QTBUG-107762. +url = indexlinking + +depends = \ + qmlpropertygroups + +sources = linking.qdoc + +sources.fileextensions = "*.qml *.cpp *.qdoc" +headers.fileextensions = "*.h" + +# images +imagedirs = ../images + +# zero warning policy +warninglimit = 0 +warninglimit.enabled = true + +# don't write host system-specific paths to index files +locationinfo = false + +# By default, use -outputdir directly, no subdir. +# outputsubdir '.' matches the root of expected_output/ +HTML.nosubdirs = true +HTML.outputsubdir = . diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/indexlinking/linking.qdoc b/src/qdoc/qdoc/tests/generatedoutput/testdata/indexlinking/linking.qdoc new file mode 100644 index 000000000..2206ec712 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/indexlinking/linking.qdoc @@ -0,0 +1,41 @@ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +/*! + \page index-linking.html + \title Linking + + \section1 QML properties + \list A + \li Property group: \l [QML] {Parent::group}. + \li Property in a group: \l [QmlPropertyGroups] + QDoc.Test::Parent::group.c. + \endlist + + \section1 Auto-linking to types in code snippets + + \qml + import QtQuick + + ProgressBar { + // Linking to int value type + property int progress: 0 + } + \endqml + + \code + // 'int' should not link anywhere in C++ code + int main() { int x{0}; return x; } + \endcode +*/ + +/*! + \title LinkModule QML Types + \qmlmodule LinkModule 1.0 +*/ + +/*! + \qmltype GrandChild + \inqmlmodule LinkModule + \inherits AnotherChild +*/ diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/DocTest.qml b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/DocTest.qml new file mode 100644 index 000000000..0bf95132d --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/DocTest.qml @@ -0,0 +1,86 @@ +// Copyright (C) 2019 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +import QtQuick 2.0 + +/*! + \qmltype DocTest + \inherits Test + \inqmlmodule QDoc.Test + \brief Represents a doc test case. + \since QDoc.Test 0.9 + + \section1 Introduction + + A documentation test case, itself documented inline in \DocTest.qml. +*/ +Item { + id: testCase + + /*! + \qmlsignal QDocTest::completed + */ + signal completed + + /*! + \qmlsignal DocTest::test(var bar) + Signal with parameter \a bar. + */ + signal foo(var bar) + + /*! + Signals that something is \a really happening. + */ + signal itsHappening(bool really) + + /*! + \qmlproperty string DocTest::name + + Name of the test. + \qml + DocTest { + name: "test" + // ... + } + \endqml + */ + required property string name + + /*! + Whether the test is active. + \default true + + \sa name + */ + property bool active: true + + /*! \internal */ + property int doctest_internal: -1 + + /*! + \qmlmethod DocTest::fail(message = "oops") + \since QDoc.Test 1.0 + + Fails the current test case, with the optional \a message. + */ + function fail(msg) { + if (msg === undefined) + msg = "oops"; + } + + /*! \internal */ + function doctest_fail(msg) { + if (msg === undefined) + msg = ""; + } + + /*! + \brief Fails the current test case, hard. + \list + \li Prints out \a msg. + \li Accepts a random \a option. + \endlist + */ + function fail_hard(msg = "facepalm", option = 123) { + } +} diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/cmaketest/CMakeLists.txt b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/cmaketest/CMakeLists.txt new file mode 100644 index 000000000..89eafa300 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/cmaketest/CMakeLists.txt @@ -0,0 +1,2 @@ +cmake_minimum_required(VERSION 3.16) +project (QDOCTEST) diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/cmaketest/doc/src/cmaketest.qdoc b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/cmaketest/doc/src/cmaketest.qdoc new file mode 100644 index 000000000..bb7b63263 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/cmaketest/doc/src/cmaketest.qdoc @@ -0,0 +1,9 @@ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +/*! + \example cmaketest + \title CMake Example Project + \image leonardo-da-vinci.png + //! Icon made by Smashicons from www.flaticon.com +*/ diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/cmaketest/main.cpp b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/cmaketest/main.cpp new file mode 100644 index 000000000..68d71eb71 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/cmaketest/main.cpp @@ -0,0 +1 @@ +void main(){} diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/ProgressBar.qml b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/ProgressBar.qml new file mode 100644 index 000000000..39e48da54 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/ProgressBar.qml @@ -0,0 +1,98 @@ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +import QtQuick 1.0 + +/*! + \qmltype ProgressBar + \inqmlmodule UIComponents + \brief A component that shows the progress of an event. + + A ProgressBar shows the linear progress of an event as its \l value. + The range is specified using the \l {minimum} and the \l{maximum} values. + + The ProgressBar component is part of the \l {UI Components} module. + + This documentation is part of the \l{componentset}{UIComponents} example. +*/ +Item { + id: progressbar + + /*! + The minimum value of the ProgressBar range. + The \l value must not be less than this value. + */ + property int minimum: 0 + + /*! + The maximum value of the ProgressBar range. + The \l value must not be more than this value. + */ + property int maximum: 100 + + /*! + The value of the progress. + */ + property int value: 0 + + /*! + \qmlproperty color ProgressBar::color + The color of the ProgressBar's gradient. Must bind to a color type. + + \omit + The "\qmlproperty <type> <property name>" is needed because + property alias need to have their types manually entered. + + QDoc will not publish the documentation within omit and endomit. + \endomit + + \sa secondColor + */ + property alias color: gradient1.color + + /*! + \qmlproperty color ProgressBar::secondColor + The second color of the ProgressBar's gradient. + Must bind to a color type. + + \omit + The "\qmlproperty <type> <property name>" is needed because + property alias need to have their types manually entered. + + QDoc will not publish the documentation within omit and endomit. + \endomit + + \sa color + */ + property alias secondColor: gradient2.color + + width: 250; height: 23 + clip: true + + Rectangle { + id: highlight + + /*! + An internal documentation comment. The widthDest property is not + a public API and therefore will not be exposed. + */ + property int widthDest: ((progressbar.width * (value - minimum)) / (maximum - minimum) - 6) + + width: highlight.widthDest + Behavior on width { SmoothedAnimation { velocity: 1200 } } + + anchors { left: parent.left; top: parent.top; bottom: parent.bottom; margins: 3 } + radius: 1 + gradient: Gradient { + GradientStop { id: gradient1; position: 0.0 } + GradientStop { id: gradient2; position: 1.0 } + } + + } + Text { + anchors { right: highlight.right; rightMargin: 6; verticalCenter: parent.verticalCenter } + color: "white" + font.bold: true + text: Math.floor((value - minimum) / (maximum - minimum) * 100) + '%' + } +} diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/Switch.qml b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/Switch.qml new file mode 100644 index 000000000..2b39bb820 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/Switch.qml @@ -0,0 +1,105 @@ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +import QtQuick 1.0 + +/*! + \qmltype ToggleSwitch + \inqmlmodule UIComponents + \brief A component that can be turned on or off. + + A toggle switch has two states: an \c on and an \c off state. The \c off + state is when the \l on property is set to \c false. + + The ToggleSwitch component is part of the \l {UI Components} module. + + This documentation is part of the \l{componentset}{UIComponents} example. + +*/ +Item { + id: toggleswitch + width: background.width; height: background.height + + /*! + Indicates the state of the switch. If \c false, then the switch is in + the \c off state. + + \omit + The \qmlproperty <type> <propertyname> is not necessary as QDoc + will associate this property to the ToggleSwitch + + QDoc will not publish the documentation within omit and endomit. + \endomit + */ + property bool on: false + + + /*! + A method to toggle the switch. If the switch is \c on, the toggling it + will turn it \c off. Toggling a switch in the \c off position will + turn it \c on. + */ + function toggle() { + if (toggleswitch.state == "on") + toggleswitch.state = "off"; + else + toggleswitch.state = "on"; + } + + + /*! + \internal + + An internal function to synchronize the switch's internals. This + function is not for public access. The \internal command will + prevent QDoc from publishing this comment in the public API. + */ + function releaseSwitch() { + if (knob.x == 1) { + if (toggleswitch.state == "off") return; + } + if (knob.x == 78) { + if (toggleswitch.state == "on") return; + } + toggle(); + } + + Rectangle { + id: background + width: 130; height: 48 + radius: 48 + color: "lightsteelblue" + MouseArea { anchors.fill: parent; onClicked: toggle() } + } + + Rectangle { + id: knob + width: 48; height: 48 + radius: width + color: "lightblue" + + MouseArea { + anchors.fill: parent + drag.target: knob; drag.axis: Drag.XAxis; drag.minimumX: 1; drag.maximumX: 78 + onClicked: toggle() + onReleased: releaseSwitch() + } + } + + states: [ + State { + name: "on" + PropertyChanges { target: knob; x: 78 } + PropertyChanges { target: toggleswitch; on: true } + }, + State { + name: "off" + PropertyChanges { target: knob; x: 1 } + PropertyChanges { target: toggleswitch; on: false } + } + ] + + transitions: Transition { + NumberAnimation { properties: "x"; easing.type: Easing.InOutQuad; duration: 200 } + } +} diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/TabWidget.qml b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/TabWidget.qml new file mode 100644 index 000000000..1816d31c0 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/TabWidget.qml @@ -0,0 +1,146 @@ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +import QtQuick 1.0 + +/*! + \qmltype TabWidget + \inqmlmodule UIComponents + \brief A widget that places its children as tabs. + + A TabWidget places its children as tabs in a view. Selecting + a tab involves selecting the tab at the top. + + The TabWidget component is part of the \l {UI Components} module. + + This documentation is part of the \l{componentset}{UIComponents} example. + + \section1 Adding Tabs + + To add a tab, declare the tab as a child of the TabWidget. + + \code + TabWidget { + id: tabwidget + + Rectangle { + id: tab1 + color: "red" + //... omitted + } + Rectangle { + id: tab2 + color: "blue" + //... omitted + } + + } + \endcode + +*/ +Item { + id: tabWidget + + /*! + \internal + + Setting the default property to stack.children means any child items + of the TabWidget are actually added to the 'stack' item's children. + + See the \l{"Property Binding in QML"} + documentation for details on default properties. + + This is an implementation detail, not meant for public knowledge. Putting + the \internal command at the beginning will cause QDoc to not publish this + documentation in the public API page. + + Normally, a property alias needs to have a + "\qmlproperty <type> <propertyname>" to assign the alias a type. + + */ + default property alias content: stack.children + + + /*! + The currently active tab in the TabWidget. + */ + property int current: 0 + + /*! + A sample \c{read-only} property. + A contrived property to demonstrate QDoc's ability to detect + read-only properties. + + The signature is: + \code + readonly property int sampleReadOnlyProperty: 0 + \endcode + + Note that the property must be initialized to a value. + + */ + readonly property int sampleReadOnlyProperty: 0 + + /*! + \internal + + This handler is an implementation + detail. The \c{\internal} command will prevent QDoc from publishing this + documentation on the public API. + */ + onCurrentChanged: setOpacities() + Component.onCompleted: setOpacities() + + /*! + \internal + + An internal function to set the opacity. + The \internal command will prevent QDoc from publishing this + documentation on the public API. + */ + function setOpacities() { + for (var i = 0; i < stack.children.length; ++i) { + stack.children[i].opacity = (i == current ? 1 : 0) + } + } + + Row { + id: header + + Repeater { + model: stack.children.length + delegate: Rectangle { + width: tabWidget.width / stack.children.length; height: 36 + + Rectangle { + width: parent.width; height: 1 + anchors { bottom: parent.bottom; bottomMargin: 1 } + color: "#acb2c2" + } + BorderImage { + anchors { fill: parent; leftMargin: 2; topMargin: 5; rightMargin: 1 } + border { left: 7; right: 7 } + source: "tab.png" + visible: tabWidget.current == index + } + Text { + horizontalAlignment: Qt.AlignHCenter; verticalAlignment: Qt.AlignVCenter + anchors.fill: parent + text: stack.children[index].title + elide: Text.ElideRight + font.bold: tabWidget.current == index + } + MouseArea { + anchors.fill: parent + onClicked: tabWidget.current = index + } + } + } + } + + Item { + id: stack + width: tabWidget.width + anchors.top: header.bottom; anchors.bottom: tabWidget.bottom + } +} diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/componentset.pro b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/componentset.pro new file mode 100644 index 000000000..5b44737c2 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/componentset.pro @@ -0,0 +1,5 @@ +SOURCES = componentset.pro \ + ProgressBar.qml \ + Switch.qml \ + TabWidget.qml \ + uicomponents.qdoc diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/componentset.qml b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/componentset.qml new file mode 100644 index 000000000..4f75ece75 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/componentset.qml @@ -0,0 +1,7 @@ +// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +import QtQuick 2.0 + +Item { +} diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/examples.qdoc b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/examples.qdoc new file mode 100644 index 000000000..898f706c4 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/examples.qdoc @@ -0,0 +1,82 @@ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +/*! + \example componentset + \title QML Documentation Example + \brief Example for documenting QML types. + + \testnoautolist + + \meta tags {test,sample} + \meta tag {application} + \meta category {Application Example} + \meta installpath tutorials + + This example demonstrates one of the ways to document QML types. It also + generates a warning about a missing example image, on purpose. + + In particular, there are sample types that are documented with QDoc + commands comments. There are documentation comments for the QML types + and their public interfaces. The types are grouped into a module, the + \l{UI Components} module. + + The uicomponents.qdoc file generates + the overview page for the \l{UI Components} module page. + + The generated documentation is available in the \l{UI Components} module. + + \section1 QML Class + + The QML types use the \\qmltype to document the + type. In addition, they have the \\inmodule + command in order for QDoc to associate them to the \c UIComponents module. + + QDoc uses the \\brief command to place a basic + description when listing the types. + + \section1 Properties, Signals, Handlers, and Methods + + The types have their properties, signals, handlers, and methods + defined in their respective QML files. QDoc associates the properties and + methods to the types, therefore, you only need to place the + documentation above the property, method, or signal. + + To document the type of a \e {property alias}, you must use the + \\qmlproperty command to specify the data type. + + \code + \qmlproperty int anAliasedProperty + An aliased property of type int. + \endcode + + \section2 Internal Documentation + + You may declare that a documentation is for internal use by placing the + \\internal command after the beginning QDoc comment + \begincomment. QDoc will prevent the internal documentation from appearing + in the public API. + + If you wish to omit certain parts of the documentation, you may use the + \\omit and \\endomit command. + + \section1 QML Types with C++ Implementation + + This example only demonstrates the documentation for types in QML + files, but the regular QML commands may be placed + inside C++ classes to define the public API of the QML type. + +*/ + + +/*! + \qmlmodule UIComponents 1.0 + \title UI Components + \brief Basic set of UI components. + + This is a listing of a list of UI components implemented by QML types. These + files are available for general import and they are based on the + Qt Quick Code Samples. + + This module is part of the \l{componentset}{UIComponents} example. +*/ diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/uicomponents.qdoc.sample b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/uicomponents.qdoc.sample new file mode 100644 index 000000000..9818adc06 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/componentset/uicomponents.qdoc.sample @@ -0,0 +1,14 @@ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +/*! + \qmlmodule UIComponents 1.0 + \title UI Components + \brief Basic set of UI components + + This is a listing of a list of UI components implemented by QML types. These + files are available for general import and they are based off the \l{Qt + Quick Code Samples}. + + This module is part of the \l{componentset}{UIComponents} example. +*/ diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/doctest/DocTest.qml b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/doctest/DocTest.qml new file mode 100644 index 000000000..ea2312c4c --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/doctest/DocTest.qml @@ -0,0 +1,11 @@ +// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +import QtQuick + +/*! + //! omit the \qmltype command, file name (base) is the type name. + \inqmlmodule Test.NoVer + \brief Shadows the type name in QDoc.Test module. +*/ +Item {} diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/modules.qdoc b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/modules.qdoc new file mode 100644 index 000000000..c3f4379f9 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/modules.qdoc @@ -0,0 +1,19 @@ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +/*! + \page qmlmodules.html + \title QML Modules + + \generatelist qml-modules + + \section1 QML types + + \generatelist qmltypesbymodule QDoc.Test + + \section1 QML value types + + \generatelist qmlvaluetypes + + \generatelist qmlvaluetypesbymodule QDoc.Test +*/ diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/parent.qdoc b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/parent.qdoc new file mode 100644 index 000000000..a2e41eadd --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/parent.qdoc @@ -0,0 +1,87 @@ +// Copyright (C) 2019 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +/*! + \qmltype AbstractParent + \inqmlmodule QDoc.Test + \qmlabstract + \brief Abstract base QML type. +*/ + +/*! + \qmlproperty list<Child> AbstractParent::children + \qmldefault + \brief Children of the type. +*/ + +/*! + \qmlmethod void AbstractParent::rear(Child child, var method = Strict) + \brief Do some abstract parenting on \a child using a specific \a method. +*/ + +/*! + \qmlproperty string AbstractParent::name + \brief Name of this parent. +*/ + +/*! + \qmlmethod void AbstractParent::name(Child child, name) + \brief Name a \a child using \a name. + +*/ + +/*! + \qmlmethod void AbstractParent::name() + \brief Name all children with random names. +*/ + +/*! + \qmltype Child + \inqmlmodule QDoc.Test + \inherits AbstractParent + \brief A Child inheriting its parent. +*/ + +/*! + //! override from abstract base + \qmlproperty string Child::name + \brief Name of this child. +*/ + +/*! + //! override from abstract base + \qmlmethod void Child::name(Child child, name) + \brief Name a \a child of this child using \a name. +*/ + +/*! + \qmlvaluetype int + \inqmlmodule QDoc.Test + + \brief An integer value type. +*/ + +/*! + \qmlmethod int int::abs() + Returns the absolute value of this integer. +*/ + +/*! + \qmltype InternParent + \inqmlmodule QDoc.Test + \internal + \qmlabstract + \brief Internal abstract base QML type. +*/ + +/*! + \qmlproperty int InternParent::prop + \brief Propagated to inheriting type docs. +*/ + +/*! + \qmltype YetAnotherChild + \inherits InternParent + \inqmlmodule QDoc.Test + \brief A type inheriting from internal abstract parent. +*/ diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/type.cpp b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/type.cpp new file mode 100644 index 000000000..f3b8b9f0d --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/qml/type.cpp @@ -0,0 +1,127 @@ +// Copyright (C) 2019 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +#include "testcpp.h" + +/*! + \qmlmodule QDoc.Test \QDocTestVer + \title QDoc.Test QML Module + \brief QML Types for the Test module. + \since 1.1 + \preliminary + + \testnoautolist +*/ + +/*! + \qmlmodule Test.Empty 1.0 + \title No QML Types Here + \brief A QML module with no member types. +*/ + +/*! + \qmlmodule Test.NoVer + \title Versionless QML Module + \brief QML Types for the Test module without version. + \since 1.1 + \modulestate Tech Preview +*/ + +/*! + \qmltype Type + \instantiates TestQDoc::Test + \inqmlmodule QDoc.Test + \brief A QML type documented in a .cpp file. + \meta status { <Work In Progress> } +*/ + +/*! + \qmltype TypeNoVersion + \instantiates TestQDoc::TestDerived + \inqmlmodule Test.NoVer + \brief Another QML type documented in a .cpp file. +*/ + +/*! + \qmltype OldType + \inqmlmodule QDoc.Test + \brief Deprecated old type. + \deprecated [1.0] +*/ + +/*! + \qmlproperty int Type::id + \readonly + \brief A read-only property. +*/ + +/*! + \qmlproperty string QDoc.Test::Type::name + \required + \brief Name of the Test. +*/ + +/*! + \qmlattachedproperty enumeration Type::type + \default Type.NoType + + \value Type.NoType + Nothing + \value Type.SomeType + Something +*/ + +/*! + \qmlproperty int Type::group.first + \qmlproperty int Type::group.second + \qmlproperty int Type::group.third + + \brief A property group. +*/ + +/*! + \qmlsignal Type::group.created + + This signal is prefixed with \e group. +*/ + +/*! + \qmlproperty int Type::fourth + \qmlproperty int Type::fifth + + \brief A group of properties sharing a documentation comment. +*/ + +/*! + \qmlmethod Type Type::copy(a) + + Returns another Type based on \a a. +*/ + +/*! + \qmlmethod Type::enable() + \qmlmethod Type::disable() + + Enables or disables this type. +*/ + +/*! + \qmlsignal Type::completed(int status) + + This signal is emitted when the operation completed with \a status. +*/ + +/*! + \qmlattachedsignal Type::configured() + + This attached signal is emitted when the type was configured. +*/ + +/*! + \qmlmethod Type::deprecatedMethod() + + \deprecated [6.2] This method has no replacement. + + This is a method that should include information about being deprecated + and that it has been so since 6.2 in its docs. +*/ diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/qmlpropertygroups/parent.qdoc b/src/qdoc/qdoc/tests/generatedoutput/testdata/qmlpropertygroups/parent.qdoc new file mode 100644 index 000000000..baabde91d --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/qmlpropertygroups/parent.qdoc @@ -0,0 +1,37 @@ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +/*! + \qmltype Parent + \inqmlmodule QDoc.Test + \brief Base QML type. +*/ + +/*! + \qmlproperty int Parent::group.c + \qmlproperty int Parent::group.a + \qmlproperty int Parent::group.b + \brief Property group. +*/ + +/*! + \qmlproperty int Parent::group.b + \readonly +*/ + +/*! + \qmlproperty int Parent::group.c + \since 2.0 +*/ + +/*! + \qmltype AnotherChild + \inqmlmodule QDoc.Test + \inherits Parent + \brief Just another child inheriting a parent. +*/ + +/*! + \qmlproperty string AnotherChild::name + \brief Name of this child. +*/ diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/qmlpropertygroups/qmlpropertygroups.qdocconf b/src/qdoc/qdoc/tests/generatedoutput/testdata/qmlpropertygroups/qmlpropertygroups.qdocconf new file mode 100644 index 000000000..b2e569e43 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/qmlpropertygroups/qmlpropertygroups.qdocconf @@ -0,0 +1,63 @@ +sources.fileextensions = "*.qml *.cpp *.qdoc" +headers.fileextensions = "*.h" + +# images +imagedirs = ../images + +# zero warning policy +warninglimit = 0 +warninglimit.enabled = true + +# don't write host system-specific paths to index files +locationinfo = false + +includepaths += -I../testcpp + +headers = ../testcpp/testcpp.h +sources = ../testcpp/testcpp.cpp \ + ../testcpp/classlists.qdoc + +macro.CMDFN = \\\\fn +macro.nothing = \\dontdocument () +macro.testnoautolist = \\if defined(test_noautolist)\n\\noautolist\n\\endif + +navigation.cppclassespage = "QDoc Test C++ Classes" + +moduleheader = TestCPP + +project = Test +description = "A test project for QDoc build artifacts" +outputdir = ./html + +exampledirs = ../qml + +headerdirs += ../ +sourcedirs += ../qml + +# Exclude source files from other tests' subdirs +excludedirs = ../bug80259 + +examples.fileextensions = "*.qml *.cpp" + +macro.begincomment = "\\c{/*}" +macro.QDocTestVer = "1.1" + +navigation.qmltypespage = "QDoc.Test QML Module" +navigation.qmltypestitle = "Types" +warninglimit += 1 + +manifestmeta.examplecategories = "Application Examples" \ + "Desktop" \ + "Mobile" \ + "Embedded" + +project = QmlPropertyGroups +url = https://doc.qt.io/${project} + +sourcedirs += . + +outputformats = HTML DocBook + +{HTML.nosubdirs,DocBook.nosubdirs} = true +HTML.outputsubdir = qmlpropertygroups +DocBook.outputsubdir = qmlpropertygroups-docbook diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/singleexec/singleexec.qdocconf b/src/qdoc/qdoc/tests/generatedoutput/testdata/singleexec/singleexec.qdocconf new file mode 100644 index 000000000..7a3354329 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/singleexec/singleexec.qdocconf @@ -0,0 +1,4 @@ +../configs/testcpp_singleexec.qdocconf + +../crossmodule/crossmodule_singleexec.qdocconf + diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/testcpp/TestCPP b/src/qdoc/qdoc/tests/generatedoutput/testdata/testcpp/TestCPP new file mode 100644 index 000000000..4ed786108 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/testcpp/TestCPP @@ -0,0 +1,5 @@ +#include "testcpp.h" + +#ifdef test_template +# include "testtemplate.h" +#endif diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/testcpp/classlists.qdoc b/src/qdoc/qdoc/tests/generatedoutput/testdata/testcpp/classlists.qdoc new file mode 100644 index 000000000..84b543cb2 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/testcpp/classlists.qdoc @@ -0,0 +1,51 @@ +// Copyright (C) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +/*! + \page obsolete-classes.html + \title Obsolete Classes + + \section1 Classes with obsolete members + \generatelist obsoletecppmembers + + \section2 TestQDoc +*/ + +/*! + \page autolinking.html + \title Autolinking + + //! a section title that qualifies for autolinking + \section1 TestQDoc + + The string TestQDoc links to the C++ namespace unless linking explicitly, + \l {#TestQDoc}{like this}, or \l {TestQDoc}{this}. Also, + + Autolinks: + + \list + \li TestQDoc::TestDerived + \endlist + + Explicit links: + + \list + \li \l [CPP] {TestQDoc::TestDerived} + \li \l {Obsolete Classes#TestQDoc} + \endlist + + //! a section title shadowing a known property name + \section1 someProp +*/ + +/*! + \group cpptypes + \title Test C++ Types + + \generatelist testgroup +*/ + +/*! + \externalpage https://doc.qt.io/qt/17-qdoc-commands-thread.html#reentrant-command + \title reentrant +*/ diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/testcpp/properties.qdoc b/src/qdoc/qdoc/tests/generatedoutput/testdata/testcpp/properties.qdoc new file mode 100644 index 000000000..2de2f93d1 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/testcpp/properties.qdoc @@ -0,0 +1,55 @@ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only + +/*! + \property TestQDoc::TestDerived::bindableProp + Some property. + + \sa someProp +*/ + +/*! + \property TestQDoc::TestDerived::someProp + Another property. +*/ + +/*! + \property TestQDoc::TestDerived::name + \brief a name. +*/ + +/*! + \property TestQDoc::TestDerived::intProp + An integer property. +*/ + +/*! + \property TestQDoc::TestDerived::boolProp + A boolean property. +*/ + +/*! + \fn TestQDoc::TestDerived::invokeMe() const + \brief Something invokable. +*/ + +/*! + \qmlmodule TheModule +*/ + +/*! + \qmltype TheType + \instantiates TestQDoc::TestDerived + \inqmlmodule TheModule +*/ + +/*! + \qmlproperty string TheType::name + \brief Read-only status of this property is resolved from Q_PROPERTY. +*/ + +/*! + //! avoid link warnings for auto-generated links to QProperty + \externalpage https://wiki.qt.io/QProperty + \title QProperty +*/ diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/testcpp/snippets/snippet_testcpp.cpp b/src/qdoc/qdoc/tests/generatedoutput/testdata/testcpp/snippets/snippet_testcpp.cpp new file mode 100644 index 000000000..1660fbc2b --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/testcpp/snippets/snippet_testcpp.cpp @@ -0,0 +1,3 @@ +//! [random tag] +You're not supposed to see this. +//! [random tag] diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/testcpp/testcpp.cpp b/src/qdoc/qdoc/tests/generatedoutput/testdata/testcpp/testcpp.cpp new file mode 100644 index 000000000..033db4791 --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/testcpp/testcpp.cpp @@ -0,0 +1,418 @@ +// Copyright (C) 2019 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only +#include "testcpp.h" + +namespace TestQDoc { + +/* +//! [random tag] +\note This is just a test. +//! [random tag] + +//! [args] +\1\2 \3 \2\1 +//! [args] +*/ + +/*! + \module TestCPP + \qtvariable testcpp + \qtcmakepackage QDocTest + \title QDoc Test C++ Classes + \brief A test module page. + \since 2.0 + + \testnoautolist + + \include testcpp.cpp random tag + \include testcpp.cpp {args} {/} {*} {Look, Ma! {I'm made of arguments!}} + +\if defined(test_nestedmacro) + \versionnote {module} {\ver 5.15.0} + \ver 1.0.0 +\endif + + \section1 Linking to function-like things + + \list + \li \l {TestQDoc::Test::someFunctionDefaultArg} + {someFunctionDefaultArg()} + \li QDOCTEST_MACRO2() + \li \l {TestQDoc::Test::}{QDOCTEST_MACRO2(int &x)} + \li \l {section()} + \li \l {section()} {section() is a section title} + \li \l {TestQDoc::Test::Test()} {open( parenthesis} + \li \l {https://en.cppreference.com/w/cpp/utility/move} + {C++11 added std::move(T&& t)} + \endlist + + \section2 section() +*/ + +/*! + \namespace TestQDoc + \inheaderfile TestCPP + \inmodule TestCPP + \brief A namespace. + + \section1 Usage + This namespace is for testing QDoc output. +*/ + +/*! + \class TestQDoc::Test + \inmodule TestCPP + \brief A class in a namespace. + +\if defined(test_ignoresince) + //! omitted by ignoresince + \since 1.1 +\endif + \ingroup testgroup + \ingroup cpptypes + \reentrant +*/ + +/*! + \fn TestQDoc::Test::Test() + + Default constructor. +*/ + +/*! + \fn Test &Test::operator=(Test &&other) + \ingroup testgroup + + Move-assigns \a other. +*/ + +/*! + \class TestQDoc::TestDerived + \inmodule TestCPP + \brief A class in a namespace, derived from \l [CPP] Test. +*/ + +/*! + \macro QDOCTEST_MACRO + \relates TestQDoc +\if defined(test_ignoresince) + //! omitted by ignoresince.Test + \since Test 0.9 +\endif +*/ + +/*! + \macro QDOCTEST_MACRO2(int &x) + \relates TestQDoc::Test + \since Test 1.1 + \brief A macro with argument \a x. + \ingroup testgroup +*/ + +/*! +\if defined(test_properties) + \property TestQDoc::Test::id +\else + \nothing +\endif +*/ + +/*! + \deprecated [6.0] Use someFunction() instead. +*/ +void Test::deprecatedMember() +{ + return; +} + +/*! + \obsolete + + Use someFunction() instead. +*/ +void Test::obsoleteMember() +{ + return; +} + +/*! + \obsolete Use obsoleteMember() instead. +*/ +void Test::anotherObsoleteMember() +{ + return; +} + +/*! + \nonreentrant + Function that takes a parameter \a i and \a b. +\if defined(test_ignoresince) + \since 2.0 +\endif + \ingroup testgroup +*/ +void Test::someFunctionDefaultArg(int i, bool b = false) const +{ + return; +} + +/*! + \fn void Test::func(bool) + \internal +*/ + +/*! + \fn [funcPtr] void (*funcPtr(bool b, const char *s))(bool) + + Returns a pointer to a function that takes a boolean. Uses \a b and \a s. +*/ + +/*! + \fn [op-inc] Test::operator++() + \fn [op-dec] Test::operator--() + \deprecated +*/ + +/*! + This method has en dashes in its documentation -- as you'll find + represented by \c{--} in the sources -- here and there. The important bit + to note is that when passed e.g. to the \\c command, the two hyphens are + processed as input to the command and not replaced by an en dash. This also + applies to code blocks, where otherwise, the decrement operator would get + completely borked: + + \code + for (int i = 42; i > 0; --i) + // Do something cool during countdown. + \endcode + + ...as it would be silly if this would output --i instead of \c {--i}. + + ----------------------------------------------------------------------- + + It still allows people to add a bunch of dashes, though, without replacing + them all with a series of en dashes. Of course, they might want to use the + \\hr command instead, like this: + \hr + + -- You can also start a new paragraph with an en dash, if you want to. + + //! Self-referencing \sa-command for tests. + \sa methodWithEnDashInItsDocs +*/ +void Test::methodWithEnDashInItsDocs() +{ + // Nothing to see here. +} + +/*! + This method has em dashes in its documentation---as you'll find + represented by \c{---} in the sources---here and there. The important bit + to note is that when passed e.g. to the \\c command, the three hyphens are + processed as input to the command and not replaced by an em dash. + + ----------------------------------------------------------------------- + + People can still add a bunch of dashes, though, without QDoc replacing + them all with a series of em dashes. + + ---You can also start a new paragraph with an em dash, if you want to. + + \sa methodWithEnDashInItsDocs + +*/ +void Test::methodWithEmDashInItsDocs() +{ + // Woah! Look at that! +} + +// Documented below with an \fn command. Unnecessary but we support it, and it's used. +int Test::someFunction(int, int v) +{ + return v; +} + +/*! + \fn void TestQDoc::Test::inlineFunction() + + \brief An inline function, documented using the \CMDFN QDoc command. +*/ + +/*! + \fn int Test::someFunction(int, int v = 0) + + Function that takes a parameter \a v. + Also returns the value of \a v. +\if defined(test_ignoresince) + \since Test 1.0 +\endif +*/ + +/*! + Function that must be reimplemented. +*/ +void Test::virtualFun() +{ + return; +} + +/*! + \fn bool Test::operator==(const Test &lhs, const Test &rhs) + + Returns true if \a lhs and \a rhs are equal. +*/ + +/*! + \typedef TestQDoc::Test::SomeType + \brief A typedef. +*/ + +/*! + \reimp +*/ +void TestDerived::virtualFun() +{ + return; +} + +/*! + \fn TestQDoc::Test::overload() + \fn Test::overload(bool b) + //! The second overload should match even without the fully qualified path + + Overloads that share a documentation comment, optionally taking + a parameter \a b. +*/ + +/*! + \fn Test::overload(bool b) + \since Test 1.2 +*/ + +/*! + \typealias TestQDoc::TestDerived::DerivedType + An aliased typedef. +*/ + +/*! + \typedef TestQDoc::TestDerived::NotTypedef + I'm an alias, not a typedef. +*/ + +/*! + \obsolete + + Static obsolete method. +*/ +void TestDerived::staticObsoleteMember() +{ + return; +} + +/*! +\if defined(test_properties) + \fn void TestDerived::emitSomething() + Emitted when things happen. +\else + \nothing +\endif +*/ + +/*! +\if defined(test_properties) + \reimp +\else + \nothing +\endif +*/ +int TestDerived::id() +{ + return 1; +} + +/*! + Returns a value using an aliases type. +*/ +TestDerived::NotTypedef TestDerived::someValue() +{ + return 0; +} + +/*! +\if defined(test_template) + \fn template <typename T1, typename T2> void TestQDoc::Test::funcTemplate(T1 a, T2 b) + \brief Function template with two parameters, \a a and \a b. +\else + \nothing +\endif +*/ + +/*! +\if defined(test_template) + \struct TestQDoc::Test::Struct + \inmodule TestCPP + \brief Templated struct. +\else + \nothing +\endif +*/ + +/*! +\if defined(test_template) + \typealias TestQDoc::Test::Specialized +\else + \nothing +\endif +*/ + +/*! +\if defined(test_template) + \class TestQDoc::Vec + \inmodule TestCPP + \brief Type alias that has its own reference. +\else + \nothing +\endif +*/ + +/*! +\if defined(test_template) + \macro Q_INVOKABLE + \relates TestQDoc::Test + + This is a mock Q_INVOKABLE for the purpose of ensuring QDoc autolink to it + as expected. +\else + \nothing +\endif +*/ + +} // namespace TestQDoc + + +/*! + \namespace CrossModuleRef + \inmodule TestCPP + \brief Namespace that has documented functions in multiple modules. + \since 3.0 +*/ +namespace CrossModuleRef { + +/*! + Document me! +*/ +void documentMe() +{ +} + +} // namespace CrossModuleRef + +/*! + \class DontLinkToMe + \inmodule TestCPP + \brief Class that does not generate documentation. +*/ + +/*! + \dontdocument (DontLinkToMe) +*/ diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/testcpp/testcpp.h b/src/qdoc/qdoc/tests/generatedoutput/testdata/testcpp/testcpp.h new file mode 100644 index 000000000..a5b2d221f --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/testdata/testcpp/testcpp.h @@ -0,0 +1,137 @@ +// Copyright (C) 2019 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only +#pragma once + +#ifdef test_properties +#include <QtCore/qmetaobject.h> +#include <QtCore/qproperty.h> +#include <QtCore/qstring.h> +#endif + +#define QDOCTEST_MACRO test +#define QDOCTEST_MACRO2(x) (x) < 0 ? 0 : (x)) + +namespace TestQDoc { + +class Test { +#ifdef test_properties + Q_OBJECT + Q_PROPERTY(int id READ id) +#endif +public: + +#ifdef test_template +template<typename D, typename T> struct Struct {}; +template<typename T> +using Specialized = Struct<int, T>; +#endif + +#ifdef test_template +# define Q_INVOKABLE void foo() {}; +#endif + +#ifdef test_scopedenum + enum ClassicEnum { Yee, Haw, Howdy, Partner }; + + enum class ScopedEnum : unsigned char { + This = 0x01, + That = 0x02, + All = This | That, + OmittedValue = 99, + UselessValue, + VeryLastValue + }; +#endif + typedef struct { + int data; + } SomeType; + int someFunction(int, int v = 0); + void someFunctionDefaultArg(int i, bool b) const; + void obsoleteMember(); + void anotherObsoleteMember(); + void deprecatedMember(); + void methodWithEnDashInItsDocs(); + void methodWithEmDashInItsDocs(); + void func(bool) {}; + //! [funcPtr] + void (*funcPtr(bool b, const char *s))(bool) { + return func; + } + //! [op-inc] + Test &operator++() { return *this; } + //! [op-dec] + Test &operator--() { return *this; } + + void anotherFunc() {}; + inline void inlineFunction() {}; + virtual void virtualFun(); + + friend bool operator==(const Test &lhs, const Test &rhs) { return false; } + +protected: + void overload() {} + void overload(bool b) { if (!b) return; } +#ifdef test_template + template <typename T1, typename T2> void funcTemplate(T1 a, T2 b) { + a = b; + } +#endif +#ifdef test_properties + virtual int id() { return 0; } +#endif +}; + +class TestDerived : public Test { +#ifdef test_properties + Q_OBJECT + + Q_PROPERTY(QString bindableProp READ bindableProp WRITE setBindableProp NOTIFY bindablePropChanged BINDABLE bindableProp) + Q_PROPERTY(QString someProp READ someProp BINDABLE somBindableProp) + Q_PROPERTY(int *intProp READ getInt STORED false CONSTANT FINAL) + Q_PROPERTY(const QString *name READ name) + QDOC_PROPERTY(bool boolProp READ boolProp WRITE setBoolProp NOTIFY boolPropChanged RESET resetBoolProp REVISION 1) +#endif + +public: + using DerivedType = Test::SomeType; + using NotTypedef = int; + void virtualFun() override; + static void staticObsoleteMember(); + NotTypedef someValue(); +#ifdef test_properties + QBindable<QString> bindableProp(); + QBindable<QString> someBindableProp(); + const QString &someProp(); + int *getInt(); + bool boolProp(); + const QString *name() const; + + Q_INVOKABLE void invokeMe() const {} + int id() override; + +Q_SIGNALS: + void emitSomething(QPrivateSignal); + void bindablePropChanged(); + Q_REVISION(1) void boolPropChanged(); + +public Q_SLOTS: + void setBindableProp(const QString &s); + void setBoolProp(bool b); + void resetBoolProp(); +#endif +}; + +#ifdef test_template +template <typename T> +struct BaseVec {}; +template <typename T> +using Vec = BaseVec<T>; +#endif + +} // namespace TestQDoc + +namespace CrossModuleRef { + void documentMe(); +} + +class DontLinkToMe {}; diff --git a/src/qdoc/qdoc/tests/generatedoutput/tst_generatedoutput.cpp b/src/qdoc/qdoc/tests/generatedoutput/tst_generatedoutput.cpp new file mode 100644 index 000000000..07ded08ad --- /dev/null +++ b/src/qdoc/qdoc/tests/generatedoutput/tst_generatedoutput.cpp @@ -0,0 +1,283 @@ +// Copyright (C) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only +#include <QProcess> +#include <QTemporaryDir> +#include <QDirIterator> +#include <QtTest> + +class tst_generatedOutput : public QObject +{ + Q_OBJECT + +public: + void setRegenerate() { m_regen = true; } + +private slots: + void initTestCase(); + void init(); + + // HTML generator + void htmlFromCpp(); + + // Output format independent tests + void inheritedQmlPropertyGroups(); + void crossModuleLinking(); + void indexLinking(); + void includeFromExampleDirs(); + void singleExec(); + void preparePhase(); + void generatePhase(); + void noAutoList(); + +private: + QScopedPointer<QTemporaryDir> m_outputDir; + QString m_qdoc; + QDir m_expectedDir; + QString m_extraParams; + bool m_regen = false; + + void runQDocProcess(const QStringList &arguments); + void compareLineByLine(const QStringList &expectedFiles); + void testAndCompare(const char *input, const char *outNames, const char *extraParams = nullptr); + void copyIndexFiles(); +}; + +void tst_generatedOutput::initTestCase() +{ + // Build the path to the QDoc binary the same way moc tests do for moc. + const auto binpath = QLibraryInfo::path(QLibraryInfo::BinariesPath); + const auto extension = QSysInfo::productType() == "windows" ? ".exe" : ""; + m_qdoc = binpath + QLatin1String("/qdoc") + extension; + m_expectedDir.setPath(QFINDTESTDATA("expected_output")); + + // Resolve the path to the file containing extra parameters + m_extraParams = QFileInfo(QTest::currentAppName()).dir().filePath("qdocincludepaths.inc"); + if (!QFileInfo::exists(m_extraParams)) { + qWarning().nospace() << QStringLiteral("Cannot locate") + << qUtf8Printable(m_extraParams); + m_extraParams.clear(); + } else { + m_extraParams.insert(0, '@'); + } +} + +void tst_generatedOutput::init() +{ + m_outputDir.reset(new QTemporaryDir()); + if (!m_outputDir->isValid()) { + const QString errorMessage = + "Couldn't create temporary directory: " + m_outputDir->errorString(); + QFAIL(qPrintable(errorMessage)); + } +} + +void tst_generatedOutput::runQDocProcess(const QStringList &arguments) +{ + QProcess qdocProcess; + qdocProcess.setProgram(m_qdoc); + qdocProcess.setArguments(arguments); + + auto failQDoc = [&](QProcess::ProcessError) { + QFAIL(qPrintable(QStringLiteral("Running qdoc failed with exit code %1: %2") + .arg(qdocProcess.exitCode()).arg(qdocProcess.errorString()))); + }; + QObject::connect(&qdocProcess, &QProcess::errorOccurred, this, failQDoc); + + qdocProcess.start(); + qdocProcess.waitForFinished(); + if (qdocProcess.exitCode() == 0) + return; + + QString errors = qdocProcess.readAllStandardError(); + if (!errors.isEmpty()) + qInfo().nospace() << "Received errors:\n" << qUtf8Printable(errors); + if (!QTest::currentTestFailed()) + failQDoc(QProcess::UnknownError); +} + +void tst_generatedOutput::compareLineByLine(const QStringList &expectedFiles) +{ + for (const auto &file : expectedFiles) { + QString expected(m_expectedDir.filePath(file)); + QString actual(m_outputDir->filePath(file)); + + QFile expectedFile(expected); + if (!expectedFile.open(QIODevice::ReadOnly)) + QFAIL(qPrintable(QString("Cannot open expected data file: %1").arg(expected))); + QTextStream expectedIn(&expectedFile); + + QFile actualFile(actual); + if (!actualFile.open(QIODevice::ReadOnly)) + QFAIL(qPrintable(QString("Cannot open actual data file: %1").arg(actual))); + QTextStream actualIn(&actualFile); + + const QLatin1String delim(": "); + int lineNumber = 0; + while (!expectedIn.atEnd() && !actualIn.atEnd()) { + lineNumber++; + QString prefix = file + delim + QString::number(lineNumber) + delim; + QString expectedLine = prefix + expectedIn.readLine(); + QString actualLine = prefix + actualIn.readLine(); + QCOMPARE(actualLine, expectedLine); + } + } +} + +void tst_generatedOutput::testAndCompare(const char *input, const char *outNames, + const char *extraParams) +{ + QStringList args{ "-outputdir", m_outputDir->path() + "/", QFINDTESTDATA(input) }; + if (extraParams) + args << QString(QLatin1String(extraParams)).split(QChar(' ')); + + runQDocProcess(args); + + if (QTest::currentTestFailed()) + return; + + QStringList expectedOuts(QString(QLatin1String(outNames)).split(QChar(' '))); + if (m_regen) { + QVERIFY(m_expectedDir.mkpath(m_expectedDir.path())); + for (const auto &file : std::as_const(expectedOuts)) { + QFileInfo fileInfo(m_expectedDir.filePath(file)); + fileInfo.dir().remove(fileInfo.fileName()); // Allowed to fail + QVERIFY(m_expectedDir.mkpath(fileInfo.dir().path())); + QVERIFY2(QFile::copy(m_outputDir->filePath(file), fileInfo.filePath()), + qPrintable(QStringLiteral("Failed to copy '%1'").arg(file))); + } + QSKIP("Regenerated expected output only."); + } + + compareLineByLine(expectedOuts); +} + +// Copy <project>.index to <project>/<project>.index in the outputdir +void tst_generatedOutput::copyIndexFiles() +{ + QDirIterator it(m_outputDir->path(), QStringList("*.index"), QDir::Files, QDirIterator::Subdirectories); + while (it.hasNext()) { + QFileInfo fileInfo(it.next()); + QDir indexDir(m_outputDir->path()); + QVERIFY(indexDir.mkpath(fileInfo.baseName())); + QVERIFY(indexDir.cd(fileInfo.baseName())); + if (!indexDir.exists(fileInfo.fileName())) + QVERIFY(QFile::copy(fileInfo.filePath(), indexDir.filePath(fileInfo.fileName()))); + } +} + +void tst_generatedOutput::htmlFromCpp() +{ + testAndCompare("testdata/configs/testcpp.qdocconf", + "testcpp-module.html " + "testqdoc-test.html " + "testqdoc-test-members.html " + "testqdoc-test-obsolete.html " + "testqdoc-testderived.html " + "testqdoc-testderived-members.html " + "testqdoc-testderived-obsolete.html " + "obsolete-classes.html " + "autolinking.html " + "cpptypes.html " + "testqdoc.html"); +} + +void tst_generatedOutput::inheritedQmlPropertyGroups() +{ + testAndCompare("testdata/qmlpropertygroups/qmlpropertygroups.qdocconf", + "qmlpropertygroups/qml-qdoc-test-anotherchild-members.html " + "qmlpropertygroups/qml-qdoc-test-parent.html " + "qmlpropertygroups-docbook/qml-qdoc-test-parent.xml"); +} + +void tst_generatedOutput::indexLinking() +{ + { + QScopedValueRollback<bool> skipRegen(m_regen, false); + inheritedQmlPropertyGroups(); + } + copyIndexFiles(); + QString indexDir = QLatin1String("-indexdir ") + m_outputDir->path(); + testAndCompare("testdata/indexlinking/indexlinking.qdocconf", + "index-linking.html " + "qml-linkmodule-grandchild-members.html", + indexDir.toLatin1().data()); +} + +void tst_generatedOutput::crossModuleLinking() +{ + { + QScopedValueRollback<bool> skipRegen(m_regen, false); + htmlFromCpp(); + } + copyIndexFiles(); + QString indexDir = QLatin1String("-indexdir ") + m_outputDir->path(); + testAndCompare("testdata/crossmodule/crossmodule.qdocconf", + "crossmodule/testtype.html " + "crossmodule/testtype-members.html " + "crossmodule/crossmoduleref-sub-crossmodule.html", + indexDir.toLatin1().data()); +} + +void tst_generatedOutput::includeFromExampleDirs() +{ + testAndCompare("testdata/includefromexampledirs/includefromexampledirs.qdocconf", + "includefromexampledirs/index.html " + "includefromexampledirs/qml-qdoc-test-abstractparent.html " + "includefromexampledirs/qml-qdoc-test-abstractparent-members.html"); +} + +void tst_generatedOutput::singleExec() +{ + // Build both testcpp and crossmodule projects in single-exec mode + testAndCompare("testdata/singleexec/singleexec.qdocconf", + "testcpp/testcpp-module.html " + "testcpp/testqdoc-test.html " + "testcpp/testqdoc-test-members.html " + "testcpp/testqdoc.html " + "testcpp/crossmoduleref.html " + "crossmodule/crossmodule/all-namespaces.html " + "crossmodule/crossmodule/testtype.html " + "crossmodule/crossmodule/testtype-members.html", + "-single-exec"); +} + +void tst_generatedOutput::preparePhase() +{ + testAndCompare("testdata/configs/testcpp.qdocconf", + "testcpp.index", + "-prepare"); +} + +void tst_generatedOutput::generatePhase() +{ + testAndCompare("testdata/configs/testcpp.qdocconf", + "testcpp-module.html " + "testqdoc-test.html " + "testqdoc-test-members.html " + "testqdoc.html", + "-generate"); +} + +void tst_generatedOutput::noAutoList() +{ + testAndCompare("testdata/configs/noautolist.qdocconf", + "noautolist/testcpp-module.html " + "noautolist/test-componentset-example.html " + "noautolist/qdoc-test-qmlmodule.html " + "noautolist-docbook/testcpp-module.xml " + "noautolist-docbook/test-componentset-example.xml " + "noautolist-docbook/qdoc-test-qmlmodule.xml"); +} + +int main(int argc, char *argv[]) +{ + tst_generatedOutput tc; + // Re-populate expected data and skip tests if option -regenerate is set + if (argc == 2 && QByteArray(argv[1]) == "-regenerate") { + tc.setRegenerate(); + --argc; + } + return QTest::qExec(&tc, argc, argv); +} + +#include "tst_generatedoutput.moc" |
