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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
|
/****************************************************************************
**
** Copyright (C) 2016 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$
**
****************************************************************************/
/*!
\page 21-0-qdoc-configuration.html
\previouspage Creating DITA Maps
\contentspage QDoc Manual
\nextpage Generic Configuration Variables
\title The QDoc Configuration File
Before running QDoc, you must create a QDoc configuration file to
tell QDoc where to find the source files that contain the QDoc
comments. The pathname to your configuration file is passed to
QDoc on the command line:
\quotation
\c {/current/dir$ ../../bin/qdoc ./config.qdocconf}
\endquotation
\section1 General Description
The configuration file is a list of entries of the form \e
{"variable = value"}. Using the configuration variables, you can
define where QDoc should find the various source files, images and
examples, where to put generated documentation etc. The
configuration file can also contain directives like \c
include. For an example, see \l {minimal-qdocconf}{a minimal qdocconf file}.
You can also use configuration variables to get QDoc to support
\l{Supporting Derived Projects} {derived projects}, i.e QDoc can
generate links in your project's documentation to elements in the
Qt online documentation. See the \l {Supporting Derived projects}
section.
The value of a configuration variable can be set using either '='
or '+='. The difference is that '=' overrides the previous value,
while '+=' adds a new value to the current one.
Some configuration variables accept a list of strings as their
value, for example:
\l {sourcedirs-variable}
{\c{sourcedirs}}, while others accept only a single string. Double
quotes around a value string are optional, but including them allows
you to use special characters like '=' and ' \" ' within the value
string, for example:
\badcode
HTML.postheader = "<a href=\"index.html\">Home</a>"
\endcode
If an entry spans many lines, use a backslash at the end of every
line but the last:
\badcode
sourcedirs = kernel \
tools \
widgets
\endcode
\section1 Configuration Variables
\section1 Variable List
\list
\li \l {alias-variable} {alias}
\li \l {Cpp.ignoredirectives-variable} {Cpp.ignoredirectives}
\li \l {Cpp.ignoretokens-variable} {Cpp.ignoretokens}
\li \l {defines-variable} {defines}
\li \l {edition-variable} {edition}
\li \l {exampledirs-variable} {exampledirs}
\li \l {examples-variable} {examples}
\li \l {examples.fileextensions-variable} {examples.fileextensions}
\li \l {excludedirs-variable} {excludedirs}
\li \l {excludefiles-variable} {excludefiles}
\li \l {extraimages-variable} {extraimages}
\li \l {falsehoods-variable} {falsehoods}
\li \l {headerdirs-variable} {headerdirs}
\li \l {headers-variable} {headers}
\li \l {headers.fileextensions-variable} {headers.fileextensions}
\li \l {HTML.footer-variable} {HTML.footer}
\li \l {HTML.postheader-variable} {HTML.postheader}
\li \l {HTML.style-variable} {HTML.style}
\li \l {imagedirs-variable} {imagedirs}
\li \l {images-variable} {images}
\li \l {images.fileextensions-variable} {images.fileextensions}
\li \l {language-variable} {language}
\li \l {macro-variable} {macro}
\li \l {manifestmeta-variable} {manifestmeta}
\li \l {navigation-variable} {navigation}
\li \l {outputdir-variable} {outputdir}
\li \l {outputformats-variable} {outputformats}
\li \l {outputprefixes-variable} {outputprefixes}
\li \l {outputsuffixes-variable} {outputsuffixes}
\li \l {sourcedirs-variable} {sourcedirs}
\li \l {sources-variable} {sources}
\li \l {sources.fileextensions-variable} {sources.fileextensions}
\li \l {spurious-variable} {spurious}
\li \l {tabsize-variable} {tabsize}
\li \l {version-variable} {version}
\li \l {versionsym-variable} {versionsym}
\li \l {warninglimit-variable} {warninglimit}
\endlist
\section1 Categories
\list
\li \l {Generic Configuration Variables}
\li \l {C++ Specific Configuration Variables}
\li \l {Format-specific Configuration Variables}
\endlist
\section1 Configuration File Examples
\list
\li A minimum configuration file: \l minimum.qdocconf
\li The Qt configuration file: \l qtgui.qdocconf
\endlist
*/
/*!
\page 22-qdoc-configuration-generalvariables.html
\previouspage The QDoc Configuration File
\contentspage QDoc Manual
\nextpage Creating Help Project Files
\title Generic Configuration Variables
With the general QDoc configuration variables, you can define
where QDoc will find the various source files it needs to generate
the documentation, as well as the directory to put the generated
documentation. You can also do some minor manipulation of QDoc
itself, controlling its output and processing behavior.
\target alias-variable
\section1 alias
The \c alias variable renames a QDoc command.
The general syntax is \tt {alias.\e{original-command-name} = \e
temporary-command-name}.
\badcode
alias.e = i
\endcode
This renames the built-in command \\e (italics) to be \\i. The \c
alias variable is often used for compatibility reasons.
See also \l {macro-variable} {macro}.
\target codeindent-variable
\section1 codeindent
The \c codeindent variable specifies the level of indentation that
QDoc uses when writing code snippets.
QDoc originally used a hard-coded value of four spaces for code
indentation to ensure that code snippets could be easily
distinguished from surrounding text. Since we can use \l{HTML
Specific Configuration Variables#HTML.stylesheets} {stylesheets}
to adjust the appearance of certain types of HTML elements, this
level of indentation is not always required.
\target codeprefix-variable
\target codesuffix-variable
\section1 codeprefix, codesuffix
The \c codeprefix and \c codesuffix variables specify a pair of
strings that each code snippet is enclosed in.
\target defines-variable
\section1 defines
The \c defines variable specifies the C++ preprocessor symbols
that QDoc will recognize and respond to.
When a preprocessor symbol is specified using the \c defines
variable, you can also use the \l {if-command} {\\if} command to
enclose documentation that only will be included if the
preprocessor symbol is defined.
The values of the variable are regular expressions (see QRegExp
for details). By default, no symbol is defined, meaning that code
protected with #ifdef...#endif will be ignored.
\badcode
defines = Q_QDOC \
QT_.*_SUPPORT \
QT_.*_LIB \
QT_COMPAT \
QT3_SUPPORT \
Q_OS_.* \
Q_BYTE_ORDER \
__cplusplus
\endcode
This ensures that QDoc will process the code that requires these
symbols to be defined. For example:
\code
#ifdef Q_OS_WIN
HDC getDC() const;
void releaseDC(HDC) const;
#endif
\endcode
Since the Q_OS_.* regular expression (specified using the \c
defines variable) matches Q_OS_WIN, QDoc will process the code
within #ifdef and #endif in our example.
You can also define preprocessor symbols manually on the command
line using the -D option. For example:
\badcode
currentdirectory$ qdoc -Dconsoleedition qtgui.qdocconf
\endcode
In this case the -D option ensures that the \c consoleedition
preprocessor symbol is defined when QDoc processes the source
files defined in the qtgui.qdocconf file.
See also \l {falsehoods-variable} {falsehoods} and \l {if-command} {\\if}.
\target edition-variable
\section1 edition
The \c edition variable specifies which modules are included in
each edition of a package, and provides QDoc with information to
provide class lists for each edition.
This feature is mostly used when providing documentation for Qt
packages.
The \c edition variable is always used with a particular edition
name to define the modules for that edition:
\badcode
edition.Console = QtCore QtNetwork QtSql QtXml
edition.Desktop = QtCore QtGui QtNetwork QtOpenGL QtSql QtXml \
QtDesigner QtAssistant Qt3Support QAxContainer \
QAxServer
edition.DesktopLight = QtCore QtGui Qt3SupportLight
\endcode
In the above examples, the \c Console edition only includes the
contents of four modules. Only the classes from these modules will
be used when the \l{Miscellaneous#generatelist-command}
{generatelist} command is used to generate a list of classes for
this edition:
\badcode
\generatelist{classesbyedition Console}
\endcode
\target exampledirs-variable
\section1 exampledirs
The \c exampledirs variable specifies the directories containing
the source code of the example files.
The \l {examples-variable} {examples} and \l
{exampledirs-variable} {exampledirs} variables are used by the \l
{quotefromfile-command} {\\quotefromfile}, \l {quotefile-command}
{\\quotefile} and \l {example-command} {\\example} commands. If
both the \l {examples-variable} {examples} and \l
{exampledirs-variable} {exampledirs} variables are defined, QDoc
will search in both, first in \l {examples-variable} {examples}
then in \l {exampledirs-variable} {exampledirs}.
QDoc will search through the directories in the specified order,
and accept the first matching file it finds. It will only search
in the specified directories, \e not in subdirectories.
\badcode
exampledirs = $QTDIR/doc/src \
$QTDIR/examples \
$QTDIR \
$QTDIR/qmake/examples
examples = $QTDIR/examples/widgets/analogclock/analogclock.cpp
\endcode
When processing
\badcode
\quotefromfile widgets/calculator/calculator.cpp
\endcode
QDoc will see if there is a file called \c calculator.cpp
listed as a value in the \l {examples-variable} {\c examples} variable. If
there isn't, it will search in the \c exampledirs variable, and
first see if there exists a file called
\badcode
$QTDIR/doc/src/widgets/calculator/calculator.cpp
\endcode
If it doesn't, QDoc will continue looking for a file called
\badcode
$QTDIR/examples/widgets/calculator/calculator.cpp
\endcode
and so forth.
See also \l {examples-variable}{examples}.
\target examples-variable
\section1 examples
The \c examples variable allows you to specify individual example
files in addition to those located in the directories specified by
the \l {exampledirs-variable} {\c exampledirs} variable.
The \c examples and \l {exampledirs-variable} {\c exampledirs}
variables are used by the \l {quotefromfile-command}
{\\quotefromfile}, \l {quotefile-command} {\\quotefile} and \l
{example-command} {\\example} commands. If both the \c examples and \l
{exampledirs-variable} {\c exampledirs} variables are defined,
QDoc will search in both, first in \c examples then in \l
{exampledirs-variable} {\c exampledirs}.
QDoc will search through the values listed for the \c examples
variable, in the specified order, and accept the first one it
finds.
For an extensive example, see the \l {exampledirs-variable} {\c
exampledirs} command. But note that if you know the file is listed
in the \c examples variable, you don't need to specify its path:
\badcode
\quotefromfile calculator.cpp
\endcode
See also \l {exampledirs-variable} {exampledirs}.
\target examples.fileextensions-variable
\section1 examples.fileextensions
The \c examples.fileextensions variable specifies the file
extensions that qdoc will look for when collecting example files
for display in the documentation.
The default extensions are *.cpp, *.h, *.js, *.xq, *.svg, *.xml
and *.ui.
The extensions are given as standard wildcard expressions. You
can add a file extension to the filter using '+='. For example:
\badcode
examples.fileextensions += *.qrc
\endcode
See also \l{headers.fileextensions}.
\target excludedirs-variable
\section1 excludedirs
The \c excludedirs variable is for listing directories that should \e{not}
be processed by qdoc, even if the same directories are included by the
\l {sourcedirs-variable} {sourcedirs} or \l {headerdirs-variable} {headerdirs}
variables.
For example:
\badcode
sourcedirs = src/corelib
excludedirs = src/corelib/tmp
\endcode
When executed, QDoc will exclude the listed directories from
further consideration. Files in these directories will not be
read by qdoc.
See also \l {excludefiles-variable} {excludefiles}.
\target excludefiles-variable
\section1 excludefiles
The \c excludefiles variable allows you to specify individual files
that should \e{not} be processed by qdoc.
\badcode
excludefiles += $QT_CORE_SOURCES/../../src/widgets/kernel/qwidget.h \
$QT_CORE_SOURCES/../../src/widgets/kernel/qwidget.cpp
\endcode
If you include the above in your qdocconf file for qtbase, there
will be no class documentation generated for QWidget.
Since Qt 5.6, also simple wildcards ('*' and '?') are recognized by
\c excludefiles. For example, to exclude all private Qt header files
from being parsed, define the following:
\badcode
excludefiles += "*_p.h"
\endcode
See also \l {excludedirs-variable} {excludedirs}.
\target extraimages-variable
\section1 extraimages
The \c extraimages variable tells QDoc to incorporate specific
images in the generated documentation.
QDoc will not recognize images used within HTML (or any other
markup language). If we want the images to be copied from the
directories specified by \l {imagedirs} {\c imagedirs} (the images
in question must be located in these directories) to the output
directory, we must specify the images using the \c extraimages
variable.
The general syntax is \tt {extraimages.\e{format} = \e image}. The
file extension is optional.
For example, in \l qtgui.qdocconf we use a couple of images within
the HTML.postheader variable which value is pure HTML. For that
reason, these images are specified using the \c extraimages
variable:
\badcode
extraimages.HTML = qt-logo
\endcode
See also \l images and \l imagedirs.
\target falsehoods-variable
\section1 falsehoods
The \c falsehoods variable defines the truth value of specified
preprocessor symbols as false.
If this variable is not set for a preprocessor symbol, QDoc
assumes its truth value is true. The exception is '0', which value
always is false.
QDoc will recognize, and is able to evaluate, the following
preprocessor syntax:
\code
#ifdef NOTYET
...
#endif
#if defined (NOTYET)
...
#end if
\endcode
However, faced with unknown syntax like
\code
#if NOTYET
...
#endif
\endcode
QDoc will evaluate it as true by default, \e unless the
preprocessor symbol is specified within the \c falsehoods variable
entry:
\badcode
falsehoods = NOTYET
\endcode
See also \l defines.
\target generateindex-variable
\section1 generateindex
The \c generateindex variable contains a boolean value that
specifies whether to generate an index file when HTML
documentation is generated.
By default, an index file is always generated with HTML
documentation, so this variable is typically only used when
disabling this feature (by setting the value to \c false) or when
enabling index generation for the WebXML output (by setting the
value to \c true).
\target headerdirs-variable
\section1 headerdirs
The \c headerdirs variable specifies the directories containing
the header files associated with the \c .cpp source files used in
the documentation.
\badcode
headerdirs = $QTDIR/src \
$QTDIR/extensions/activeqt \
$QTDIR/extensions/motif \
$QTDIR/tools/designer/src/lib/extension \
$QTDIR/tools/designer/src/lib/sdk \
$QTDIR/tools/designer/src/lib/uilib
\endcode
When executed, the first thing QDoc will do is to read through the
headers specified in the \l {headers} {\c headers} variable, and
the ones located in the directories specified in the \c headerdir
variable (including all subdirectories), building an internal
structure of the classes and their functions.
Then it will read through the sources specified in the \l
{sources-variable} {\c sources}, and the ones located in the
directories specified in the \l {sourcedirs-variable} {\c
sourcedirs} varible (including all subdirectories), merging the
documentation with the structure it retrieved from the header
files.
If both the \c headers and \c headerdirs variables are defined,
QDoc will read through both, first \l {headers} {\c headers} then
\c headerdirs.
In the specified directories, QDoc will only read the files with
the \c fileextensions specified in the \l {headers.fileextensions}
{\c headers.fileextensions} variable. The default extensions are
*.ch, *.h, *.h++, *.hh, *.hpp, and *.hxx". The files specified by
\l {headers} {\c headers} will be read without taking into account
their fileextensions.
See also \l headers and \l headers.fileextensions.
\target headers-variable
\section1 headers
The \c headers variable allows you to specify individual header
files in addition to those located in the directories specified by
the \l {headerdirs} {\c headerdirs} variable.
\badcode
headers = $QTDIR/src/gui/widgets/qlineedit.h \
$QTDIR/src/gui/widgets/qpushbutton.h
\endcode
When processing the \c headers variable, QDoc behaves in the same
way as it does when processing the \l {headerdirs} {\c headerdirs}
variable. For more information, see the \l {headerdirs} {\c
headerdirs} variable.
See also \l headerdirs.
\target headers.fileextensions-variable
\section1 headers.fileextensions
The \c headers.fileextensions variable specify the extension used
by the headers.
When processing the header files specified in the \l {headerdirs}
{\c headerdirs} variable, QDoc will only read the files with the
fileextensions specified in the \c headers.fileextensions
variable. In this way QDoc avoids spending time reading irrelevant
files.
The default extensions are *.ch, *.h, *.h++, *.hh, *.hpp, and
*.hxx.
The extensions are given as standard wildcard expressions. You
can add a file extension to the filter using '+='. For example:
\badcode
header.fileextensions += *.H
\endcode
\warning The above assignment may not work as described.
See also \l headerdirs.
\target imagedirs-variable
\section1 imagedirs
The \c imagedirs variable specifies the directories containing the
images used in the documentation.
The \l {images} {\c images} and \c imagedirs variables are used by
the \l {image-command} {\\image} and \l {inlineimage-command}
{\\inlineimage} commands. If both the \l {images} {\c images} and
\c imagedirs variables are defined, QDoc will search in both. First
in \l {images} {\c images}, then in \c imagedirs.
QDoc will search through the directories in the specified order,
and accept the first matching file it finds. It will only search
in the specified directories, \e not in subdirectories.
\badcode
imagedirs = $QTDIR/doc/src/images \
$QTDIR/examples
images = $QTDIR/doc/src/images/calculator-example.png
\endcode
When processing
\badcode
\image calculator-example.png
\endcode
QDoc will then see if there is a file called
calculator-example.png listed as a value in the \c images
variable. If there isn't, it will search in the \c imagedirs
variable for:
\badcode
$QTDIR/doc/src/images/calculator-example.png
\endcode
If the file doesn't exist, QDoc will look for a file called
\badcode
$QTDIR/examples/calculator-example.png
\endcode
You can filter the images in an image directory using the \l
{images.fileextensions} {\c images.fileextensions} variable. The
general idea behind the \l {images.fileextensions} {\c images.fileextensions}
variable is to enable different image format for different output format.
\warning The \l {images.fileextensions} {\c images.fileextensions}
variable's functionality is preliminary since QDoc at this point
only supports HTML.
See also \l images and \l images.fileextensions.
\target images-variable
\section1 images
The \c images variable allows you to specify individual image
files in addition to those located in the directories specified by
the \l {imagedirs} {\c imagedirs} variable.
\badcode
images = $QTDIR/doc/src/images/calculator-example.png
\endcode
When processing the \c images variable, QDoc behaves in the same
way as it does when processing the \l {imagedirs} {\c imagedirs}
variable. For more information, see the \l {imagedirs} {\c
imagedirs} variable.
See also \l imagedirs and \l images.fileextensions.
\target images.fileextensions-variable
\section1 images.fileextensions
The images.fileextensions variable filters the files within an
image directory.
The variable's values (the extensions) are given as standard
wildcard expressions. The general syntax is: \tt
{images.fileextensions.\e{format} = *.\e{extension}}.
The idea is to enable different image format for different output
format.
\badcode
images.fileextensions.HTML = *.png
images.fileextensions.LOUT = *.eps
\endcode
Then, when processing the \l {image-command} {\\image} and \l
{inlineimage-command} {\\inlineimage} commands, QDoc will only
search for files with extensions specified in the variable
containing the list of output formats.
\warning This is only a preliminary functionality since QDoc at this
point only supports HTML.
The default extensions for HTML are *.png, *.jpg, *.jpeg, and
*.gif.
You can add a file extension to the filter using '+='. For
example:
\badcode
images.fileextensions.HTML += *.eps
\endcode
See also \l imagedirs and \l images.
\target language-variable
\section1 language
The \c language variable specifies the language of the source code
that is used in the documentation.
Currently, C++ is the only language that QDoc understands. It is
also the default language, and doesn't really need to be
specified. However, a possible example of a language variable
statement:
\badcode
language = Cpp
\endcode
This identifies C++ as the language of the Qt source code.
\target macro-variable
\section1 macro
The \c macro variable is used to create your own simple QDoc
commands. The syntax is \tt {macro.\e{command} = \e{definition}},
where the definition is written using QDoc syntax.
A macro variable can be restricted for use in one type of output
generation. By appending \c {.HTML} to the macro name, for
example, the macro is only used when generating HTML output. By
appending \c {.DITAXML} to the macro name, the macro is only used
when generating DITA XML.
\badcode
macro.gui = "\\b"
macro.raisedaster.HTML = "<sup>*</sup>"
\endcode
The first macro defines the \\gui command to render its argument
using a bold font. The second macro defines the \\raisedaster
command to render a superscript asterisk, but only when generating
HTML.
A macro can also take up to seven parameters:
\badcode
macro.hello = "Hello \1!"
\endcode
Parameters are passed to macros the same way as to other commands:
\badcode
\hello World
\endcode
When using more than one parameter, or when an argument
contains whitespace, enclose each argument in braces:
\badcode
macro.verinfo = "\1 (version \2)"
\endcode
\badcode
\verinfo {QFooBar} {1.0 beta}
\endcode
See also \l {alias-variable} {alias}.
\target manifestmeta-variable
\section1 manifestmeta
The \c manifestmeta variable specifies additional meta-content
for the example manifest files generated by QDoc.
See the \l{Manifest Meta Content} section for more information.
\target naturallanguage-variable
\section1 naturallanguage
The \c naturallanguage variable specifies the natural language
used for the documentation generated by qdoc.
\badcode
naturallanguage = zh-Hans
\endcode
By default, the natural language is \c en for compatibility with
legacy documentation.
qdoc will add the natural language information to the HTML it
generates, using the \c lang and \c xml:lang attributes.
See also \l {sourceencoding-variable} {sourceencoding},
\l {outputencoding-variable} {outputencoding},
\l{http://www.w3.org/TR/xhtml1/#C_7}
{C.7. The lang and xml:lang Attributes} and
\l{http://www.w3.org/TR/i18n-html-tech-lang/#ri20040429.113217290}
{Best Practice 13: Using Hans and Hant codes}.
\target navigation-variable
\section1 navigation
The \c navigation sub-variables, if defined, set the home page, landing
page, C++ classes page, and QML types page that are visible in the
generated navigation bar for each page.
In a project with multiple sub-projects (for example, Qt modules), each
sub-project typically defines its own landing page while the same home
page is used across all sub-projects.
\b Sub-variables
\table
\row \li \c navigation.homepage
\li Project home page.
\row \li \c navigation.hometitle
\li (Optional) User-visible title for the home page.
Default value is taken from \c homepage.
\row \li \c navigation.landingpage
\li Sub-project landing page.
\row \li \c navigation.landingtitle
\li (Optional) User-visible title for the landing page.
Defaults value is taken from \c landingpage.
\row \li \c navigation.cppclassespage
\li Top-level page that lists all C++ classes for this (sub-)project.
Typically, the title of a \l {module-command}{\\module} page.
\row \li \c navigation.cppclassestitle
\li (Optional) User-visible title for the C++ classes page.
Default is "C++ Classes".
\row \li \c navigation.qmltypespage
\li Top-level page that lists all QML types for this (sub-)project.
Typically, the title of a \l {qmlmodule-command}{\\qmlmodule} page.
\row \li \c navigation.qmltypestitle
\li (Optional) User-visible title for the QML types page.
Default is "QML Types".
\endtable
For example:
\badcode
# Common configuration
navigation.homepage = index.html
navigation.hometitle = "Qt $QT_VER"
# qtquick.qdocconf
navigation.landingpage = "Qt Quick"
navigation.cppclassespage = "Qt Quick C++ Classes"
navigation.qmltypespage = "Qt Quick QML Types"
\endcode
The above configuration produces the following navigation bar for \c Item QML type:
\badcode
Qt 5.10 > Qt Quick > QML Types > Item QML Type
\endcode
\target outputdir-variable
\section1 outputdir
The \c outputdir variable specifies the directory where QDoc will
put the generated documentation.
\badcode
outputdir = $QTDIR/doc/html
\endcode
locates the generated Qt reference documentation in
$QTDIR/doc/html. For example, the documentation of the QWidget
class is located in
\badcode
$QTDIR/doc/html/qwidget.html
\endcode
The associated images will be put in an \c images subdirectory.
\warning When running QDoc multiple times using the same output
directory, all files from the previous run will be lost.
\target outputencoding-variable
\section1 outputencoding
The \c outputencoding variable specifies the encoding used for the
documentation generated by qdoc.
\badcode
outputencoding = UTF-8
\endcode
By default, the output encoding is \c ISO-8859-1 (Latin1) for
compatibility with legacy documentation. When generating
documentation for some languages, particularly non-European
languages, this is not sufficient and an encoding such as UTF-8 is
required.
qdoc will encode HTML using this encoding and generate the correct
declarations to indicate to browsers which encoding is being
used. The \l naturallanguage configuration variable should also be
specified to provide browsers with a complete set of character
encoding and language information.
See also \l outputencoding and \l naturallanguage.
\target outputformats-variable
\section1 outputformats
The \c outputformats variable specifies the format(s) of
the generated documentation.
Since Qt 5.11, QDoc supports the HTML and WebXML formats. If no
\c outputformats are specified, QDoc generates the documentation
in HTML (the default format). Both output formats can be specified,
with dedicated output directories and other settings. For example:
\badcode
outputformats = WebXML HTML
WebXML.nosubdirs = true
WebXML.outputsubdir = webxml
WebXML.quotinginformation = true
\endcode
This generates HTML documentation using the default settings, as well
as WebXML documentation into output subdirectory \e webxml.
\target outputprefixes-variable
\section1 outputprefixes
The \c outputprefixes variable specifies a mapping between types of files
and the prefixes to prepend to the HTML file names in the generated
documentation.
\badcode
outputprefixes = QML JS
outputprefixes.QML = uicomponents-
outputprefixes.JS = uicomponents-
\endcode
By default, files containing the API documentation for QML types
are prefixed with "qml-", and javaScript types with "js-". In the
above example, the prefix \c "uicomponents" is used instead for
both.
The output prefix is applied to file names for documentation on
QML and JS types.
\target outputsuffixes-variable
\section1 outputsuffixes
The \c outputsuffixes variable specifies a mapping between types of
files and module name suffixes to append to the HTML file names.
\badcode
outputsuffixes = QML
outputsuffixes.QML = -tp
\endcode
Given a QML module name \e FooBar and the default
\l {outputprefixes-variable}{output prefix} ("qml-"), the file name of
the generated HTML page for a QML type \e FooWidget would be
\c qml-foobar-tp-foowidget.html.
By default, no suffix is used. The output suffix, if defined, is applied
to file names for documentation on QML and JS types, and their respective
module pages.
The \c outputsuffixes variable was introduced in QDoc 5.6.
\target qhp-variable
\section1 qhp
The \c qhp variable is used to define the information to be
written out to Qt Help Project (\c{qhp}) files.
See the \l{Creating Help Project Files} chapter for information
about this process.
\target sourcedirs-variable
\section1 sourcedirs
The \c sourcedirs variable specifies the directories containing
the \c .cpp or \c .qdoc files used in the documentation.
\badcode
sourcedirs += .. \
../../../examples/gui/doc/src
\endcode
When executed, the first thing QDoc will do is to read through the
headers specified in the \l {header-command} {\c header} variable,
and the ones located in the directories specified in the \c
headerdir variable (including all subdirectories), building an
internal structure of the classes and their functions.
Then it will read through the sources specified in the \l
{sources} {\c sources}, and the ones located in the directories
specified in the \l {sourcedirs} {\c sourcedirs} variable
(including all subdirectories), merging the documentation with the
structure it retrieved from the header files.
If both the \c sources and \c sourcedirs variables are defined,
QDoc will read through both, first \l {sources} {\c sources} then
\c sourcedirs.
In the specified directories, QDoc will only read the files with
the \c fileextensions specified in the \l {sources.fileextensions}
{\c sources.fileextensions} variable. The default extensions are
*.c++, *.cc, *.cpp and *.cxx. The files specified by \l {sources}
{\c sources} will be read independent of their fileextensions.
See also \l {sources-variable} {sources} and
\l {sources.fileextensions-variable} {sources.fileextensions}.
\target sourceencoding-variable
\section1 sourceencoding
The \c sourceencoding variable specifies the encoding used for the
source code and documentation.
\badcode
sourceencoding = UTF-8
\endcode
By default, the source encoding is \c ISO-8859-1 (Latin1) for
compatibility with legacy documentation. For some languages,
particularly non-European languages, this is not sufficient and an
encoding such as UTF-8 is required.
Although qdoc will use the encoding to read source and
documentation files, limitations of C++ compilers may prevent you
from using non-ASCII characters in source code comments. In cases
like these, it is possible to write API documentation completely
in documentation files.
See also \l {naturallanguage-variable} {naturallanguage} and
\l {outputencoding-variable} {outputencoding}.
\target sources-variable
\section1 sources
The \c sources variable allows you to specify individual source
files in addition to those located in the directories specified by
the \l {sourcedirs-variable} {sourcedirs} variable.
\badcode
sources = $QTDIR/src/gui/widgets/qlineedit.cpp \
$QTDIR/src/gui/widgets/qpushbutton.cpp
\endcode
When processing the \c sources variable, QDoc behaves in the same
way as it does when processing the \l {sourcedirs-variable}
{sourcedirs} variable. For more information, see the \l
{sourcedirs-variable} {sourcedirs} variable.
See also \l {sourcedirs-variable} {sourcedirs}.
\target sources.fileextensions-variable
\section1 sources.fileextensions
The \c sources.fileextensions variable filters the files within a
source directory.
When processing the source files specified in the \l {sourcedirs}
{\c sourcedirs} variable, QDoc will only read the files with the
fileextensions specified in the \c sources.fileextensions
variable. In this way QDoc avoid spending time reading irrelevant
files.
The default extensions are *.c++, *.cc, *.cpp and *.cxx.
The extensions are given as standard wildcard expressions. You
can add a file extension to the filter using '+='. For example:
\badcode
sources.fileextensions += *.CC
\endcode
\warning The above assignment may not work as described.
See also \l {sourcedirs-variable} {sourcedirs} and \l
(sources-variable} {sources}.
\target spurious-variable
\section1 spurious
The \c spurious variable excludes specified QDoc warnings from the
output. The warnings are specified using standard wildcard
expressions.
\badcode
spurious = "Cannot find .*" \
"Missing .*"
\endcode
makes sure that warnings matching either of these expressions,
will not be part of the output when running QDoc. For example
would the following warning be omitted from the output:
\badcode
src/opengl/qgl_mac.cpp:156: Missing parameter name
\endcode
\target syntaxhighlighting
\section1 syntaxhighlighting
The \c syntaxhighlighting variable specifies whether QDoc should
perform syntax highlighting on source code quoted in the
documentation it generates.
\badcode
syntaxhighlighting = true
\endcode
will enable syntax highlighting for all supported programming
languages.
\target tabsize-variable
\section1 tabsize
The \c tabsize variable defines the size of a tab character.
\badcode
tabsize = 4
\endcode
will give the tab character the size of 4 spaces. The default
value of the variable is 8, and doesn't need to be specified.
\target tagfile-variable
\section1 tagfile
The \c tagfile variable specifies the Doxygen tag file to be
written when HTML is generated.
\target version-variable
\section1 version
The \c version variable specifies the version number of the
documented software.
\badcode
version = 5.6.0
\endcode
When a version number is specified (using the \tt{\l version} or
\tt {\l versionsym} variables in a \c .qdocconf file), it is
accessible through the corresponding \\version command for use in
the documentation.
\warning The \\version command's functionality is not fully
implemented; currently it only works within raw HTML code.
See also \l versionsym.
\target versionsym-variable
\section1 versionsym
The \c versionsym variable specifies a C++ preprocessor symbol
that defines the version number of the documented software.
\badcode
versionsym = QT_VERSION_STR
\endcode
QT_VERSION_STR is defined in qglobal.h as follows
\badcode
#define QT_VERSION_STR "4.0.1"
\endcode
When a version number is specified (using the \tt{\l version} or
\tt {\l versionsym} variables in a \c .qdocconf file), it is
accessible through the corresponding \\version command for use in
the documentation.
\warning The \\version command's functionality is not fully
implemented. Currently, it only works within raw HTML code.
See also \l {version} {\\version}.
\target warninglimit-variable
\section1 warninglimit
The \c warninglimit variable sets the maximum number of documentation
warnings allowed. If this limit is exceeded, QDoc continues as normal
but exits with the warning count as the error code. If the limit was
not exceeded or \c warninglimit was not defined, QDoc process exits
with 0, assuming there were no other critical errors.
Setting the \c warninglimit to \c 0 means failure on any warning.
\note By default, QDoc does not enforce the warning limit. Enable it
with \c {warninglimit.enabled = true} or by defining
the \c QDOC_ENABLE_WARNINGLIMIT environment variable.
For example,
\badcode
# Fail the documentation build if we have more than 100 warnings
warninglimit = 100
warninglimit.enabled = true
\endcode
The \c warninglimit variable was introduced in Qt 5.11.
*/
/*!
\page 22-creating-help-project-files.html
\previouspage Generic Configuration Variables
\contentspage QDoc Manual
\nextpage C++ Specific Configuration Variables
\title Creating Help Project Files
\section1 Overview
Qt Assistant uses a system for managing Qt documentation that requires
QDoc to generate inventories of files in a format that is similar to the
old style DCF format, but with additional features.
QDoc allows configuration variables to be used to specify which pages are
to be used in each documentation set it generates. These are specified as
subvariables of the \c qhp variable with each set declared using a unique
identifier as a subvariable.
For example, the configuration file for the Qt Quick documentation set
specifies information about the set as subvariables with the
\c{qhp.QtQuick} prefix:
\badcode
qhp.projects = QtQuick
qhp.QtQuick.file = qtquick.qhp
qhp.QtQuick.namespace = org.qt-project.qtquick.$QT_VERSION_TAG
qhp.QtQuick.virtualFolder = qtquick
qhp.QtQuick.indexTitle = Qt Quick
qhp.QtQuick.indexRoot =
qhp.QtQuick.filterAttributes = qtquick $QT_VERSION qtrefdoc
qhp.QtQuick.customFilters.Qt.name = QtQuick $QT_VERSION
qhp.QtQuick.customFilters.Qt.filterAttributes = qtquick $QT_VERSION
qhp.QtQuick.subprojects = qmltypes classes examples
qhp.QtQuick.subprojects.qmltypes.title = QML Types
qhp.QtQuick.subprojects.qmltypes.indexTitle = Qt Quick QML Types
qhp.QtQuick.subprojects.qmltypes.selectors = qmlclass
qhp.QtQuick.subprojects.qmltypes.sortPages = true
qhp.QtQuick.subprojects.classes.title = Classes
qhp.QtQuick.subprojects.classes.title = C++ Classes
qhp.QtQuick.subprojects.classes.indexTitle = Qt Quick C++ Classes
qhp.QtQuick.subprojects.classes.selectors = class fake:headerfile
qhp.QtQuick.subprojects.classes.sortPages = true
qhp.QtQuick.subprojects.examples.title = Examples
qhp.QtQuick.subprojects.examples.indexTitle = Qt Quick Examples and Tutorials
qhp.QtQuick.subprojects.examples.selectors = fake:example
\endcode
The documentation set may include one or more subprojects, which are added
to the table of contents under the name specified by \c title. The page
in the documentation referred to by the \c indexTitle acts as the index page
for the subproject. The page types to list under the subproject are specified
by \c selectors. The entries are alphabetically sorted if \c sortPages is set
to \c true.
\section2 Using Selectors
The \c selectors property specifies which page types are listed under the
table of contents entry for a subproject. Multiple selectors can be listed,
separated by whitespace.
\table
\header \li Selector \li Description
\row \li \c namespace \li Namespaces
\row \li \c class \li Classes
\row \li \c qmltype \li QML Types
\row \li \c qmlclass \li Alias for \c qmltype.
\row \li \c module[:name] \li C++ modules or members of the module
with a specified name.
\row \li \c qmlmodule[:name] \li QML modules or members of the module
with a specified name.
\row \li \c doc[:subtype] \li Documentation pages with a specified
\c subtype. Multiple subtypes can be
listed as a comma-separated list.
\row \li \c fake \li Alias for \c doc.
\row \li \c group[:groupname] \li Documentation pages for members of a
specified group, as added using the
\l {ingroup-command}
{\\ingroup} groupname command.
Multiple group names can be listed as
a comma-separated list.
(Introduced in QDoc 5.6).
\endtable
Available subtypes for the \c doc selector:
\table
\header \li Subtype \li Description
\row \li \c example \li Examples
\row \li \c headerfile \li Header files
\row \li \c page \li Documentation pages defined with the
\l {page-command} {\\page} command.
\endtable
For example, the following configuration would select example pages and
pages that include the \c {\ingroup tutorials} command:
\badcode
qhp.QtQuickControls.subprojects = examples
qhp.QtQuickControls.subprojects.examples.title = Examples and Tutorials
qhp.QtQuickControls.subprojects.examples.indexTitle = Qt Quick Controls Examples
qhp.QtQuickControls.subprojects.examples.selectors = doc:example group:tutorials
qhp.QtQuickControls.subprojects.examples.sortPages = true
\endcode
\section2 Adding Table of Contents
To create a table of contents for a manual, create a subproject with
a \c{type} property and set it to \c{manual}. The page in the documentation
referred to by the \c{indexTitle} property must contain a list of links
that acts as a table of contents for the whole manual. QDoc will take the
information in this list and create a table of contents for the subproject.
For example, the configuration file for Qt Creator defines only one
subproject for its documentation, including all the documentation in a
single manual:
\badcode
qhp.QtCreator.subprojects = manual
qhp.QtCreator.subprojects.manual.title = Qt Creator Manual
qhp.QtCreator.subprojects.manual.indexTitle = Qt Creator Manual
qhp.QtCreator.subprojects.manual.type = manual
\endcode
In this example, the page entitled "Qt Creator Manual" contains a nested
list of links to pages in the documentation which is duplicated in
Qt Assistant's Contents tab.
*/
/*!
\page 23-qdoc-configuration-cppvariables.html
\previouspage Creating Help Project Files
\contentspage QDoc Manual
\nextpage Format-specific Configuration Variables
\title C++ Specific Configuration Variables
The C++ specific configuration variables are provided to avoid
erroneous documentation due to non-standard C++ constructs.
\target Cpp.ignoredirectives-variable
\section1 Cpp.ignoredirectives
The \c Cpp.ignoredirectives variable makes QDoc ignore the
specified non-standard constructs, within C++ source code.
If not specified by the \tt {\l Cpp.ignoretokens} or \tt {\l
Cpp.ignoredirectives} variables, non-standard constructs
(typically macros) can result in erroneous documentation.
\badcode
Cpp.ignoredirectives = Q_DECLARE_INTERFACE \
Q_DECLARE_OPERATORS_FOR_FLAGS \
Q_DECLARE_PRIVATE \
Q_DECLARE_PUBLIC \
Q_DISABLE_COPY \
Q_DUMMY_COMPARISON_OPERATOR \
Q_ENUMS \
Q_FLAGS \
Q_INTERFACES \
__attribute__
\endcode
makes sure that when processing the code below, for example, QDoc
will simply ignore the 'Q_ENUMS' and 'Q_FLAGS' expressions:
\code
class Q_CORE_EXPORT Qt {
Q_OBJECT
Q_ENUMS(Orientation TextFormat BackgroundMode
DateFormat ScrollBarPolicy FocusPolicy
ContextMenuPolicy CaseSensitivity
LayoutDirection ArrowType)
Q_ENUMS(ToolButtonStyle)
Q_FLAGS(Alignment)
Q_FLAGS(Orientations)
Q_FLAGS(DockWidgetAreas)
public:
...
};
\endcode
The Q_OBJECT macro, however, is an exception: QDoc recognizes this
particular non-standard construct, so there is no need specifying
it using the \tt {\l Cpp.ignoredirectives} variable.
Regarding the Q_CORE_EXPORT macro; see the documentation of the
\tt {\l Cpp.ignoretokens} variable.
See also \l Cpp.ignoretokens.
\target Cpp.ignoretokens-variable
\section1 Cpp.ignoretokens
The \c Cpp.ignoretokens variable makes QDoc ignore the specified
non-standard constructs, within C++ source code.
If not specified by the \tt {\l Cpp.ignoretokens} or \tt {\l
Cpp.ignoredirectives} variables, non-standard constructs
(typically macros) can result in erroneous documentation.
In \l qtgui.qdocconf:
\badcode
Cpp.ignoretokens = QAXFACTORY_EXPORT \
QM_EXPORT_CANVAS \
...
Q_COMPAT_EXPORT \
Q_CORE_EXPORT \
Q_EXPLICIT \
Q_EXPORT \
...
Q_XML_EXPORT
\endcode
makes sure that when processing the code below, for example, QDoc
will simply ignore the 'Q_CORE_EXPORT' expression:
\code
class Q_CORE_EXPORT Qt {
Q_OBJECT
Q_ENUMS(Orientation TextFormat BackgroundMode
DateFormat ScrollBarPolicy FocusPolicy
ContextMenuPolicy CaseSensitivity
LayoutDirection ArrowType)
Q_ENUMS(ToolButtonStyle)
Q_FLAGS(Alignment)
Q_FLAGS(Orientations)
Q_FLAGS(DockWidgetAreas)
public:
...
};
\endcode
Regarding the Q_OBJECT, Q_ENUMS and Q_FLAGS macros; see the
documentation of the \tt {\l Cpp.ignoredirectives} variable.
See also \l Cpp.ignoredirectives.
*/
/*!
\page 24-qdoc-configuration-htmlvariables.html
\previouspage C++ Specific Configuration Variables
\contentspage QDoc Manual
\nextpage Supporting Derived Projects
\keyword HTML Specific Configuration Variables
\title Format-specific Configuration Variables
The format-specific configuration variables define the generated
documentation's style, or define the contents of the
documentation's footer or postheader.
Some of the configuration values are relevant only for the HTML
output format and their values contain raw HTML.
\target HTML.footer-variable
\section1 HTML.footer
The \c HTML.footer variable defines the content of the generated
HTML documentation's footer.
The footer is rendered at the bottom of the generated
documentation page.
The variable's value is given as raw HTML code enclosed by
quotation marks. Note that if the value spans several lines, each
line needs to be enclosed by quotation marks.
\badcode
HTML.footer = "<p /><address><hr /><div align=\"center\">\n" \
...
"</tr></table></div></address>"
\endcode
\target FORMAT.nosubdirs
\section1 <FORMAT>.nosubdirs
A boolean value which, when \c true, enables single-directory output
mode; all generated files go to \l {FORMAT.outputsubdir} directory,
instead of a subdirectory based on the documentation project name.
\target FORMAT.outputsubdir
\section1 <FORMAT>.outputsubdir
Defines the subdirectory under \l outputdir where documentation is
generated.
\badcode
HTML.nosubdirs = true
HTML.outputsubdir = html
\endcode
With above, the output goes to \c {<outputdir>/html}.
\target HTML.postheader-variable
\section1 HTML.postheader
The \c HTML.postheader variable defines the content of the
generated HTML documentation's postheader.
The header is rendered at the top of the generated documentation
page.
The variable's value is given as raw HTML enclosed by quotation
marks. Note that if the value spans several lines, each line needs
to be enclosed by quotation marks.
\badcode
HTML.postheader = "<table border=\"0\"..." \
...
"<img src=\"images/qt-logo.png\" \
"align=\"right\" width=\"203\" height=\"32\""\
"border=\"0\" />" \
"</td></tr>" \
"</table>"
\endcode
The complete variable entry in \l qtgui.qdocconf provides the
standard header of the \l {http://doc.qt.io/qt-5/qtgui-index.html}
{Qt GUI Documentation}.
\target FORMAT.quotinginformation
\section1 <FORMAT>.quotinginformation
A boolean value which, when \c true, generates references to
quoted content (for example, \l {quotefromfile-command}{\\quotefromfile}
and \l {snippet-command}{\\snippet} commands) instead of including
the content directly.
Used currently for the \c WebXML output format.
\badcode
WebXML.quotinginformation = true
\endcode
\target HTML.style-variable
\section1 HTML.style
The HTML.style variable defines the style for
the generated HTML documentation.
The variable's value is given as raw HTML enclosed by quotation
marks. Note that if the value spans several lines, each line needs
to be enclosed by quotation marks.
\badcode
HTML.style = "h3.fn,span.fn" \
"{ margin-left: 1cm; text-indent: -1cm; }\n" \
"a:link { color: #004faf; text-decoration: none }\n" \
"a:visited" \
"{ color: #672967; text-decoration: none }\n" \
"td.postheader { font-family: sans-serif }\n" \
"tr.address { font-family: sans-serif }\n" \
"body { background: #ffffff; color: black; }"
\endcode
\target HTML.stylesheets-variable
\section1 HTML.stylesheets
The HTML.stylesheets variable defines a list of stylesheets
to use for the generated HTML documentation.
Using separate stylesheets for the documentation makes it easier
to customize and experiment with the style used once the contents
has been generated. Typically, it is only necessary to define a
single stylesheet for any set of documentation; for example:
\badcode
HTML.stylesheets = path/to/classic.css
\endcode
QDoc expects to find stylesheets in the directory containing the
\l qtgui.qdocconf file, and it will copy those specified to the output
directory alongside the HTML pages.
\target HTML.tocdepth
\section1 <FORMAT>.tocdepth
The \c {<FORMAT>.tocdepth} variable defines how many document sections
are printed in the table of contents. Setting tocdepth to \c 0 disables
the table of contents while leaving it undefined prints all document
sections.
Currently only has an effect for the HTML format:
\badcode
HTML.tocdepth = 3
\endcode
*/
/*!
\page 25-qdoc-configuration-derivedprojects.html
\previouspage Format-specific Configuration Variables
\contentspage QDoc Manual
\nextpage Example Manifest Files
\title Supporting Derived Projects
Some configuration variables allow you to use QDoc to support
Qt-based projects. They allow your project to contain links to the
online Qt documentation, which means that QDoc will be able to
create links to the class reference documentation, without any
explicit linking command.
\target description-variable
\section1 description
The description variable holds a short description of the
associated project.
See also \l project.
\target indexes-variable
\section1 indexes
The \c indexes variable lists the index files that will be used to
generate references.
For example. to make a derived Qt project contain links to the Qt
Reference documentation, you need to specify the associated index
file:
\badcode
indexes = $QTDIR/doc/html/qt.index
\endcode
See also \l project and \l url.
\target project-variable
\section1 project
The \c project variable provides a name for the project associated
with the \c .qdocconf file.
The project's name is used to form a file name for the associated
project's \e index file.
\badcode
project = QtCreator
\endcode
This will cause an index file called \c qtcreator.index to be
created.
See also \l description and \l indexes.
\target url-variable
\section1 url
The \c url variable holds the base URL for the reference
documentation associated with the current project.
The URL is stored in the generated index file for the
project. When we use the index on its own, QDoc will use this as
the base URL when constructing links to classes, functions, and
other things listed in the index.
\badcode
project = Qt
description = Qt Reference Documentation
url = http://doc.qt.io/qt-4.8/
...
\endcode
This makes sure that whenever \c qt.index is used to generate
references to for example Qt classes, the base URL is \c
http://doc.qt.io/qt-4.8/.
See also \l indexes.
\target howto
\section1 How to Support Derived Projects
This feature makes use of the comprehensive indexes generated by
QDoc when it creates the Qt reference documentation.
For example, \l qtgui.qdocconf (the configuration file for Qt)
contains the following variable definitions:
\badcode
project = Qt
description = Qt Reference Documentation
url = http://doc.qt.io/qt-4.8/
...
\endcode
The \l project variable name is used to form a file name for the
index file; in this case the \c qt.index file is created. The \l
url is stored in the index file. Afterwards, QDoc will use this
as the base URL when constructing links to classes, functions,
and other things listed in the index.
*/
/*!
\page 26-qdoc-configuration-example-manifest-files.html
\previouspage Supporting Derived Projects
\contentspage QDoc Manual
\title Example Manifest Files
QDoc generates XML files that contain information about all documented
examples and demos. These files, named \c {examples-manifest.xml} and
\c {demos-manifest.xml}, are used by Qt Creator to present a list of
examples in its welcome screen and to link to their documentation.
\section1 Manifest XML Structure
A manifest file has the following structure:
\badcode
<?xml version="1.0" encoding="UTF-8"?>
<instructionals module="QtGui">
<examples>
<example
name="Analog Clock Window Example"
docUrl="qthelp://org.qt-project.qtgui.502/qtgui/analogclock.html"
projectPath="gui/analogclock/analogclock.pro"
imageUrl="qthelp://org.qt-project.qtgui.502/qtgui/images/analogclock-window-example.png">
<description><![CDATA[The Analog Clock Window example shows how
to draw the contents of a custom window.]]></description>
<tags>analog,clock,window</tags>
<fileToOpen>gui/analogclock/main.cpp</fileToOpen>
</example>
...
</examples>
</instructionals>
\endcode
Each \c {<example>} element contains information about a name,
description, the location of the project file and documentation,
as well as a list of tags associated with the example.
\target metacontent
\section1 Manifest Meta Content
It is possible to augment the manifest files with additional
meta-content - that is, extra attributes and tags for selected
examples, using the \c manifestmeta configuration command.
One use case for meta-content is highlighting a number of prominent
examples. Another is improving search functionality by adding
relevant keywords as tags for a certain category of examples.
The examples for which meta-content is applied to is specified using
one or more filters. Matching examples to filters is done based on
names, with each example name prefixed with a module name and a
slash. Simple wildcard matching is supported; by using \c {*} at the
end it's possible to match multiple examples with a single string.
Example:
\badcode
manifestmeta.filters = highlighted sql webkit global
manifestmeta.highlighted.names = "QtGui/Analog Clock Window Example" \
"QtWidgets/Analog Clock Example"
manifestmeta.highlighted.attributes = isHighlighted:true
manifestmeta.sql.names = "QtSql/*"
manifestmeta.sql.tags = database,sql
manifestmeta.webkit.names = "QtWebKitExamples/*"
manifestmeta.webkit.tags = webkit
manifestmeta.global.names = *
manifestmeta.global.tags = qt5
\endcode
Above, an \c isHighlighted attribute is added to two examples. If
the attribute value is omitted, QDoc uses the string \c {true} by
default. Extra tags are added for Qt WebKit and Qt SQL examples, and
another tag is applied to all examples by using just \c {*} as the
match string.
*/
/*!
\page 21-3-qt-dita-xml-output.html
\previouspage minimum.qdocconf
\contentspage QDoc Manual
\nextpage QA Pages
\title Generating DITA XML Output
QDoc can generate \l {http://dita.xml.org} {DITA XML output}.
In your configuration file, set your \c {outputformats} variable
to \c {DITAXML}, and send the output to an appropriate directory:
\badcode
outputdir = $QTDIR/doc/ditaxml
outputformats = DITAXML
\endcode
And include these macros in your configuration file to prevent
QDoc from doing some escaping that doesn't validate in XML:
\badcode
macro.aacute.DITAXML = "á"
macro.Aring.DITAXML = "Å"
macro.aring.DITAXML = "å"
macro.Auml.DITAXML = "Ä"
macro.br.DITAXML = " "
macro.BR.DITAXML = " "
macro.copyright.DITAXML = "©"
macro.eacute.DITAXML = "é"
macro.hr.DITAXML = " "
macro.iacute.DITAXML = "í"
macro.oslash.DITAXML = "ø"
macro.ouml.DITAXML = "ö"
macro.raisedaster.DITAXML = "<sup>*</sup>"
macro.rarrow.DITAXML = "→"
macro.reg.DITAXML = "<sup>®</sup>"
macro.uuml.DITAXML = "ü"
macro.mdash.DITAXML = "—"
macro.emptyspan.DITAXML = " "
\endcode
You can also set default values for some of the tags in the DITA
\c {<prolog>} and \c {<metadata>} elements:
\badcode
dita.metadata.default.author = Qt Development Frameworks
dita.metadata.default.permissions = all
dita.metadata.default.publisher = Qt Project
dita.metadata.default.copyryear = 2017
dita.metadata.default.copyrholder = Qt Project
dita.metadata.default.audience = programmer
\endcode
See the \l {meta-command}
{\\meta} command for more details on DITA metadata.
*/
/*!
\page 21-1-minimum-qdocconf.html
\previouspage qtgui.qdocconf
\contentspage QDoc Manual
\nextpage Generating DITA XML Output
\title minimum.qdocconf
\quotefile examples/minimum.qdocconf
*/
/*!
\page 21-2-qtgui-qdocconf.html
\previouspage Supporting Derived Projects
\contentspage QDoc Manual
\nextpage minimum.qdocconf
\title qtgui.qdocconf
\quotefile files/qtgui.qdocconf
*/
|