Register
Login
Resources
Docs Blog Datasets Glossary Case Studies Tutorials & Webinars
Product
Data Engine LLMs Platform Enterprise
Pricing Explore
Connect to our Discord channel

doc_autogeneration.doxygen 106 KB

You have to be logged in to leave a comment. Sign In
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
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
  1. # Doxyfile 1.8.11
  2. # This file describes the settings to be used by the documentation system
  3. # doxygen (www.doxygen.org) for a project.
  4. #
  5. # All text after a double hash (##) is considered a comment and is placed in
  6. # front of the TAG it is preceding.
  7. #
  8. # All text after a single hash (#) is considered a comment and will be ignored.
  9. # The format is:
  10. # TAG = value [value, ...]
  11. # For lists, items can also be appended using:
  12. # TAG += value [value, ...]
  13. # Values that contain spaces should be placed between quotes (\" \").
  14. #---------------------------------------------------------------------------
  15. # Project related configuration options
  16. #---------------------------------------------------------------------------
  17. # This tag specifies the encoding used for all characters in the config file
  18. # that follow. The default is UTF-8 which is also the encoding used for all text
  19. # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
  20. # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
  21. # for the list of possible encodings.
  22. # The default value is: UTF-8.
  23. DOXYFILE_ENCODING = UTF-8
  24. # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
  25. # double-quotes, unless you are using Doxywizard) that should identify the
  26. # project for which the documentation is generated. This name is used in the
  27. # title of most generated pages and in a few other places.
  28. # The default value is: My Project.
  29. PROJECT_NAME = OpenPose
  30. # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
  31. # could be handy for archiving the generated documentation or if some version
  32. # control system is used.
  33. PROJECT_NUMBER = 1.0.0rc2
  34. # Using the PROJECT_BRIEF tag one can provide an optional one line description
  35. # for a project that appears at the top of each page and should give viewer a
  36. # quick idea about the purpose of the project. Keep the description short.
  37. PROJECT_BRIEF = "OpenPose: A Real-Time Multi-Person Key-Point Detection And Multi-Threading C++ Library"
  38. # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
  39. # in the documentation. The maximum height of the logo should not exceed 55
  40. # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
  41. # the logo to the output directory.
  42. PROJECT_LOGO =
  43. # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
  44. # into which the generated documentation will be written. If a relative path is
  45. # entered, it will be relative to the location where doxygen was started. If
  46. # left blank the current directory will be used.
  47. OUTPUT_DIRECTORY = doxygen
  48. # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
  49. # directories (in 2 levels) under the output directory of each output format and
  50. # will distribute the generated files over these directories. Enabling this
  51. # option can be useful when feeding doxygen a huge amount of source files, where
  52. # putting all generated files in the same directory would otherwise causes
  53. # performance problems for the file system.
  54. # The default value is: NO.
  55. CREATE_SUBDIRS = NO
  56. # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
  57. # characters to appear in the names of generated files. If set to NO, non-ASCII
  58. # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
  59. # U+3044.
  60. # The default value is: NO.
  61. ALLOW_UNICODE_NAMES = NO
  62. # The OUTPUT_LANGUAGE tag is used to specify the language in which all
  63. # documentation generated by doxygen is written. Doxygen will use this
  64. # information to generate all constant output in the proper language.
  65. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
  66. # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
  67. # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
  68. # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
  69. # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
  70. # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
  71. # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
  72. # Ukrainian and Vietnamese.
  73. # The default value is: English.
  74. OUTPUT_LANGUAGE = English
  75. # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
  76. # descriptions after the members that are listed in the file and class
  77. # documentation (similar to Javadoc). Set to NO to disable this.
  78. # The default value is: YES.
  79. BRIEF_MEMBER_DESC = YES
  80. # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
  81. # description of a member or function before the detailed description
  82. #
  83. # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  84. # brief descriptions will be completely suppressed.
  85. # The default value is: YES.
  86. REPEAT_BRIEF = YES
  87. # This tag implements a quasi-intelligent brief description abbreviator that is
  88. # used to form the text in various listings. Each string in this list, if found
  89. # as the leading text of the brief description, will be stripped from the text
  90. # and the result, after processing the whole list, is used as the annotated
  91. # text. Otherwise, the brief description is used as-is. If left blank, the
  92. # following values are used ($name is automatically replaced with the name of
  93. # the entity):The $name class, The $name widget, The $name file, is, provides,
  94. # specifies, contains, represents, a, an and the.
  95. ABBREVIATE_BRIEF = "The $name class" \
  96. "The $name widget" \
  97. "The $name file" \
  98. is \
  99. provides \
  100. specifies \
  101. contains \
  102. represents \
  103. a \
  104. an \
  105. the
  106. # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  107. # doxygen will generate a detailed section even if there is only a brief
  108. # description.
  109. # The default value is: NO.
  110. ALWAYS_DETAILED_SEC = NO
  111. # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
  112. # inherited members of a class in the documentation of that class as if those
  113. # members were ordinary class members. Constructors, destructors and assignment
  114. # operators of the base classes will not be shown.
  115. # The default value is: NO.
  116. INLINE_INHERITED_MEMB = NO
  117. # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
  118. # before files name in the file list and in the header files. If set to NO the
  119. # shortest path that makes the file name unique will be used
  120. # The default value is: YES.
  121. FULL_PATH_NAMES = YES
  122. # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
  123. # Stripping is only done if one of the specified strings matches the left-hand
  124. # part of the path. The tag can be used to show relative paths in the file list.
  125. # If left blank the directory from which doxygen is run is used as the path to
  126. # strip.
  127. #
  128. # Note that you can specify absolute paths here, but also relative paths, which
  129. # will be relative from the directory where doxygen is started.
  130. # This tag requires that the tag FULL_PATH_NAMES is set to YES.
  131. STRIP_FROM_PATH =
  132. # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
  133. # path mentioned in the documentation of a class, which tells the reader which
  134. # header file to include in order to use a class. If left blank only the name of
  135. # the header file containing the class definition is used. Otherwise one should
  136. # specify the list of include paths that are normally passed to the compiler
  137. # using the -I flag.
  138. STRIP_FROM_INC_PATH =
  139. # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
  140. # less readable) file names. This can be useful is your file systems doesn't
  141. # support long names like on DOS, Mac, or CD-ROM.
  142. # The default value is: NO.
  143. SHORT_NAMES = NO
  144. # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
  145. # first line (until the first dot) of a Javadoc-style comment as the brief
  146. # description. If set to NO, the Javadoc-style will behave just like regular Qt-
  147. # style comments (thus requiring an explicit @brief command for a brief
  148. # description.)
  149. # The default value is: NO.
  150. JAVADOC_AUTOBRIEF = NO
  151. # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
  152. # line (until the first dot) of a Qt-style comment as the brief description. If
  153. # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
  154. # requiring an explicit \brief command for a brief description.)
  155. # The default value is: NO.
  156. QT_AUTOBRIEF = NO
  157. # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
  158. # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
  159. # a brief description. This used to be the default behavior. The new default is
  160. # to treat a multi-line C++ comment block as a detailed description. Set this
  161. # tag to YES if you prefer the old behavior instead.
  162. #
  163. # Note that setting this tag to YES also means that rational rose comments are
  164. # not recognized any more.
  165. # The default value is: NO.
  166. MULTILINE_CPP_IS_BRIEF = NO
  167. # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
  168. # documentation from any documented member that it re-implements.
  169. # The default value is: YES.
  170. INHERIT_DOCS = YES
  171. # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
  172. # page for each member. If set to NO, the documentation of a member will be part
  173. # of the file/class/namespace that contains it.
  174. # The default value is: NO.
  175. SEPARATE_MEMBER_PAGES = NO
  176. # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
  177. # uses this value to replace tabs by spaces in code fragments.
  178. # Minimum value: 1, maximum value: 16, default value: 4.
  179. TAB_SIZE = 4
  180. # This tag can be used to specify a number of aliases that act as commands in
  181. # the documentation. An alias has the form:
  182. # name=value
  183. # For example adding
  184. # "sideeffect=@par Side Effects:\n"
  185. # will allow you to put the command \sideeffect (or @sideeffect) in the
  186. # documentation, which will result in a user-defined paragraph with heading
  187. # "Side Effects:". You can put \n's in the value part of an alias to insert
  188. # newlines.
  189. ALIASES =
  190. # This tag can be used to specify a number of word-keyword mappings (TCL only).
  191. # A mapping has the form "name=value". For example adding "class=itcl::class"
  192. # will allow you to use the command class in the itcl::class meaning.
  193. TCL_SUBST =
  194. # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
  195. # only. Doxygen will then generate output that is more tailored for C. For
  196. # instance, some of the names that are used will be different. The list of all
  197. # members will be omitted, etc.
  198. # The default value is: NO.
  199. OPTIMIZE_OUTPUT_FOR_C = NO
  200. # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
  201. # Python sources only. Doxygen will then generate output that is more tailored
  202. # for that language. For instance, namespaces will be presented as packages,
  203. # qualified scopes will look different, etc.
  204. # The default value is: NO.
  205. OPTIMIZE_OUTPUT_JAVA = NO
  206. # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
  207. # sources. Doxygen will then generate output that is tailored for Fortran.
  208. # The default value is: NO.
  209. OPTIMIZE_FOR_FORTRAN = NO
  210. # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
  211. # sources. Doxygen will then generate output that is tailored for VHDL.
  212. # The default value is: NO.
  213. OPTIMIZE_OUTPUT_VHDL = NO
  214. # Doxygen selects the parser to use depending on the extension of the files it
  215. # parses. With this tag you can assign which parser to use for a given
  216. # extension. Doxygen has a built-in mapping, but you can override or extend it
  217. # using this tag. The format is ext=language, where ext is a file extension, and
  218. # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
  219. # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
  220. # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
  221. # Fortran. In the later case the parser tries to guess whether the code is fixed
  222. # or free formatted code, this is the default for Fortran type files), VHDL. For
  223. # instance to make doxygen treat .inc files as Fortran files (default is PHP),
  224. # and .f files as C (default is Fortran), use: inc=Fortran f=C.
  225. #
  226. # Note: For files without extension you can use no_extension as a placeholder.
  227. #
  228. # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
  229. # the files are not read by doxygen.
  230. EXTENSION_MAPPING =
  231. # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
  232. # according to the Markdown format, which allows for more readable
  233. # documentation. See http://daringfireball.net/projects/markdown/ for details.
  234. # The output of markdown processing is further processed by doxygen, so you can
  235. # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
  236. # case of backward compatibilities issues.
  237. # The default value is: YES.
  238. MARKDOWN_SUPPORT = YES
  239. # When enabled doxygen tries to link words that correspond to documented
  240. # classes, or namespaces to their corresponding documentation. Such a link can
  241. # be prevented in individual cases by putting a % sign in front of the word or
  242. # globally by setting AUTOLINK_SUPPORT to NO.
  243. # The default value is: YES.
  244. AUTOLINK_SUPPORT = YES
  245. # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
  246. # to include (a tag file for) the STL sources as input, then you should set this
  247. # tag to YES in order to let doxygen match functions declarations and
  248. # definitions whose arguments contain STL classes (e.g. func(std::string);
  249. # versus func(std::string) {}). This also make the inheritance and collaboration
  250. # diagrams that involve STL classes more complete and accurate.
  251. # The default value is: NO.
  252. BUILTIN_STL_SUPPORT = NO
  253. # If you use Microsoft's C++/CLI language, you should set this option to YES to
  254. # enable parsing support.
  255. # The default value is: NO.
  256. CPP_CLI_SUPPORT = NO
  257. # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
  258. # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
  259. # will parse them like normal C++ but will assume all classes use public instead
  260. # of private inheritance when no explicit protection keyword is present.
  261. # The default value is: NO.
  262. SIP_SUPPORT = NO
  263. # For Microsoft's IDL there are propget and propput attributes to indicate
  264. # getter and setter methods for a property. Setting this option to YES will make
  265. # doxygen to replace the get and set methods by a property in the documentation.
  266. # This will only work if the methods are indeed getting or setting a simple
  267. # type. If this is not the case, or you want to show the methods anyway, you
  268. # should set this option to NO.
  269. # The default value is: YES.
  270. IDL_PROPERTY_SUPPORT = YES
  271. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  272. # tag is set to YES then doxygen will reuse the documentation of the first
  273. # member in the group (if any) for the other members of the group. By default
  274. # all members of a group must be documented explicitly.
  275. # The default value is: NO.
  276. DISTRIBUTE_GROUP_DOC = NO
  277. # If one adds a struct or class to a group and this option is enabled, then also
  278. # any nested class or struct is added to the same group. By default this option
  279. # is disabled and one has to add nested compounds explicitly via \ingroup.
  280. # The default value is: NO.
  281. GROUP_NESTED_COMPOUNDS = NO
  282. # Set the SUBGROUPING tag to YES to allow class member groups of the same type
  283. # (for instance a group of public functions) to be put as a subgroup of that
  284. # type (e.g. under the Public Functions section). Set it to NO to prevent
  285. # subgrouping. Alternatively, this can be done per class using the
  286. # \nosubgrouping command.
  287. # The default value is: YES.
  288. SUBGROUPING = YES
  289. # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
  290. # are shown inside the group in which they are included (e.g. using \ingroup)
  291. # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
  292. # and RTF).
  293. #
  294. # Note that this feature does not work in combination with
  295. # SEPARATE_MEMBER_PAGES.
  296. # The default value is: NO.
  297. INLINE_GROUPED_CLASSES = NO
  298. # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
  299. # with only public data fields or simple typedef fields will be shown inline in
  300. # the documentation of the scope in which they are defined (i.e. file,
  301. # namespace, or group documentation), provided this scope is documented. If set
  302. # to NO, structs, classes, and unions are shown on a separate page (for HTML and
  303. # Man pages) or section (for LaTeX and RTF).
  304. # The default value is: NO.
  305. INLINE_SIMPLE_STRUCTS = NO
  306. # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
  307. # enum is documented as struct, union, or enum with the name of the typedef. So
  308. # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
  309. # with name TypeT. When disabled the typedef will appear as a member of a file,
  310. # namespace, or class. And the struct will be named TypeS. This can typically be
  311. # useful for C code in case the coding convention dictates that all compound
  312. # types are typedef'ed and only the typedef is referenced, never the tag name.
  313. # The default value is: NO.
  314. TYPEDEF_HIDES_STRUCT = NO
  315. # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
  316. # cache is used to resolve symbols given their name and scope. Since this can be
  317. # an expensive process and often the same symbol appears multiple times in the
  318. # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
  319. # doxygen will become slower. If the cache is too large, memory is wasted. The
  320. # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
  321. # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
  322. # symbols. At the end of a run doxygen will report the cache usage and suggest
  323. # the optimal cache size from a speed point of view.
  324. # Minimum value: 0, maximum value: 9, default value: 0.
  325. LOOKUP_CACHE_SIZE = 0
  326. #---------------------------------------------------------------------------
  327. # Build related configuration options
  328. #---------------------------------------------------------------------------
  329. # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
  330. # documentation are documented, even if no documentation was available. Private
  331. # class members and static file members will be hidden unless the
  332. # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
  333. # Note: This will also disable the warnings about undocumented members that are
  334. # normally produced when WARNINGS is set to YES.
  335. # The default value is: NO.
  336. EXTRACT_ALL = YES
  337. # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
  338. # be included in the documentation.
  339. # The default value is: NO.
  340. EXTRACT_PRIVATE = NO
  341. # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
  342. # scope will be included in the documentation.
  343. # The default value is: NO.
  344. EXTRACT_PACKAGE = NO
  345. # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
  346. # included in the documentation.
  347. # The default value is: NO.
  348. EXTRACT_STATIC = NO
  349. # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
  350. # locally in source files will be included in the documentation. If set to NO,
  351. # only classes defined in header files are included. Does not have any effect
  352. # for Java sources.
  353. # The default value is: YES.
  354. EXTRACT_LOCAL_CLASSES = YES
  355. # This flag is only useful for Objective-C code. If set to YES, local methods,
  356. # which are defined in the implementation section but not in the interface are
  357. # included in the documentation. If set to NO, only methods in the interface are
  358. # included.
  359. # The default value is: NO.
  360. EXTRACT_LOCAL_METHODS = NO
  361. # If this flag is set to YES, the members of anonymous namespaces will be
  362. # extracted and appear in the documentation as a namespace called
  363. # 'anonymous_namespace{file}', where file will be replaced with the base name of
  364. # the file that contains the anonymous namespace. By default anonymous namespace
  365. # are hidden.
  366. # The default value is: NO.
  367. EXTRACT_ANON_NSPACES = NO
  368. # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
  369. # undocumented members inside documented classes or files. If set to NO these
  370. # members will be included in the various overviews, but no documentation
  371. # section is generated. This option has no effect if EXTRACT_ALL is enabled.
  372. # The default value is: NO.
  373. HIDE_UNDOC_MEMBERS = NO
  374. # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
  375. # undocumented classes that are normally visible in the class hierarchy. If set
  376. # to NO, these classes will be included in the various overviews. This option
  377. # has no effect if EXTRACT_ALL is enabled.
  378. # The default value is: NO.
  379. HIDE_UNDOC_CLASSES = NO
  380. # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
  381. # (class|struct|union) declarations. If set to NO, these declarations will be
  382. # included in the documentation.
  383. # The default value is: NO.
  384. HIDE_FRIEND_COMPOUNDS = NO
  385. # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
  386. # documentation blocks found inside the body of a function. If set to NO, these
  387. # blocks will be appended to the function's detailed documentation block.
  388. # The default value is: NO.
  389. HIDE_IN_BODY_DOCS = NO
  390. # The INTERNAL_DOCS tag determines if documentation that is typed after a
  391. # \internal command is included. If the tag is set to NO then the documentation
  392. # will be excluded. Set it to YES to include the internal documentation.
  393. # The default value is: NO.
  394. INTERNAL_DOCS = NO
  395. # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
  396. # names in lower-case letters. If set to YES, upper-case letters are also
  397. # allowed. This is useful if you have classes or files whose names only differ
  398. # in case and if your file system supports case sensitive file names. Windows
  399. # and Mac users are advised to set this option to NO.
  400. # The default value is: system dependent.
  401. CASE_SENSE_NAMES = NO
  402. # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
  403. # their full class and namespace scopes in the documentation. If set to YES, the
  404. # scope will be hidden.
  405. # The default value is: NO.
  406. HIDE_SCOPE_NAMES = NO
  407. # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
  408. # append additional text to a page's title, such as Class Reference. If set to
  409. # YES the compound reference will be hidden.
  410. # The default value is: NO.
  411. HIDE_COMPOUND_REFERENCE= NO
  412. # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
  413. # the files that are included by a file in the documentation of that file.
  414. # The default value is: YES.
  415. SHOW_INCLUDE_FILES = YES
  416. # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
  417. # grouped member an include statement to the documentation, telling the reader
  418. # which file to include in order to use the member.
  419. # The default value is: NO.
  420. SHOW_GROUPED_MEMB_INC = NO
  421. # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
  422. # files with double quotes in the documentation rather than with sharp brackets.
  423. # The default value is: NO.
  424. FORCE_LOCAL_INCLUDES = NO
  425. # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
  426. # documentation for inline members.
  427. # The default value is: YES.
  428. INLINE_INFO = YES
  429. # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
  430. # (detailed) documentation of file and class members alphabetically by member
  431. # name. If set to NO, the members will appear in declaration order.
  432. # The default value is: YES.
  433. SORT_MEMBER_DOCS = YES
  434. # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
  435. # descriptions of file, namespace and class members alphabetically by member
  436. # name. If set to NO, the members will appear in declaration order. Note that
  437. # this will also influence the order of the classes in the class list.
  438. # The default value is: NO.
  439. SORT_BRIEF_DOCS = NO
  440. # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
  441. # (brief and detailed) documentation of class members so that constructors and
  442. # destructors are listed first. If set to NO the constructors will appear in the
  443. # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
  444. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
  445. # member documentation.
  446. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
  447. # detailed member documentation.
  448. # The default value is: NO.
  449. SORT_MEMBERS_CTORS_1ST = NO
  450. # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
  451. # of group names into alphabetical order. If set to NO the group names will
  452. # appear in their defined order.
  453. # The default value is: NO.
  454. SORT_GROUP_NAMES = NO
  455. # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
  456. # fully-qualified names, including namespaces. If set to NO, the class list will
  457. # be sorted only by class name, not including the namespace part.
  458. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
  459. # Note: This option applies only to the class list, not to the alphabetical
  460. # list.
  461. # The default value is: NO.
  462. SORT_BY_SCOPE_NAME = NO
  463. # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
  464. # type resolution of all parameters of a function it will reject a match between
  465. # the prototype and the implementation of a member function even if there is
  466. # only one candidate or it is obvious which candidate to choose by doing a
  467. # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
  468. # accept a match between prototype and implementation in such cases.
  469. # The default value is: NO.
  470. STRICT_PROTO_MATCHING = NO
  471. # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
  472. # list. This list is created by putting \todo commands in the documentation.
  473. # The default value is: YES.
  474. GENERATE_TODOLIST = YES
  475. # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
  476. # list. This list is created by putting \test commands in the documentation.
  477. # The default value is: YES.
  478. GENERATE_TESTLIST = YES
  479. # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
  480. # list. This list is created by putting \bug commands in the documentation.
  481. # The default value is: YES.
  482. GENERATE_BUGLIST = YES
  483. # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
  484. # the deprecated list. This list is created by putting \deprecated commands in
  485. # the documentation.
  486. # The default value is: YES.
  487. GENERATE_DEPRECATEDLIST= YES
  488. # The ENABLED_SECTIONS tag can be used to enable conditional documentation
  489. # sections, marked by \if <section_label> ... \endif and \cond <section_label>
  490. # ... \endcond blocks.
  491. ENABLED_SECTIONS =
  492. # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
  493. # initial value of a variable or macro / define can have for it to appear in the
  494. # documentation. If the initializer consists of more lines than specified here
  495. # it will be hidden. Use a value of 0 to hide initializers completely. The
  496. # appearance of the value of individual variables and macros / defines can be
  497. # controlled using \showinitializer or \hideinitializer command in the
  498. # documentation regardless of this setting.
  499. # Minimum value: 0, maximum value: 10000, default value: 30.
  500. MAX_INITIALIZER_LINES = 30
  501. # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
  502. # the bottom of the documentation of classes and structs. If set to YES, the
  503. # list will mention the files that were used to generate the documentation.
  504. # The default value is: YES.
  505. SHOW_USED_FILES = YES
  506. # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
  507. # will remove the Files entry from the Quick Index and from the Folder Tree View
  508. # (if specified).
  509. # The default value is: YES.
  510. SHOW_FILES = YES
  511. # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
  512. # page. This will remove the Namespaces entry from the Quick Index and from the
  513. # Folder Tree View (if specified).
  514. # The default value is: YES.
  515. SHOW_NAMESPACES = YES
  516. # The FILE_VERSION_FILTER tag can be used to specify a program or script that
  517. # doxygen should invoke to get the current version for each file (typically from
  518. # the version control system). Doxygen will invoke the program by executing (via
  519. # popen()) the command command input-file, where command is the value of the
  520. # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
  521. # by doxygen. Whatever the program writes to standard output is used as the file
  522. # version. For an example see the documentation.
  523. FILE_VERSION_FILTER =
  524. # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
  525. # by doxygen. The layout file controls the global structure of the generated
  526. # output files in an output format independent way. To create the layout file
  527. # that represents doxygen's defaults, run doxygen with the -l option. You can
  528. # optionally specify a file name after the option, if omitted DoxygenLayout.xml
  529. # will be used as the name of the layout file.
  530. #
  531. # Note that if you run doxygen from a directory containing a file called
  532. # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
  533. # tag is left empty.
  534. LAYOUT_FILE =
  535. # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
  536. # the reference definitions. This must be a list of .bib files. The .bib
  537. # extension is automatically appended if omitted. This requires the bibtex tool
  538. # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
  539. # For LaTeX the style of the bibliography can be controlled using
  540. # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
  541. # search path. See also \cite for info how to create references.
  542. CITE_BIB_FILES =
  543. #---------------------------------------------------------------------------
  544. # Configuration options related to warning and progress messages
  545. #---------------------------------------------------------------------------
  546. # The QUIET tag can be used to turn on/off the messages that are generated to
  547. # standard output by doxygen. If QUIET is set to YES this implies that the
  548. # messages are off.
  549. # The default value is: NO.
  550. QUIET = NO
  551. # The WARNINGS tag can be used to turn on/off the warning messages that are
  552. # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
  553. # this implies that the warnings are on.
  554. #
  555. # Tip: Turn warnings on while writing the documentation.
  556. # The default value is: YES.
  557. WARNINGS = YES
  558. # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
  559. # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
  560. # will automatically be disabled.
  561. # The default value is: YES.
  562. WARN_IF_UNDOCUMENTED = YES
  563. # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
  564. # potential errors in the documentation, such as not documenting some parameters
  565. # in a documented function, or documenting parameters that don't exist or using
  566. # markup commands wrongly.
  567. # The default value is: YES.
  568. WARN_IF_DOC_ERROR = YES
  569. # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
  570. # are documented, but have no documentation for their parameters or return
  571. # value. If set to NO, doxygen will only warn about wrong or incomplete
  572. # parameter documentation, but not about the absence of documentation.
  573. # The default value is: NO.
  574. WARN_NO_PARAMDOC = NO
  575. # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
  576. # a warning is encountered.
  577. # The default value is: NO.
  578. WARN_AS_ERROR = NO
  579. # The WARN_FORMAT tag determines the format of the warning messages that doxygen
  580. # can produce. The string should contain the $file, $line, and $text tags, which
  581. # will be replaced by the file and line number from which the warning originated
  582. # and the warning text. Optionally the format may contain $version, which will
  583. # be replaced by the version of the file (if it could be obtained via
  584. # FILE_VERSION_FILTER)
  585. # The default value is: $file:$line: $text.
  586. WARN_FORMAT = "$file:$line: $text"
  587. # The WARN_LOGFILE tag can be used to specify a file to which warning and error
  588. # messages should be written. If left blank the output is written to standard
  589. # error (stderr).
  590. WARN_LOGFILE =
  591. #---------------------------------------------------------------------------
  592. # Configuration options related to the input files
  593. #---------------------------------------------------------------------------
  594. # The INPUT tag is used to specify the files and/or directories that contain
  595. # documented source files. You may enter file names like myfile.cpp or
  596. # directories like /usr/src/myproject. Separate the files or directories with
  597. # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
  598. # Note: If this tag is empty the current directory is searched.
  599. INPUT = ../README.md ../include/openpose/
  600. # This tag can be used to specify the character encoding of the source files
  601. # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
  602. # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
  603. # documentation (see: http://www.gnu.org/software/libiconv) for the list of
  604. # possible encodings.
  605. # The default value is: UTF-8.
  606. INPUT_ENCODING = UTF-8
  607. # If the value of the INPUT tag contains directories, you can use the
  608. # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
  609. # *.h) to filter out the source-files in the directories.
  610. #
  611. # Note that for custom extensions or not directly supported extensions you also
  612. # need to set EXTENSION_MAPPING for the extension otherwise the files are not
  613. # read by doxygen.
  614. #
  615. # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
  616. # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
  617. # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
  618. # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
  619. # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
  620. FILE_PATTERNS = *.c \
  621. *.cc \
  622. *.cxx \
  623. *.cpp \
  624. *.c++ \
  625. *.java \
  626. *.ii \
  627. *.ixx \
  628. *.ipp \
  629. *.i++ \
  630. *.inl \
  631. *.idl \
  632. *.ddl \
  633. *.odl \
  634. *.h \
  635. *.hh \
  636. *.hxx \
  637. *.hpp \
  638. *.h++ \
  639. *.cs \
  640. *.d \
  641. *.php \
  642. *.php4 \
  643. *.php5 \
  644. *.phtml \
  645. *.inc \
  646. *.m \
  647. *.markdown \
  648. *.md \
  649. *.mm \
  650. *.dox \
  651. *.py \
  652. *.pyw \
  653. *.f90 \
  654. *.f \
  655. *.for \
  656. *.tcl \
  657. *.vhd \
  658. *.vhdl \
  659. *.ucf \
  660. *.qsf \
  661. *.as \
  662. *.js
  663. # The RECURSIVE tag can be used to specify whether or not subdirectories should
  664. # be searched for input files as well.
  665. # The default value is: NO.
  666. RECURSIVE = YES
  667. # The EXCLUDE tag can be used to specify files and/or directories that should be
  668. # excluded from the INPUT source files. This way you can easily exclude a
  669. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  670. #
  671. # Note that relative paths are relative to the directory from which doxygen is
  672. # run.
  673. EXCLUDE =
  674. # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
  675. # directories that are symbolic links (a Unix file system feature) are excluded
  676. # from the input.
  677. # The default value is: NO.
  678. EXCLUDE_SYMLINKS = NO
  679. # If the value of the INPUT tag contains directories, you can use the
  680. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  681. # certain files from those directories.
  682. #
  683. # Note that the wildcards are matched against the file with absolute path, so to
  684. # exclude all test directories for example use the pattern */test/*
  685. EXCLUDE_PATTERNS =
  686. # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
  687. # (namespaces, classes, functions, etc.) that should be excluded from the
  688. # output. The symbol name can be a fully qualified name, a word, or if the
  689. # wildcard * is used, a substring. Examples: ANamespace, AClass,
  690. # AClass::ANamespace, ANamespace::*Test
  691. #
  692. # Note that the wildcards are matched against the file with absolute path, so to
  693. # exclude all test directories use the pattern */test/*
  694. EXCLUDE_SYMBOLS =
  695. # The EXAMPLE_PATH tag can be used to specify one or more files or directories
  696. # that contain example code fragments that are included (see the \include
  697. # command).
  698. EXAMPLE_PATH =
  699. # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  700. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
  701. # *.h) to filter out the source-files in the directories. If left blank all
  702. # files are included.
  703. EXAMPLE_PATTERNS = *
  704. # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  705. # searched for input files to be used with the \include or \dontinclude commands
  706. # irrespective of the value of the RECURSIVE tag.
  707. # The default value is: NO.
  708. EXAMPLE_RECURSIVE = NO
  709. # The IMAGE_PATH tag can be used to specify one or more files or directories
  710. # that contain images that are to be included in the documentation (see the
  711. # \image command).
  712. IMAGE_PATH =
  713. # The INPUT_FILTER tag can be used to specify a program that doxygen should
  714. # invoke to filter for each input file. Doxygen will invoke the filter program
  715. # by executing (via popen()) the command:
  716. #
  717. # <filter> <input-file>
  718. #
  719. # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
  720. # name of an input file. Doxygen will then use the output that the filter
  721. # program writes to standard output. If FILTER_PATTERNS is specified, this tag
  722. # will be ignored.
  723. #
  724. # Note that the filter must not add or remove lines; it is applied before the
  725. # code is scanned, but not when the output code is generated. If lines are added
  726. # or removed, the anchors will not be placed correctly.
  727. #
  728. # Note that for custom extensions or not directly supported extensions you also
  729. # need to set EXTENSION_MAPPING for the extension otherwise the files are not
  730. # properly processed by doxygen.
  731. INPUT_FILTER =
  732. # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
  733. # basis. Doxygen will compare the file name with each pattern and apply the
  734. # filter if there is a match. The filters are a list of the form: pattern=filter
  735. # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
  736. # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
  737. # patterns match the file name, INPUT_FILTER is applied.
  738. #
  739. # Note that for custom extensions or not directly supported extensions you also
  740. # need to set EXTENSION_MAPPING for the extension otherwise the files are not
  741. # properly processed by doxygen.
  742. FILTER_PATTERNS =
  743. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  744. # INPUT_FILTER) will also be used to filter the input files that are used for
  745. # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
  746. # The default value is: NO.
  747. FILTER_SOURCE_FILES = NO
  748. # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
  749. # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
  750. # it is also possible to disable source filtering for a specific pattern using
  751. # *.ext= (so without naming a filter).
  752. # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
  753. FILTER_SOURCE_PATTERNS =
  754. # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
  755. # is part of the input, its contents will be placed on the main page
  756. # (index.html). This can be useful if you have a project on for instance GitHub
  757. # and want to reuse the introduction page also for the doxygen output.
  758. USE_MDFILE_AS_MAINPAGE = ../README.md
  759. #---------------------------------------------------------------------------
  760. # Configuration options related to source browsing
  761. #---------------------------------------------------------------------------
  762. # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
  763. # generated. Documented entities will be cross-referenced with these sources.
  764. #
  765. # Note: To get rid of all source code in the generated output, make sure that
  766. # also VERBATIM_HEADERS is set to NO.
  767. # The default value is: NO.
  768. SOURCE_BROWSER = NO
  769. # Setting the INLINE_SOURCES tag to YES will include the body of functions,
  770. # classes and enums directly into the documentation.
  771. # The default value is: NO.
  772. INLINE_SOURCES = NO
  773. # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
  774. # special comment blocks from generated source code fragments. Normal C, C++ and
  775. # Fortran comments will always remain visible.
  776. # The default value is: YES.
  777. STRIP_CODE_COMMENTS = YES
  778. # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
  779. # function all documented functions referencing it will be listed.
  780. # The default value is: NO.
  781. REFERENCED_BY_RELATION = NO
  782. # If the REFERENCES_RELATION tag is set to YES then for each documented function
  783. # all documented entities called/used by that function will be listed.
  784. # The default value is: NO.
  785. REFERENCES_RELATION = NO
  786. # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
  787. # to YES then the hyperlinks from functions in REFERENCES_RELATION and
  788. # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
  789. # link to the documentation.
  790. # The default value is: YES.
  791. REFERENCES_LINK_SOURCE = YES
  792. # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
  793. # source code will show a tooltip with additional information such as prototype,
  794. # brief description and links to the definition and documentation. Since this
  795. # will make the HTML file larger and loading of large files a bit slower, you
  796. # can opt to disable this feature.
  797. # The default value is: YES.
  798. # This tag requires that the tag SOURCE_BROWSER is set to YES.
  799. SOURCE_TOOLTIPS = YES
  800. # If the USE_HTAGS tag is set to YES then the references to source code will
  801. # point to the HTML generated by the htags(1) tool instead of doxygen built-in
  802. # source browser. The htags tool is part of GNU's global source tagging system
  803. # (see http://www.gnu.org/software/global/global.html). You will need version
  804. # 4.8.6 or higher.
  805. #
  806. # To use it do the following:
  807. # - Install the latest version of global
  808. # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
  809. # - Make sure the INPUT points to the root of the source tree
  810. # - Run doxygen as normal
  811. #
  812. # Doxygen will invoke htags (and that will in turn invoke gtags), so these
  813. # tools must be available from the command line (i.e. in the search path).
  814. #
  815. # The result: instead of the source browser generated by doxygen, the links to
  816. # source code will now point to the output of htags.
  817. # The default value is: NO.
  818. # This tag requires that the tag SOURCE_BROWSER is set to YES.
  819. USE_HTAGS = NO
  820. # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
  821. # verbatim copy of the header file for each class for which an include is
  822. # specified. Set to NO to disable this.
  823. # See also: Section \class.
  824. # The default value is: YES.
  825. VERBATIM_HEADERS = YES
  826. # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
  827. # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
  828. # cost of reduced performance. This can be particularly helpful with template
  829. # rich C++ code for which doxygen's built-in parser lacks the necessary type
  830. # information.
  831. # Note: The availability of this option depends on whether or not doxygen was
  832. # generated with the -Duse-libclang=ON option for CMake.
  833. # The default value is: NO.
  834. CLANG_ASSISTED_PARSING = NO
  835. # If clang assisted parsing is enabled you can provide the compiler with command
  836. # line options that you would normally use when invoking the compiler. Note that
  837. # the include paths will already be set by doxygen for the files and directories
  838. # specified with INPUT and INCLUDE_PATH.
  839. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
  840. CLANG_OPTIONS =
  841. #---------------------------------------------------------------------------
  842. # Configuration options related to the alphabetical class index
  843. #---------------------------------------------------------------------------
  844. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
  845. # compounds will be generated. Enable this if the project contains a lot of
  846. # classes, structs, unions or interfaces.
  847. # The default value is: YES.
  848. ALPHABETICAL_INDEX = YES
  849. # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
  850. # which the alphabetical index list will be split.
  851. # Minimum value: 1, maximum value: 20, default value: 5.
  852. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
  853. COLS_IN_ALPHA_INDEX = 5
  854. # In case all classes in a project start with a common prefix, all classes will
  855. # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
  856. # can be used to specify a prefix (or a list of prefixes) that should be ignored
  857. # while generating the index headers.
  858. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
  859. IGNORE_PREFIX =
  860. #---------------------------------------------------------------------------
  861. # Configuration options related to the HTML output
  862. #---------------------------------------------------------------------------
  863. # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
  864. # The default value is: YES.
  865. GENERATE_HTML = YES
  866. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
  867. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  868. # it.
  869. # The default directory is: html.
  870. # This tag requires that the tag GENERATE_HTML is set to YES.
  871. HTML_OUTPUT = html
  872. # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
  873. # generated HTML page (for example: .htm, .php, .asp).
  874. # The default value is: .html.
  875. # This tag requires that the tag GENERATE_HTML is set to YES.
  876. HTML_FILE_EXTENSION = .html
  877. # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
  878. # each generated HTML page. If the tag is left blank doxygen will generate a
  879. # standard header.
  880. #
  881. # To get valid HTML the header file that includes any scripts and style sheets
  882. # that doxygen needs, which is dependent on the configuration options used (e.g.
  883. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
  884. # default header using
  885. # doxygen -w html new_header.html new_footer.html new_stylesheet.css
  886. # YourConfigFile
  887. # and then modify the file new_header.html. See also section "Doxygen usage"
  888. # for information on how to generate the default header that doxygen normally
  889. # uses.
  890. # Note: The header is subject to change so you typically have to regenerate the
  891. # default header when upgrading to a newer version of doxygen. For a description
  892. # of the possible markers and block names see the documentation.
  893. # This tag requires that the tag GENERATE_HTML is set to YES.
  894. HTML_HEADER =
  895. # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
  896. # generated HTML page. If the tag is left blank doxygen will generate a standard
  897. # footer. See HTML_HEADER for more information on how to generate a default
  898. # footer and what special commands can be used inside the footer. See also
  899. # section "Doxygen usage" for information on how to generate the default footer
  900. # that doxygen normally uses.
  901. # This tag requires that the tag GENERATE_HTML is set to YES.
  902. HTML_FOOTER =
  903. # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
  904. # sheet that is used by each HTML page. It can be used to fine-tune the look of
  905. # the HTML output. If left blank doxygen will generate a default style sheet.
  906. # See also section "Doxygen usage" for information on how to generate the style
  907. # sheet that doxygen normally uses.
  908. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
  909. # it is more robust and this tag (HTML_STYLESHEET) will in the future become
  910. # obsolete.
  911. # This tag requires that the tag GENERATE_HTML is set to YES.
  912. HTML_STYLESHEET =
  913. # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
  914. # cascading style sheets that are included after the standard style sheets
  915. # created by doxygen. Using this option one can overrule certain style aspects.
  916. # This is preferred over using HTML_STYLESHEET since it does not replace the
  917. # standard style sheet and is therefore more robust against future updates.
  918. # Doxygen will copy the style sheet files to the output directory.
  919. # Note: The order of the extra style sheet files is of importance (e.g. the last
  920. # style sheet in the list overrules the setting of the previous ones in the
  921. # list). For an example see the documentation.
  922. # This tag requires that the tag GENERATE_HTML is set to YES.
  923. HTML_EXTRA_STYLESHEET =
  924. # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
  925. # other source files which should be copied to the HTML output directory. Note
  926. # that these files will be copied to the base HTML output directory. Use the
  927. # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
  928. # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
  929. # files will be copied as-is; there are no commands or markers available.
  930. # This tag requires that the tag GENERATE_HTML is set to YES.
  931. HTML_EXTRA_FILES =
  932. # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
  933. # will adjust the colors in the style sheet and background images according to
  934. # this color. Hue is specified as an angle on a colorwheel, see
  935. # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
  936. # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
  937. # purple, and 360 is red again.
  938. # Minimum value: 0, maximum value: 359, default value: 220.
  939. # This tag requires that the tag GENERATE_HTML is set to YES.
  940. HTML_COLORSTYLE_HUE = 220
  941. # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
  942. # in the HTML output. For a value of 0 the output will use grayscales only. A
  943. # value of 255 will produce the most vivid colors.
  944. # Minimum value: 0, maximum value: 255, default value: 100.
  945. # This tag requires that the tag GENERATE_HTML is set to YES.
  946. HTML_COLORSTYLE_SAT = 100
  947. # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
  948. # luminance component of the colors in the HTML output. Values below 100
  949. # gradually make the output lighter, whereas values above 100 make the output
  950. # darker. The value divided by 100 is the actual gamma applied, so 80 represents
  951. # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
  952. # change the gamma.
  953. # Minimum value: 40, maximum value: 240, default value: 80.
  954. # This tag requires that the tag GENERATE_HTML is set to YES.
  955. HTML_COLORSTYLE_GAMMA = 80
  956. # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
  957. # page will contain the date and time when the page was generated. Setting this
  958. # to YES can help to show when doxygen was last run and thus if the
  959. # documentation is up to date.
  960. # The default value is: NO.
  961. # This tag requires that the tag GENERATE_HTML is set to YES.
  962. HTML_TIMESTAMP = NO
  963. # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
  964. # documentation will contain sections that can be hidden and shown after the
  965. # page has loaded.
  966. # The default value is: NO.
  967. # This tag requires that the tag GENERATE_HTML is set to YES.
  968. HTML_DYNAMIC_SECTIONS = NO
  969. # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
  970. # shown in the various tree structured indices initially; the user can expand
  971. # and collapse entries dynamically later on. Doxygen will expand the tree to
  972. # such a level that at most the specified number of entries are visible (unless
  973. # a fully collapsed tree already exceeds this amount). So setting the number of
  974. # entries 1 will produce a full collapsed tree by default. 0 is a special value
  975. # representing an infinite number of entries and will result in a full expanded
  976. # tree by default.
  977. # Minimum value: 0, maximum value: 9999, default value: 100.
  978. # This tag requires that the tag GENERATE_HTML is set to YES.
  979. HTML_INDEX_NUM_ENTRIES = 100
  980. # If the GENERATE_DOCSET tag is set to YES, additional index files will be
  981. # generated that can be used as input for Apple's Xcode 3 integrated development
  982. # environment (see: http://developer.apple.com/tools/xcode/), introduced with
  983. # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
  984. # Makefile in the HTML output directory. Running make will produce the docset in
  985. # that directory and running make install will install the docset in
  986. # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
  987. # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
  988. # for more information.
  989. # The default value is: NO.
  990. # This tag requires that the tag GENERATE_HTML is set to YES.
  991. GENERATE_DOCSET = NO
  992. # This tag determines the name of the docset feed. A documentation feed provides
  993. # an umbrella under which multiple documentation sets from a single provider
  994. # (such as a company or product suite) can be grouped.
  995. # The default value is: Doxygen generated docs.
  996. # This tag requires that the tag GENERATE_DOCSET is set to YES.
  997. DOCSET_FEEDNAME = "Doxygen generated docs"
  998. # This tag specifies a string that should uniquely identify the documentation
  999. # set bundle. This should be a reverse domain-name style string, e.g.
  1000. # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
  1001. # The default value is: org.doxygen.Project.
  1002. # This tag requires that the tag GENERATE_DOCSET is set to YES.
  1003. DOCSET_BUNDLE_ID = org.doxygen.Project
  1004. # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
  1005. # the documentation publisher. This should be a reverse domain-name style
  1006. # string, e.g. com.mycompany.MyDocSet.documentation.
  1007. # The default value is: org.doxygen.Publisher.
  1008. # This tag requires that the tag GENERATE_DOCSET is set to YES.
  1009. DOCSET_PUBLISHER_ID = org.doxygen.Publisher
  1010. # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
  1011. # The default value is: Publisher.
  1012. # This tag requires that the tag GENERATE_DOCSET is set to YES.
  1013. DOCSET_PUBLISHER_NAME = Publisher
  1014. # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
  1015. # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
  1016. # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
  1017. # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
  1018. # Windows.
  1019. #
  1020. # The HTML Help Workshop contains a compiler that can convert all HTML output
  1021. # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
  1022. # files are now used as the Windows 98 help format, and will replace the old
  1023. # Windows help format (.hlp) on all Windows platforms in the future. Compressed
  1024. # HTML files also contain an index, a table of contents, and you can search for
  1025. # words in the documentation. The HTML workshop also contains a viewer for
  1026. # compressed HTML files.
  1027. # The default value is: NO.
  1028. # This tag requires that the tag GENERATE_HTML is set to YES.
  1029. GENERATE_HTMLHELP = NO
  1030. # The CHM_FILE tag can be used to specify the file name of the resulting .chm
  1031. # file. You can add a path in front of the file if the result should not be
  1032. # written to the html output directory.
  1033. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1034. CHM_FILE =
  1035. # The HHC_LOCATION tag can be used to specify the location (absolute path
  1036. # including file name) of the HTML help compiler (hhc.exe). If non-empty,
  1037. # doxygen will try to run the HTML help compiler on the generated index.hhp.
  1038. # The file has to be specified with full path.
  1039. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1040. HHC_LOCATION =
  1041. # The GENERATE_CHI flag controls if a separate .chi index file is generated
  1042. # (YES) or that it should be included in the master .chm file (NO).
  1043. # The default value is: NO.
  1044. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1045. GENERATE_CHI = NO
  1046. # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
  1047. # and project file content.
  1048. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1049. CHM_INDEX_ENCODING =
  1050. # The BINARY_TOC flag controls whether a binary table of contents is generated
  1051. # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
  1052. # enables the Previous and Next buttons.
  1053. # The default value is: NO.
  1054. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1055. BINARY_TOC = NO
  1056. # The TOC_EXPAND flag can be set to YES to add extra items for group members to
  1057. # the table of contents of the HTML help documentation and to the tree view.
  1058. # The default value is: NO.
  1059. # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1060. TOC_EXPAND = NO
  1061. # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
  1062. # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
  1063. # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
  1064. # (.qch) of the generated HTML documentation.
  1065. # The default value is: NO.
  1066. # This tag requires that the tag GENERATE_HTML is set to YES.
  1067. GENERATE_QHP = NO
  1068. # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
  1069. # the file name of the resulting .qch file. The path specified is relative to
  1070. # the HTML output folder.
  1071. # This tag requires that the tag GENERATE_QHP is set to YES.
  1072. QCH_FILE =
  1073. # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
  1074. # Project output. For more information please see Qt Help Project / Namespace
  1075. # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
  1076. # The default value is: org.doxygen.Project.
  1077. # This tag requires that the tag GENERATE_QHP is set to YES.
  1078. QHP_NAMESPACE = org.doxygen.Project
  1079. # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
  1080. # Help Project output. For more information please see Qt Help Project / Virtual
  1081. # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
  1082. # folders).
  1083. # The default value is: doc.
  1084. # This tag requires that the tag GENERATE_QHP is set to YES.
  1085. QHP_VIRTUAL_FOLDER = doc
  1086. # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
  1087. # filter to add. For more information please see Qt Help Project / Custom
  1088. # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  1089. # filters).
  1090. # This tag requires that the tag GENERATE_QHP is set to YES.
  1091. QHP_CUST_FILTER_NAME =
  1092. # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
  1093. # custom filter to add. For more information please see Qt Help Project / Custom
  1094. # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  1095. # filters).
  1096. # This tag requires that the tag GENERATE_QHP is set to YES.
  1097. QHP_CUST_FILTER_ATTRS =
  1098. # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
  1099. # project's filter section matches. Qt Help Project / Filter Attributes (see:
  1100. # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
  1101. # This tag requires that the tag GENERATE_QHP is set to YES.
  1102. QHP_SECT_FILTER_ATTRS =
  1103. # The QHG_LOCATION tag can be used to specify the location of Qt's
  1104. # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
  1105. # generated .qhp file.
  1106. # This tag requires that the tag GENERATE_QHP is set to YES.
  1107. QHG_LOCATION =
  1108. # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
  1109. # generated, together with the HTML files, they form an Eclipse help plugin. To
  1110. # install this plugin and make it available under the help contents menu in
  1111. # Eclipse, the contents of the directory containing the HTML and XML files needs
  1112. # to be copied into the plugins directory of eclipse. The name of the directory
  1113. # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
  1114. # After copying Eclipse needs to be restarted before the help appears.
  1115. # The default value is: NO.
  1116. # This tag requires that the tag GENERATE_HTML is set to YES.
  1117. GENERATE_ECLIPSEHELP = NO
  1118. # A unique identifier for the Eclipse help plugin. When installing the plugin
  1119. # the directory name containing the HTML and XML files should also have this
  1120. # name. Each documentation set should have its own identifier.
  1121. # The default value is: org.doxygen.Project.
  1122. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
  1123. ECLIPSE_DOC_ID = org.doxygen.Project
  1124. # If you want full control over the layout of the generated HTML pages it might
  1125. # be necessary to disable the index and replace it with your own. The
  1126. # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
  1127. # of each HTML page. A value of NO enables the index and the value YES disables
  1128. # it. Since the tabs in the index contain the same information as the navigation
  1129. # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
  1130. # The default value is: NO.
  1131. # This tag requires that the tag GENERATE_HTML is set to YES.
  1132. DISABLE_INDEX = NO
  1133. # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
  1134. # structure should be generated to display hierarchical information. If the tag
  1135. # value is set to YES, a side panel will be generated containing a tree-like
  1136. # index structure (just like the one that is generated for HTML Help). For this
  1137. # to work a browser that supports JavaScript, DHTML, CSS and frames is required
  1138. # (i.e. any modern browser). Windows users are probably better off using the
  1139. # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
  1140. # further fine-tune the look of the index. As an example, the default style
  1141. # sheet generated by doxygen has an example that shows how to put an image at
  1142. # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
  1143. # the same information as the tab index, you could consider setting
  1144. # DISABLE_INDEX to YES when enabling this option.
  1145. # The default value is: NO.
  1146. # This tag requires that the tag GENERATE_HTML is set to YES.
  1147. GENERATE_TREEVIEW = YES
  1148. # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
  1149. # doxygen will group on one line in the generated HTML documentation.
  1150. #
  1151. # Note that a value of 0 will completely suppress the enum values from appearing
  1152. # in the overview section.
  1153. # Minimum value: 0, maximum value: 20, default value: 4.
  1154. # This tag requires that the tag GENERATE_HTML is set to YES.
  1155. ENUM_VALUES_PER_LINE = 4
  1156. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
  1157. # to set the initial width (in pixels) of the frame in which the tree is shown.
  1158. # Minimum value: 0, maximum value: 1500, default value: 250.
  1159. # This tag requires that the tag GENERATE_HTML is set to YES.
  1160. TREEVIEW_WIDTH = 250
  1161. # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
  1162. # external symbols imported via tag files in a separate window.
  1163. # The default value is: NO.
  1164. # This tag requires that the tag GENERATE_HTML is set to YES.
  1165. EXT_LINKS_IN_WINDOW = NO
  1166. # Use this tag to change the font size of LaTeX formulas included as images in
  1167. # the HTML documentation. When you change the font size after a successful
  1168. # doxygen run you need to manually remove any form_*.png images from the HTML
  1169. # output directory to force them to be regenerated.
  1170. # Minimum value: 8, maximum value: 50, default value: 10.
  1171. # This tag requires that the tag GENERATE_HTML is set to YES.
  1172. FORMULA_FONTSIZE = 10
  1173. # Use the FORMULA_TRANPARENT tag to determine whether or not the images
  1174. # generated for formulas are transparent PNGs. Transparent PNGs are not
  1175. # supported properly for IE 6.0, but are supported on all modern browsers.
  1176. #
  1177. # Note that when changing this option you need to delete any form_*.png files in
  1178. # the HTML output directory before the changes have effect.
  1179. # The default value is: YES.
  1180. # This tag requires that the tag GENERATE_HTML is set to YES.
  1181. FORMULA_TRANSPARENT = YES
  1182. # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
  1183. # http://www.mathjax.org) which uses client side Javascript for the rendering
  1184. # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
  1185. # installed or if you want to formulas look prettier in the HTML output. When
  1186. # enabled you may also need to install MathJax separately and configure the path
  1187. # to it using the MATHJAX_RELPATH option.
  1188. # The default value is: NO.
  1189. # This tag requires that the tag GENERATE_HTML is set to YES.
  1190. USE_MATHJAX = NO
  1191. # When MathJax is enabled you can set the default output format to be used for
  1192. # the MathJax output. See the MathJax site (see:
  1193. # http://docs.mathjax.org/en/latest/output.html) for more details.
  1194. # Possible values are: HTML-CSS (which is slower, but has the best
  1195. # compatibility), NativeMML (i.e. MathML) and SVG.
  1196. # The default value is: HTML-CSS.
  1197. # This tag requires that the tag USE_MATHJAX is set to YES.
  1198. MATHJAX_FORMAT = HTML-CSS
  1199. # When MathJax is enabled you need to specify the location relative to the HTML
  1200. # output directory using the MATHJAX_RELPATH option. The destination directory
  1201. # should contain the MathJax.js script. For instance, if the mathjax directory
  1202. # is located at the same level as the HTML output directory, then
  1203. # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
  1204. # Content Delivery Network so you can quickly see the result without installing
  1205. # MathJax. However, it is strongly recommended to install a local copy of
  1206. # MathJax from http://www.mathjax.org before deployment.
  1207. # The default value is: http://cdn.mathjax.org/mathjax/latest.
  1208. # This tag requires that the tag USE_MATHJAX is set to YES.
  1209. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
  1210. # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
  1211. # extension names that should be enabled during MathJax rendering. For example
  1212. # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
  1213. # This tag requires that the tag USE_MATHJAX is set to YES.
  1214. MATHJAX_EXTENSIONS =
  1215. # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
  1216. # of code that will be used on startup of the MathJax code. See the MathJax site
  1217. # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
  1218. # example see the documentation.
  1219. # This tag requires that the tag USE_MATHJAX is set to YES.
  1220. MATHJAX_CODEFILE =
  1221. # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
  1222. # the HTML output. The underlying search engine uses javascript and DHTML and
  1223. # should work on any modern browser. Note that when using HTML help
  1224. # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
  1225. # there is already a search function so this one should typically be disabled.
  1226. # For large projects the javascript based search engine can be slow, then
  1227. # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
  1228. # search using the keyboard; to jump to the search box use <access key> + S
  1229. # (what the <access key> is depends on the OS and browser, but it is typically
  1230. # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
  1231. # key> to jump into the search results window, the results can be navigated
  1232. # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
  1233. # the search. The filter options can be selected when the cursor is inside the
  1234. # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
  1235. # to select a filter and <Enter> or <escape> to activate or cancel the filter
  1236. # option.
  1237. # The default value is: YES.
  1238. # This tag requires that the tag GENERATE_HTML is set to YES.
  1239. SEARCHENGINE = YES
  1240. # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
  1241. # implemented using a web server instead of a web client using Javascript. There
  1242. # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
  1243. # setting. When disabled, doxygen will generate a PHP script for searching and
  1244. # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
  1245. # and searching needs to be provided by external tools. See the section
  1246. # "External Indexing and Searching" for details.
  1247. # The default value is: NO.
  1248. # This tag requires that the tag SEARCHENGINE is set to YES.
  1249. SERVER_BASED_SEARCH = NO
  1250. # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
  1251. # script for searching. Instead the search results are written to an XML file
  1252. # which needs to be processed by an external indexer. Doxygen will invoke an
  1253. # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
  1254. # search results.
  1255. #
  1256. # Doxygen ships with an example indexer (doxyindexer) and search engine
  1257. # (doxysearch.cgi) which are based on the open source search engine library
  1258. # Xapian (see: http://xapian.org/).
  1259. #
  1260. # See the section "External Indexing and Searching" for details.
  1261. # The default value is: NO.
  1262. # This tag requires that the tag SEARCHENGINE is set to YES.
  1263. EXTERNAL_SEARCH = NO
  1264. # The SEARCHENGINE_URL should point to a search engine hosted by a web server
  1265. # which will return the search results when EXTERNAL_SEARCH is enabled.
  1266. #
  1267. # Doxygen ships with an example indexer (doxyindexer) and search engine
  1268. # (doxysearch.cgi) which are based on the open source search engine library
  1269. # Xapian (see: http://xapian.org/). See the section "External Indexing and
  1270. # Searching" for details.
  1271. # This tag requires that the tag SEARCHENGINE is set to YES.
  1272. SEARCHENGINE_URL =
  1273. # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
  1274. # search data is written to a file for indexing by an external tool. With the
  1275. # SEARCHDATA_FILE tag the name of this file can be specified.
  1276. # The default file is: searchdata.xml.
  1277. # This tag requires that the tag SEARCHENGINE is set to YES.
  1278. SEARCHDATA_FILE = searchdata.xml
  1279. # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
  1280. # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
  1281. # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
  1282. # projects and redirect the results back to the right project.
  1283. # This tag requires that the tag SEARCHENGINE is set to YES.
  1284. EXTERNAL_SEARCH_ID =
  1285. # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
  1286. # projects other than the one defined by this configuration file, but that are
  1287. # all added to the same external search index. Each project needs to have a
  1288. # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
  1289. # to a relative location where the documentation can be found. The format is:
  1290. # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
  1291. # This tag requires that the tag SEARCHENGINE is set to YES.
  1292. EXTRA_SEARCH_MAPPINGS =
  1293. #---------------------------------------------------------------------------
  1294. # Configuration options related to the LaTeX output
  1295. #---------------------------------------------------------------------------
  1296. # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
  1297. # The default value is: YES.
  1298. GENERATE_LATEX = NO
  1299. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
  1300. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1301. # it.
  1302. # The default directory is: latex.
  1303. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1304. LATEX_OUTPUT = latex
  1305. # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  1306. # invoked.
  1307. #
  1308. # Note that when enabling USE_PDFLATEX this option is only used for generating
  1309. # bitmaps for formulas in the HTML output, but not in the Makefile that is
  1310. # written to the output directory.
  1311. # The default file is: latex.
  1312. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1313. LATEX_CMD_NAME = latex
  1314. # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
  1315. # index for LaTeX.
  1316. # The default file is: makeindex.
  1317. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1318. MAKEINDEX_CMD_NAME = makeindex
  1319. # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
  1320. # documents. This may be useful for small projects and may help to save some
  1321. # trees in general.
  1322. # The default value is: NO.
  1323. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1324. COMPACT_LATEX = NO
  1325. # The PAPER_TYPE tag can be used to set the paper type that is used by the
  1326. # printer.
  1327. # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
  1328. # 14 inches) and executive (7.25 x 10.5 inches).
  1329. # The default value is: a4.
  1330. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1331. PAPER_TYPE = a4
  1332. # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
  1333. # that should be included in the LaTeX output. The package can be specified just
  1334. # by its name or with the correct syntax as to be used with the LaTeX
  1335. # \usepackage command. To get the times font for instance you can specify :
  1336. # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
  1337. # To use the option intlimits with the amsmath package you can specify:
  1338. # EXTRA_PACKAGES=[intlimits]{amsmath}
  1339. # If left blank no extra packages will be included.
  1340. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1341. EXTRA_PACKAGES =
  1342. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
  1343. # generated LaTeX document. The header should contain everything until the first
  1344. # chapter. If it is left blank doxygen will generate a standard header. See
  1345. # section "Doxygen usage" for information on how to let doxygen write the
  1346. # default header to a separate file.
  1347. #
  1348. # Note: Only use a user-defined header if you know what you are doing! The
  1349. # following commands have a special meaning inside the header: $title,
  1350. # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
  1351. # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
  1352. # string, for the replacement values of the other commands the user is referred
  1353. # to HTML_HEADER.
  1354. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1355. LATEX_HEADER =
  1356. # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
  1357. # generated LaTeX document. The footer should contain everything after the last
  1358. # chapter. If it is left blank doxygen will generate a standard footer. See
  1359. # LATEX_HEADER for more information on how to generate a default footer and what
  1360. # special commands can be used inside the footer.
  1361. #
  1362. # Note: Only use a user-defined footer if you know what you are doing!
  1363. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1364. LATEX_FOOTER =
  1365. # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
  1366. # LaTeX style sheets that are included after the standard style sheets created
  1367. # by doxygen. Using this option one can overrule certain style aspects. Doxygen
  1368. # will copy the style sheet files to the output directory.
  1369. # Note: The order of the extra style sheet files is of importance (e.g. the last
  1370. # style sheet in the list overrules the setting of the previous ones in the
  1371. # list).
  1372. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1373. LATEX_EXTRA_STYLESHEET =
  1374. # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
  1375. # other source files which should be copied to the LATEX_OUTPUT output
  1376. # directory. Note that the files will be copied as-is; there are no commands or
  1377. # markers available.
  1378. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1379. LATEX_EXTRA_FILES =
  1380. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
  1381. # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
  1382. # contain links (just like the HTML output) instead of page references. This
  1383. # makes the output suitable for online browsing using a PDF viewer.
  1384. # The default value is: YES.
  1385. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1386. PDF_HYPERLINKS = YES
  1387. # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
  1388. # the PDF file directly from the LaTeX files. Set this option to YES, to get a
  1389. # higher quality PDF documentation.
  1390. # The default value is: YES.
  1391. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1392. USE_PDFLATEX = YES
  1393. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
  1394. # command to the generated LaTeX files. This will instruct LaTeX to keep running
  1395. # if errors occur, instead of asking the user for help. This option is also used
  1396. # when generating formulas in HTML.
  1397. # The default value is: NO.
  1398. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1399. LATEX_BATCHMODE = NO
  1400. # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
  1401. # index chapters (such as File Index, Compound Index, etc.) in the output.
  1402. # The default value is: NO.
  1403. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1404. LATEX_HIDE_INDICES = NO
  1405. # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
  1406. # code with syntax highlighting in the LaTeX output.
  1407. #
  1408. # Note that which sources are shown also depends on other settings such as
  1409. # SOURCE_BROWSER.
  1410. # The default value is: NO.
  1411. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1412. LATEX_SOURCE_CODE = NO
  1413. # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
  1414. # bibliography, e.g. plainnat, or ieeetr. See
  1415. # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
  1416. # The default value is: plain.
  1417. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1418. LATEX_BIB_STYLE = plain
  1419. # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
  1420. # page will contain the date and time when the page was generated. Setting this
  1421. # to NO can help when comparing the output of multiple runs.
  1422. # The default value is: NO.
  1423. # This tag requires that the tag GENERATE_LATEX is set to YES.
  1424. LATEX_TIMESTAMP = NO
  1425. #---------------------------------------------------------------------------
  1426. # Configuration options related to the RTF output
  1427. #---------------------------------------------------------------------------
  1428. # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
  1429. # RTF output is optimized for Word 97 and may not look too pretty with other RTF
  1430. # readers/editors.
  1431. # The default value is: NO.
  1432. GENERATE_RTF = NO
  1433. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
  1434. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1435. # it.
  1436. # The default directory is: rtf.
  1437. # This tag requires that the tag GENERATE_RTF is set to YES.
  1438. RTF_OUTPUT = rtf
  1439. # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
  1440. # documents. This may be useful for small projects and may help to save some
  1441. # trees in general.
  1442. # The default value is: NO.
  1443. # This tag requires that the tag GENERATE_RTF is set to YES.
  1444. COMPACT_RTF = NO
  1445. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
  1446. # contain hyperlink fields. The RTF file will contain links (just like the HTML
  1447. # output) instead of page references. This makes the output suitable for online
  1448. # browsing using Word or some other Word compatible readers that support those
  1449. # fields.
  1450. #
  1451. # Note: WordPad (write) and others do not support links.
  1452. # The default value is: NO.
  1453. # This tag requires that the tag GENERATE_RTF is set to YES.
  1454. RTF_HYPERLINKS = NO
  1455. # Load stylesheet definitions from file. Syntax is similar to doxygen's config
  1456. # file, i.e. a series of assignments. You only have to provide replacements,
  1457. # missing definitions are set to their default value.
  1458. #
  1459. # See also section "Doxygen usage" for information on how to generate the
  1460. # default style sheet that doxygen normally uses.
  1461. # This tag requires that the tag GENERATE_RTF is set to YES.
  1462. RTF_STYLESHEET_FILE =
  1463. # Set optional variables used in the generation of an RTF document. Syntax is
  1464. # similar to doxygen's config file. A template extensions file can be generated
  1465. # using doxygen -e rtf extensionFile.
  1466. # This tag requires that the tag GENERATE_RTF is set to YES.
  1467. RTF_EXTENSIONS_FILE =
  1468. # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
  1469. # with syntax highlighting in the RTF output.
  1470. #
  1471. # Note that which sources are shown also depends on other settings such as
  1472. # SOURCE_BROWSER.
  1473. # The default value is: NO.
  1474. # This tag requires that the tag GENERATE_RTF is set to YES.
  1475. RTF_SOURCE_CODE = NO
  1476. #---------------------------------------------------------------------------
  1477. # Configuration options related to the man page output
  1478. #---------------------------------------------------------------------------
  1479. # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
  1480. # classes and files.
  1481. # The default value is: NO.
  1482. GENERATE_MAN = NO
  1483. # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
  1484. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1485. # it. A directory man3 will be created inside the directory specified by
  1486. # MAN_OUTPUT.
  1487. # The default directory is: man.
  1488. # This tag requires that the tag GENERATE_MAN is set to YES.
  1489. MAN_OUTPUT = man
  1490. # The MAN_EXTENSION tag determines the extension that is added to the generated
  1491. # man pages. In case the manual section does not start with a number, the number
  1492. # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
  1493. # optional.
  1494. # The default value is: .3.
  1495. # This tag requires that the tag GENERATE_MAN is set to YES.
  1496. MAN_EXTENSION = .3
  1497. # The MAN_SUBDIR tag determines the name of the directory created within
  1498. # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
  1499. # MAN_EXTENSION with the initial . removed.
  1500. # This tag requires that the tag GENERATE_MAN is set to YES.
  1501. MAN_SUBDIR =
  1502. # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
  1503. # will generate one additional man file for each entity documented in the real
  1504. # man page(s). These additional files only source the real man page, but without
  1505. # them the man command would be unable to find the correct page.
  1506. # The default value is: NO.
  1507. # This tag requires that the tag GENERATE_MAN is set to YES.
  1508. MAN_LINKS = NO
  1509. #---------------------------------------------------------------------------
  1510. # Configuration options related to the XML output
  1511. #---------------------------------------------------------------------------
  1512. # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
  1513. # captures the structure of the code including all documentation.
  1514. # The default value is: NO.
  1515. GENERATE_XML = NO
  1516. # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
  1517. # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1518. # it.
  1519. # The default directory is: xml.
  1520. # This tag requires that the tag GENERATE_XML is set to YES.
  1521. XML_OUTPUT = xml
  1522. # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
  1523. # listings (including syntax highlighting and cross-referencing information) to
  1524. # the XML output. Note that enabling this will significantly increase the size
  1525. # of the XML output.
  1526. # The default value is: YES.
  1527. # This tag requires that the tag GENERATE_XML is set to YES.
  1528. XML_PROGRAMLISTING = YES
  1529. #---------------------------------------------------------------------------
  1530. # Configuration options related to the DOCBOOK output
  1531. #---------------------------------------------------------------------------
  1532. # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
  1533. # that can be used to generate PDF.
  1534. # The default value is: NO.
  1535. GENERATE_DOCBOOK = NO
  1536. # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
  1537. # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
  1538. # front of it.
  1539. # The default directory is: docbook.
  1540. # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
  1541. DOCBOOK_OUTPUT = docbook
  1542. # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
  1543. # program listings (including syntax highlighting and cross-referencing
  1544. # information) to the DOCBOOK output. Note that enabling this will significantly
  1545. # increase the size of the DOCBOOK output.
  1546. # The default value is: NO.
  1547. # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
  1548. DOCBOOK_PROGRAMLISTING = NO
  1549. #---------------------------------------------------------------------------
  1550. # Configuration options for the AutoGen Definitions output
  1551. #---------------------------------------------------------------------------
  1552. # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
  1553. # AutoGen Definitions (see http://autogen.sf.net) file that captures the
  1554. # structure of the code including all documentation. Note that this feature is
  1555. # still experimental and incomplete at the moment.
  1556. # The default value is: NO.
  1557. GENERATE_AUTOGEN_DEF = NO
  1558. #---------------------------------------------------------------------------
  1559. # Configuration options related to the Perl module output
  1560. #---------------------------------------------------------------------------
  1561. # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
  1562. # file that captures the structure of the code including all documentation.
  1563. #
  1564. # Note that this feature is still experimental and incomplete at the moment.
  1565. # The default value is: NO.
  1566. GENERATE_PERLMOD = NO
  1567. # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
  1568. # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
  1569. # output from the Perl module output.
  1570. # The default value is: NO.
  1571. # This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1572. PERLMOD_LATEX = NO
  1573. # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
  1574. # formatted so it can be parsed by a human reader. This is useful if you want to
  1575. # understand what is going on. On the other hand, if this tag is set to NO, the
  1576. # size of the Perl module output will be much smaller and Perl will parse it
  1577. # just the same.
  1578. # The default value is: YES.
  1579. # This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1580. PERLMOD_PRETTY = YES
  1581. # The names of the make variables in the generated doxyrules.make file are
  1582. # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
  1583. # so different doxyrules.make files included by the same Makefile don't
  1584. # overwrite each other's variables.
  1585. # This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1586. PERLMOD_MAKEVAR_PREFIX =
  1587. #---------------------------------------------------------------------------
  1588. # Configuration options related to the preprocessor
  1589. #---------------------------------------------------------------------------
  1590. # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
  1591. # C-preprocessor directives found in the sources and include files.
  1592. # The default value is: YES.
  1593. ENABLE_PREPROCESSING = YES
  1594. # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
  1595. # in the source code. If set to NO, only conditional compilation will be
  1596. # performed. Macro expansion can be done in a controlled way by setting
  1597. # EXPAND_ONLY_PREDEF to YES.
  1598. # The default value is: NO.
  1599. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1600. MACRO_EXPANSION = NO
  1601. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
  1602. # the macro expansion is limited to the macros specified with the PREDEFINED and
  1603. # EXPAND_AS_DEFINED tags.
  1604. # The default value is: NO.
  1605. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1606. EXPAND_ONLY_PREDEF = NO
  1607. # If the SEARCH_INCLUDES tag is set to YES, the include files in the
  1608. # INCLUDE_PATH will be searched if a #include is found.
  1609. # The default value is: YES.
  1610. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1611. SEARCH_INCLUDES = YES
  1612. # The INCLUDE_PATH tag can be used to specify one or more directories that
  1613. # contain include files that are not input files but should be processed by the
  1614. # preprocessor.
  1615. # This tag requires that the tag SEARCH_INCLUDES is set to YES.
  1616. INCLUDE_PATH =
  1617. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  1618. # patterns (like *.h and *.hpp) to filter out the header-files in the
  1619. # directories. If left blank, the patterns specified with FILE_PATTERNS will be
  1620. # used.
  1621. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1622. INCLUDE_FILE_PATTERNS =
  1623. # The PREDEFINED tag can be used to specify one or more macro names that are
  1624. # defined before the preprocessor is started (similar to the -D option of e.g.
  1625. # gcc). The argument of the tag is a list of macros of the form: name or
  1626. # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
  1627. # is assumed. To prevent a macro definition from being undefined via #undef or
  1628. # recursively expanded use the := operator instead of the = operator.
  1629. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1630. PREDEFINED =
  1631. # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
  1632. # tag can be used to specify a list of macro names that should be expanded. The
  1633. # macro definition that is found in the sources will be used. Use the PREDEFINED
  1634. # tag if you want to use a different macro definition that overrules the
  1635. # definition found in the source code.
  1636. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1637. EXPAND_AS_DEFINED =
  1638. # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
  1639. # remove all references to function-like macros that are alone on a line, have
  1640. # an all uppercase name, and do not end with a semicolon. Such function macros
  1641. # are typically used for boiler-plate code, and will confuse the parser if not
  1642. # removed.
  1643. # The default value is: YES.
  1644. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1645. SKIP_FUNCTION_MACROS = YES
  1646. #---------------------------------------------------------------------------
  1647. # Configuration options related to external references
  1648. #---------------------------------------------------------------------------
  1649. # The TAGFILES tag can be used to specify one or more tag files. For each tag
  1650. # file the location of the external documentation should be added. The format of
  1651. # a tag file without this location is as follows:
  1652. # TAGFILES = file1 file2 ...
  1653. # Adding location for the tag files is done as follows:
  1654. # TAGFILES = file1=loc1 "file2 = loc2" ...
  1655. # where loc1 and loc2 can be relative or absolute paths or URLs. See the
  1656. # section "Linking to external documentation" for more information about the use
  1657. # of tag files.
  1658. # Note: Each tag file must have a unique name (where the name does NOT include
  1659. # the path). If a tag file is not located in the directory in which doxygen is
  1660. # run, you must also specify the path to the tagfile here.
  1661. TAGFILES =
  1662. # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
  1663. # tag file that is based on the input files it reads. See section "Linking to
  1664. # external documentation" for more information about the usage of tag files.
  1665. GENERATE_TAGFILE =
  1666. # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
  1667. # the class index. If set to NO, only the inherited external classes will be
  1668. # listed.
  1669. # The default value is: NO.
  1670. ALLEXTERNALS = NO
  1671. # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
  1672. # in the modules index. If set to NO, only the current project's groups will be
  1673. # listed.
  1674. # The default value is: YES.
  1675. EXTERNAL_GROUPS = YES
  1676. # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
  1677. # the related pages index. If set to NO, only the current project's pages will
  1678. # be listed.
  1679. # The default value is: YES.
  1680. EXTERNAL_PAGES = YES
  1681. # The PERL_PATH should be the absolute path and name of the perl script
  1682. # interpreter (i.e. the result of 'which perl').
  1683. # The default file (with absolute path) is: /usr/bin/perl.
  1684. PERL_PATH = /usr/bin/perl
  1685. #---------------------------------------------------------------------------
  1686. # Configuration options related to the dot tool
  1687. #---------------------------------------------------------------------------
  1688. # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
  1689. # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
  1690. # NO turns the diagrams off. Note that this option also works with HAVE_DOT
  1691. # disabled, but it is recommended to install and use dot, since it yields more
  1692. # powerful graphs.
  1693. # The default value is: YES.
  1694. CLASS_DIAGRAMS = NO
  1695. # You can define message sequence charts within doxygen comments using the \msc
  1696. # command. Doxygen will then run the mscgen tool (see:
  1697. # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
  1698. # documentation. The MSCGEN_PATH tag allows you to specify the directory where
  1699. # the mscgen tool resides. If left empty the tool is assumed to be found in the
  1700. # default search path.
  1701. MSCGEN_PATH =
  1702. # You can include diagrams made with dia in doxygen documentation. Doxygen will
  1703. # then run dia to produce the diagram and insert it in the documentation. The
  1704. # DIA_PATH tag allows you to specify the directory where the dia binary resides.
  1705. # If left empty dia is assumed to be found in the default search path.
  1706. DIA_PATH =
  1707. # If set to YES the inheritance and collaboration graphs will hide inheritance
  1708. # and usage relations if the target is undocumented or is not a class.
  1709. # The default value is: YES.
  1710. HIDE_UNDOC_RELATIONS = YES
  1711. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  1712. # available from the path. This tool is part of Graphviz (see:
  1713. # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
  1714. # Bell Labs. The other options in this section have no effect if this option is
  1715. # set to NO
  1716. # The default value is: YES.
  1717. HAVE_DOT = NO
  1718. # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
  1719. # to run in parallel. When set to 0 doxygen will base this on the number of
  1720. # processors available in the system. You can set it explicitly to a value
  1721. # larger than 0 to get control over the balance between CPU load and processing
  1722. # speed.
  1723. # Minimum value: 0, maximum value: 32, default value: 0.
  1724. # This tag requires that the tag HAVE_DOT is set to YES.
  1725. DOT_NUM_THREADS = 0
  1726. # When you want a differently looking font in the dot files that doxygen
  1727. # generates you can specify the font name using DOT_FONTNAME. You need to make
  1728. # sure dot is able to find the font, which can be done by putting it in a
  1729. # standard location or by setting the DOTFONTPATH environment variable or by
  1730. # setting DOT_FONTPATH to the directory containing the font.
  1731. # The default value is: Helvetica.
  1732. # This tag requires that the tag HAVE_DOT is set to YES.
  1733. DOT_FONTNAME = Helvetica
  1734. # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
  1735. # dot graphs.
  1736. # Minimum value: 4, maximum value: 24, default value: 10.
  1737. # This tag requires that the tag HAVE_DOT is set to YES.
  1738. DOT_FONTSIZE = 10
  1739. # By default doxygen will tell dot to use the default font as specified with
  1740. # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
  1741. # the path where dot can find it using this tag.
  1742. # This tag requires that the tag HAVE_DOT is set to YES.
  1743. DOT_FONTPATH =
  1744. # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
  1745. # each documented class showing the direct and indirect inheritance relations.
  1746. # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
  1747. # The default value is: YES.
  1748. # This tag requires that the tag HAVE_DOT is set to YES.
  1749. CLASS_GRAPH = YES
  1750. # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
  1751. # graph for each documented class showing the direct and indirect implementation
  1752. # dependencies (inheritance, containment, and class references variables) of the
  1753. # class with other documented classes.
  1754. # The default value is: YES.
  1755. # This tag requires that the tag HAVE_DOT is set to YES.
  1756. COLLABORATION_GRAPH = YES
  1757. # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
  1758. # groups, showing the direct groups dependencies.
  1759. # The default value is: YES.
  1760. # This tag requires that the tag HAVE_DOT is set to YES.
  1761. GROUP_GRAPHS = YES
  1762. # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
  1763. # collaboration diagrams in a style similar to the OMG's Unified Modeling
  1764. # Language.
  1765. # The default value is: NO.
  1766. # This tag requires that the tag HAVE_DOT is set to YES.
  1767. UML_LOOK = NO
  1768. # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
  1769. # class node. If there are many fields or methods and many nodes the graph may
  1770. # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
  1771. # number of items for each type to make the size more manageable. Set this to 0
  1772. # for no limit. Note that the threshold may be exceeded by 50% before the limit
  1773. # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
  1774. # but if the number exceeds 15, the total amount of fields shown is limited to
  1775. # 10.
  1776. # Minimum value: 0, maximum value: 100, default value: 10.
  1777. # This tag requires that the tag HAVE_DOT is set to YES.
  1778. UML_LIMIT_NUM_FIELDS = 10
  1779. # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
  1780. # collaboration graphs will show the relations between templates and their
  1781. # instances.
  1782. # The default value is: NO.
  1783. # This tag requires that the tag HAVE_DOT is set to YES.
  1784. TEMPLATE_RELATIONS = NO
  1785. # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
  1786. # YES then doxygen will generate a graph for each documented file showing the
  1787. # direct and indirect include dependencies of the file with other documented
  1788. # files.
  1789. # The default value is: YES.
  1790. # This tag requires that the tag HAVE_DOT is set to YES.
  1791. INCLUDE_GRAPH = YES
  1792. # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
  1793. # set to YES then doxygen will generate a graph for each documented file showing
  1794. # the direct and indirect include dependencies of the file with other documented
  1795. # files.
  1796. # The default value is: YES.
  1797. # This tag requires that the tag HAVE_DOT is set to YES.
  1798. INCLUDED_BY_GRAPH = YES
  1799. # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
  1800. # dependency graph for every global function or class method.
  1801. #
  1802. # Note that enabling this option will significantly increase the time of a run.
  1803. # So in most cases it will be better to enable call graphs for selected
  1804. # functions only using the \callgraph command. Disabling a call graph can be
  1805. # accomplished by means of the command \hidecallgraph.
  1806. # The default value is: NO.
  1807. # This tag requires that the tag HAVE_DOT is set to YES.
  1808. CALL_GRAPH = NO
  1809. # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
  1810. # dependency graph for every global function or class method.
  1811. #
  1812. # Note that enabling this option will significantly increase the time of a run.
  1813. # So in most cases it will be better to enable caller graphs for selected
  1814. # functions only using the \callergraph command. Disabling a caller graph can be
  1815. # accomplished by means of the command \hidecallergraph.
  1816. # The default value is: NO.
  1817. # This tag requires that the tag HAVE_DOT is set to YES.
  1818. CALLER_GRAPH = NO
  1819. # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
  1820. # hierarchy of all classes instead of a textual one.
  1821. # The default value is: YES.
  1822. # This tag requires that the tag HAVE_DOT is set to YES.
  1823. GRAPHICAL_HIERARCHY = YES
  1824. # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
  1825. # dependencies a directory has on other directories in a graphical way. The
  1826. # dependency relations are determined by the #include relations between the
  1827. # files in the directories.
  1828. # The default value is: YES.
  1829. # This tag requires that the tag HAVE_DOT is set to YES.
  1830. DIRECTORY_GRAPH = YES
  1831. # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  1832. # generated by dot. For an explanation of the image formats see the section
  1833. # output formats in the documentation of the dot tool (Graphviz (see:
  1834. # http://www.graphviz.org/)).
  1835. # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
  1836. # to make the SVG files visible in IE 9+ (other browsers do not have this
  1837. # requirement).
  1838. # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
  1839. # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
  1840. # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
  1841. # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
  1842. # png:gdiplus:gdiplus.
  1843. # The default value is: png.
  1844. # This tag requires that the tag HAVE_DOT is set to YES.
  1845. DOT_IMAGE_FORMAT = png
  1846. # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
  1847. # enable generation of interactive SVG images that allow zooming and panning.
  1848. #
  1849. # Note that this requires a modern browser other than Internet Explorer. Tested
  1850. # and working are Firefox, Chrome, Safari, and Opera.
  1851. # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
  1852. # the SVG files visible. Older versions of IE do not have SVG support.
  1853. # The default value is: NO.
  1854. # This tag requires that the tag HAVE_DOT is set to YES.
  1855. INTERACTIVE_SVG = NO
  1856. # The DOT_PATH tag can be used to specify the path where the dot tool can be
  1857. # found. If left blank, it is assumed the dot tool can be found in the path.
  1858. # This tag requires that the tag HAVE_DOT is set to YES.
  1859. DOT_PATH =
  1860. # The DOTFILE_DIRS tag can be used to specify one or more directories that
  1861. # contain dot files that are included in the documentation (see the \dotfile
  1862. # command).
  1863. # This tag requires that the tag HAVE_DOT is set to YES.
  1864. DOTFILE_DIRS =
  1865. # The MSCFILE_DIRS tag can be used to specify one or more directories that
  1866. # contain msc files that are included in the documentation (see the \mscfile
  1867. # command).
  1868. MSCFILE_DIRS =
  1869. # The DIAFILE_DIRS tag can be used to specify one or more directories that
  1870. # contain dia files that are included in the documentation (see the \diafile
  1871. # command).
  1872. DIAFILE_DIRS =
  1873. # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
  1874. # path where java can find the plantuml.jar file. If left blank, it is assumed
  1875. # PlantUML is not used or called during a preprocessing step. Doxygen will
  1876. # generate a warning when it encounters a \startuml command in this case and
  1877. # will not generate output for the diagram.
  1878. PLANTUML_JAR_PATH =
  1879. # When using plantuml, the specified paths are searched for files specified by
  1880. # the !include statement in a plantuml block.
  1881. PLANTUML_INCLUDE_PATH =
  1882. # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
  1883. # that will be shown in the graph. If the number of nodes in a graph becomes
  1884. # larger than this value, doxygen will truncate the graph, which is visualized
  1885. # by representing a node as a red box. Note that doxygen if the number of direct
  1886. # children of the root node in a graph is already larger than
  1887. # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
  1888. # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  1889. # Minimum value: 0, maximum value: 10000, default value: 50.
  1890. # This tag requires that the tag HAVE_DOT is set to YES.
  1891. DOT_GRAPH_MAX_NODES = 50
  1892. # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
  1893. # generated by dot. A depth value of 3 means that only nodes reachable from the
  1894. # root by following a path via at most 3 edges will be shown. Nodes that lay
  1895. # further from the root node will be omitted. Note that setting this option to 1
  1896. # or 2 may greatly reduce the computation time needed for large code bases. Also
  1897. # note that the size of a graph can be further restricted by
  1898. # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  1899. # Minimum value: 0, maximum value: 1000, default value: 0.
  1900. # This tag requires that the tag HAVE_DOT is set to YES.
  1901. MAX_DOT_GRAPH_DEPTH = 0
  1902. # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  1903. # background. This is disabled by default, because dot on Windows does not seem
  1904. # to support this out of the box.
  1905. #
  1906. # Warning: Depending on the platform used, enabling this option may lead to
  1907. # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
  1908. # read).
  1909. # The default value is: NO.
  1910. # This tag requires that the tag HAVE_DOT is set to YES.
  1911. DOT_TRANSPARENT = NO
  1912. # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
  1913. # files in one run (i.e. multiple -o and -T options on the command line). This
  1914. # makes dot run faster, but since only newer versions of dot (>1.8.10) support
  1915. # this, this feature is disabled by default.
  1916. # The default value is: NO.
  1917. # This tag requires that the tag HAVE_DOT is set to YES.
  1918. DOT_MULTI_TARGETS = NO
  1919. # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
  1920. # explaining the meaning of the various boxes and arrows in the dot generated
  1921. # graphs.
  1922. # The default value is: YES.
  1923. # This tag requires that the tag HAVE_DOT is set to YES.
  1924. GENERATE_LEGEND = YES
  1925. # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
  1926. # files that are used to generate the various graphs.
  1927. # The default value is: YES.
  1928. # This tag requires that the tag HAVE_DOT is set to YES.
  1929. DOT_CLEANUP = YES
Tip!

Press p or to see the previous file or, n or to see the next file

Comments

Loading...