diff options
| author | Thibaut Cuvelier <cuvelier.thibaut@gmail.com> | 2022-09-21 01:29:45 +0200 |
|---|---|---|
| committer | Paul Wicking <paul.wicking@qt.io> | 2022-11-03 17:41:31 +0100 |
| commit | 75831eef6d1147a29817309f9c239a1a6fe9086e (patch) | |
| tree | 8ff2b5d3ad6989938b32cd29ddeda9670a247cd7 /tests/auto/qdoc/generatedoutput | |
| parent | 347d0dc9fb8b5925d26cd70539370bc765ef45dd (diff) | |
| download | qttools-75831eef6d1147a29817309f9c239a1a6fe9086e.tar.gz | |
Add a test case for a tricky excerpt of QDoc
The most important part is the \quotation that contains a \raw HTML table.
This triggers specific behavior in the DocBook output.
Change-Id: I47e75c2f091a56652ea89a4902491856453efbd4
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Luca Di Sera <luca.disera@qt.io>
Diffstat (limited to 'tests/auto/qdoc/generatedoutput')
4 files changed, 125 insertions, 1 deletions
diff --git a/tests/auto/qdoc/generatedoutput/expected_output/qdoctests-qdocmanuallikefileoutput.html b/tests/auto/qdoc/generatedoutput/expected_output/qdoctests-qdocmanuallikefileoutput.html new file mode 100644 index 000000000..a12b6626e --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/expected_output/qdoctests-qdocmanuallikefileoutput.html @@ -0,0 +1,63 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- qdoctests-outputfromqdocmanuallikefiles.qdoc --> + <title>Document Navigation | OutputFromQDocFiles</title> +</head> +<body> +<li id="buildversion">OutputFromQDocFiles - A test project for QDoc build artifacts</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#commands">Commands</a></li> +<li class="level2"><a href="#previouspage">\previouspage</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">Document Navigation</h1> +<!-- $$$qdoctests-qdocmanuallikefileoutput.html-description --> +<div class="descr" id="details"> +<p>The navigation commands...</p> +<blockquote> <table border="0" cellpadding="0" cellspacing="5" width="100%"> + + <tr> + <p> + [Previous: <a href="15-qdoc-commands-navigation.html#deadlink"> + Basic Qt</a>] + [<a href="15-qdoc-commands-navigation.html#deadlink">Contents</a>] + [Next: <a href="15-qdoc-commands-navigation.html#deadlink"> + Creating Dialogs</a>] + </p> + + <h1 align="center">Getting Started<br /></h1> + + <p> + This chapter shows how to combine basic C++ with the + functionality provided by Qt to create a few small graphical + interface (GUI) applications. + </p> + + <p> + [Previous: <a href="15-qdoc-commands-navigation.html#deadlink"> + Basic Qt</a>] + [<a href="15-qdoc-commands-navigation.html#deadlink">Contents</a>] + [Next: <a href="15-qdoc-commands-navigation.html#deadlink"> + Creating Dialogs</a>] + </p> + + </table> + </blockquote> +<pre class="cpp"><span class="operator"><</span>head<span class="operator">></span> + <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span> + <span class="operator"><</span>link rel<span class="operator">=</span><span class="string">"start"</span> href<span class="operator">=</span><span class="string">"basicqt.html"</span> <span class="operator">/</span><span class="operator">></span> + <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span> +<span class="operator"><</span><span class="operator">/</span>head<span class="operator">></span></pre> +<h2 id="commands">Commands</h2> +<span id="previouspage-command"></span><h3 id="previouspage">\previouspage</h3> +<p>The \previouspage command...</p> +</div> +<!-- @@@qdoctests-qdocmanuallikefileoutput.html --> +</body> +</html> diff --git a/tests/auto/qdoc/generatedoutput/testdata/configs/test.qdocconf b/tests/auto/qdoc/generatedoutput/testdata/configs/test.qdocconf index b076bdae1..ac70d3aef 100644 --- a/tests/auto/qdoc/generatedoutput/testdata/configs/test.qdocconf +++ b/tests/auto/qdoc/generatedoutput/testdata/configs/test.qdocconf @@ -4,7 +4,8 @@ description = "A test project for QDoc build artifacts" buildversion = "$project - $description" moduleheader = -sources = ../outputfromqdocfiles/qdoctests-outputfromqdocfiles.qdoc +sources = ../outputfromqdocfiles/qdoctests-outputfromqdocfiles.qdoc \ + ../outputfromqdocfiles/qdoctests-outputfromqdocmanuallikefiles.qdoc macro.beginqdoc = "\\c {/*!}" macro.endqdoc = "\\c */" diff --git a/tests/auto/qdoc/generatedoutput/testdata/outputfromqdocfiles/qdoctests-outputfromqdocmanuallikefiles.qdoc b/tests/auto/qdoc/generatedoutput/testdata/outputfromqdocfiles/qdoctests-outputfromqdocmanuallikefiles.qdoc new file mode 100644 index 000000000..23f229745 --- /dev/null +++ b/tests/auto/qdoc/generatedoutput/testdata/outputfromqdocfiles/qdoctests-outputfromqdocmanuallikefiles.qdoc @@ -0,0 +1,59 @@ +// Copyright (C) 2022 Thibaut Cuvelier +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 +// Excerpts from src/qdoc/doc/qdoc-guide.qdoc + +/*! + \page qdoctests-qdocmanuallikefileoutput.html + + \title Document Navigation + + The navigation commands... + + \quotation + \raw HTML + <table border="0" cellpadding="0" cellspacing="5" width="100%"> + + <tr> + <p> + [Previous: <a href="15-qdoc-commands-navigation.html#deadlink"> + Basic Qt</a>] + [<a href="15-qdoc-commands-navigation.html#deadlink">Contents</a>] + [Next: <a href="15-qdoc-commands-navigation.html#deadlink"> + Creating Dialogs</a>] + </p> + + <h1 align="center">Getting Started<br /></h1> + + <p> + This chapter shows how to combine basic C++ with the + functionality provided by Qt to create a few small graphical + interface (GUI) applications. + </p> + + <p> + [Previous: <a href="15-qdoc-commands-navigation.html#deadlink"> + Basic Qt</a>] + [<a href="15-qdoc-commands-navigation.html#deadlink">Contents</a>] + [Next: <a href="15-qdoc-commands-navigation.html#deadlink"> + Creating Dialogs</a>] + </p> + + </table> + \endraw + \endquotation + + \code + <head> + ... + <link rel="start" href="basicqt.html" /> + ... + </head> + \endcode + + \section1 Commands + + \target previouspage-command + \section2 \\previouspage + + The \\previouspage command... +*/
\ No newline at end of file diff --git a/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp b/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp index 07d89c51a..b377dadf1 100644 --- a/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp +++ b/tests/auto/qdoc/generatedoutput/tst_generatedoutput.cpp @@ -204,6 +204,7 @@ void tst_generatedOutput::htmlFromQDocFile() testAndCompare("testdata/configs/test.qdocconf", "qdoctests-qdocfileoutput.html " "qdoctests-qdocfileoutput-linking.html " + "qdoctests-qdocmanuallikefileoutput.html " "qdoctests-qdocfileoutput-exhaustive.html " "toc.html"); } |