diff options
Diffstat (limited to 'src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/outputfromqdocfiles/expected/html/qdoctests-qdocfileoutput.html')
| -rw-r--r-- | src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/outputfromqdocfiles/expected/html/qdoctests-qdocfileoutput.html | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/outputfromqdocfiles/expected/html/qdoctests-qdocfileoutput.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/outputfromqdocfiles/expected/html/qdoctests-qdocfileoutput.html new file mode 100644 index 000000000..a38d4e3b4 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/outputfromqdocfiles/expected/html/qdoctests-qdocfileoutput.html @@ -0,0 +1,70 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- qdoctests-outputfromqdocfiles.qdoc --> + <meta name="description" content="This is a simple page for testing purposes only."> + <title>Testing QDoc output from .qdoc files | OutputFromQDocFiles</title> +</head> +<body> +<li id="buildversion">OutputFromQDocFiles - A test project for QDoc build artifacts</li> + <link rel="next" href="qdoctests-qdocfileoutput-linking.html" /> +<p class="naviNextPrevious headerNavi"> +<a class="nextPage" href="qdoctests-qdocfileoutput-linking.html">QDoc Linking Test</a> +</p> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +<ul> +<li class="level1"><a href="#supported-file-types">Supported file types</a></li> +<li class="level1"><a href="#further-information">Further information</a></li> +<li class="level1"><a href="#linking">Linking</a></li> +<li class="level1"><a href="#qdoc-linking-test">QDoc Linking Test</a></li> +<li class="level1"><a href="#linking-to-something-in-a-section-title">Linking to something in a section title</a></li> +</ul> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">Testing QDoc output from .qdoc files</h1> +<!-- $$$qdoctests-qdocfileoutput.html-description --> +<div class="descr" id="details"> +<p>QDoc generates documentation for software projects. It does this by extracting <i>QDoc comments</i> from project source files. QDoc comments are signified by a C-style-like comment tag followed by an exclamation point, like this: <code translate="no">/*!</code> <code translate="no">This text is contained within QDoc comment tags.</code> <code translate="no">*/</code>.</p> +<h2 id="supported-file-types">Supported file types</h2> +<p>QDoc parses <code translate="no">.cpp</code> and <code translate="no">.qdoc</code> files. It does extract comments from header (<code translate="no">.h</code>) files.</p> +<h2 id="further-information">Further information</h2> +<p>This test document is written with the purpose of testing the output QDoc generates when parsing <code translate="no">.qdoc</code> files. It is fairly simple and makes use of a limited subset of QDoc's command. Those commands are:</p> +<ul> +<li><code translate="no">\page</code></li> +<li><code translate="no">\title</code></li> +<li><code translate="no">\brief</code></li> +<li><code translate="no">\e</code> (for emphasizing "QDoc comments")</li> +<li><code translate="no">\c</code> (for multiple monospace-formatted entries)</li> +<li><code translate="no">\section1</code></li> +<li><code translate="no">\list</code></li> +<li><code translate="no">\li</code></li> +<li><code translate="no">\endlist</code></li> +</ul> +<h2 id="linking">Linking</h2> +<p>There are multiple ways to create hyperlinks to other topics:</p> +<ul> +<li><a href="qdoctests-qdocfileoutput-linking.html">Linking to a page title</a></li> +<li><a href="qdoctests-qdocfileoutput-linking.html#link-targets">Linking to a section title</a></li> +<li><a href="qdoctests-qdocfileoutput-linking.html#link-test-target">Linking using a \target string</a></li> +<li><a href="qdoctests-qdocfileoutput-linking.html">Linking using a \keyword string</a></li> +</ul> +<h2 id="qdoc-linking-test">QDoc Linking Test</h2> +<p>This section title is overridden by another target which takes precedence.</p> +<h2 id="linking-to-something-in-a-section-title">Linking to <a href="qdoctests-qdocfileoutput.html#further-information">something</a> in a section title</h2> +<p>This is allowed but a questionable practice.</p> +<details> +<summary>QDoc details</summary> +<div class="admonition note"> +<p><b>Note: </b>You're looking at detailed information.</p> +</div> +</details> +</div> +<!-- @@@qdoctests-qdocfileoutput.html --> +<p class="naviNextPrevious footerNavi"> +<a class="nextPage" href="qdoctests-qdocfileoutput-linking.html">QDoc Linking Test</a> +</p> +</body> +</html> |