blob: b6b8dc6cb6ddde1477dc8192632c1ae65c7f2b4c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
<?xml version="1.0" encoding="UTF-8"?>
<WebXML>
<document>
<page name="qdoctests-qdocfileoutput.html" href="qdoctests-qdocfileoutput.html" status="active" location="qdoctests-outputfromqdocfiles.qdoc" documented="true" subtype="page" title="Testing QDoc output from .qdoc files" fulltitle="Testing QDoc output from .qdoc files" subtitle="" brief="This is a simple page for testing purposes only">
<contents name="supported-file-types" title="Supported file types" level="1"/>
<contents name="further-information" title="Further information" level="1"/>
<contents name="linking" title="Linking" level="1"/>
<contents name="qdoc-linking-test" title="QDoc Linking Test" level="1"/>
<contents name="linking-to-something-in-a-section-title" title="Linking to something in a section title" level="1"/>
<description>
<relation href="qdoctests-qdocfileoutput-exhaustive.html" type="page" meta="next" description="Exhaustive testing of QDoc commands"/>
<brief>This is a simple page for testing purposes only.</brief>
<para>QDoc generates documentation for software projects. It does this by extracting <italic>QDoc comments</italic> from project source files. QDoc comments are signified by a C-style-like comment tag followed by an exclamation point, like this: <teletype type="highlighted">/*!</teletype> <teletype type="highlighted">This text is contained within QDoc comment tags.</teletype> <teletype type="highlighted">*/</teletype>.</para>
<section id="supported-file-types">
<heading level="1">Supported file types</heading>
<para>QDoc parses <teletype type="highlighted">.cpp</teletype> and <teletype type="highlighted">.qdoc</teletype> files. It does extract comments from header (<teletype type="highlighted">.h</teletype>) files.</para>
</section>
<section id="further-information">
<heading level="1">Further information</heading>
<para>This test document is written with the purpose of testing the output QDoc generates when parsing <teletype type="highlighted">.qdoc</teletype> files. It is fairly simple and makes use of a limited subset of QDoc's command. Those commands are:</para>
<list type="bullet">
<item>
<para>
<teletype type="highlighted">\page</teletype></para>
</item>
<item>
<para>
<teletype type="highlighted">\title</teletype></para>
</item>
<item>
<para>
<teletype type="highlighted">\brief</teletype></para>
</item>
<item>
<para>
<teletype type="highlighted">\e</teletype> (for emphasizing "QDoc comments")</para>
</item>
<item>
<para>
<teletype type="highlighted">\c</teletype> (for multiple monospace-formatted entries)</para>
</item>
<item>
<para>
<teletype type="highlighted">\section1</teletype></para>
</item>
<item>
<para>
<teletype type="highlighted">\list</teletype></para>
</item>
<item>
<para>
<teletype type="highlighted">\li</teletype></para>
</item>
<item>
<para>
<teletype type="highlighted">\endlist</teletype></para>
</item>
</list>
</section>
<section id="linking">
<heading level="1">Linking</heading>
<para>There are multiple ways to create hyperlinks to other topics:</para>
<list type="bullet">
<item>
<para>
<link raw="Testing QDoc's link command" href="qdoctests-qdocfileoutput-linking.html" type="page" page="Testing QDoc's link command">Linking to a page title</link></para>
</item>
<item>
<para>
<link raw="Link targets" href="qdoctests-qdocfileoutput-linking.html#link-targets" type="page" page="Testing QDoc's link command">Linking to a section title</link></para>
</item>
<item>
<para>
<link raw="link-test-target" href="qdoctests-qdocfileoutput-linking.html#link-test-target" type="page" page="Testing QDoc's link command">Linking using a \target string</link></para>
</item>
<item>
<para>
<link raw="QDoc Linking Test" href="qdoctests-qdocfileoutput-linking.html" type="page" page="Testing QDoc's link command">Linking using a \keyword string</link></para>
</item>
</list>
</section>
<section id="qdoc-linking-test">
<heading level="1">QDoc Linking Test</heading>
<para>This section title is overridden by another target which takes precedence.</para>
</section>
<section id="linking-to-something-in-a-section-title">
<heading level="1">Linking to <link raw="Further information" href="qdoctests-qdocfileoutput.html#further-information" type="page" page="Testing QDoc output from .qdoc files">something</link> in a section title</heading>
<para>This is allowed but a questionable practice.</para>
<para>
<bold>Note:</bold> You're looking at detailed information.</para>
</section>
</description>
</page>
</document>
</WebXML>
|
