diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2021-03-11 13:32:13 +0100 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2021-03-22 10:18:32 +0100 |
| commit | 10268e3e9c5f47db8231f2ac907a46cf9283d365 (patch) | |
| tree | ccfa72e90a0bf30dbfcfa1f0ba835afad49be4dc /tests | |
| parent | ccd9f4eb9b8200fa26f32ffacae6ae93619ca867 (diff) | |
qdoc: Stop auto-linking to section titles
The purpose of the auto-linking feature is to link strings in the
text that resemble class or function names to API reference. However,
QDoc did not discriminate between the types of the resolved link
targets. Therefore, writing
\section1 QString
on a random \page would potentially redirect all autolinks to QString
to that section.
To fix, turn Node::Genus into attributes so we can do bitwise operations
on the genus, and introduce Node::API that includes all API reference
node genera.
Node::API is not assigned to nodes directly, but is used in searches
to match against any API reference nodes.
Pick-to: 6.0 6.1
Task-number: QTBUG-91141
Change-Id: Ic0a22b7105e1278662f5ae7d4132980200638225
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'tests')
8 files changed, 79 insertions, 0 deletions
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/autolinking.html b/tests/auto/qdoc/generatedoutput/expected_output/autolinking.html new file mode 100644 index 000000000..a8495eb90 --- /dev/null +++ b/tests/auto/qdoc/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><a name="toc">Contents</a></h3> +<ul> +<li class="level1"><a href="#testqdoc">TestQDoc</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">Autolinking</h1> +<span class="subtitle"></span> +<!-- $$$autolinking.html-description --> +<div class="descr"> <a name="details"></a> +<a name="testqdoc"></a> +<h2 id="testqdoc">TestQDoc</h2> +<p>The string <a href="testqdoc.html">TestQDoc</a> links to the C++ namespace unless linking explicitly, <a href="autolinking.html#testqdoc">like this</a>, or <a href="autolinking.html#testqdoc">this</a>. Also,</p> +<p>Autolinks:</p> +<ul> +<li><a href="testqdoc-testderived.html">TestQDoc::TestDerived</a></li> +</ul> +<p>Explicit links:</p> +<ul> +<li><a href="testqdoc-testderived.html">TestQDoc::TestDerived</a></li> +<li><a href="obsolete-classes.html#testqdoc">Obsolete Classes#TestQDoc</a></li> +</ul> +</div> +<!-- @@@autolinking.html --> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/dontdocument/dontdocument.qhp b/tests/auto/qdoc/generatedoutput/expected_output/dontdocument/dontdocument.qhp index 8484915eb..c83440461 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/dontdocument/dontdocument.qhp +++ b/tests/auto/qdoc/generatedoutput/expected_output/dontdocument/dontdocument.qhp @@ -20,6 +20,7 @@ </section> </toc> <keywords> + <keyword name="Autolinking" id="Autolinking" ref="autolinking.html"/> <keyword name="Classes" id="Classes" ref="classes.html"/> <keyword name="Obsolete Classes" id="Obsolete Classes" ref="obsolete-classes.html"/> <keyword name="QDOCTEST_MACRO" id="QDOCTEST_MACRO" ref="testqdoc.html#QDOCTEST_MACRO"/> @@ -47,6 +48,7 @@ <keyword name="virtualFun" id="TestDerived::virtualFun" ref="testqdoc-testderived.html#virtualFun"/> </keywords> <files> + <file>autolinking.html</file> <file>classes.html</file> <file>obsolete-classes.html</file> <file>seenclass.html</file> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/obsolete-classes.html b/tests/auto/qdoc/generatedoutput/expected_output/obsolete-classes.html index 93a35078b..e8e4c4e3a 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/obsolete-classes.html +++ b/tests/auto/qdoc/generatedoutput/expected_output/obsolete-classes.html @@ -11,6 +11,7 @@ <h3><a name="toc">Contents</a></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> @@ -26,6 +27,8 @@ <dd><a href="..//testqdoc-testderived-obsolete.html">TestDerived</a> (<a href="testqdoc.html">TestQDoc</a>)</dd> </dl> </div> +<a name="testqdoc"></a> +<h3 id="testqdoc">TestQDoc</h3> </div> <!-- @@@obsolete-classes.html --> </body> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/properties/testcpp.index b/tests/auto/qdoc/generatedoutput/expected_output/properties/testcpp.index index b08864064..dd2b42463 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/properties/testcpp.index +++ b/tests/auto/qdoc/generatedoutput/expected_output/properties/testcpp.index @@ -6,8 +6,12 @@ <function name="QDOCTEST_MACRO2" href="testqdoc-test.html#QDOCTEST_MACRO2" status="active" access="public" documented="true" related="1" since="Test 1.1" meta="macrowithparams" virtual="non" const="false" static="false" final="false" override="false" type="" 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="" module="TestCPP"> + <contents name="testqdoc" title="TestQDoc" level="1"/> + </page> <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="" module="TestCPP"> <contents name="classes-with-obsolete-members" title="Classes with obsolete members" level="1"/> + <contents name="testqdoc" title="TestQDoc" level="2"/> </page> <page name="https://wiki.qt.io/QProperty" href="https://wiki.qt.io/QProperty" status="active" location="properties.qdoc" documented="true" subtype="externalpage" title="QProperty" fulltitle="QProperty" subtitle=""/> <namespace name="TestQDoc" href="testqdoc.html" status="active" access="public" location="testcpp.h" documented="true" module="TestCPP" brief="A namespace"> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/test.qhp b/tests/auto/qdoc/generatedoutput/expected_output/test.qhp index 40e35b27a..4fffda513 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/test.qhp +++ b/tests/auto/qdoc/generatedoutput/expected_output/test.qhp @@ -8,6 +8,7 @@ <section ref="uicomponents-qmlmodule.html" title="UI Components"> <section ref="uicomponents-qmlmodule.html" title="Test"> <section ref="qdoc-test-qmlmodule.html" title=""/> + <section ref="autolinking.html" title="Autolinking"/> <section ref="test-cmaketest-example.html" title="CMake Example Project"/> <section ref="test-demos-demo-example.html" title="Demo"/> <section ref="test-demos-hidden-example.html" title="Hidden Demo"/> @@ -61,6 +62,7 @@ <keywords> <keyword name="AbstractParent" id="QML.AbstractParent" ref="qml-qdoc-test-abstractparent.html"/> <keyword name="AbstractParent" id="QML.QDoc.Test1.AbstractParent" ref="qml-qdoc-test-abstractparent.html"/> + <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="DocTest" id="QML.DocTest" ref="qml-qdoc-test-doctest.html"/> @@ -140,6 +142,7 @@ <keyword name="virtualFun" id="TestDerived::virtualFun" ref="testqdoc-testderived.html#virtualFun"/> </keywords> <files> + <file>autolinking.html</file> <file>images/leonardo-da-vinci.png</file> <file>obsolete-classes.html</file> <file>qdoc-test-qmlmodule.html</file> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/testcpp.index b/tests/auto/qdoc/generatedoutput/expected_output/testcpp.index index d0b2309b4..9f17e95d0 100644 --- a/tests/auto/qdoc/generatedoutput/expected_output/testcpp.index +++ b/tests/auto/qdoc/generatedoutput/expected_output/testcpp.index @@ -6,8 +6,12 @@ <function name="QDOCTEST_MACRO2" href="testqdoc-test.html#QDOCTEST_MACRO2" status="active" access="public" documented="true" related="1" since="Test 1.1" meta="macrowithparams" virtual="non" const="false" static="false" final="false" override="false" type="" 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="" module="TestCPP"> + <contents name="testqdoc" title="TestQDoc" level="1"/> + </page> <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="" module="TestCPP"> <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" documented="true" module="TestCPP" brief="A namespace"> <contents name="usage" title="Usage" level="1"/> diff --git a/tests/auto/qdoc/generatedoutput/testdata/testcpp/classlists.qdoc b/tests/auto/qdoc/generatedoutput/testdata/testcpp/classlists.qdoc index 7e57b57ee..188676c05 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/testcpp/classlists.qdoc +++ b/tests/auto/qdoc/generatedoutput/testdata/testcpp/classlists.qdoc @@ -32,4 +32,30 @@ \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 */ diff --git a/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp b/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp index 515b816d4..31885fec2 100644 --- a/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp +++ b/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp @@ -240,6 +240,7 @@ void tst_generatedOutput::htmlFromCpp() "testqdoc-testderived-members.html " "testqdoc-testderived-obsolete.html " "obsolete-classes.html " + "autolinking.html " "testqdoc.html"); } |