diff options
author | Paul Wicking <paul.wicking@qt.io> | 2024-03-21 14:09:09 +0100 |
---|---|---|
committer | Paul Wicking <paul.wicking@qt.io> | 2024-04-03 07:33:39 +0100 |
commit | b30834e1995dae431a2de5bd9075c665bc7b3dd0 (patch) | |
tree | 6b25a4f1f5404bf84d170d6740f1cd3254afd7bf | |
parent | b979e82cc1dbf0497e59a604e771f920c28c8f8f (diff) |
QDoc: Move `dontdocument` test
QDoc's new `tst_validateQdocOutputFiles` provides better
infrastructure for testing output generated by QDoc than
`tst_generatedOutput` does. Move the test data for the `dontdocument`
test case of the latter into the `comprehensiveproject` of the former,
and modify the expected output accordingly.
Task-number: QTBUG-119500
Pick-to: 6.7
Change-Id: Ib8ca88ff2e7545c60920b0042c6d8b944ea54722
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
19 files changed, 129 insertions, 91 deletions
diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/dontdocument/dontdocument.qhp b/src/qdoc/qdoc/tests/generatedoutput/expected_output/dontdocument/dontdocument.qhp deleted file mode 100644 index 7d789e193..000000000 --- a/src/qdoc/qdoc/tests/generatedoutput/expected_output/dontdocument/dontdocument.qhp +++ /dev/null @@ -1,75 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<QtHelpProject version="1.0"> - <namespace>org.qt-project.dontdocument.001</namespace> - <virtualFolder>test</virtualFolder> - <metaData name="version" value=""/> - <filterSection> - <toc> - <section ref="testcpp-module.html" title="QDoc Test C++ Classes"> - <section ref="testcpp-module.html" title="Classes"> - <section ref="seenclass.html" title="SeenClass Class Reference"/> - <section ref="testqdoc-test.html" title="TestQDoc::Test Class Reference"> - <section ref="testqdoc-test-members.html" title="List of all members"/> - <section ref="testqdoc-test-obsolete.html" title="Obsolete members"/> - </section> - <section ref="testqdoc-testderived.html" title="TestQDoc::TestDerived Class Reference"> - <section ref="testqdoc-testderived-members.html" title="List of all members"/> - <section ref="testqdoc-testderived-obsolete.html" title="Obsolete members"/> - </section> - </section> - </section> - </toc> - <keywords> - <keyword name="Autolinking" id="Autolinking" ref="autolinking.html"/> - <keyword name="Classes" id="Classes" ref="classes.html"/> - <keyword name="CrossModuleRef" id="CrossModuleRef" ref="crossmoduleref.html"/> - <keyword name="Obsolete Classes" id="Obsolete Classes" ref="obsolete-classes.html"/> - <keyword name="QDOCTEST_MACRO" id="QDOCTEST_MACRO" ref="testqdoc.html#QDOCTEST_MACRO"/> - <keyword name="QDOCTEST_MACRO2" id="QDOCTEST_MACRO2" ref="testqdoc-test.html#QDOCTEST_MACRO2"/> - <keyword name="QDoc Test C++ Classes" id="QDoc Test C++ Classes" ref="testcpp-module.html"/> - <keyword name="SeenClass" id="SeenClass" ref="seenclass.html"/> - <keyword name="Test" id="TestQDoc::Test" ref="testqdoc-test.html"/> - <keyword name="Test C++ Types" id="Test C++ Types" ref="cpptypes.html"/> - <keyword name="Test::SomeType" id="Test::SomeType" ref="testqdoc-test.html#SomeType-typedef"/> - <keyword name="TestDerived" id="TestQDoc::TestDerived" ref="testqdoc-testderived.html"/> - <keyword name="TestDerived::DerivedType" id="TestDerived::DerivedType" ref="testqdoc-testderived.html#DerivedType-typedef"/> - <keyword name="TestDerived::NotTypedef" id="TestDerived::NotTypedef" ref="testqdoc-testderived.html#NotTypedef-typedef"/> - <keyword name="TestQDoc" id="TestQDoc" ref="testqdoc.html"/> - <keyword name="anotherObsoleteMember" id="Test::anotherObsoleteMember" ref="testqdoc-test-obsolete.html#anotherObsoleteMember"/> - <keyword name="deprecatedMember" id="Test::deprecatedMember" ref="testqdoc-test-obsolete.html#deprecatedMember"/> - <keyword name="documentMe" id="CrossModuleRef::documentMe" ref="crossmoduleref.html#documentMe"/> - <keyword name="funcPtr" id="Test::funcPtr" ref="testqdoc-test.html#funcPtr"/> - <keyword name="inlineFunction" id="Test::inlineFunction" ref="testqdoc-test.html#inlineFunction"/> - <keyword name="methodWithEmDashInItsDocs" id="Test::methodWithEmDashInItsDocs" ref="testqdoc-test.html#methodWithEmDashInItsDocs"/> - <keyword name="methodWithEnDashInItsDocs" id="Test::methodWithEnDashInItsDocs" ref="testqdoc-test.html#methodWithEnDashInItsDocs"/> - <keyword name="obsoleteMember" id="Test::obsoleteMember" ref="testqdoc-test-obsolete.html#obsoleteMember"/> - <keyword name="operator++" id="Test::operator++" ref="testqdoc-test-obsolete.html#operator-2b-2b"/> - <keyword name="operator--" id="Test::operator--" ref="testqdoc-test-obsolete.html#operator--"/> - <keyword name="operator=" id="Test::operator=" ref="testqdoc-test.html#operator-eq"/> - <keyword name="operator==" id="operator==" ref="testqdoc-test.html#operator-eq-eq"/> - <keyword name="overload" id="Test::overload" ref="testqdoc-test.html#overload"/> - <keyword name="someFunction" id="Test::someFunction" ref="testqdoc-test.html#someFunction"/> - <keyword name="someFunctionDefaultArg" id="Test::someFunctionDefaultArg" ref="testqdoc-test.html#someFunctionDefaultArg"/> - <keyword name="someValue" id="TestDerived::someValue" ref="testqdoc-testderived.html#someValue"/> - <keyword name="staticObsoleteMember" id="TestDerived::staticObsoleteMember" ref="testqdoc-testderived-obsolete.html#staticObsoleteMember"/> - <keyword name="virtualFun" id="Test::virtualFun" ref="testqdoc-test.html#virtualFun"/> - <keyword name="virtualFun" id="TestDerived::virtualFun" ref="testqdoc-testderived.html#virtualFun"/> - </keywords> - <files> - <file>autolinking.html</file> - <file>classes.html</file> - <file>cpptypes.html</file> - <file>crossmoduleref.html</file> - <file>obsolete-classes.html</file> - <file>seenclass.html</file> - <file>testcpp-module.html</file> - <file>testqdoc-test-members.html</file> - <file>testqdoc-test-obsolete.html</file> - <file>testqdoc-test.html</file> - <file>testqdoc-testderived-members.html</file> - <file>testqdoc-testderived-obsolete.html</file> - <file>testqdoc-testderived.html</file> - <file>testqdoc.html</file> - </files> - </filterSection> -</QtHelpProject> diff --git a/src/qdoc/qdoc/tests/generatedoutput/tst_generatedoutput.cpp b/src/qdoc/qdoc/tests/generatedoutput/tst_generatedoutput.cpp index d88004d3f..64218523d 100644 --- a/src/qdoc/qdoc/tests/generatedoutput/tst_generatedoutput.cpp +++ b/src/qdoc/qdoc/tests/generatedoutput/tst_generatedoutput.cpp @@ -20,7 +20,6 @@ private slots: void htmlFromCpp(); // Output format independent tests - void dontDocument(); void inheritedQmlPropertyGroups(); void crossModuleLinking(); void indexLinking(); @@ -184,14 +183,6 @@ void tst_generatedOutput::htmlFromCpp() "testqdoc.html"); } -void tst_generatedOutput::dontDocument() -{ - testAndCompare("testdata/dontdocument/dontdocument.qdocconf", - "dontdocument/classes.html " - "dontdocument/seenclass.html " - "dontdocument/dontdocument.qhp"); -} - void tst_generatedOutput::inheritedQmlPropertyGroups() { testAndCompare("testdata/qmlpropertygroups/qmlpropertygroups.qdocconf", diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/comprehensiveproject.qdocconf b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/comprehensiveproject.qdocconf index 7e7c73dae..4315e216d 100644 --- a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/comprehensiveproject.qdocconf +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/comprehensiveproject.qdocconf @@ -23,9 +23,12 @@ DocBook.usedocbookextensions = true includepaths += -I. -headers = testcpp.h +headers = testcpp.h \ + dont.h sources = testcpp.cpp \ - classlists.qdoc + classlists.qdoc \ + dont.cpp \ + unseenclass.qdoc exampledirs = snippets macro.CMDFN = \\\\fn diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/dontdocument/dont.cpp b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/dont.cpp index 02337e2e4..02337e2e4 100644 --- a/src/qdoc/qdoc/tests/generatedoutput/testdata/dontdocument/dont.cpp +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/dont.cpp diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/dontdocument/dont.h b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/dont.h index 4db913e55..4db913e55 100644 --- a/src/qdoc/qdoc/tests/generatedoutput/testdata/dontdocument/dont.h +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/dont.h diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/classes.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/classes.xml new file mode 100644 index 000000000..68d7a4616 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/classes.xml @@ -0,0 +1,30 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title>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 project for QDoc build artifacts.</db:para></db:abstract> +</db:info> +<db:variablelist role="annotatedclasses"> +<db:varlistentry> +<db:term><db:link xlink:href="seenclass.xml" xlink:role="class">SeenClass</db:link></db:term> +<db:listitem> +<db:para>A public but undocumented class.</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term><db:link xlink:href="testqdoc-test.xml" xlink:role="class">TestQDoc::Test</db:link></db:term> +<db:listitem> +<db:para>A class in a namespace.</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term><db:link xlink:href="testqdoc-testderived.xml" xlink:role="class">TestQDoc::TestDerived</db:link></db:term> +<db:listitem> +<db:para>A class in a namespace, derived from Test.</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/seenclass.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/seenclass.xml new file mode 100644 index 000000000..abb697567 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/seenclass.xml @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en"> +<db:info> +<db:title its:translate="no">SeenClass Class</db:title> +<db:productname>Test</db:productname> +<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev> +<db:abstract> +<db:para>A public but undocumented class.</db:para> +<db:para>This class was introduced in Qt 2.0.</db:para> +</db:abstract> +</db:info> +<db:variablelist its:translate="no"> +<db:varlistentry> +<db:term>Header</db:term> +<db:listitem> +<db:para>SeenClass</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Since</db:term> +<db:listitem> +<db:para>Qt 2.0</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>CMake</db:term> +<db:listitem> +<db:para>find_package(Qt6 REQUIRED COMPONENTS QDocTest)</db:para> +<db:para>target_link_libraries(mytarget PRIVATE Qt6::QDocTest)</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>qmake</db:term> +<db:listitem> +<db:para>QT += testcpp</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +</db:section> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/testcpp-module.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/testcpp-module.xml index 83dbd2f2e..1ef7bd780 100644 --- a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/testcpp-module.xml +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/testcpp-module.xml @@ -32,6 +32,12 @@ <db:title>Classes</db:title> <db:variablelist role="classes"> <db:varlistentry> +<db:term><db:link xlink:href="seenclass.xml" xlink:role="class">SeenClass</db:link></db:term> +<db:listitem> +<db:para>A public but undocumented class.</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> <db:term><db:link xlink:href="testqdoc-test.xml" xlink:role="class">TestQDoc::Test</db:link></db:term> <db:listitem> <db:para>A class in a namespace.</db:para> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/dontdocument/classes.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/classes.html index e01914d6b..6a8df3334 100644 --- a/src/qdoc/qdoc/tests/generatedoutput/expected_output/dontdocument/classes.html +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/classes.html @@ -2,8 +2,8 @@ <html lang="en"> <head> <meta charset="utf-8"> -<!-- test.qdoc --> - <title>Classes | TestCPP</title> +<!-- unseenclass.qdoc --> + <title>Classes | Test 6.2.11</title> </head> <body> <div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> diff --git a/src/qdoc/qdoc/tests/generatedoutput/expected_output/dontdocument/seenclass.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/seenclass.html index a4f91eda8..ece82ceb7 100644 --- a/src/qdoc/qdoc/tests/generatedoutput/expected_output/dontdocument/seenclass.html +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/seenclass.html @@ -4,7 +4,7 @@ <meta charset="utf-8"> <!-- dont.cpp --> <meta name="description" content="A public but undocumented class."> - <title>SeenClass Class | TestCPP</title> + <title>SeenClass Class | Test 6.2.11</title> </head> <body> <li><a href="testcpp-module.html" translate="no">C++ Classes</a></li> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test.index b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test.index index c32263365..e6d43591c 100644 --- a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test.index +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test.index @@ -34,6 +34,7 @@ </function> <qmlproperty name="name" fullname="QDoc.Test.Child.name" href="qml-qdoc-test-child.html#name-prop" status="active" access="public" location="parent.qdoc" documented="true" type="string" attached="false" writable="true" brief="Name of this child"/> </qmlclass> + <page name="classes.html" href="classes.html" status="active" location="unseenclass.qdoc" documented="true" subtype="page" title="Classes" fulltitle="Classes" subtitle=""/> <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> @@ -91,6 +92,7 @@ <contents name="qml-types" title="QML types" level="1"/> <contents name="qml-value-types" title="QML value types" level="1"/> </page> + <class name="SeenClass" href="seenclass.html" status="active" access="public" location="dont.h" since="2.0" documented="true" module="TestCPP" brief="A public but undocumented class"/> <qmlclass name="Switch" qml-module-name="UIComponents" fullname="UIComponents.Switch" href="qml-uicomponents-switch.html" status="active" access="public" location="Switch.qml" documented="true" title="Switch" fulltitle="Switch" subtitle="" brief="A component that can be turned on or off"> <function name="toggle" fullname="UIComponents.Switch.toggle" href="qml-uicomponents-switch.html#toggle-method" status="active" access="public" documented="true" meta="qmlmethod"/> <qmlproperty name="on" fullname="UIComponents.Switch.on" href="qml-uicomponents-switch.html#on-prop" status="active" access="public" documented="true" type="bool" attached="false" writable="true"/> @@ -174,6 +176,7 @@ <qmlproperty name="group" fullname="QDoc.Test.Type.group" href="qml-qdoc-test-type.html#group-prop" status="active" access="public" documented="true"/> </qmlclass> <qmlclass name="TypeNoVersion" qml-module-name="Test.NoVer" fullname="Test.NoVer.TypeNoVersion" href="qml-test-nover-typenoversion.html" status="active" access="public" since="1.1" documented="true" title="TypeNoVersion" fulltitle="TypeNoVersion" subtitle="" brief="Another QML type documented in a .cpp file"/> + <class name="UnseenClass" href="unseenclass.html" status="ignored" access="public" location="dont.h" since="2.0" documented="true" module="TestCPP" brief="A public but undocumented class"/> <qmlclass name="YetAnotherChild" qml-module-name="QDoc.Test" qml-base-type="QDoc.Test::InternParent" fullname="QDoc.Test.YetAnotherChild" href="qml-qdoc-test-yetanotherchild.html" status="active" access="public" location="parent.qdoc" since="1.1" documented="true" title="YetAnotherChild" fulltitle="YetAnotherChild" subtitle="" brief="A type inheriting from internal abstract parent"/> <qmlvaluetype name="int" qml-module-name="QDoc.Test" fullname="QDoc.Test.int" href="qml-int.html" status="active" access="public" location="parent.qdoc" since="1.1" documented="true" title="int" fulltitle="int" subtitle="" brief="An integer value type"> <function name="abs" fullname="QDoc.Test.int.abs" href="qml-int.html#abs-method" status="active" access="public" location="parent.qdoc" documented="true" meta="qmlmethod" type="int"/> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test.qhp b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test.qhp index 663a01fd6..67cb374cb 100644 --- a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test.qhp +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/test.qhp @@ -9,6 +9,7 @@ <section ref="uicomponents-qmlmodule.html" title="Test"> <section ref="autolinking.html" title="Autolinking"/> <section ref="test-cmaketest-example.html" title="CMake Example Project"/> + <section ref="classes.html" title="Classes"/> <section ref="test-demos-demo-example.html" title="Demo"/> <section ref="test-demos-hidden-example.html" title="Hidden Demo"/> <section ref="test-empty-qmlmodule.html" title="No QML Types Here"/> @@ -22,6 +23,7 @@ </section> <section ref="testcpp-module.html" title="Classes"> <section ref="crossmoduleref.html" title="CrossModuleRef"/> + <section ref="seenclass.html" title="SeenClass Class Reference"/> <section ref="testqdoc.html" title="TestQDoc"/> <section ref="testqdoc-test.html" title="TestQDoc::Test Class Reference"> <section ref="testqdoc-test-members.html" title="List of all members"/> @@ -71,6 +73,7 @@ <keyword name="Autolinking" id="Autolinking" ref="autolinking.html"/> <keyword name="Child" id="QML.Child" ref="qml-qdoc-test-child.html"/> <keyword name="Child" id="QML.QDoc.Test1.Child" ref="qml-qdoc-test-child.html"/> + <keyword name="Classes" id="Classes" ref="classes.html"/> <keyword name="CrossModuleRef" id="CrossModuleRef" ref="crossmoduleref.html"/> <keyword name="DocTest" id="QML.DocTest" ref="qml-qdoc-test-doctest.html"/> <keyword name="DocTest" id="QML.QDoc.Test1.DocTest" ref="qml-qdoc-test-doctest.html"/> @@ -86,6 +89,7 @@ <keyword name="QDoc Test C++ Classes" id="QDoc Test C++ Classes" ref="testcpp-module.html"/> <keyword name="QDoc.Test" id="QML.Test.QDoc" ref="qdoc-test-qmlmodule.html"/> <keyword name="QML Modules" id="QML Modules" ref="qmlmodules.html"/> + <keyword name="SeenClass" id="SeenClass" ref="seenclass.html"/> <keyword name="Switch" id="QML.Switch" ref="qml-uicomponents-switch.html"/> <keyword name="Switch" id="QML.UIComponents1.Switch" ref="qml-uicomponents-switch.html"/> <keyword name="TabWidget" id="QML.TabWidget" ref="qml-uicomponents-tabwidget.html"/> @@ -169,6 +173,7 @@ </keywords> <files> <file>autolinking.html</file> + <file>classes.html</file> <file>cpptypes.html</file> <file>crossmoduleref.html</file> <file>images/leonardo-da-vinci.png</file> @@ -199,6 +204,7 @@ <file>qml-uicomponents-tabwidget-members.html</file> <file>qml-uicomponents-tabwidget.html</file> <file>qmlmodules.html</file> + <file>seenclass.html</file> <file>test-cmaketest-cmakelists-txt.html</file> <file>test-cmaketest-example.html</file> <file>test-cmaketest-main-cpp.html</file> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testcpp-module.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testcpp-module.html index f139d2ff8..1ba884a0f 100644 --- a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testcpp-module.html +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testcpp-module.html @@ -31,8 +31,9 @@ </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> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="seenclass.html">SeenClass</a></p></td><td class="tblDescr"><p>A public but undocumented class</p></td></tr> +<tr class="even 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="odd 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"> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testtagfile.tags b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testtagfile.tags index 768e33e8a..43c31fe85 100644 --- a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testtagfile.tags +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testtagfile.tags @@ -99,6 +99,10 @@ <filename>qml-uicomponents-progressbar.html</filename> </compound> <compound kind="class"> + <name>SeenClass</name> + <filename>seenclass.html</filename> + </compound> + <compound kind="class"> <name>UIComponents.Switch</name> <filename>qml-uicomponents-switch.html</filename> <member kind="function" protection="public" virtualness="non" static="no"> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/classes.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/classes.webxml new file mode 100644 index 000000000..55faed6d6 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/classes.webxml @@ -0,0 +1,10 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <page name="classes.html" href="classes.html" status="active" location="unseenclass.qdoc" documented="true" subtype="page" title="Classes" fulltitle="Classes" subtitle=""> + <description> + <generatedlist contents="annotatedclasses"/> + </description> + </page> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/seenclass.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/seenclass.webxml new file mode 100644 index 000000000..92c2ad8f0 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/seenclass.webxml @@ -0,0 +1,10 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <class name="SeenClass" href="seenclass.html" status="active" access="public" location="dont.h" since="2.0" documented="true" module="TestCPP" brief="A public but undocumented class"> + <description> + <brief>A public but undocumented class.</brief> + </description> + </class> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test.index b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test.index index 34d54c394..5c76473f3 100644 --- a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test.index +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/test.index @@ -31,6 +31,7 @@ </function> <qmlproperty name="name" fullname="QDoc.Test.Child.name" href="qml-qdoc-test-child.html#name-prop" status="active" access="public" location="parent.qdoc" documented="true" type="string" attached="false" writable="true" brief="Name of this child"/> </qmlclass> + <page name="classes.html" href="classes.html" status="active" location="unseenclass.qdoc" documented="true" subtype="page" title="Classes" fulltitle="Classes" subtitle=""/> <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> @@ -79,6 +80,7 @@ <contents name="qml-types" title="QML types" level="1"/> <contents name="qml-value-types" title="QML value types" level="1"/> </page> + <class name="SeenClass" href="seenclass.html" status="active" access="public" location="dont.h" since="2.0" documented="true" module="TestCPP" brief="A public but undocumented class"/> <qmlclass name="Switch" qml-module-name="UIComponents" fullname="UIComponents.Switch" href="qml-uicomponents-switch.html" status="active" access="public" location="Switch.qml" documented="true" title="Switch" fulltitle="Switch" subtitle="" brief="A component that can be turned on or off"> <function name="toggle" fullname="UIComponents.Switch.toggle" href="qml-uicomponents-switch.html#toggle-method" status="active" access="public" documented="true" meta="qmlmethod"/> <qmlproperty name="on" fullname="UIComponents.Switch.on" href="qml-uicomponents-switch.html#on-prop" status="active" access="public" documented="true" type="bool" attached="false" writable="true"/> @@ -162,6 +164,7 @@ <qmlproperty name="group" fullname="QDoc.Test.Type.group" href="qml-qdoc-test-type.html#group-prop" status="active" access="public" documented="true"/> </qmlclass> <qmlclass name="TypeNoVersion" qml-module-name="Test.NoVer" fullname="Test.NoVer.TypeNoVersion" href="qml-test-nover-typenoversion.html" status="active" access="public" since="1.1" documented="true" title="TypeNoVersion" fulltitle="TypeNoVersion" subtitle="" brief="Another QML type documented in a .cpp file"/> + <class name="UnseenClass" href="unseenclass.html" status="ignored" access="public" location="dont.h" since="2.0" documented="true" module="TestCPP" brief="A public but undocumented class"/> <qmlclass name="YetAnotherChild" qml-module-name="QDoc.Test" qml-base-type="QDoc.Test::InternParent" fullname="QDoc.Test.YetAnotherChild" href="qml-qdoc-test-yetanotherchild.html" status="active" access="public" location="parent.qdoc" since="1.1" documented="true" title="YetAnotherChild" fulltitle="YetAnotherChild" subtitle="" brief="A type inheriting from internal abstract parent"/> <qmlvaluetype name="int" qml-module-name="QDoc.Test" fullname="QDoc.Test.int" href="qml-int.html" status="active" access="public" location="parent.qdoc" since="1.1" documented="true" title="int" fulltitle="int" subtitle="" brief="An integer value type"> <function name="abs" fullname="QDoc.Test.int.abs" href="qml-int.html#abs-method" status="active" access="public" location="parent.qdoc" documented="true" meta="qmlmethod" type="int"/> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testtagfile.tags b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testtagfile.tags index 768e33e8a..43c31fe85 100644 --- a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testtagfile.tags +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/webxml/testtagfile.tags @@ -99,6 +99,10 @@ <filename>qml-uicomponents-progressbar.html</filename> </compound> <compound kind="class"> + <name>SeenClass</name> + <filename>seenclass.html</filename> + </compound> + <compound kind="class"> <name>UIComponents.Switch</name> <filename>qml-uicomponents-switch.html</filename> <member kind="function" protection="public" virtualness="non" static="no"> diff --git a/src/qdoc/qdoc/tests/generatedoutput/testdata/dontdocument/test.qdoc b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/unseenclass.qdoc index d73fce531..d73fce531 100644 --- a/src/qdoc/qdoc/tests/generatedoutput/testdata/dontdocument/test.qdoc +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/unseenclass.qdoc |