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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\if defined(test_navigation)
\nextpage {qdoctests-qdocfileoutput-linking.html}{QDoc Linking Test}
\endif
\page qdoctests-qdocfileoutput.html
\title Testing \PROD output from .qdoc files
\brief This is a simple page for testing purposes only.
QDoc generates documentation for software projects. It does this by
extracting \e {QDoc comments} from project source files. QDoc comments are
signified by a C-style-like comment tag followed by an exclamation point,
like this:
\beginqdoc \c {This text is contained within QDoc comment tags.} \endqdoc.
\section1 Supported file types
QDoc parses \c .cpp and \c .qdoc files. It does extract comments from
header (\c {.h}) files.
\section1 Further information
This test document is written with the purpose of testing the output QDoc
generates when parsing \c .qdoc files. It is fairly simple and makes use of
a limited subset of QDoc's command. Those commands are:
\list
\li \c {\page}
\li \c {\title}
\li \c {\brief}
\li \c {\e} (for emphasizing "QDoc comments")
\li \c {\c} (for multiple monospace-formatted entries)
\li \c {\section1}
\li \c {\list}
\li \c {\li}
\li \c {\endlist}
\endlist
\section1 Linking
There are multiple ways to create hyperlinks to other topics:
\list
\li \l {Testing QDoc's link command}{Linking to a page title}
\li \l {Link targets}{Linking to a section title}
\li \l {link-test-target}{Linking using a \\target string}
\li \l {QDoc Linking Test}{Linking using a \\keyword string}
\endlist
*/
/*!
\if defined(test_navigation)
\previouspage qdoctests-qdocfileoutput.html \PROD Testing
\nextpage Table of Contents
\endif
\keyword QDoc Linking Test
\page qdoctests-qdocfileoutput-linking.html
\title Testing QDoc's link command
\brief This is a page for testing QDoc's link command.
\target link-test-target
\section1 Link targets
Valid parameters for the link command (\c {\l}) are page and section
titles, targets defined with \\target or \\keyword commands, and API
reference keywords (types, methods, namespaces, and so on).
*/
/*!
\if defined(test_navigation)
\previouspage {Testing QDoc's link command}{QDoc Linking Test}
\endif
\page toc.html
\title Table of Contents
\list
\li \l {Testing \PROD output from .qdoc files}{\PROD Testing}
\li \l {QDoc Linking Test}
\li \l {Table of Contents}
\endlist
*/
/*!
\page qdoctests-qdocfileoutput-exhaustive.html
\title Exhaustive testing of QDoc commands
\brief This page is a dumping ground for QDoc commands under test.
\section1 This is a section1
\section2 This is a section2
\section3 This is a section3
\section4 This is a section4
\endsection4
\endsection3
\endsection2
\endsection1
\badcode
This is bad code
\endcode
This text should have a line break riiiiight \br noooow.
\b{All your text belong to bold}
...And this is an examble of only \b bold being, well, bold.
\dots
\js
// If I knew JavaScript, this is where I would write it.
\endjs
\qmltext
And if I knew qmltext, I guess this is where that would go.
\endqmltext
\caption This a caption
\legalese
Lorem legal ipsum
\endlegalese
\quotation
This is a quotation.
\endquotation
\raw HTML
<html><body>This is <b>raw</b>. Like the <h1>Eddie Murphy</h1> movie. Just not as funny.</body></html>
\endraw
\sidebar
Look, ma! I made a sidebar!
\endsidebar
\table
\row \li Table item in a table row
\row \li Another item in a different row
\endtable
\granularity
\important This is really important.
\oldcode
This is old code.
\newcode
This is new and shiny!
\endcode
\note The code above doesn't compile
\hr
\warning The following commands have yet to be tested:
footnote
link
//! Check why above two (when used in this order) cause missing linefeeds on Windows/webxml
sincelist
header
index
topicref // or just don’t care, remove it
image
inlineimage
printline
printto
printuntil // what’s the difference between printto and printuntil???
quotefile
quotefromfile
quotefunction
skipline
skipto
skipuntil
span
snippet
codeline
overload
sub
sup
tableofcontents
tt
uicontrol
endmapref
endomit
underline
unicode
*/
|
