diff options
Diffstat (limited to 'src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile')
14 files changed, 411 insertions, 0 deletions
diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/docbook/headers.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/docbook/headers.xml new file mode 100644 index 000000000..052108b2a --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/docbook/headers.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>Headers</db:title> +<db:productname>HeaderFile</db:productname> +<db:titleabbrev>HeaderFile Reference Documentation</db:titleabbrev> +<db:abstract> +<db:para>HeaderFile Reference Documentation.</db:para></db:abstract> +</db:info> +<db:anchor xml:id="details"/> +<db:variablelist role="members"> +<db:varlistentry> +<db:term><db:link xlink:href="testheader.xml" xlink:role=""><TestHeader></db:link></db:term> +<db:listitem> +<db:para>A header file.</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/docbook/testheader.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/docbook/testheader.xml new file mode 100644 index 000000000..03a49cb67 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/docbook/testheader.xml @@ -0,0 +1,68 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title><TestHeader> - Test Header</db:title> +<db:productname>HeaderFile</db:productname> +<db:titleabbrev>HeaderFile Reference Documentation</db:titleabbrev> +<db:abstract> +<db:para>A header file.</db:para> +</db:abstract> +</db:info> +<db:variablelist> +<db:varlistentry> +<db:term>Header</db:term> +<db:listitem> +<db:para>TestHeader</db:para> +</db:listitem> +</db:varlistentry> +<db:varlistentry> +<db:term>Group</db:term> +<db:listitem> +<db:para><TestHeader> is part of <db:simplelist><db:member><db:link xlink:href="headers.xml">Headers</db:link></db:member><db:member><db:link xlink:href="tests.xml">Tests</db:link></db:member></db:simplelist> +</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +<db:section xml:id="details"> +<db:title>Detailed Description</db:title> +</db:section> +<db:section xml:id="type-documentation"> +<db:title>Type Documentation</db:title> +<db:section xml:id="Globals-enum"> +<db:title>enum Globals</db:title> +<db:informaltable> +<db:thead> +<db:tr> +<db:th>Constant</db:th> +</db:tr> +</db:thead> +<db:tr> +<db:td> +<db:para><db:code>Glo</db:code></db:para> +</db:td> +<db:td><db:code>0</db:code></db:td> +</db:tr> +<db:tr> +<db:td> +<db:para><db:code>Bal</db:code></db:para> +</db:td> +<db:td><db:code>1</db:code></db:td> +</db:tr> +</db:informaltable> +</db:section> +</db:section> +<db:section xml:id="variable-documentation"> +<db:title>Variable Documentation</db:title> +<db:section xml:id="globalVar-var"> +<db:title>const int globalVar</db:title> +<db:para>Global variable.</db:para> +</db:section> +</db:section> +<db:section xml:id="function-documentation"> +<db:title>Function Documentation</db:title> +<db:section xml:id="globalFunc"> +<db:title>void globalFunc()</db:title> +<db:para>Global function.</db:para> +</db:section> +</db:section> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/docbook/tests.xml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/docbook/tests.xml new file mode 100644 index 000000000..25f95affd --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/docbook/tests.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8"?> +<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.2" xml:lang="en"> +<db:info> +<db:title>Tests</db:title> +<db:productname>HeaderFile</db:productname> +<db:titleabbrev>HeaderFile Reference Documentation</db:titleabbrev> +<db:abstract> +<db:para>HeaderFile Reference Documentation.</db:para></db:abstract> +</db:info> +<db:anchor xml:id="details"/> +<db:variablelist role="members"> +<db:varlistentry> +<db:term><db:link xlink:href="testheader.xml" xlink:role=""><TestHeader></db:link></db:term> +<db:listitem> +<db:para>A header file.</db:para> +</db:listitem> +</db:varlistentry> +</db:variablelist> +</db:article> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/html/headerfile.index b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/html/headerfile.index new file mode 100644 index 000000000..cf72522f9 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/html/headerfile.index @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE QDOCINDEX> +<INDEX url="" title="HeaderFile Reference Documentation" version="" project="HeaderFile"> + <namespace name="" status="active" access="public" module="headerfile"> + <function name="globalFunc" href="testheader.html#globalFunc" status="active" access="public" location="testheader.h" documented="true" related="0" meta="plain" type="void" brief="Global function" signature="void globalFunc()"/> + <header name="<TestHeader>" href="testheader.html" status="active" documented="true" groups="headers,tests" module="TestCPP" brief="A header file" title="Test Header" fulltitle="<TestHeader> - Test Header" subtitle=""> + <function name="globalFunc" href="testheader.html#globalFunc" status="active" access="public" location="testheader.h" documented="true" related="0" meta="plain" type="void" brief="Global function" signature="void globalFunc()"/> + <enum name="Globals" href="testheader.html#Globals-enum" status="active" access="public" location="testheader.h" related="1" documented="true"> + <value name="Glo" value="0"/> + <value name="Bal" value="1"/> + </enum> + <variable name="globalVar" href="testheader.html#globalVar-var" status="active" access="public" location="testheader.h" related="2" documented="true" type="const int" static="false" brief="Global variable"/> + </header> + <enum name="Globals" href="testheader.html#Globals-enum" status="active" access="public" location="testheader.h" related="1" documented="true"> + <value name="Glo" value="0"/> + <value name="Bal" value="1"/> + </enum> + <variable name="globalVar" href="testheader.html#globalVar-var" status="active" access="public" location="testheader.h" related="2" documented="true" type="const int" static="false" brief="Global variable"/> + <group name="headers" href="headers.html" status="active" documented="true" seen="true" title="Headers"/> + <group name="tests" href="tests.html" status="active" documented="true" seen="true" title="Tests"/> + <module name="TestCPP" href="testcpp-module.html" status="internal" seen="false" title=""/> + </namespace> +</INDEX> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/html/headers.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/html/headers.html new file mode 100644 index 000000000..1a60ec30b --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/html/headers.html @@ -0,0 +1,19 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testheader.cpp --> + <title>Headers | HeaderFile</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">Headers</h1> +<!-- $$$headers-description --> +<div class="descr" id="details"> +</div> +<!-- @@@headers --> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="testheader.html"><TestHeader></a></p></td><td class="tblDescr"><p>A header file</p></td></tr> +</table></div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/html/testheader.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/html/testheader.html new file mode 100644 index 000000000..a728ddd12 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/html/testheader.html @@ -0,0 +1,69 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testheader.cpp --> + <meta name="description" content="A header file."> + <title><TestHeader> - Test Header | HeaderFile</title> +</head> +<body> +<li><a href="headers.html">Headers</a></li> +<li><TestHeader> - Test Header</li> +<div class="sidebar"> +<div class="toc"> +<h3 id="toc">Contents</h3> +</div> +<div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title" translate="no"><TestHeader> - Test Header</h1> +<!-- $$$<TestHeader>-brief --> +<p>A header file. <a href="#details">More...</a></p> +<!-- @@@<TestHeader> --> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <TestHeader></span></td></tr> +</table></div> +<ul> +<li><TestHeader> is part of <a href="headers.html">Headers</a> and <a href="tests.html">Tests</a>.</li> +</ul> +<h2 id="types">Types</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="testheader.html#Globals-enum" translate="no">Globals</a></b> { Glo, Bal }</td></tr> +</table></div> +<h2 id="variables">Variables</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> const int </td><td class="memItemRight bottomAlign"><b><a href="testheader.html#globalVar-var" translate="no">globalVar</a></b></td></tr> +</table></div> +<h2 id="functions">Functions</h2> +<div class="table"><table class="alignedsummary" translate="no"> +<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="testheader.html#globalFunc" translate="no">globalFunc</a></b>()</td></tr> +</table></div> +<!-- $$$<TestHeader>-description --> +<div class="descr"> +<h2 id="details">Detailed Description</h2> +</div> +<!-- @@@<TestHeader> --> +<div class="types"> +<h2>Type Documentation</h2> +<!-- $$$Globals$$$Glo$$$Bal --> +<h3 class="fn" translate="no" id="Globals-enum">enum <span class="name">Globals</span></h3> +<div class="table"><table class="valuelist"><tr><th class="tblConst">Constant</th><th class="tblVal">Value</th></tr> +<tr><td class="topAlign"><code translate="no">Glo</code></td><td class="topAlign tblval"><code translate="no">0</code></td></tr> +<tr><td class="topAlign"><code translate="no">Bal</code></td><td class="topAlign tblval"><code translate="no">1</code></td></tr> +</table></div> +<!-- @@@Globals --> +</div> +<div class="vars"> +<h2>Variable Documentation</h2> +<!-- $$$globalVar --> +<h3 class="fn" translate="no" id="globalVar-var">const <span class="type">int</span> <span class="name">globalVar</span></h3> +<p>Global variable.</p> +<!-- @@@globalVar --> +</div> +<div class="func"> +<h2>Function Documentation</h2> +<!-- $$$globalFunc[overload1]$$$globalFunc --> +<h3 class="fn" translate="no" id="globalFunc"><span class="type">void</span> <span class="name">globalFunc</span>()</h3> +<p>Global function.</p> +<!-- @@@globalFunc --> +</div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/html/tests.html b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/html/tests.html new file mode 100644 index 000000000..a4221f375 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/html/tests.html @@ -0,0 +1,19 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> +<!-- testheader.cpp --> + <title>Tests | HeaderFile</title> +</head> +<body> +<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div> +<h1 class="title">Tests</h1> +<!-- $$$tests-description --> +<div class="descr" id="details"> +</div> +<!-- @@@tests --> +<div class="table"><table class="annotated"> +<tr class="odd topAlign"><td class="tblName" translate="no"><p><a href="testheader.html"><TestHeader></a></p></td><td class="tblDescr"><p>A header file</p></td></tr> +</table></div> +</body> +</html> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/webxml/headerfile.index b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/webxml/headerfile.index new file mode 100644 index 000000000..cf72522f9 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/webxml/headerfile.index @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE QDOCINDEX> +<INDEX url="" title="HeaderFile Reference Documentation" version="" project="HeaderFile"> + <namespace name="" status="active" access="public" module="headerfile"> + <function name="globalFunc" href="testheader.html#globalFunc" status="active" access="public" location="testheader.h" documented="true" related="0" meta="plain" type="void" brief="Global function" signature="void globalFunc()"/> + <header name="<TestHeader>" href="testheader.html" status="active" documented="true" groups="headers,tests" module="TestCPP" brief="A header file" title="Test Header" fulltitle="<TestHeader> - Test Header" subtitle=""> + <function name="globalFunc" href="testheader.html#globalFunc" status="active" access="public" location="testheader.h" documented="true" related="0" meta="plain" type="void" brief="Global function" signature="void globalFunc()"/> + <enum name="Globals" href="testheader.html#Globals-enum" status="active" access="public" location="testheader.h" related="1" documented="true"> + <value name="Glo" value="0"/> + <value name="Bal" value="1"/> + </enum> + <variable name="globalVar" href="testheader.html#globalVar-var" status="active" access="public" location="testheader.h" related="2" documented="true" type="const int" static="false" brief="Global variable"/> + </header> + <enum name="Globals" href="testheader.html#Globals-enum" status="active" access="public" location="testheader.h" related="1" documented="true"> + <value name="Glo" value="0"/> + <value name="Bal" value="1"/> + </enum> + <variable name="globalVar" href="testheader.html#globalVar-var" status="active" access="public" location="testheader.h" related="2" documented="true" type="const int" static="false" brief="Global variable"/> + <group name="headers" href="headers.html" status="active" documented="true" seen="true" title="Headers"/> + <group name="tests" href="tests.html" status="active" documented="true" seen="true" title="Tests"/> + <module name="TestCPP" href="testcpp-module.html" status="internal" seen="false" title=""/> + </namespace> +</INDEX> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/webxml/headers.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/webxml/headers.webxml new file mode 100644 index 000000000..6fdc7de0b --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/webxml/headers.webxml @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <group name="headers" href="headers.html" status="active" documented="true" seen="true" title="Headers"> + <description> + <table width="100%"> + <row> + <item> + <para> + <link raw="<TestHeader>" href="testheader.html" type=""/> + </para> + </item> + <item> + <para>A header file.</para> + </item> + </row> + </table> + </description> + </group> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/webxml/testheader.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/webxml/testheader.webxml new file mode 100644 index 000000000..fcc37e5ca --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/webxml/testheader.webxml @@ -0,0 +1,34 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <header name="<TestHeader>" href="testheader.html" status="active" documented="true" groups="headers,tests" module="TestCPP" brief="A header file" title="Test Header" fulltitle="<TestHeader> - Test Header" subtitle=""> + <description> + <brief>A header file.</brief> + </description> + <function name="globalFunc" href="testheader.html#globalFunc" status="active" access="public" location="testheader.h" documented="true" related="0" meta="plain" type="void" brief="Global function" signature="void globalFunc()"> + <description> + <brief>Global function.</brief> + </description> + </function> + <enum name="Globals" href="testheader.html#Globals-enum" status="active" access="public" location="testheader.h" related="1" documented="true"> + <value name="Glo" value="0"/> + <value name="Bal" value="1"/> + <description> + <list type="enum"> + <definition> + <term>Glo</term>Glo</definition> + <item/> + <definition> + <term>Bal</term>Bal</definition> + <item/> + </list> + </description> + </enum> + <variable name="globalVar" href="testheader.html#globalVar-var" status="active" access="public" location="testheader.h" related="2" documented="true" type="const int" static="false" brief="Global variable"> + <description> + <brief>This variable holds Global variable..</brief> + </description> + </variable> + </header> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/webxml/tests.webxml b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/webxml/tests.webxml new file mode 100644 index 000000000..7c3deb373 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/expected/webxml/tests.webxml @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8"?> +<WebXML> + <document> + <group name="tests" href="tests.html" status="active" documented="true" seen="true" title="Tests"> + <description> + <table width="100%"> + <row> + <item> + <para> + <link raw="<TestHeader>" href="testheader.html" type=""/> + </para> + </item> + <item> + <para>A header file.</para> + </item> + </row> + </table> + </description> + </group> + </document> +</WebXML> diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/headerfile.qdocconf b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/headerfile.qdocconf new file mode 100644 index 000000000..b449319cc --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/headerfile.qdocconf @@ -0,0 +1,25 @@ +sources.fileextensions = "*.qml *.cpp *.qdoc" +headers.fileextensions = "*.h" + +# images +imagedirs = ./src/images + +# zero warning policy +warninglimit = 0 +warninglimit.enabled = true + +# don't write host system-specific paths to index files +locationinfo = false + +project = HeaderFile +moduleheader = .src/testheader.h + +{includepaths,sourcedirs,headerdirs} += ./src + +outputformats = HTML WebXML DocBook +HTML.nosubdirs = true +HTML.outputsubdir = html +WebXML.nosubdirs = true +WebXML.outputsubdir = webxml +DocBook.nosubdirs = true +DocBook.outputsubdir = docbook diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/src/testheader.cpp b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/src/testheader.cpp new file mode 100644 index 000000000..43c512f36 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/src/testheader.cpp @@ -0,0 +1,43 @@ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 + +#include "testheader.h" + +const int globalVar = 0; + +/*! + \headerfile <TestHeader> + \title Test Header + \inmodule TestCPP + \brief A header file. + \ingroup headers + \ingroup tests +*/ + +/*! + \group headers + \title Headers +*/ + +/*! \group tests + \title Tests +*/ + +/*! + \fn void globalFunc() + \brief Global function. + \relates <TestHeader> +*/ + +/*! + \variable globalVar + \brief Global variable. + \relates <TestHeader> +*/ + +/*! + \enum Globals + \relates <TestHeader> + \value Glo + \value Bal +*/ diff --git a/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/src/testheader.h b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/src/testheader.h new file mode 100644 index 000000000..5ea361685 --- /dev/null +++ b/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/headerfile/src/testheader.h @@ -0,0 +1,8 @@ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 + +#pragma once + +void globalFunc() {}; +enum Globals { Glo, Bal }; +extern const int globalVar; |