diff options
Diffstat (limited to 'tests/auto/qdoc/generatedoutput')
5 files changed, 136 insertions, 0 deletions
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/adventures-with-non-ascii-characters.html b/tests/auto/qdoc/generatedoutput/expected_output/adventures-with-non-ascii-characters.html new file mode 100644 index 000000000..5d7532e88 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/adventures-with-non-ascii-characters.html @@ -0,0 +1,46 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- adventures_with_non_ascii_characters.qdoc --> + <meta name="description" content="Test that non-ascii characters work as input to QDoc commands."> + <title>Adventures with non-ascii characters in QDoc | NonAsciiCharacterInput</title> +</head> +<body> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#a-713da3e8">A 大纲视图</a></li> +<li class="level1"><a href="#3d-42faee45">3D场景视图</a></li> +<li class="level1"><a href="#3d-c57e864e">这就是3D场景视图</a></li> +<li class="level1"><a href="#662952c1">属性视图</a></li> +<li class="level1"><a href="#further-details">Further details</a></li> +<li class="level2"><a href="#ascii-characters-that-are-non-printable-ascii-such-as-or-521d09f0">Ascii characters that are non-printable ascii, such as ß, ü, or ø</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">Adventures with non-ascii characters in QDoc</h1> +<!-- $$$adventures_with_non_ascii_characters.html-description --> +<div class="descr" id="details"> +<p>The purpose of this test data is to provide a regression mechanism as part of QDoc's end-to-end test, tst_generatedOutput, for an issue (QTBUG-64506) that was reported against QDoc's \section1 command. The issue, as experienced by the reporter of the bug, is that if the \section1 command is followed by a non-ascii character (for example Chinese characters), navigation links aren't generated for the section title. The bug was filed against Qt 5.9.2. This test case aims at reproducing the issue as filed by the reporter.</p> +<p>Such this document snippet:</p> +<h2 id="a-713da3e8">A 大纲视图</h2> +<p>The reporter states that this link works, presumably because it begins with the ascii character "A".</p> +<p>这就是大纲视图</p> +<h2 id="3d-42faee45">3D场景视图</h2> +<p>The reporter states that this link works, presumably because it begins with the digit "3".</p> +<p>这就是3D场景视图</p> +<h2 id="3d-c57e864e">这就是3D场景视图</h2> +<p>If this section generates a duplicate anchor, "3D", it's because 3D is the only part of the section title QDoc recognizes. This is an error caused by the same bug, and the link should somehow reflect that QDoc encountered the Chinese (or any non-ascii) characters instead.</p> +<h2 id="662952c1">属性视图</h2> +<p>The reporter states that this link doesn't work, presumably because it begins with the Chinese character "属".</p> +<p>这就是属性视图</p> +<h2 id="further-details">Further details</h2> +<p>The bug report is at <a href="https://bugreports.qt.io/browse/QTBUG-64506" translate="no">https://bugreports.qt.io/browse/QTBUG-64506</a>. It contains the content used to trigger the behavior in this test case. The Chinese characters are copied verbatim from the report.</p> +<h3 id="ascii-characters-that-are-non-printable-ascii-such-as-or-521d09f0">Ascii characters that are non-printable ascii, such as ß, ü, or ø</h3> +<p>A whole range of ascii characters are not printable ascii characters. These could also cause issues for QDoc. This section is here to confirm linking to such section titles works as expected. It's made a section2 to exercise the behavior for other section levels than 1.</p> +</div> +<!-- @@@adventures_with_non_ascii_characters.html --> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/expected_output/html/nonasciicharacterinput.index b/tests/auto/qdoc/generatedoutput/expected_output/html/nonasciicharacterinput.index new file mode 100644 index 000000000..613bb05a4 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/html/nonasciicharacterinput.index @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE QDOCINDEX> +<INDEX url="" title="NonAsciiCharacterInput Reference Documentation" version="" project="NonAsciiCharacterInput"> + <namespace name="" status="active" access="public" module="nonasciicharacterinput"> + <page name="adventures_with_non_ascii_characters.html" href="adventures-with-non-ascii-characters.html" status="active" location="adventures_with_non_ascii_characters.qdoc" documented="true" subtype="page" title="Adventures with non-ascii characters in QDoc" fulltitle="Adventures with non-ascii characters in QDoc" subtitle="" brief="Test that non-ascii characters work as input to QDoc commands"> + <contents name="a-713da3e8" title="A 大纲视图" level="1"/> + <contents name="3d-42faee45" title="3D场景视图" level="1"/> + <contents name="3d-c57e864e" title="这就是3D场景视图" level="1"/> + <contents name="662952c1" title="属性视图" level="1"/> + <contents name="further-details" title="Further details" level="1"/> + <contents name="ascii-characters-that-are-non-printable-ascii-such-as-or-521d09f0" title="Ascii characters that are non-printable ascii, such as ß, ü, or ø" level="2"/> + </page> + </namespace> +</INDEX> diff --git a/tests/auto/qdoc/generatedoutput/testdata/non_ascii_character_input/adventures_with_non_ascii_characters.qdoc b/tests/auto/qdoc/generatedoutput/testdata/non_ascii_character_input/adventures_with_non_ascii_characters.qdoc new file mode 100644 index 000000000..b1f23adf7 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/testdata/non_ascii_character_input/adventures_with_non_ascii_characters.qdoc @@ -0,0 +1,54 @@ +// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \page adventures_with_non_ascii_characters.html + \title Adventures with non-ascii characters in QDoc + \brief Test that non-ascii characters work as input to QDoc commands. + + The purpose of this test data is to provide a regression mechanism as part + of QDoc's end-to-end test, tst_generatedOutput, for an issue (QTBUG-64506) + that was reported against QDoc's \\section1 command. The issue, as + experienced by the reporter of the bug, is that if the \\section1 command + is followed by a non-ascii character (for example Chinese characters), + navigation links aren't generated for the section title. The bug was filed + against Qt 5.9.2. This test case aims at reproducing the issue as filed by + the reporter. + + Such this document snippet: + + \section1 A 大纲视图 + The reporter states that this link works, presumably because it begins with + the ascii character "A". + + 这就是大纲视图 + + \section1 3D场景视图 + The reporter states that this link works, presumably because it begins with + the digit "3". + + 这就是3D场景视图 + + \section1 这就是3D场景视图 + If this section generates a duplicate anchor, "3D", it's because 3D + is the only part of the section title QDoc recognizes. This is an error + caused by the same bug, and the link should somehow reflect that QDoc + encountered the Chinese (or any non-ascii) characters instead. + + \section1 属性视图 + The reporter states that this link doesn't work, presumably because it + begins with the Chinese character "属". + + 这就是属性视图 + + \section1 Further details + The bug report is at \l https://bugreports.qt.io/browse/QTBUG-64506. It + contains the content used to trigger the behavior in this test case. The + Chinese characters are copied verbatim from the report. + + \section2 Ascii characters that are non-printable ascii, such as ß, ü, or ø + A whole range of ascii characters are not printable ascii characters. These + could also cause issues for QDoc. This section is here to confirm linking + to such section titles works as expected. It's made a section2 to exercise + the behavior for other section levels than 1. +*/ diff --git a/tests/auto/qdoc/generatedoutput/testdata/non_ascii_character_input/non_ascii_character_input.qdocconf b/tests/auto/qdoc/generatedoutput/testdata/non_ascii_character_input/non_ascii_character_input.qdocconf new file mode 100644 index 000000000..28235c037 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/testdata/non_ascii_character_input/non_ascii_character_input.qdocconf @@ -0,0 +1,13 @@ +# Copyright (C) 2023 The Qt Company Ltd. +# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +include(../configs/config.qdocconf) +project = NonAsciiCharacterInput + +headerdirs = . +sourcedirs = . +exampledirs = . + +outputformats = WebXML HTML +WebXML.quotinginformation = true +WebXML.nosubdirs = true diff --git a/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp b/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp index f110b9e45..269739242 100644 --- a/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp +++ b/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp @@ -60,6 +60,7 @@ private slots: void testTagFile(); void testGlobalFunctions(); void proxyPage(); + void nonAsciiCharacterInput(); private: QScopedPointer<QTemporaryDir> m_outputDir; @@ -588,6 +589,14 @@ void tst_generatedOutput::proxyPage() "proxypage-docbook/stdpair-proxy.xml"); } +void tst_generatedOutput::nonAsciiCharacterInput() +{ + testAndCompare("testdata/non_ascii_character_input/non_ascii_character_input.qdocconf", + "html/nonasciicharacterinput.index " + "adventures-with-non-ascii-characters.html"); +} + + int main(int argc, char *argv[]) { tst_generatedOutput tc; |