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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>man.doxy Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.8.0 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">man.doxy</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor"># Doxyfile 1.7.6</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span>
<a name="l00003"></a>00003 <span class="preprocessor"># This file describes the settings to be used by the documentation system</span>
<a name="l00004"></a>00004 <span class="preprocessor"></span><span class="preprocessor"># doxygen (www.doxygen.org) for a project</span>
<a name="l00005"></a>00005 <span class="preprocessor"></span><span class="preprocessor">#</span>
<a name="l00006"></a>00006 <span class="preprocessor"></span><span class="preprocessor"># All text after a hash (#) is considered a comment and will be ignored</span>
<a name="l00007"></a>00007 <span class="preprocessor"></span><span class="preprocessor"># The format is:</span>
<a name="l00008"></a>00008 <span class="preprocessor"></span><span class="preprocessor"># TAG = value [value, ...]</span>
<a name="l00009"></a>00009 <span class="preprocessor"></span><span class="preprocessor"># For lists items can also be appended using:</span>
<a name="l00010"></a>00010 <span class="preprocessor"></span><span class="preprocessor"># TAG += value [value, ...]</span>
<a name="l00011"></a>00011 <span class="preprocessor"></span><span class="preprocessor"># Values that contain spaces should be placed between quotes (" ")</span>
<a name="l00012"></a>00012 <span class="preprocessor"></span>
<a name="l00013"></a>00013 <span class="preprocessor">#---------------------------------------------------------------------------</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span><span class="preprocessor"># Project related configuration options</span>
<a name="l00015"></a>00015 <span class="preprocessor"></span><span class="preprocessor">#---------------------------------------------------------------------------</span>
<a name="l00016"></a>00016 <span class="preprocessor"></span>
<a name="l00017"></a>00017 <span class="preprocessor"># This tag specifies the encoding used for all characters in the config file </span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor"># that follow. The default is UTF-8 which is also the encoding used for all </span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor"># text before the first occurrence of this tag. Doxygen uses libiconv (or the </span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor"># iconv built into libc) for the transcoding. See </span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor"># http://www.gnu.org/software/libiconv for the list of possible encodings.</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00023"></a>00023 DOXYFILE_ENCODING = UTF-8
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="preprocessor"># The PROJECT_NAME tag is a single word (or sequence of words) that should </span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor"># identify the project. Note that if you do not use Doxywizard you need </span>
<a name="l00027"></a>00027 <span class="preprocessor"></span><span class="preprocessor"># to put quotes around the project name if it contains spaces.</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span>
<a name="l00029"></a>00029 PROJECT_NAME =
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="preprocessor"># The PROJECT_NUMBER tag can be used to enter a project or revision number. </span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor"># This could be handy for archiving the generated documentation or </span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor"># if some version control system is used.</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span>
<a name="l00035"></a>00035 PROJECT_NUMBER = 0.9.3
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="preprocessor"># Using the PROJECT_BRIEF tag one can provide an optional one line description </span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor"># for a project that appears at the top of each page and should give viewer </span>
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor"># a quick idea about the purpose of the project. Keep the description short.</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span>
<a name="l00041"></a>00041 PROJECT_BRIEF =
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="preprocessor"># With the PROJECT_LOGO tag one can specify an logo or icon that is </span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor"># included in the documentation. The maximum height of the logo should not </span>
<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor"># exceed 55 pixels and the maximum width should not exceed 200 pixels. </span>
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="preprocessor"># Doxygen will copy the logo to the output directory.</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span>
<a name="l00048"></a>00048 PROJECT_LOGO = ./image/logo-mini.png
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="preprocessor"># The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) </span>
<a name="l00051"></a>00051 <span class="preprocessor"></span><span class="preprocessor"># base path where the generated documentation will be put. </span>
<a name="l00052"></a>00052 <span class="preprocessor"></span><span class="preprocessor"># If a relative path is entered, it will be relative to the location </span>
<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor"># where doxygen was started. If left blank the current directory will be used.</span>
<a name="l00054"></a>00054 <span class="preprocessor"></span>
<a name="l00055"></a>00055 OUTPUT_DIRECTORY = .
<a name="l00056"></a>00056
<a name="l00057"></a>00057 # If the CREATE_SUBDIRS tag is <span class="keyword">set</span> to YES, then doxygen will create
<a name="l00058"></a>00058 <span class="preprocessor"># 4096 sub-directories (in 2 levels) under the output directory of each output </span>
<a name="l00059"></a>00059 <span class="preprocessor"></span><span class="preprocessor"># format and will distribute the generated files over these directories. </span>
<a name="l00060"></a>00060 <span class="preprocessor"></span><span class="preprocessor"># Enabling this option can be useful when feeding doxygen a huge amount of </span>
<a name="l00061"></a>00061 <span class="preprocessor"></span><span class="preprocessor"># source files, where putting all generated files in the same directory would </span>
<a name="l00062"></a>00062 <span class="preprocessor"></span><span class="preprocessor"># otherwise cause performance problems for the file system.</span>
<a name="l00063"></a>00063 <span class="preprocessor"></span>
<a name="l00064"></a>00064 CREATE_SUBDIRS = NO
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="preprocessor"># The OUTPUT_LANGUAGE tag is used to specify the language in which all </span>
<a name="l00067"></a>00067 <span class="preprocessor"></span><span class="preprocessor"># documentation generated by doxygen is written. Doxygen will use this </span>
<a name="l00068"></a>00068 <span class="preprocessor"></span><span class="preprocessor"># information to generate all constant output in the proper language. </span>
<a name="l00069"></a>00069 <span class="preprocessor"></span><span class="preprocessor"># The default language is English, other supported languages are: </span>
<a name="l00070"></a>00070 <span class="preprocessor"></span><span class="preprocessor"># Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, </span>
<a name="l00071"></a>00071 <span class="preprocessor"></span><span class="preprocessor"># Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, </span>
<a name="l00072"></a>00072 <span class="preprocessor"></span><span class="preprocessor"># Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English </span>
<a name="l00073"></a>00073 <span class="preprocessor"></span><span class="preprocessor"># messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, </span>
<a name="l00074"></a>00074 <span class="preprocessor"></span><span class="preprocessor"># Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, </span>
<a name="l00075"></a>00075 <span class="preprocessor"></span><span class="preprocessor"># Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.</span>
<a name="l00076"></a>00076 <span class="preprocessor"></span>
<a name="l00077"></a>00077 OUTPUT_LANGUAGE = English
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="preprocessor"># If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will </span>
<a name="l00080"></a>00080 <span class="preprocessor"></span><span class="preprocessor"># include brief member descriptions after the members that are listed in </span>
<a name="l00081"></a>00081 <span class="preprocessor"></span><span class="preprocessor"># the file and class documentation (similar to JavaDoc). </span>
<a name="l00082"></a>00082 <span class="preprocessor"></span><span class="preprocessor"># Set to NO to disable this.</span>
<a name="l00083"></a>00083 <span class="preprocessor"></span>
<a name="l00084"></a>00084 BRIEF_MEMBER_DESC = NO
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="preprocessor"># If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend </span>
<a name="l00087"></a>00087 <span class="preprocessor"></span><span class="preprocessor"># the brief description of a member or function before the detailed description. </span>
<a name="l00088"></a>00088 <span class="preprocessor"></span><span class="preprocessor"># Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the </span>
<a name="l00089"></a>00089 <span class="preprocessor"></span><span class="preprocessor"># brief descriptions will be completely suppressed.</span>
<a name="l00090"></a>00090 <span class="preprocessor"></span>
<a name="l00091"></a>00091 REPEAT_BRIEF = YES
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="preprocessor"># This tag implements a quasi-intelligent brief description abbreviator </span>
<a name="l00094"></a>00094 <span class="preprocessor"></span><span class="preprocessor"># that is used to form the text in various listings. Each string </span>
<a name="l00095"></a>00095 <span class="preprocessor"></span><span class="preprocessor"># in this list, if found as the leading text of the brief description, will be </span>
<a name="l00096"></a>00096 <span class="preprocessor"></span><span class="preprocessor"># stripped from the text and the result after processing the whole list, is </span>
<a name="l00097"></a>00097 <span class="preprocessor"></span><span class="preprocessor"># used as the annotated text. Otherwise, the brief description is used as-is. </span>
<a name="l00098"></a>00098 <span class="preprocessor"></span><span class="preprocessor"># If left blank, the following values are used ("$name" is automatically </span>
<a name="l00099"></a>00099 <span class="preprocessor"></span><span class="preprocessor"># replaced with the name of the entity): "The $name class" "The $name widget" </span>
<a name="l00100"></a>00100 <span class="preprocessor"></span><span class="preprocessor"># "The $name file" "is" "provides" "specifies" "contains" </span>
<a name="l00101"></a>00101 <span class="preprocessor"></span><span class="preprocessor"># "represents" "a" "an" "the"</span>
<a name="l00102"></a>00102 <span class="preprocessor"></span>
<a name="l00103"></a>00103 ABBREVIATE_BRIEF = <span class="stringliteral">"The $name class "</span> \
<a name="l00104"></a>00104 <span class="stringliteral">"The $name widget "</span> \
<a name="l00105"></a>00105 <span class="stringliteral">"The $name file "</span> \
<a name="l00106"></a>00106 is \
<a name="l00107"></a>00107 provides \
<a name="l00108"></a>00108 specifies \
<a name="l00109"></a>00109 contains \
<a name="l00110"></a>00110 represents \
<a name="l00111"></a>00111 a \
<a name="l00112"></a>00112 an \
<a name="l00113"></a>00113 the
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="preprocessor"># If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then </span>
<a name="l00116"></a>00116 <span class="preprocessor"></span><span class="preprocessor"># Doxygen will generate a detailed section even if there is only a brief </span>
<a name="l00117"></a>00117 <span class="preprocessor"></span><span class="preprocessor"># description.</span>
<a name="l00118"></a>00118 <span class="preprocessor"></span>
<a name="l00119"></a>00119 ALWAYS_DETAILED_SEC = NO
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="preprocessor"># If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all </span>
<a name="l00122"></a>00122 <span class="preprocessor"></span><span class="preprocessor"># inherited members of a class in the documentation of that class as if those </span>
<a name="l00123"></a>00123 <span class="preprocessor"></span><span class="preprocessor"># members were ordinary class members. Constructors, destructors and assignment </span>
<a name="l00124"></a>00124 <span class="preprocessor"></span><span class="preprocessor"># operators of the base classes will not be shown.</span>
<a name="l00125"></a>00125 <span class="preprocessor"></span>
<a name="l00126"></a>00126 INLINE_INHERITED_MEMB = NO
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="preprocessor"># If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full </span>
<a name="l00129"></a>00129 <span class="preprocessor"></span><span class="preprocessor"># path before files name in the file list and in the header files. If set </span>
<a name="l00130"></a>00130 <span class="preprocessor"></span><span class="preprocessor"># to NO the shortest path that makes the file name unique will be used.</span>
<a name="l00131"></a>00131 <span class="preprocessor"></span>
<a name="l00132"></a>00132 FULL_PATH_NAMES = NO
<a name="l00133"></a>00133
<a name="l00134"></a>00134 <span class="preprocessor"># If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag </span>
<a name="l00135"></a>00135 <span class="preprocessor"></span><span class="preprocessor"># can be used to strip a user-defined part of the path. Stripping is </span>
<a name="l00136"></a>00136 <span class="preprocessor"></span><span class="preprocessor"># only done if one of the specified strings matches the left-hand part of </span>
<a name="l00137"></a>00137 <span class="preprocessor"></span><span class="preprocessor"># the path. The tag can be used to show relative paths in the file list. </span>
<a name="l00138"></a>00138 <span class="preprocessor"></span><span class="preprocessor"># If left blank the directory from which doxygen is run is used as the </span>
<a name="l00139"></a>00139 <span class="preprocessor"></span><span class="preprocessor"># path to strip.</span>
<a name="l00140"></a>00140 <span class="preprocessor"></span>
<a name="l00141"></a>00141 STRIP_FROM_PATH = <span class="stringliteral">"C:/Documents and Settings/Groove/ "</span>
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="preprocessor"># The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of </span>
<a name="l00144"></a>00144 <span class="preprocessor"></span><span class="preprocessor"># the path mentioned in the documentation of a class, which tells </span>
<a name="l00145"></a>00145 <span class="preprocessor"></span><span class="preprocessor"># the reader which header file to include in order to use a class. </span>
<a name="l00146"></a>00146 <span class="preprocessor"></span><span class="preprocessor"># If left blank only the name of the header file containing the class </span>
<a name="l00147"></a>00147 <span class="preprocessor"></span><span class="preprocessor"># definition is used. Otherwise one should specify the include paths that </span>
<a name="l00148"></a>00148 <span class="preprocessor"></span><span class="preprocessor"># are normally passed to the compiler using the -I flag.</span>
<a name="l00149"></a>00149 <span class="preprocessor"></span>
<a name="l00150"></a>00150 STRIP_FROM_INC_PATH =
<a name="l00151"></a>00151
<a name="l00152"></a>00152 <span class="preprocessor"># If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter </span>
<a name="l00153"></a>00153 <span class="preprocessor"></span><span class="preprocessor"># (but less readable) file names. This can be useful if your file system </span>
<a name="l00154"></a>00154 <span class="preprocessor"></span><span class="preprocessor"># doesn't support long names like on DOS, Mac, or CD-ROM.</span>
<a name="l00155"></a>00155 <span class="preprocessor"></span>
<a name="l00156"></a>00156 SHORT_NAMES = YES
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="preprocessor"># If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen </span>
<a name="l00159"></a>00159 <span class="preprocessor"></span><span class="preprocessor"># will interpret the first line (until the first dot) of a JavaDoc-style </span>
<a name="l00160"></a>00160 <span class="preprocessor"></span><span class="preprocessor"># comment as the brief description. If set to NO, the JavaDoc </span>
<a name="l00161"></a>00161 <span class="preprocessor"></span><span class="preprocessor"># comments will behave just like regular Qt-style comments </span>
<a name="l00162"></a>00162 <span class="preprocessor"></span><span class="preprocessor"># (thus requiring an explicit @brief command for a brief description.)</span>
<a name="l00163"></a>00163 <span class="preprocessor"></span>
<a name="l00164"></a>00164 JAVADOC_AUTOBRIEF = YES
<a name="l00165"></a>00165
<a name="l00166"></a>00166 <span class="preprocessor"># If the QT_AUTOBRIEF tag is set to YES then Doxygen will </span>
<a name="l00167"></a>00167 <span class="preprocessor"></span><span class="preprocessor"># interpret the first line (until the first dot) of a Qt-style </span>
<a name="l00168"></a>00168 <span class="preprocessor"></span><span class="preprocessor"># comment as the brief description. If set to NO, the comments </span>
<a name="l00169"></a>00169 <span class="preprocessor"></span><span class="preprocessor"># will behave just like regular Qt-style comments (thus requiring </span>
<a name="l00170"></a>00170 <span class="preprocessor"></span><span class="preprocessor"># an explicit \brief command for a brief description.)</span>
<a name="l00171"></a>00171 <span class="preprocessor"></span>
<a name="l00172"></a>00172 QT_AUTOBRIEF = NO
<a name="l00173"></a>00173
<a name="l00174"></a>00174 <span class="preprocessor"># The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen </span>
<a name="l00175"></a>00175 <span class="preprocessor"></span><span class="preprocessor"># treat a multi-line C++ special comment block (i.e. a block of //! or /// </span>
<a name="l00176"></a>00176 <span class="preprocessor"></span><span class="preprocessor"># comments) as a brief description. This used to be the default behaviour. </span>
<a name="l00177"></a>00177 <span class="preprocessor"></span><span class="preprocessor"># The new default is to treat a multi-line C++ comment block as a detailed </span>
<a name="l00178"></a>00178 <span class="preprocessor"></span><span class="preprocessor"># description. Set this tag to YES if you prefer the old behaviour instead.</span>
<a name="l00179"></a>00179 <span class="preprocessor"></span>
<a name="l00180"></a>00180 MULTILINE_CPP_IS_BRIEF = NO
<a name="l00181"></a>00181
<a name="l00182"></a>00182 <span class="preprocessor"># If the INHERIT_DOCS tag is set to YES (the default) then an undocumented </span>
<a name="l00183"></a>00183 <span class="preprocessor"></span><span class="preprocessor"># member inherits the documentation from any documented member that it </span>
<a name="l00184"></a>00184 <span class="preprocessor"></span><span class="preprocessor"># re-implements.</span>
<a name="l00185"></a>00185 <span class="preprocessor"></span>
<a name="l00186"></a>00186 INHERIT_DOCS = YES
<a name="l00187"></a>00187
<a name="l00188"></a>00188 <span class="preprocessor"># If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce </span>
<a name="l00189"></a>00189 <span class="preprocessor"></span><span class="preprocessor"># a new page for each member. If set to NO, the documentation of a member will </span>
<a name="l00190"></a>00190 <span class="preprocessor"></span><span class="preprocessor"># be part of the file/class/namespace that contains it.</span>
<a name="l00191"></a>00191 <span class="preprocessor"></span>
<a name="l00192"></a>00192 SEPARATE_MEMBER_PAGES = NO
<a name="l00193"></a>00193
<a name="l00194"></a>00194 <span class="preprocessor"># The TAB_SIZE tag can be used to set the number of spaces in a tab. </span>
<a name="l00195"></a>00195 <span class="preprocessor"></span><span class="preprocessor"># Doxygen uses this value to replace tabs by spaces in code fragments.</span>
<a name="l00196"></a>00196 <span class="preprocessor"></span>
<a name="l00197"></a>00197 TAB_SIZE = 8
<a name="l00198"></a>00198
<a name="l00199"></a>00199 <span class="preprocessor"># This tag can be used to specify a number of aliases that acts </span>
<a name="l00200"></a>00200 <span class="preprocessor"></span><span class="preprocessor"># as commands in the documentation. An alias has the form "name=value". </span>
<a name="l00201"></a>00201 <span class="preprocessor"></span><span class="preprocessor"># For example adding "sideeffect=\par Side Effects:\n" will allow you to </span>
<a name="l00202"></a>00202 <span class="preprocessor"></span><span class="preprocessor"># put the command \sideeffect (or @sideeffect) in the documentation, which </span>
<a name="l00203"></a>00203 <span class="preprocessor"></span><span class="preprocessor"># will result in a user-defined paragraph with heading "Side Effects:". </span>
<a name="l00204"></a>00204 <span class="preprocessor"></span><span class="preprocessor"># You can put \n's in the value part of an alias to insert newlines.</span>
<a name="l00205"></a>00205 <span class="preprocessor"></span>
<a name="l00206"></a>00206 ALIASES =
<a name="l00207"></a>00207
<a name="l00208"></a>00208 <span class="preprocessor"># This tag can be used to specify a number of word-keyword mappings (TCL only). </span>
<a name="l00209"></a>00209 <span class="preprocessor"></span><span class="preprocessor"># A mapping has the form "name=value". For example adding </span>
<a name="l00210"></a>00210 <span class="preprocessor"></span><span class="preprocessor"># "class=itcl::class" will allow you to use the command class in the </span>
<a name="l00211"></a>00211 <span class="preprocessor"></span><span class="preprocessor"># itcl::class meaning.</span>
<a name="l00212"></a>00212 <span class="preprocessor"></span>
<a name="l00213"></a>00213 TCL_SUBST =
<a name="l00214"></a>00214
<a name="l00215"></a>00215 <span class="preprocessor"># Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C </span>
<a name="l00216"></a>00216 <span class="preprocessor"></span><span class="preprocessor"># sources only. Doxygen will then generate output that is more tailored for C. </span>
<a name="l00217"></a>00217 <span class="preprocessor"></span><span class="preprocessor"># For instance, some of the names that are used will be different. The list </span>
<a name="l00218"></a>00218 <span class="preprocessor"></span><span class="preprocessor"># of all members will be omitted, etc.</span>
<a name="l00219"></a>00219 <span class="preprocessor"></span>
<a name="l00220"></a>00220 OPTIMIZE_OUTPUT_FOR_C = NO
<a name="l00221"></a>00221
<a name="l00222"></a>00222 <span class="preprocessor"># Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java </span>
<a name="l00223"></a>00223 <span class="preprocessor"></span><span class="preprocessor"># sources only. Doxygen will then generate output that is more tailored for </span>
<a name="l00224"></a>00224 <span class="preprocessor"></span><span class="preprocessor"># Java. For instance, namespaces will be presented as packages, qualified </span>
<a name="l00225"></a>00225 <span class="preprocessor"></span><span class="preprocessor"># scopes will look different, etc.</span>
<a name="l00226"></a>00226 <span class="preprocessor"></span>
<a name="l00227"></a>00227 OPTIMIZE_OUTPUT_JAVA = NO
<a name="l00228"></a>00228
<a name="l00229"></a>00229 <span class="preprocessor"># Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran </span>
<a name="l00230"></a>00230 <span class="preprocessor"></span><span class="preprocessor"># sources only. Doxygen will then generate output that is more tailored for </span>
<a name="l00231"></a>00231 <span class="preprocessor"></span><span class="preprocessor"># Fortran.</span>
<a name="l00232"></a>00232 <span class="preprocessor"></span>
<a name="l00233"></a>00233 OPTIMIZE_FOR_FORTRAN = NO
<a name="l00234"></a>00234
<a name="l00235"></a>00235 <span class="preprocessor"># Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL </span>
<a name="l00236"></a>00236 <span class="preprocessor"></span><span class="preprocessor"># sources. Doxygen will then generate output that is tailored for </span>
<a name="l00237"></a>00237 <span class="preprocessor"></span><span class="preprocessor"># VHDL.</span>
<a name="l00238"></a>00238 <span class="preprocessor"></span>
<a name="l00239"></a>00239 OPTIMIZE_OUTPUT_VHDL = NO
<a name="l00240"></a>00240
<a name="l00241"></a>00241 <span class="preprocessor"># Doxygen selects the parser to use depending on the extension of the files it </span>
<a name="l00242"></a>00242 <span class="preprocessor"></span><span class="preprocessor"># parses. With this tag you can assign which parser to use for a given extension. </span>
<a name="l00243"></a>00243 <span class="preprocessor"></span><span class="preprocessor"># Doxygen has a built-in mapping, but you can override or extend it using this </span>
<a name="l00244"></a>00244 <span class="preprocessor"></span><span class="preprocessor"># tag. The format is ext=language, where ext is a file extension, and language </span>
<a name="l00245"></a>00245 <span class="preprocessor"></span><span class="preprocessor"># is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, </span>
<a name="l00246"></a>00246 <span class="preprocessor"></span><span class="preprocessor"># C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make </span>
<a name="l00247"></a>00247 <span class="preprocessor"></span><span class="preprocessor"># doxygen treat .inc files as Fortran files (default is PHP), and .f files as C </span>
<a name="l00248"></a>00248 <span class="preprocessor"></span><span class="preprocessor"># (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions </span>
<a name="l00249"></a>00249 <span class="preprocessor"></span><span class="preprocessor"># you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.</span>
<a name="l00250"></a>00250 <span class="preprocessor"></span>
<a name="l00251"></a>00251 EXTENSION_MAPPING =
<a name="l00252"></a>00252
<a name="l00253"></a>00253 <span class="preprocessor"># If you use STL classes (i.e. std::string, std::vector, etc.) but do not want </span>
<a name="l00254"></a>00254 <span class="preprocessor"></span><span class="preprocessor"># to include (a tag file for) the STL sources as input, then you should </span>
<a name="l00255"></a>00255 <span class="preprocessor"></span><span class="preprocessor"># set this tag to YES in order to let doxygen match functions declarations and </span>
<a name="l00256"></a>00256 <span class="preprocessor"></span><span class="preprocessor"># definitions whose arguments contain STL classes (e.g. func(std::string); v.s. </span>
<a name="l00257"></a>00257 <span class="preprocessor"></span><span class="preprocessor"># func(std::string) {}). This also makes the inheritance and collaboration </span>
<a name="l00258"></a>00258 <span class="preprocessor"></span><span class="preprocessor"># diagrams that involve STL classes more complete and accurate.</span>
<a name="l00259"></a>00259 <span class="preprocessor"></span>
<a name="l00260"></a>00260 BUILTIN_STL_SUPPORT = NO
<a name="l00261"></a>00261
<a name="l00262"></a>00262 <span class="preprocessor"># If you use Microsoft's C++/CLI language, you should set this option to YES to </span>
<a name="l00263"></a>00263 <span class="preprocessor"></span><span class="preprocessor"># enable parsing support.</span>
<a name="l00264"></a>00264 <span class="preprocessor"></span>
<a name="l00265"></a>00265 CPP_CLI_SUPPORT = NO
<a name="l00266"></a>00266
<a name="l00267"></a>00267 <span class="preprocessor"># Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. </span>
<a name="l00268"></a>00268 <span class="preprocessor"></span><span class="preprocessor"># Doxygen will parse them like normal C++ but will assume all classes use public </span>
<a name="l00269"></a>00269 <span class="preprocessor"></span><span class="preprocessor"># instead of private inheritance when no explicit protection keyword is present.</span>
<a name="l00270"></a>00270 <span class="preprocessor"></span>
<a name="l00271"></a>00271 SIP_SUPPORT = NO
<a name="l00272"></a>00272
<a name="l00273"></a>00273 <span class="preprocessor"># For Microsoft's IDL there are propget and propput attributes to indicate getter </span>
<a name="l00274"></a>00274 <span class="preprocessor"></span><span class="preprocessor"># and setter methods for a property. Setting this option to YES (the default) </span>
<a name="l00275"></a>00275 <span class="preprocessor"></span><span class="preprocessor"># will make doxygen replace the get and set methods by a property in the </span>
<a name="l00276"></a>00276 <span class="preprocessor"></span><span class="preprocessor"># documentation. This will only work if the methods are indeed getting or </span>
<a name="l00277"></a>00277 <span class="preprocessor"></span><span class="preprocessor"># setting a simple type. If this is not the case, or you want to show the </span>
<a name="l00278"></a>00278 <span class="preprocessor"></span><span class="preprocessor"># methods anyway, you should set this option to NO.</span>
<a name="l00279"></a>00279 <span class="preprocessor"></span>
<a name="l00280"></a>00280 IDL_PROPERTY_SUPPORT = YES
<a name="l00281"></a>00281
<a name="l00282"></a>00282 <span class="preprocessor"># If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC </span>
<a name="l00283"></a>00283 <span class="preprocessor"></span><span class="preprocessor"># tag is set to YES, then doxygen will reuse the documentation of the first </span>
<a name="l00284"></a>00284 <span class="preprocessor"></span><span class="preprocessor"># member in the group (if any) for the other members of the group. By default </span>
<a name="l00285"></a>00285 <span class="preprocessor"></span><span class="preprocessor"># all members of a group must be documented explicitly.</span>
<a name="l00286"></a>00286 <span class="preprocessor"></span>
<a name="l00287"></a>00287 DISTRIBUTE_GROUP_DOC = NO
<a name="l00288"></a>00288
<a name="l00289"></a>00289 <span class="preprocessor"># Set the SUBGROUPING tag to YES (the default) to allow class member groups of </span>
<a name="l00290"></a>00290 <span class="preprocessor"></span><span class="preprocessor"># the same type (for instance a group of public functions) to be put as a </span>
<a name="l00291"></a>00291 <span class="preprocessor"></span><span class="preprocessor"># subgroup of that type (e.g. under the Public Functions section). Set it to </span>
<a name="l00292"></a>00292 <span class="preprocessor"></span><span class="preprocessor"># NO to prevent subgrouping. Alternatively, this can be done per class using </span>
<a name="l00293"></a>00293 <span class="preprocessor"></span><span class="preprocessor"># the \nosubgrouping command.</span>
<a name="l00294"></a>00294 <span class="preprocessor"></span>
<a name="l00295"></a>00295 SUBGROUPING = NO
<a name="l00296"></a>00296
<a name="l00297"></a>00297 <span class="preprocessor"># When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and </span>
<a name="l00298"></a>00298 <span class="preprocessor"></span><span class="preprocessor"># unions are shown inside the group in which they are included (e.g. using </span>
<a name="l00299"></a>00299 <span class="preprocessor"></span><span class="preprocessor"># @ingroup) instead of on a separate page (for HTML and Man pages) or </span>
<a name="l00300"></a>00300 <span class="preprocessor"></span><span class="preprocessor"># section (for LaTeX and RTF).</span>
<a name="l00301"></a>00301 <span class="preprocessor"></span>
<a name="l00302"></a>00302 INLINE_GROUPED_CLASSES = NO
<a name="l00303"></a>00303
<a name="l00304"></a>00304 <span class="preprocessor"># When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and </span>
<a name="l00305"></a>00305 <span class="preprocessor"></span><span class="preprocessor"># unions with only public data fields will be shown inline in the documentation </span>
<a name="l00306"></a>00306 <span class="preprocessor"></span><span class="preprocessor"># of the scope in which they are defined (i.e. file, namespace, or group </span>
<a name="l00307"></a>00307 <span class="preprocessor"></span><span class="preprocessor"># documentation), provided this scope is documented. If set to NO (the default), </span>
<a name="l00308"></a>00308 <span class="preprocessor"></span><span class="preprocessor"># structs, classes, and unions are shown on a separate page (for HTML and Man </span>
<a name="l00309"></a>00309 <span class="preprocessor"></span><span class="preprocessor"># pages) or section (for LaTeX and RTF).</span>
<a name="l00310"></a>00310 <span class="preprocessor"></span>
<a name="l00311"></a>00311 INLINE_SIMPLE_STRUCTS = NO
<a name="l00312"></a>00312
<a name="l00313"></a>00313 <span class="preprocessor"># When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum </span>
<a name="l00314"></a>00314 <span class="preprocessor"></span><span class="preprocessor"># is documented as struct, union, or enum with the name of the typedef. So </span>
<a name="l00315"></a>00315 <span class="preprocessor"></span><span class="preprocessor"># typedef struct TypeS {} TypeT, will appear in the documentation as a struct </span>
<a name="l00316"></a>00316 <span class="preprocessor"></span><span class="preprocessor"># with name TypeT. When disabled the typedef will appear as a member of a file, </span>
<a name="l00317"></a>00317 <span class="preprocessor"></span><span class="preprocessor"># namespace, or class. And the struct will be named TypeS. This can typically </span>
<a name="l00318"></a>00318 <span class="preprocessor"></span><span class="preprocessor"># be useful for C code in case the coding convention dictates that all compound </span>
<a name="l00319"></a>00319 <span class="preprocessor"></span><span class="preprocessor"># types are typedef'ed and only the typedef is referenced, never the tag name.</span>
<a name="l00320"></a>00320 <span class="preprocessor"></span>
<a name="l00321"></a>00321 TYPEDEF_HIDES_STRUCT = NO
<a name="l00322"></a>00322
<a name="l00323"></a>00323 <span class="preprocessor"># The SYMBOL_CACHE_SIZE determines the size of the internal cache use to </span>
<a name="l00324"></a>00324 <span class="preprocessor"></span><span class="preprocessor"># determine which symbols to keep in memory and which to flush to disk. </span>
<a name="l00325"></a>00325 <span class="preprocessor"></span><span class="preprocessor"># When the cache is full, less often used symbols will be written to disk. </span>
<a name="l00326"></a>00326 <span class="preprocessor"></span><span class="preprocessor"># For small to medium size projects (<1000 input files) the default value is </span>
<a name="l00327"></a>00327 <span class="preprocessor"></span><span class="preprocessor"># probably good enough. For larger projects a too small cache size can cause </span>
<a name="l00328"></a>00328 <span class="preprocessor"></span><span class="preprocessor"># doxygen to be busy swapping symbols to and from disk most of the time </span>
<a name="l00329"></a>00329 <span class="preprocessor"></span><span class="preprocessor"># causing a significant performance penalty. </span>
<a name="l00330"></a>00330 <span class="preprocessor"></span><span class="preprocessor"># If the system has enough physical memory increasing the cache will improve the </span>
<a name="l00331"></a>00331 <span class="preprocessor"></span><span class="preprocessor"># performance by keeping more symbols in memory. Note that the value works on </span>
<a name="l00332"></a>00332 <span class="preprocessor"></span><span class="preprocessor"># a logarithmic scale so increasing the size by one will roughly double the </span>
<a name="l00333"></a>00333 <span class="preprocessor"></span><span class="preprocessor"># memory usage. The cache size is given by this formula: </span>
<a name="l00334"></a>00334 <span class="preprocessor"></span><span class="preprocessor"># 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, </span>
<a name="l00335"></a>00335 <span class="preprocessor"></span><span class="preprocessor"># corresponding to a cache size of 2^16 = 65536 symbols</span>
<a name="l00336"></a>00336 <span class="preprocessor"></span>
<a name="l00337"></a>00337 SYMBOL_CACHE_SIZE = 0
<a name="l00338"></a>00338
<a name="l00339"></a>00339 <span class="preprocessor">#---------------------------------------------------------------------------</span>
<a name="l00340"></a>00340 <span class="preprocessor"></span><span class="preprocessor"># Build related configuration options</span>
<a name="l00341"></a>00341 <span class="preprocessor"></span><span class="preprocessor">#---------------------------------------------------------------------------</span>
<a name="l00342"></a>00342 <span class="preprocessor"></span>
<a name="l00343"></a>00343 <span class="preprocessor"># If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in </span>
<a name="l00344"></a>00344 <span class="preprocessor"></span><span class="preprocessor"># documentation are documented, even if no documentation was available. </span>
<a name="l00345"></a>00345 <span class="preprocessor"></span><span class="preprocessor"># Private class members and static file members will be hidden unless </span>
<a name="l00346"></a>00346 <span class="preprocessor"></span><span class="preprocessor"># the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES</span>
<a name="l00347"></a>00347 <span class="preprocessor"></span>
<a name="l00348"></a>00348 EXTRACT_ALL = NO
<a name="l00349"></a>00349
<a name="l00350"></a>00350 <span class="preprocessor"># If the EXTRACT_PRIVATE tag is set to YES all private members of a class </span>
<a name="l00351"></a>00351 <span class="preprocessor"></span><span class="preprocessor"># will be included in the documentation.</span>
<a name="l00352"></a>00352 <span class="preprocessor"></span>
<a name="l00353"></a>00353 EXTRACT_PRIVATE = NO
<a name="l00354"></a>00354
<a name="l00355"></a>00355 <span class="preprocessor"># If the EXTRACT_STATIC tag is set to YES all static members of a file </span>
<a name="l00356"></a>00356 <span class="preprocessor"></span><span class="preprocessor"># will be included in the documentation.</span>
<a name="l00357"></a>00357 <span class="preprocessor"></span>
<a name="l00358"></a>00358 EXTRACT_STATIC = YES
<a name="l00359"></a>00359
<a name="l00360"></a>00360 <span class="preprocessor"># If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) </span>
<a name="l00361"></a>00361 <span class="preprocessor"></span><span class="preprocessor"># defined locally in source files will be included in the documentation. </span>
<a name="l00362"></a>00362 <span class="preprocessor"></span><span class="preprocessor"># If set to NO only classes defined in header files are included.</span>
<a name="l00363"></a>00363 <span class="preprocessor"></span>
<a name="l00364"></a>00364 EXTRACT_LOCAL_CLASSES = NO
<a name="l00365"></a>00365
<a name="l00366"></a>00366 <span class="preprocessor"># This flag is only useful for Objective-C code. When set to YES local </span>
<a name="l00367"></a>00367 <span class="preprocessor"></span><span class="preprocessor"># methods, which are defined in the implementation section but not in </span>
<a name="l00368"></a>00368 <span class="preprocessor"></span><span class="preprocessor"># the interface are included in the documentation. </span>
<a name="l00369"></a>00369 <span class="preprocessor"></span><span class="preprocessor"># If set to NO (the default) only methods in the interface are included.</span>
<a name="l00370"></a>00370 <span class="preprocessor"></span>
<a name="l00371"></a>00371 EXTRACT_LOCAL_METHODS = NO
<a name="l00372"></a>00372
<a name="l00373"></a>00373 <span class="preprocessor"># If this flag is set to YES, the members of anonymous namespaces will be </span>
<a name="l00374"></a>00374 <span class="preprocessor"></span><span class="preprocessor"># extracted and appear in the documentation as a namespace called </span>
<a name="l00375"></a>00375 <span class="preprocessor"></span><span class="preprocessor"># 'anonymous_namespace{file}', where file will be replaced with the base </span>
<a name="l00376"></a>00376 <span class="preprocessor"></span><span class="preprocessor"># name of the file that contains the anonymous namespace. By default </span>
<a name="l00377"></a>00377 <span class="preprocessor"></span><span class="preprocessor"># anonymous namespaces are hidden.</span>
<a name="l00378"></a>00378 <span class="preprocessor"></span>
<a name="l00379"></a>00379 EXTRACT_ANON_NSPACES = NO
<a name="l00380"></a>00380
<a name="l00381"></a>00381 <span class="preprocessor"># If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all </span>
<a name="l00382"></a>00382 <span class="preprocessor"></span><span class="preprocessor"># undocumented members of documented classes, files or namespaces. </span>
<a name="l00383"></a>00383 <span class="preprocessor"></span><span class="preprocessor"># If set to NO (the default) these members will be included in the </span>
<a name="l00384"></a>00384 <span class="preprocessor"></span><span class="preprocessor"># various overviews, but no documentation section is generated. </span>
<a name="l00385"></a>00385 <span class="preprocessor"></span><span class="preprocessor"># This option has no effect if EXTRACT_ALL is enabled.</span>
<a name="l00386"></a>00386 <span class="preprocessor"></span>
<a name="l00387"></a>00387 HIDE_UNDOC_MEMBERS = YES
<a name="l00388"></a>00388
<a name="l00389"></a>00389 <span class="preprocessor"># If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all </span>
<a name="l00390"></a>00390 <span class="preprocessor"></span><span class="preprocessor"># undocumented classes that are normally visible in the class hierarchy. </span>
<a name="l00391"></a>00391 <span class="preprocessor"></span><span class="preprocessor"># If set to NO (the default) these classes will be included in the various </span>
<a name="l00392"></a>00392 <span class="preprocessor"></span><span class="preprocessor"># overviews. This option has no effect if EXTRACT_ALL is enabled.</span>
<a name="l00393"></a>00393 <span class="preprocessor"></span>
<a name="l00394"></a>00394 HIDE_UNDOC_CLASSES = YES
<a name="l00395"></a>00395
<a name="l00396"></a>00396 <span class="preprocessor"># If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all </span>
<a name="l00397"></a>00397 <span class="preprocessor"></span><span class="preprocessor"># friend (class|struct|union) declarations. </span>
<a name="l00398"></a>00398 <span class="preprocessor"></span><span class="preprocessor"># If set to NO (the default) these declarations will be included in the </span>
<a name="l00399"></a>00399 <span class="preprocessor"></span><span class="preprocessor"># documentation.</span>
<a name="l00400"></a>00400 <span class="preprocessor"></span>
<a name="l00401"></a>00401 HIDE_FRIEND_COMPOUNDS = YES
<a name="l00402"></a>00402
<a name="l00403"></a>00403 <span class="preprocessor"># If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any </span>
<a name="l00404"></a>00404 <span class="preprocessor"></span><span class="preprocessor"># documentation blocks found inside the body of a function. </span>
<a name="l00405"></a>00405 <span class="preprocessor"></span><span class="preprocessor"># If set to NO (the default) these blocks will be appended to the </span>
<a name="l00406"></a>00406 <span class="preprocessor"></span><span class="preprocessor"># function's detailed documentation block.</span>
<a name="l00407"></a>00407 <span class="preprocessor"></span>
<a name="l00408"></a>00408 HIDE_IN_BODY_DOCS = YES
<a name="l00409"></a>00409
<a name="l00410"></a>00410 <span class="preprocessor"># The INTERNAL_DOCS tag determines if documentation </span>
<a name="l00411"></a>00411 <span class="preprocessor"></span><span class="preprocessor"># that is typed after a \internal command is included. If the tag is set </span>
<a name="l00412"></a>00412 <span class="preprocessor"></span><span class="preprocessor"># to NO (the default) then the documentation will be excluded. </span>
<a name="l00413"></a>00413 <span class="preprocessor"></span><span class="preprocessor"># Set it to YES to include the internal documentation.</span>
<a name="l00414"></a>00414 <span class="preprocessor"></span>
<a name="l00415"></a>00415 INTERNAL_DOCS = NO
<a name="l00416"></a>00416
<a name="l00417"></a>00417 <span class="preprocessor"># If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate </span>
<a name="l00418"></a>00418 <span class="preprocessor"></span><span class="preprocessor"># file names in lower-case letters. If set to YES upper-case letters are also </span>
<a name="l00419"></a>00419 <span class="preprocessor"></span><span class="preprocessor"># allowed. This is useful if you have classes or files whose names only differ </span>
<a name="l00420"></a>00420 <span class="preprocessor"></span><span class="preprocessor"># in case and if your file system supports case sensitive file names. Windows </span>
<a name="l00421"></a>00421 <span class="preprocessor"></span><span class="preprocessor"># and Mac users are advised to set this option to NO.</span>
<a name="l00422"></a>00422 <span class="preprocessor"></span>
<a name="l00423"></a>00423 CASE_SENSE_NAMES = YES
<a name="l00424"></a>00424
<a name="l00425"></a>00425 <span class="preprocessor"># If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen </span>
<a name="l00426"></a>00426 <span class="preprocessor"></span><span class="preprocessor"># will show members with their full class and namespace scopes in the </span>
<a name="l00427"></a>00427 <span class="preprocessor"></span><span class="preprocessor"># documentation. If set to YES the scope will be hidden.</span>
<a name="l00428"></a>00428 <span class="preprocessor"></span>
<a name="l00429"></a>00429 HIDE_SCOPE_NAMES = YES
<a name="l00430"></a>00430
<a name="l00431"></a>00431 <span class="preprocessor"># If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen </span>
<a name="l00432"></a>00432 <span class="preprocessor"></span><span class="preprocessor"># will put a list of the files that are included by a file in the documentation </span>
<a name="l00433"></a>00433 <span class="preprocessor"></span><span class="preprocessor"># of that file.</span>
<a name="l00434"></a>00434 <span class="preprocessor"></span>
<a name="l00435"></a>00435 SHOW_INCLUDE_FILES = NO
<a name="l00436"></a>00436
<a name="l00437"></a>00437 <span class="preprocessor"># If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen </span>
<a name="l00438"></a>00438 <span class="preprocessor"></span><span class="preprocessor"># will list include files with double quotes in the documentation </span>
<a name="l00439"></a>00439 <span class="preprocessor"></span><span class="preprocessor"># rather than with sharp brackets.</span>
<a name="l00440"></a>00440 <span class="preprocessor"></span>
<a name="l00441"></a>00441 FORCE_LOCAL_INCLUDES = NO
<a name="l00442"></a>00442
<a name="l00443"></a>00443 <span class="preprocessor"># If the INLINE_INFO tag is set to YES (the default) then a tag [inline] </span>
<a name="l00444"></a>00444 <span class="preprocessor"></span><span class="preprocessor"># is inserted in the documentation for inline members.</span>
<a name="l00445"></a>00445 <span class="preprocessor"></span>
<a name="l00446"></a>00446 INLINE_INFO = NO
<a name="l00447"></a>00447
<a name="l00448"></a>00448 <span class="preprocessor"># If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen </span>
<a name="l00449"></a>00449 <span class="preprocessor"></span><span class="preprocessor"># will sort the (detailed) documentation of file and class members </span>
<a name="l00450"></a>00450 <span class="preprocessor"></span><span class="preprocessor"># alphabetically by member name. If set to NO the members will appear in </span>
<a name="l00451"></a>00451 <span class="preprocessor"></span><span class="preprocessor"># declaration order.</span>
<a name="l00452"></a>00452 <span class="preprocessor"></span>
<a name="l00453"></a>00453 SORT_MEMBER_DOCS = YES
<a name="l00454"></a>00454
<a name="l00455"></a>00455 <span class="preprocessor"># If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the </span>
<a name="l00456"></a>00456 <span class="preprocessor"></span><span class="preprocessor"># brief documentation of file, namespace and class members alphabetically </span>
<a name="l00457"></a>00457 <span class="preprocessor"></span><span class="preprocessor"># by member name. If set to NO (the default) the members will appear in </span>
<a name="l00458"></a>00458 <span class="preprocessor"></span><span class="preprocessor"># declaration order.</span>
<a name="l00459"></a>00459 <span class="preprocessor"></span>
<a name="l00460"></a>00460 SORT_BRIEF_DOCS = YES
<a name="l00461"></a>00461
<a name="l00462"></a>00462 <span class="preprocessor"># If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen </span>
<a name="l00463"></a>00463 <span class="preprocessor"></span><span class="preprocessor"># will sort the (brief and detailed) documentation of class members so that </span>
<a name="l00464"></a>00464 <span class="preprocessor"></span><span class="preprocessor"># constructors and destructors are listed first. If set to NO (the default) </span>
<a name="l00465"></a>00465 <span class="preprocessor"></span><span class="preprocessor"># the constructors will appear in the respective orders defined by </span>
<a name="l00466"></a>00466 <span class="preprocessor"></span><span class="preprocessor"># SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. </span>
<a name="l00467"></a>00467 <span class="preprocessor"></span><span class="preprocessor"># This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO </span>
<a name="l00468"></a>00468 <span class="preprocessor"></span><span class="preprocessor"># and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.</span>
<a name="l00469"></a>00469 <span class="preprocessor"></span>
<a name="l00470"></a>00470 SORT_MEMBERS_CTORS_1ST = NO
<a name="l00471"></a>00471
<a name="l00472"></a>00472 <span class="preprocessor"># If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the </span>
<a name="l00473"></a>00473 <span class="preprocessor"></span><span class="preprocessor"># hierarchy of group names into alphabetical order. If set to NO (the default) </span>
<a name="l00474"></a>00474 <span class="preprocessor"></span><span class="preprocessor"># the group names will appear in their defined order.</span>
<a name="l00475"></a>00475 <span class="preprocessor"></span>
<a name="l00476"></a>00476 SORT_GROUP_NAMES = NO
<a name="l00477"></a>00477
<a name="l00478"></a>00478 <span class="preprocessor"># If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be </span>
<a name="l00479"></a>00479 <span class="preprocessor"></span><span class="preprocessor"># sorted by fully-qualified names, including namespaces. If set to </span>
<a name="l00480"></a>00480 <span class="preprocessor"></span><span class="preprocessor"># NO (the default), the class list will be sorted only by class name, </span>
<a name="l00481"></a>00481 <span class="preprocessor"></span><span class="preprocessor"># not including the namespace part. </span>
<a name="l00482"></a>00482 <span class="preprocessor"></span><span class="preprocessor"># Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. </span>
<a name="l00483"></a>00483 <span class="preprocessor"></span><span class="preprocessor"># Note: This option applies only to the class list, not to the </span>
<a name="l00484"></a>00484 <span class="preprocessor"></span><span class="preprocessor"># alphabetical list.</span>
<a name="l00485"></a>00485 <span class="preprocessor"></span>
<a name="l00486"></a>00486 SORT_BY_SCOPE_NAME = YES
<a name="l00487"></a>00487
<a name="l00488"></a>00488 <span class="preprocessor"># If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to </span>
<a name="l00489"></a>00489 <span class="preprocessor"></span><span class="preprocessor"># do proper type resolution of all parameters of a function it will reject a </span>
<a name="l00490"></a>00490 <span class="preprocessor"></span><span class="preprocessor"># match between the prototype and the implementation of a member function even </span>
<a name="l00491"></a>00491 <span class="preprocessor"></span><span class="preprocessor"># if there is only one candidate or it is obvious which candidate to choose </span>
<a name="l00492"></a>00492 <span class="preprocessor"></span><span class="preprocessor"># by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen </span>
<a name="l00493"></a>00493 <span class="preprocessor"></span><span class="preprocessor"># will still accept a match between prototype and implementation in such cases.</span>
<a name="l00494"></a>00494 <span class="preprocessor"></span>
<a name="l00495"></a>00495 STRICT_PROTO_MATCHING = NO
<a name="l00496"></a>00496
<a name="l00497"></a>00497 <span class="preprocessor"># The GENERATE_TODOLIST tag can be used to enable (YES) or </span>
<a name="l00498"></a>00498 <span class="preprocessor"></span><span class="preprocessor"># disable (NO) the todo list. This list is created by putting \todo </span>
<a name="l00499"></a>00499 <span class="preprocessor"></span><span class="preprocessor"># commands in the documentation.</span>
<a name="l00500"></a>00500 <span class="preprocessor"></span>
<a name="l00501"></a>00501 GENERATE_TODOLIST = YES
<a name="l00502"></a>00502
<a name="l00503"></a>00503 <span class="preprocessor"># The GENERATE_TESTLIST tag can be used to enable (YES) or </span>
<a name="l00504"></a>00504 <span class="preprocessor"></span><span class="preprocessor"># disable (NO) the test list. This list is created by putting \test </span>
<a name="l00505"></a>00505 <span class="preprocessor"></span><span class="preprocessor"># commands in the documentation.</span>
<a name="l00506"></a>00506 <span class="preprocessor"></span>
<a name="l00507"></a>00507 GENERATE_TESTLIST = YES
<a name="l00508"></a>00508
<a name="l00509"></a>00509 <span class="preprocessor"># The GENERATE_BUGLIST tag can be used to enable (YES) or </span>
<a name="l00510"></a>00510 <span class="preprocessor"></span><span class="preprocessor"># disable (NO) the bug list. This list is created by putting \bug </span>
<a name="l00511"></a>00511 <span class="preprocessor"></span><span class="preprocessor"># commands in the documentation.</span>
<a name="l00512"></a>00512 <span class="preprocessor"></span>
<a name="l00513"></a>00513 GENERATE_BUGLIST = YES
<a name="l00514"></a>00514
<a name="l00515"></a>00515 <span class="preprocessor"># The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or </span>
<a name="l00516"></a>00516 <span class="preprocessor"></span><span class="preprocessor"># disable (NO) the deprecated list. This list is created by putting </span>
<a name="l00517"></a>00517 <span class="preprocessor"></span><span class="preprocessor"># \deprecated commands in the documentation.</span>
<a name="l00518"></a>00518 <span class="preprocessor"></span>
<a name="l00519"></a>00519 GENERATE_DEPRECATEDLIST= YES
<a name="l00520"></a>00520
<a name="l00521"></a>00521 <span class="preprocessor"># The ENABLED_SECTIONS tag can be used to enable conditional </span>
<a name="l00522"></a>00522 <span class="preprocessor"></span><span class="preprocessor"># documentation sections, marked by \if sectionname ... \endif.</span>
<a name="l00523"></a>00523 <span class="preprocessor"></span>
<a name="l00524"></a>00524 ENABLED_SECTIONS =
<a name="l00525"></a>00525
<a name="l00526"></a>00526 <span class="preprocessor"># The MAX_INITIALIZER_LINES tag determines the maximum number of lines </span>
<a name="l00527"></a>00527 <span class="preprocessor"></span><span class="preprocessor"># the initial value of a variable or macro consists of for it to appear in </span>
<a name="l00528"></a>00528 <span class="preprocessor"></span><span class="preprocessor"># the documentation. If the initializer consists of more lines than specified </span>
<a name="l00529"></a>00529 <span class="preprocessor"></span><span class="preprocessor"># here it will be hidden. Use a value of 0 to hide initializers completely. </span>
<a name="l00530"></a>00530 <span class="preprocessor"></span><span class="preprocessor"># The appearance of the initializer of individual variables and macros in the </span>
<a name="l00531"></a>00531 <span class="preprocessor"></span><span class="preprocessor"># documentation can be controlled using \showinitializer or \hideinitializer </span>
<a name="l00532"></a>00532 <span class="preprocessor"></span><span class="preprocessor"># command in the documentation regardless of this setting.</span>
<a name="l00533"></a>00533 <span class="preprocessor"></span>
<a name="l00534"></a>00534 MAX_INITIALIZER_LINES = 30
<a name="l00535"></a>00535
<a name="l00536"></a>00536 <span class="preprocessor"># Set the SHOW_USED_FILES tag to NO to disable the list of files generated </span>
<a name="l00537"></a>00537 <span class="preprocessor"></span><span class="preprocessor"># at the bottom of the documentation of classes and structs. If set to YES the </span>
<a name="l00538"></a>00538 <span class="preprocessor"></span><span class="preprocessor"># list will mention the files that were used to generate the documentation.</span>
<a name="l00539"></a>00539 <span class="preprocessor"></span>
<a name="l00540"></a>00540 SHOW_USED_FILES = NO
<a name="l00541"></a>00541
<a name="l00542"></a>00542 <span class="preprocessor"># If the sources in your project are distributed over multiple directories </span>
<a name="l00543"></a>00543 <span class="preprocessor"></span><span class="preprocessor"># then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy </span>
<a name="l00544"></a>00544 <span class="preprocessor"></span><span class="preprocessor"># in the documentation. The default is NO.</span>
<a name="l00545"></a>00545 <span class="preprocessor"></span>
<a name="l00546"></a>00546 SHOW_DIRECTORIES = NO
<a name="l00547"></a>00547
<a name="l00548"></a>00548 <span class="preprocessor"># Set the SHOW_FILES tag to NO to disable the generation of the Files page. </span>
<a name="l00549"></a>00549 <span class="preprocessor"></span><span class="preprocessor"># This will remove the Files entry from the Quick Index and from the </span>
<a name="l00550"></a>00550 <span class="preprocessor"></span><span class="preprocessor"># Folder Tree View (if specified). The default is YES.</span>
<a name="l00551"></a>00551 <span class="preprocessor"></span>
<a name="l00552"></a>00552 SHOW_FILES = YES
<a name="l00553"></a>00553
<a name="l00554"></a>00554 <span class="preprocessor"># Set the SHOW_NAMESPACES tag to NO to disable the generation of the </span>
<a name="l00555"></a>00555 <span class="preprocessor"></span><span class="preprocessor"># Namespaces page. This will remove the Namespaces entry from the Quick Index </span>
<a name="l00556"></a>00556 <span class="preprocessor"></span><span class="preprocessor"># and from the Folder Tree View (if specified). The default is YES.</span>
<a name="l00557"></a>00557 <span class="preprocessor"></span>
<a name="l00558"></a>00558 SHOW_NAMESPACES = YES
<a name="l00559"></a>00559
<a name="l00560"></a>00560 <span class="preprocessor"># The FILE_VERSION_FILTER tag can be used to specify a program or script that </span>
<a name="l00561"></a>00561 <span class="preprocessor"></span><span class="preprocessor"># doxygen should invoke to get the current version for each file (typically from </span>
<a name="l00562"></a>00562 <span class="preprocessor"></span><span class="preprocessor"># the version control system). Doxygen will invoke the program by executing (via </span>
<a name="l00563"></a>00563 <span class="preprocessor"></span><span class="preprocessor"># popen()) the command <command> <input-file>, where <command> is the value of </span>
<a name="l00564"></a>00564 <span class="preprocessor"></span><span class="preprocessor"># the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file </span>
<a name="l00565"></a>00565 <span class="preprocessor"></span><span class="preprocessor"># provided by doxygen. Whatever the program writes to standard output </span>
<a name="l00566"></a>00566 <span class="preprocessor"></span><span class="preprocessor"># is used as the file version. See the manual for examples.</span>
<a name="l00567"></a>00567 <span class="preprocessor"></span>
<a name="l00568"></a>00568 FILE_VERSION_FILTER =
<a name="l00569"></a>00569
<a name="l00570"></a>00570 <span class="preprocessor"># The LAYOUT_FILE tag can be used to specify a layout file which will be parsed </span>
<a name="l00571"></a>00571 <span class="preprocessor"></span><span class="preprocessor"># by doxygen. The layout file controls the global structure of the generated </span>
<a name="l00572"></a>00572 <span class="preprocessor"></span><span class="preprocessor"># output files in an output format independent way. The create the layout file </span>
<a name="l00573"></a>00573 <span class="preprocessor"></span><span class="preprocessor"># that represents doxygen's defaults, run doxygen with the -l option. </span>
<a name="l00574"></a>00574 <span class="preprocessor"></span><span class="preprocessor"># You can optionally specify a file name after the option, if omitted </span>
<a name="l00575"></a>00575 <span class="preprocessor"></span><span class="preprocessor"># DoxygenLayout.xml will be used as the name of the layout file.</span>
<a name="l00576"></a>00576 <span class="preprocessor"></span>
<a name="l00577"></a>00577 LAYOUT_FILE =
<a name="l00578"></a>00578
<a name="l00579"></a>00579 <span class="preprocessor"># The CITE_BIB_FILES tag can be used to specify one or more bib files </span>
<a name="l00580"></a>00580 <span class="preprocessor"></span><span class="preprocessor"># containing the references data. This must be a list of .bib files. The </span>
<a name="l00581"></a>00581 <span class="preprocessor"></span><span class="preprocessor"># .bib extension is automatically appended if omitted. Using this command </span>
<a name="l00582"></a>00582 <span class="preprocessor"></span><span class="preprocessor"># requires the bibtex tool to be installed. See also </span>
<a name="l00583"></a>00583 <span class="preprocessor"></span><span class="preprocessor"># http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style </span>
<a name="l00584"></a>00584 <span class="preprocessor"></span><span class="preprocessor"># of the bibliography can be controlled using LATEX_BIB_STYLE. To use this</span>
<a name="l00585"></a>00585 <span class="preprocessor"></span><span class="preprocessor"># feature you need bibtex and perl available in the search path.</span>
<a name="l00586"></a>00586 <span class="preprocessor"></span>
<a name="l00587"></a>00587 CITE_BIB_FILES =
<a name="l00588"></a>00588
<a name="l00589"></a>00589 <span class="preprocessor">#---------------------------------------------------------------------------</span>
<a name="l00590"></a>00590 <span class="preprocessor"></span><span class="preprocessor"># configuration options related to warning and progress messages</span>
<a name="l00591"></a>00591 <span class="preprocessor"></span><span class="preprocessor">#---------------------------------------------------------------------------</span>
<a name="l00592"></a>00592 <span class="preprocessor"></span>
<a name="l00593"></a>00593 <span class="preprocessor"># The QUIET tag can be used to turn on/off the messages that are generated </span>
<a name="l00594"></a>00594 <span class="preprocessor"></span><span class="preprocessor"># by doxygen. Possible values are YES and NO. If left blank NO is used.</span>
<a name="l00595"></a>00595 <span class="preprocessor"></span>
<a name="l00596"></a>00596 QUIET = NO
<a name="l00597"></a>00597
<a name="l00598"></a>00598 <span class="preprocessor"># The WARNINGS tag can be used to turn on/off the warning messages that are </span>
<a name="l00599"></a>00599 <span class="preprocessor"></span><span class="preprocessor"># generated by doxygen. Possible values are YES and NO. If left blank </span>
<a name="l00600"></a>00600 <span class="preprocessor"></span><span class="preprocessor"># NO is used.</span>
<a name="l00601"></a>00601 <span class="preprocessor"></span>
<a name="l00602"></a>00602 WARNINGS = YES
<a name="l00603"></a>00603
<a name="l00604"></a>00604 <span class="preprocessor"># If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings </span>
<a name="l00605"></a>00605 <span class="preprocessor"></span><span class="preprocessor"># for undocumented members. If EXTRACT_ALL is set to YES then this flag will </span>
<a name="l00606"></a>00606 <span class="preprocessor"></span><span class="preprocessor"># automatically be disabled.</span>
<a name="l00607"></a>00607 <span class="preprocessor"></span>
<a name="l00608"></a>00608 WARN_IF_UNDOCUMENTED = YES
<a name="l00609"></a>00609
<a name="l00610"></a>00610 <span class="preprocessor"># If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for </span>
<a name="l00611"></a>00611 <span class="preprocessor"></span><span class="preprocessor"># potential errors in the documentation, such as not documenting some </span>
<a name="l00612"></a>00612 <span class="preprocessor"></span><span class="preprocessor"># parameters in a documented function, or documenting parameters that </span>
<a name="l00613"></a>00613 <span class="preprocessor"></span><span class="preprocessor"># don't exist or using markup commands wrongly.</span>
<a name="l00614"></a>00614 <span class="preprocessor"></span>
<a name="l00615"></a>00615 WARN_IF_DOC_ERROR = YES
<a name="l00616"></a>00616
<a name="l00617"></a>00617 <span class="preprocessor"># The WARN_NO_PARAMDOC option can be enabled to get warnings for </span>
<a name="l00618"></a>00618 <span class="preprocessor"></span><span class="preprocessor"># functions that are documented, but have no documentation for their parameters </span>
<a name="l00619"></a>00619 <span class="preprocessor"></span><span class="preprocessor"># or return value. If set to NO (the default) doxygen will only warn about </span>
<a name="l00620"></a>00620 <span class="preprocessor"></span><span class="preprocessor"># wrong or incomplete parameter documentation, but not about the absence of </span>
<a name="l00621"></a>00621 <span class="preprocessor"></span><span class="preprocessor"># documentation.</span>
<a name="l00622"></a>00622 <span class="preprocessor"></span>
<a name="l00623"></a>00623 WARN_NO_PARAMDOC = NO
<a name="l00624"></a>00624
<a name="l00625"></a>00625 <span class="preprocessor"># The WARN_FORMAT tag determines the format of the warning messages that </span>
<a name="l00626"></a>00626 <span class="preprocessor"></span><span class="preprocessor"># doxygen can produce. The string should contain the $file, $line, and $text </span>
<a name="l00627"></a>00627 <span class="preprocessor"></span><span class="preprocessor"># tags, which will be replaced by the file and line number from which the </span>
<a name="l00628"></a>00628 <span class="preprocessor"></span><span class="preprocessor"># warning originated and the warning text. Optionally the format may contain </span>
<a name="l00629"></a>00629 <span class="preprocessor"></span><span class="preprocessor"># $version, which will be replaced by the version of the file (if it could </span>
<a name="l00630"></a>00630 <span class="preprocessor"></span><span class="preprocessor"># be obtained via FILE_VERSION_FILTER)</span>
<a name="l00631"></a>00631 <span class="preprocessor"></span>
<a name="l00632"></a>00632 WARN_FORMAT = <span class="stringliteral">"$file:$line: $text"</span>
<a name="l00633"></a>00633
<a name="l00634"></a>00634 <span class="preprocessor"># The WARN_LOGFILE tag can be used to specify a file to which warning </span>
<a name="l00635"></a>00635 <span class="preprocessor"></span><span class="preprocessor"># and error messages should be written. If left blank the output is written </span>
<a name="l00636"></a>00636 <span class="preprocessor"></span><span class="preprocessor"># to stderr.</span>
<a name="l00637"></a>00637 <span class="preprocessor"></span>
<a name="l00638"></a>00638 WARN_LOGFILE =
<a name="l00639"></a>00639
<a name="l00640"></a>00640 <span class="preprocessor">#---------------------------------------------------------------------------</span>
<a name="l00641"></a>00641 <span class="preprocessor"></span><span class="preprocessor"># configuration options related to the input files</span>
<a name="l00642"></a>00642 <span class="preprocessor"></span><span class="preprocessor">#---------------------------------------------------------------------------</span>
<a name="l00643"></a>00643 <span class="preprocessor"></span>
<a name="l00644"></a>00644 <span class="preprocessor"># The INPUT tag can be used to specify the files and/or directories that contain </span>
<a name="l00645"></a>00645 <span class="preprocessor"></span><span class="preprocessor"># documented source files. You may enter file names like "myfile.cpp" or </span>
<a name="l00646"></a>00646 <span class="preprocessor"></span><span class="preprocessor"># directories like "/usr/src/myproject". Separate the files or directories </span>
<a name="l00647"></a>00647 <span class="preprocessor"></span><span class="preprocessor"># with spaces.</span>
<a name="l00648"></a>00648 <span class="preprocessor"></span>
<a name="l00649"></a>00649 INPUT = ../glm \
<a name="l00650"></a>00650 .
<a name="l00651"></a>00651
<a name="l00652"></a>00652 # This tag can be used to specify the character encoding of the source files
<a name="l00653"></a>00653 <span class="preprocessor"># that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is </span>
<a name="l00654"></a>00654 <span class="preprocessor"></span><span class="preprocessor"># also the default input encoding. Doxygen uses libiconv (or the iconv built </span>
<a name="l00655"></a>00655 <span class="preprocessor"></span><span class="preprocessor"># into libc) for the transcoding. See http://www.gnu.org/software/libiconv for </span>
<a name="l00656"></a>00656 <span class="preprocessor"></span><span class="preprocessor"># the list of possible encodings.</span>
<a name="l00657"></a>00657 <span class="preprocessor"></span>
<a name="l00658"></a>00658 INPUT_ENCODING = UTF-8
<a name="l00659"></a>00659
<a name="l00660"></a>00660 <span class="preprocessor"># If the value of the INPUT tag contains directories, you can use the </span>
<a name="l00661"></a>00661 <span class="preprocessor"></span><span class="preprocessor"># FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp </span>
<a name="l00662"></a>00662 <span class="preprocessor"></span><span class="preprocessor"># and *.h) to filter out the source-files in the directories. If left </span>
<a name="l00663"></a>00663 <span class="preprocessor"></span><span class="preprocessor"># blank the following patterns are tested: </span>
<a name="l00664"></a>00664 <span class="preprocessor"></span><span class="preprocessor"># *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh </span>
<a name="l00665"></a>00665 <span class="preprocessor"></span><span class="preprocessor"># *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py </span>
<a name="l00666"></a>00666 <span class="preprocessor"></span><span class="preprocessor"># *.f90 *.f *.for *.vhd *.vhdl</span>
<a name="l00667"></a>00667 <span class="preprocessor"></span>
<a name="l00668"></a>00668 FILE_PATTERNS = *.hpp \
<a name="l00669"></a>00669 *.doxy
<a name="l00670"></a>00670
<a name="l00671"></a>00671 <span class="preprocessor"># The RECURSIVE tag can be used to turn specify whether or not subdirectories </span>
<a name="l00672"></a>00672 <span class="preprocessor"></span><span class="preprocessor"># should be searched for input files as well. Possible values are YES and NO. </span>
<a name="l00673"></a>00673 <span class="preprocessor"></span><span class="preprocessor"># If left blank NO is used.</span>
<a name="l00674"></a>00674 <span class="preprocessor"></span>
<a name="l00675"></a>00675 RECURSIVE = YES
<a name="l00676"></a>00676
<a name="l00677"></a>00677 <span class="preprocessor"># The EXCLUDE tag can be used to specify files and/or directories that should be </span>
<a name="l00678"></a>00678 <span class="preprocessor"></span><span class="preprocessor"># excluded from the INPUT source files. This way you can easily exclude a </span>
<a name="l00679"></a>00679 <span class="preprocessor"></span><span class="preprocessor"># subdirectory from a directory tree whose root is specified with the INPUT tag. </span>
<a name="l00680"></a>00680 <span class="preprocessor"></span><span class="preprocessor"># Note that relative paths are relative to the directory from which doxygen is </span>
<a name="l00681"></a>00681 <span class="preprocessor"></span><span class="preprocessor"># run.</span>
<a name="l00682"></a>00682 <span class="preprocessor"></span>
<a name="l00683"></a>00683 EXCLUDE =
<a name="l00684"></a>00684
<a name="l00685"></a>00685 <span class="preprocessor"># The EXCLUDE_SYMLINKS tag can be used to select whether or not files or </span>
<a name="l00686"></a>00686 <span class="preprocessor"></span><span class="preprocessor"># directories that are symbolic links (a Unix file system feature) are excluded </span>
<a name="l00687"></a>00687 <span class="preprocessor"></span><span class="preprocessor"># from the input.</span>
<a name="l00688"></a>00688 <span class="preprocessor"></span>
<a name="l00689"></a>00689 EXCLUDE_SYMLINKS = NO
<a name="l00690"></a>00690
<a name="l00691"></a>00691 <span class="preprocessor"># If the value of the INPUT tag contains directories, you can use the </span>
<a name="l00692"></a>00692 <span class="preprocessor"></span><span class="preprocessor"># EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude </span>
<a name="l00693"></a>00693 <span class="preprocessor"></span><span class="preprocessor"># certain files from those directories. Note that the wildcards are matched </span>
<a name="l00694"></a>00694 <span class="preprocessor"></span><span class="preprocessor"># against the file with absolute path, so to exclude all test directories </span>
<a name="l00695"></a>00695 <span class="preprocessor"></span><span class="preprocessor"># for example use the pattern */test</span><span class="comment">/*</span>
<a name="l00696"></a>00696 <span class="comment"></span>
<a name="l00697"></a>00697 <span class="comment">EXCLUDE_PATTERNS = </span>
<a name="l00698"></a>00698 <span class="comment"></span>
<a name="l00699"></a>00699 <span class="comment"># The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names </span>
<a name="l00700"></a>00700 <span class="comment"># (namespaces, classes, functions, etc.) that should be excluded from the </span>
<a name="l00701"></a>00701 <span class="comment"># output. The symbol name can be a fully qualified name, a word, or if the </span>
<a name="l00702"></a>00702 <span class="comment"># wildcard * is used, a substring. Examples: ANamespace, AClass, </span>
<a name="l00703"></a>00703 <span class="comment"># AClass::ANamespace, ANamespace::*Test</span>
<a name="l00704"></a>00704 <span class="comment"></span>
<a name="l00705"></a>00705 <span class="comment">EXCLUDE_SYMBOLS = </span>
<a name="l00706"></a>00706 <span class="comment"></span>
<a name="l00707"></a>00707 <span class="comment"># The EXAMPLE_PATH tag can be used to specify one or more files or </span>
<a name="l00708"></a>00708 <span class="comment"># directories that contain example code fragments that are included (see </span>
<a name="l00709"></a>00709 <span class="comment"># the \include command).</span>
<a name="l00710"></a>00710 <span class="comment"></span>
<a name="l00711"></a>00711 <span class="comment">EXAMPLE_PATH = </span>
<a name="l00712"></a>00712 <span class="comment"></span>
<a name="l00713"></a>00713 <span class="comment"># If the value of the EXAMPLE_PATH tag contains directories, you can use the </span>
<a name="l00714"></a>00714 <span class="comment"># EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp </span>
<a name="l00715"></a>00715 <span class="comment"># and *.h) to filter out the source-files in the directories. If left </span>
<a name="l00716"></a>00716 <span class="comment"># blank all files are included.</span>
<a name="l00717"></a>00717 <span class="comment"></span>
<a name="l00718"></a>00718 <span class="comment">EXAMPLE_PATTERNS = *</span>
<a name="l00719"></a>00719 <span class="comment"></span>
<a name="l00720"></a>00720 <span class="comment"># If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be </span>
<a name="l00721"></a>00721 <span class="comment"># searched for input files to be used with the \include or \dontinclude </span>
<a name="l00722"></a>00722 <span class="comment"># commands irrespective of the value of the RECURSIVE tag. </span>
<a name="l00723"></a>00723 <span class="comment"># Possible values are YES and NO. If left blank NO is used.</span>
<a name="l00724"></a>00724 <span class="comment"></span>
<a name="l00725"></a>00725 <span class="comment">EXAMPLE_RECURSIVE = NO</span>
<a name="l00726"></a>00726 <span class="comment"></span>
<a name="l00727"></a>00727 <span class="comment"># The IMAGE_PATH tag can be used to specify one or more files or </span>
<a name="l00728"></a>00728 <span class="comment"># directories that contain image that are included in the documentation (see </span>
<a name="l00729"></a>00729 <span class="comment"># the \image command).</span>
<a name="l00730"></a>00730 <span class="comment"></span>
<a name="l00731"></a>00731 <span class="comment">IMAGE_PATH = </span>
<a name="l00732"></a>00732 <span class="comment"></span>
<a name="l00733"></a>00733 <span class="comment"># The INPUT_FILTER tag can be used to specify a program that doxygen should </span>
<a name="l00734"></a>00734 <span class="comment"># invoke to filter for each input file. Doxygen will invoke the filter program </span>
<a name="l00735"></a>00735 <span class="comment"># by executing (via popen()) the command <filter> <input-file>, where <filter> </span>
<a name="l00736"></a>00736 <span class="comment"># is the value of the INPUT_FILTER tag, and <input-file> is the name of an </span>
<a name="l00737"></a>00737 <span class="comment"># input file. Doxygen will then use the output that the filter program writes </span>
<a name="l00738"></a>00738 <span class="comment"># to standard output. If FILTER_PATTERNS is specified, this tag will be </span>
<a name="l00739"></a>00739 <span class="comment"># ignored.</span>
<a name="l00740"></a>00740 <span class="comment"></span>
<a name="l00741"></a>00741 <span class="comment">INPUT_FILTER = </span>
<a name="l00742"></a>00742 <span class="comment"></span>
<a name="l00743"></a>00743 <span class="comment"># The FILTER_PATTERNS tag can be used to specify filters on a per file pattern </span>
<a name="l00744"></a>00744 <span class="comment"># basis. Doxygen will compare the file name with each pattern and apply the </span>
<a name="l00745"></a>00745 <span class="comment"># filter if there is a match. The filters are a list of the form: </span>
<a name="l00746"></a>00746 <span class="comment"># pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further </span>
<a name="l00747"></a>00747 <span class="comment"># info on how filters are used. If FILTER_PATTERNS is empty or if </span>
<a name="l00748"></a>00748 <span class="comment"># non of the patterns match the file name, INPUT_FILTER is applied.</span>
<a name="l00749"></a>00749 <span class="comment"></span>
<a name="l00750"></a>00750 <span class="comment">FILTER_PATTERNS = </span>
<a name="l00751"></a>00751 <span class="comment"></span>
<a name="l00752"></a>00752 <span class="comment"># If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using </span>
<a name="l00753"></a>00753 <span class="comment"># INPUT_FILTER) will be used to filter the input files when producing source </span>
<a name="l00754"></a>00754 <span class="comment"># files to browse (i.e. when SOURCE_BROWSER is set to YES).</span>
<a name="l00755"></a>00755 <span class="comment"></span>
<a name="l00756"></a>00756 <span class="comment">FILTER_SOURCE_FILES = NO</span>
<a name="l00757"></a>00757 <span class="comment"></span>
<a name="l00758"></a>00758 <span class="comment"># The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file </span>
<a name="l00759"></a>00759 <span class="comment"># pattern. A pattern will override the setting for FILTER_PATTERN (if any) </span>
<a name="l00760"></a>00760 <span class="comment"># and it is also possible to disable source filtering for a specific pattern </span>
<a name="l00761"></a>00761 <span class="comment"># using *.ext= (so without naming a filter). This option only has effect when </span>
<a name="l00762"></a>00762 <span class="comment"># FILTER_SOURCE_FILES is enabled.</span>
<a name="l00763"></a>00763 <span class="comment"></span>
<a name="l00764"></a>00764 <span class="comment">FILTER_SOURCE_PATTERNS = </span>
<a name="l00765"></a>00765 <span class="comment"></span>
<a name="l00766"></a>00766 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l00767"></a>00767 <span class="comment"># configuration options related to source browsing</span>
<a name="l00768"></a>00768 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l00769"></a>00769 <span class="comment"></span>
<a name="l00770"></a>00770 <span class="comment"># If the SOURCE_BROWSER tag is set to YES then a list of source files will </span>
<a name="l00771"></a>00771 <span class="comment"># be generated. Documented entities will be cross-referenced with these sources. </span>
<a name="l00772"></a>00772 <span class="comment"># Note: To get rid of all source code in the generated output, make sure also </span>
<a name="l00773"></a>00773 <span class="comment"># VERBATIM_HEADERS is set to NO.</span>
<a name="l00774"></a>00774 <span class="comment"></span>
<a name="l00775"></a>00775 <span class="comment">SOURCE_BROWSER = YES</span>
<a name="l00776"></a>00776 <span class="comment"></span>
<a name="l00777"></a>00777 <span class="comment"># Setting the INLINE_SOURCES tag to YES will include the body </span>
<a name="l00778"></a>00778 <span class="comment"># of functions and classes directly in the documentation.</span>
<a name="l00779"></a>00779 <span class="comment"></span>
<a name="l00780"></a>00780 <span class="comment">INLINE_SOURCES = NO</span>
<a name="l00781"></a>00781 <span class="comment"></span>
<a name="l00782"></a>00782 <span class="comment"># Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct </span>
<a name="l00783"></a>00783 <span class="comment"># doxygen to hide any special comment blocks from generated source code </span>
<a name="l00784"></a>00784 <span class="comment"># fragments. Normal C and C++ comments will always remain visible.</span>
<a name="l00785"></a>00785 <span class="comment"></span>
<a name="l00786"></a>00786 <span class="comment">STRIP_CODE_COMMENTS = YES</span>
<a name="l00787"></a>00787 <span class="comment"></span>
<a name="l00788"></a>00788 <span class="comment"># If the REFERENCED_BY_RELATION tag is set to YES </span>
<a name="l00789"></a>00789 <span class="comment"># then for each documented function all documented </span>
<a name="l00790"></a>00790 <span class="comment"># functions referencing it will be listed.</span>
<a name="l00791"></a>00791 <span class="comment"></span>
<a name="l00792"></a>00792 <span class="comment">REFERENCED_BY_RELATION = YES</span>
<a name="l00793"></a>00793 <span class="comment"></span>
<a name="l00794"></a>00794 <span class="comment"># If the REFERENCES_RELATION tag is set to YES </span>
<a name="l00795"></a>00795 <span class="comment"># then for each documented function all documented entities </span>
<a name="l00796"></a>00796 <span class="comment"># called/used by that function will be listed.</span>
<a name="l00797"></a>00797 <span class="comment"></span>
<a name="l00798"></a>00798 <span class="comment">REFERENCES_RELATION = YES</span>
<a name="l00799"></a>00799 <span class="comment"></span>
<a name="l00800"></a>00800 <span class="comment"># If the REFERENCES_LINK_SOURCE tag is set to YES (the default) </span>
<a name="l00801"></a>00801 <span class="comment"># and SOURCE_BROWSER tag is set to YES, then the hyperlinks from </span>
<a name="l00802"></a>00802 <span class="comment"># functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will </span>
<a name="l00803"></a>00803 <span class="comment"># link to the source code. Otherwise they will link to the documentation.</span>
<a name="l00804"></a>00804 <span class="comment"></span>
<a name="l00805"></a>00805 <span class="comment">REFERENCES_LINK_SOURCE = YES</span>
<a name="l00806"></a>00806 <span class="comment"></span>
<a name="l00807"></a>00807 <span class="comment"># If the USE_HTAGS tag is set to YES then the references to source code </span>
<a name="l00808"></a>00808 <span class="comment"># will point to the HTML generated by the htags(1) tool instead of doxygen </span>
<a name="l00809"></a>00809 <span class="comment"># built-in source browser. The htags tool is part of GNU's global source </span>
<a name="l00810"></a>00810 <span class="comment"># tagging system (see http://www.gnu.org/software/global/global.html). You </span>
<a name="l00811"></a>00811 <span class="comment"># will need version 4.8.6 or higher.</span>
<a name="l00812"></a>00812 <span class="comment"></span>
<a name="l00813"></a>00813 <span class="comment">USE_HTAGS = NO</span>
<a name="l00814"></a>00814 <span class="comment"></span>
<a name="l00815"></a>00815 <span class="comment"># If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen </span>
<a name="l00816"></a>00816 <span class="comment"># will generate a verbatim copy of the header file for each class for </span>
<a name="l00817"></a>00817 <span class="comment"># which an include is specified. Set to NO to disable this.</span>
<a name="l00818"></a>00818 <span class="comment"></span>
<a name="l00819"></a>00819 <span class="comment">VERBATIM_HEADERS = YES</span>
<a name="l00820"></a>00820 <span class="comment"></span>
<a name="l00821"></a>00821 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l00822"></a>00822 <span class="comment"># configuration options related to the alphabetical class index</span>
<a name="l00823"></a>00823 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l00824"></a>00824 <span class="comment"></span>
<a name="l00825"></a>00825 <span class="comment"># If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index </span>
<a name="l00826"></a>00826 <span class="comment"># of all compounds will be generated. Enable this if the project </span>
<a name="l00827"></a>00827 <span class="comment"># contains a lot of classes, structs, unions or interfaces.</span>
<a name="l00828"></a>00828 <span class="comment"></span>
<a name="l00829"></a>00829 <span class="comment">ALPHABETICAL_INDEX = NO</span>
<a name="l00830"></a>00830 <span class="comment"></span>
<a name="l00831"></a>00831 <span class="comment"># If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then </span>
<a name="l00832"></a>00832 <span class="comment"># the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns </span>
<a name="l00833"></a>00833 <span class="comment"># in which this list will be split (can be a number in the range [1..20])</span>
<a name="l00834"></a>00834 <span class="comment"></span>
<a name="l00835"></a>00835 <span class="comment">COLS_IN_ALPHA_INDEX = 5</span>
<a name="l00836"></a>00836 <span class="comment"></span>
<a name="l00837"></a>00837 <span class="comment"># In case all classes in a project start with a common prefix, all </span>
<a name="l00838"></a>00838 <span class="comment"># classes will be put under the same header in the alphabetical index. </span>
<a name="l00839"></a>00839 <span class="comment"># The IGNORE_PREFIX tag can be used to specify one or more prefixes that </span>
<a name="l00840"></a>00840 <span class="comment"># should be ignored while generating the index headers.</span>
<a name="l00841"></a>00841 <span class="comment"></span>
<a name="l00842"></a>00842 <span class="comment">IGNORE_PREFIX = </span>
<a name="l00843"></a>00843 <span class="comment"></span>
<a name="l00844"></a>00844 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l00845"></a>00845 <span class="comment"># configuration options related to the HTML output</span>
<a name="l00846"></a>00846 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l00847"></a>00847 <span class="comment"></span>
<a name="l00848"></a>00848 <span class="comment"># If the GENERATE_HTML tag is set to YES (the default) Doxygen will </span>
<a name="l00849"></a>00849 <span class="comment"># generate HTML output.</span>
<a name="l00850"></a>00850 <span class="comment"></span>
<a name="l00851"></a>00851 <span class="comment">GENERATE_HTML = YES</span>
<a name="l00852"></a>00852 <span class="comment"></span>
<a name="l00853"></a>00853 <span class="comment"># The HTML_OUTPUT tag is used to specify where the HTML docs will be put. </span>
<a name="l00854"></a>00854 <span class="comment"># If a relative path is entered the value of OUTPUT_DIRECTORY will be </span>
<a name="l00855"></a>00855 <span class="comment"># put in front of it. If left blank `html' will be used as the default path.</span>
<a name="l00856"></a>00856 <span class="comment"></span>
<a name="l00857"></a>00857 <span class="comment">HTML_OUTPUT = html</span>
<a name="l00858"></a>00858 <span class="comment"></span>
<a name="l00859"></a>00859 <span class="comment"># The HTML_FILE_EXTENSION tag can be used to specify the file extension for </span>
<a name="l00860"></a>00860 <span class="comment"># each generated HTML page (for example: .htm,.php,.asp). If it is left blank </span>
<a name="l00861"></a>00861 <span class="comment"># doxygen will generate files with .html extension.</span>
<a name="l00862"></a>00862 <span class="comment"></span>
<a name="l00863"></a>00863 <span class="comment">HTML_FILE_EXTENSION = .html</span>
<a name="l00864"></a>00864 <span class="comment"></span>
<a name="l00865"></a>00865 <span class="comment"># The HTML_HEADER tag can be used to specify a personal HTML header for </span>
<a name="l00866"></a>00866 <span class="comment"># each generated HTML page. If it is left blank doxygen will generate a </span>
<a name="l00867"></a>00867 <span class="comment"># standard header. Note that when using a custom header you are responsible </span>
<a name="l00868"></a>00868 <span class="comment"># for the proper inclusion of any scripts and style sheets that doxygen </span>
<a name="l00869"></a>00869 <span class="comment"># needs, which is dependent on the configuration options used. </span>
<a name="l00870"></a>00870 <span class="comment"># It is advised to generate a default header using "doxygen -w html </span>
<a name="l00871"></a>00871 <span class="comment"># header.html footer.html stylesheet.css YourConfigFile" and then modify </span>
<a name="l00872"></a>00872 <span class="comment"># that header. Note that the header is subject to change so you typically </span>
<a name="l00873"></a>00873 <span class="comment"># have to redo this when upgrading to a newer version of doxygen or when </span>
<a name="l00874"></a>00874 <span class="comment"># changing the value of configuration settings such as GENERATE_TREEVIEW!</span>
<a name="l00875"></a>00875 <span class="comment"></span>
<a name="l00876"></a>00876 <span class="comment">HTML_HEADER = </span>
<a name="l00877"></a>00877 <span class="comment"></span>
<a name="l00878"></a>00878 <span class="comment"># The HTML_FOOTER tag can be used to specify a personal HTML footer for </span>
<a name="l00879"></a>00879 <span class="comment"># each generated HTML page. If it is left blank doxygen will generate a </span>
<a name="l00880"></a>00880 <span class="comment"># standard footer.</span>
<a name="l00881"></a>00881 <span class="comment"></span>
<a name="l00882"></a>00882 <span class="comment">HTML_FOOTER = </span>
<a name="l00883"></a>00883 <span class="comment"></span>
<a name="l00884"></a>00884 <span class="comment"># The HTML_STYLESHEET tag can be used to specify a user-defined cascading </span>
<a name="l00885"></a>00885 <span class="comment"># style sheet that is used by each HTML page. It can be used to </span>
<a name="l00886"></a>00886 <span class="comment"># fine-tune the look of the HTML output. If the tag is left blank doxygen </span>
<a name="l00887"></a>00887 <span class="comment"># will generate a default style sheet. Note that doxygen will try to copy </span>
<a name="l00888"></a>00888 <span class="comment"># the style sheet file to the HTML output directory, so don't put your own </span>
<a name="l00889"></a>00889 <span class="comment"># style sheet in the HTML output directory as well, or it will be erased!</span>
<a name="l00890"></a>00890 <span class="comment"></span>
<a name="l00891"></a>00891 <span class="comment">HTML_STYLESHEET = </span>
<a name="l00892"></a>00892 <span class="comment"></span>
<a name="l00893"></a>00893 <span class="comment"># The HTML_EXTRA_FILES tag can be used to specify one or more extra images or </span>
<a name="l00894"></a>00894 <span class="comment"># other source files which should be copied to the HTML output directory. Note </span>
<a name="l00895"></a>00895 <span class="comment"># that these files will be copied to the base HTML output directory. Use the </span>
<a name="l00896"></a>00896 <span class="comment"># $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these </span>
<a name="l00897"></a>00897 <span class="comment"># files. In the HTML_STYLESHEET file, use the file name only. Also note that </span>
<a name="l00898"></a>00898 <span class="comment"># the files will be copied as-is; there are no commands or markers available.</span>
<a name="l00899"></a>00899 <span class="comment"></span>
<a name="l00900"></a>00900 <span class="comment">HTML_EXTRA_FILES = </span>
<a name="l00901"></a>00901 <span class="comment"></span>
<a name="l00902"></a>00902 <span class="comment"># The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. </span>
<a name="l00903"></a>00903 <span class="comment"># Doxygen will adjust the colors in the style sheet and background images </span>
<a name="l00904"></a>00904 <span class="comment"># according to this color. Hue is specified as an angle on a colorwheel, </span>
<a name="l00905"></a>00905 <span class="comment"># see http://en.wikipedia.org/wiki/Hue for more information. </span>
<a name="l00906"></a>00906 <span class="comment"># For instance the value 0 represents red, 60 is yellow, 120 is green, </span>
<a name="l00907"></a>00907 <span class="comment"># 180 is cyan, 240 is blue, 300 purple, and 360 is red again. </span>
<a name="l00908"></a>00908 <span class="comment"># The allowed range is 0 to 359.</span>
<a name="l00909"></a>00909 <span class="comment"></span>
<a name="l00910"></a>00910 <span class="comment">HTML_COLORSTYLE_HUE = 220</span>
<a name="l00911"></a>00911 <span class="comment"></span>
<a name="l00912"></a>00912 <span class="comment"># The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of </span>
<a name="l00913"></a>00913 <span class="comment"># the colors in the HTML output. For a value of 0 the output will use </span>
<a name="l00914"></a>00914 <span class="comment"># grayscales only. A value of 255 will produce the most vivid colors.</span>
<a name="l00915"></a>00915 <span class="comment"></span>
<a name="l00916"></a>00916 <span class="comment">HTML_COLORSTYLE_SAT = 100</span>
<a name="l00917"></a>00917 <span class="comment"></span>
<a name="l00918"></a>00918 <span class="comment"># The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to </span>
<a name="l00919"></a>00919 <span class="comment"># the luminance component of the colors in the HTML output. Values below </span>
<a name="l00920"></a>00920 <span class="comment"># 100 gradually make the output lighter, whereas values above 100 make </span>
<a name="l00921"></a>00921 <span class="comment"># the output darker. The value divided by 100 is the actual gamma applied, </span>
<a name="l00922"></a>00922 <span class="comment"># so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, </span>
<a name="l00923"></a>00923 <span class="comment"># and 100 does not change the gamma.</span>
<a name="l00924"></a>00924 <span class="comment"></span>
<a name="l00925"></a>00925 <span class="comment">HTML_COLORSTYLE_GAMMA = 80</span>
<a name="l00926"></a>00926 <span class="comment"></span>
<a name="l00927"></a>00927 <span class="comment"># If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML </span>
<a name="l00928"></a>00928 <span class="comment"># page will contain the date and time when the page was generated. Setting </span>
<a name="l00929"></a>00929 <span class="comment"># this to NO can help when comparing the output of multiple runs.</span>
<a name="l00930"></a>00930 <span class="comment"></span>
<a name="l00931"></a>00931 <span class="comment">HTML_TIMESTAMP = NO</span>
<a name="l00932"></a>00932 <span class="comment"></span>
<a name="l00933"></a>00933 <span class="comment"># If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, </span>
<a name="l00934"></a>00934 <span class="comment"># files or namespaces will be aligned in HTML using tables. If set to </span>
<a name="l00935"></a>00935 <span class="comment"># NO a bullet list will be used.</span>
<a name="l00936"></a>00936 <span class="comment"></span>
<a name="l00937"></a>00937 <span class="comment">HTML_ALIGN_MEMBERS = YES</span>
<a name="l00938"></a>00938 <span class="comment"></span>
<a name="l00939"></a>00939 <span class="comment"># If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML </span>
<a name="l00940"></a>00940 <span class="comment"># documentation will contain sections that can be hidden and shown after the </span>
<a name="l00941"></a>00941 <span class="comment"># page has loaded. For this to work a browser that supports </span>
<a name="l00942"></a>00942 <span class="comment"># JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox </span>
<a name="l00943"></a>00943 <span class="comment"># Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).</span>
<a name="l00944"></a>00944 <span class="comment"></span>
<a name="l00945"></a>00945 <span class="comment">HTML_DYNAMIC_SECTIONS = NO</span>
<a name="l00946"></a>00946 <span class="comment"></span>
<a name="l00947"></a>00947 <span class="comment"># If the GENERATE_DOCSET tag is set to YES, additional index files </span>
<a name="l00948"></a>00948 <span class="comment"># will be generated that can be used as input for Apple's Xcode 3 </span>
<a name="l00949"></a>00949 <span class="comment"># integrated development environment, introduced with OSX 10.5 (Leopard). </span>
<a name="l00950"></a>00950 <span class="comment"># To create a documentation set, doxygen will generate a Makefile in the </span>
<a name="l00951"></a>00951 <span class="comment"># HTML output directory. Running make will produce the docset in that </span>
<a name="l00952"></a>00952 <span class="comment"># directory and running "make install" will install the docset in </span>
<a name="l00953"></a>00953 <span class="comment"># ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find </span>
<a name="l00954"></a>00954 <span class="comment"># it at startup. </span>
<a name="l00955"></a>00955 <span class="comment"># See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html </span>
<a name="l00956"></a>00956 <span class="comment"># for more information.</span>
<a name="l00957"></a>00957 <span class="comment"></span>
<a name="l00958"></a>00958 <span class="comment">GENERATE_DOCSET = NO</span>
<a name="l00959"></a>00959 <span class="comment"></span>
<a name="l00960"></a>00960 <span class="comment"># When GENERATE_DOCSET tag is set to YES, this tag determines the name of the </span>
<a name="l00961"></a>00961 <span class="comment"># feed. A documentation feed provides an umbrella under which multiple </span>
<a name="l00962"></a>00962 <span class="comment"># documentation sets from a single provider (such as a company or product suite) </span>
<a name="l00963"></a>00963 <span class="comment"># can be grouped.</span>
<a name="l00964"></a>00964 <span class="comment"></span>
<a name="l00965"></a>00965 <span class="comment">DOCSET_FEEDNAME = "Doxygen generated docs"</span>
<a name="l00966"></a>00966 <span class="comment"></span>
<a name="l00967"></a>00967 <span class="comment"># When GENERATE_DOCSET tag is set to YES, this tag specifies a string that </span>
<a name="l00968"></a>00968 <span class="comment"># should uniquely identify the documentation set bundle. This should be a </span>
<a name="l00969"></a>00969 <span class="comment"># reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen </span>
<a name="l00970"></a>00970 <span class="comment"># will append .docset to the name.</span>
<a name="l00971"></a>00971 <span class="comment"></span>
<a name="l00972"></a>00972 <span class="comment">DOCSET_BUNDLE_ID = org.doxygen.Project</span>
<a name="l00973"></a>00973 <span class="comment"></span>
<a name="l00974"></a>00974 <span class="comment"># When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify </span>
<a name="l00975"></a>00975 <span class="comment"># the documentation publisher. This should be a reverse domain-name style </span>
<a name="l00976"></a>00976 <span class="comment"># string, e.g. com.mycompany.MyDocSet.documentation.</span>
<a name="l00977"></a>00977 <span class="comment"></span>
<a name="l00978"></a>00978 <span class="comment">DOCSET_PUBLISHER_ID = org.doxygen.Publisher</span>
<a name="l00979"></a>00979 <span class="comment"></span>
<a name="l00980"></a>00980 <span class="comment"># The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.</span>
<a name="l00981"></a>00981 <span class="comment"></span>
<a name="l00982"></a>00982 <span class="comment">DOCSET_PUBLISHER_NAME = Publisher</span>
<a name="l00983"></a>00983 <span class="comment"></span>
<a name="l00984"></a>00984 <span class="comment"># If the GENERATE_HTMLHELP tag is set to YES, additional index files </span>
<a name="l00985"></a>00985 <span class="comment"># will be generated that can be used as input for tools like the </span>
<a name="l00986"></a>00986 <span class="comment"># Microsoft HTML help workshop to generate a compiled HTML help file (.chm) </span>
<a name="l00987"></a>00987 <span class="comment"># of the generated HTML documentation.</span>
<a name="l00988"></a>00988 <span class="comment"></span>
<a name="l00989"></a>00989 <span class="comment">GENERATE_HTMLHELP = NO</span>
<a name="l00990"></a>00990 <span class="comment"></span>
<a name="l00991"></a>00991 <span class="comment"># If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can </span>
<a name="l00992"></a>00992 <span class="comment"># be used to specify the file name of the resulting .chm file. You </span>
<a name="l00993"></a>00993 <span class="comment"># can add a path in front of the file if the result should not be </span>
<a name="l00994"></a>00994 <span class="comment"># written to the html output directory.</span>
<a name="l00995"></a>00995 <span class="comment"></span>
<a name="l00996"></a>00996 <span class="comment">CHM_FILE = </span>
<a name="l00997"></a>00997 <span class="comment"></span>
<a name="l00998"></a>00998 <span class="comment"># If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can </span>
<a name="l00999"></a>00999 <span class="comment"># be used to specify the location (absolute path including file name) of </span>
<a name="l01000"></a>01000 <span class="comment"># the HTML help compiler (hhc.exe). If non-empty doxygen will try to run </span>
<a name="l01001"></a>01001 <span class="comment"># the HTML help compiler on the generated index.hhp.</span>
<a name="l01002"></a>01002 <span class="comment"></span>
<a name="l01003"></a>01003 <span class="comment">HHC_LOCATION = </span>
<a name="l01004"></a>01004 <span class="comment"></span>
<a name="l01005"></a>01005 <span class="comment"># If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag </span>
<a name="l01006"></a>01006 <span class="comment"># controls if a separate .chi index file is generated (YES) or that </span>
<a name="l01007"></a>01007 <span class="comment"># it should be included in the master .chm file (NO).</span>
<a name="l01008"></a>01008 <span class="comment"></span>
<a name="l01009"></a>01009 <span class="comment">GENERATE_CHI = NO</span>
<a name="l01010"></a>01010 <span class="comment"></span>
<a name="l01011"></a>01011 <span class="comment"># If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING </span>
<a name="l01012"></a>01012 <span class="comment"># is used to encode HtmlHelp index (hhk), content (hhc) and project file </span>
<a name="l01013"></a>01013 <span class="comment"># content.</span>
<a name="l01014"></a>01014 <span class="comment"></span>
<a name="l01015"></a>01015 <span class="comment">CHM_INDEX_ENCODING = </span>
<a name="l01016"></a>01016 <span class="comment"></span>
<a name="l01017"></a>01017 <span class="comment"># If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag </span>
<a name="l01018"></a>01018 <span class="comment"># controls whether a binary table of contents is generated (YES) or a </span>
<a name="l01019"></a>01019 <span class="comment"># normal table of contents (NO) in the .chm file.</span>
<a name="l01020"></a>01020 <span class="comment"></span>
<a name="l01021"></a>01021 <span class="comment">BINARY_TOC = NO</span>
<a name="l01022"></a>01022 <span class="comment"></span>
<a name="l01023"></a>01023 <span class="comment"># The TOC_EXPAND flag can be set to YES to add extra items for group members </span>
<a name="l01024"></a>01024 <span class="comment"># to the contents of the HTML help documentation and to the tree view.</span>
<a name="l01025"></a>01025 <span class="comment"></span>
<a name="l01026"></a>01026 <span class="comment">TOC_EXPAND = NO</span>
<a name="l01027"></a>01027 <span class="comment"></span>
<a name="l01028"></a>01028 <span class="comment"># If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and </span>
<a name="l01029"></a>01029 <span class="comment"># QHP_VIRTUAL_FOLDER are set, an additional index file will be generated </span>
<a name="l01030"></a>01030 <span class="comment"># that can be used as input for Qt's qhelpgenerator to generate a </span>
<a name="l01031"></a>01031 <span class="comment"># Qt Compressed Help (.qch) of the generated HTML documentation.</span>
<a name="l01032"></a>01032 <span class="comment"></span>
<a name="l01033"></a>01033 <span class="comment">GENERATE_QHP = NO</span>
<a name="l01034"></a>01034 <span class="comment"></span>
<a name="l01035"></a>01035 <span class="comment"># If the QHG_LOCATION tag is specified, the QCH_FILE tag can </span>
<a name="l01036"></a>01036 <span class="comment"># be used to specify the file name of the resulting .qch file. </span>
<a name="l01037"></a>01037 <span class="comment"># The path specified is relative to the HTML output folder.</span>
<a name="l01038"></a>01038 <span class="comment"></span>
<a name="l01039"></a>01039 <span class="comment">QCH_FILE = </span>
<a name="l01040"></a>01040 <span class="comment"></span>
<a name="l01041"></a>01041 <span class="comment"># The QHP_NAMESPACE tag specifies the namespace to use when generating </span>
<a name="l01042"></a>01042 <span class="comment"># Qt Help Project output. For more information please see </span>
<a name="l01043"></a>01043 <span class="comment"># http://doc.trolltech.com/qthelpproject.html#namespace</span>
<a name="l01044"></a>01044 <span class="comment"></span>
<a name="l01045"></a>01045 <span class="comment">QHP_NAMESPACE = org.doxygen.Project</span>
<a name="l01046"></a>01046 <span class="comment"></span>
<a name="l01047"></a>01047 <span class="comment"># The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating </span>
<a name="l01048"></a>01048 <span class="comment"># Qt Help Project output. For more information please see </span>
<a name="l01049"></a>01049 <span class="comment"># http://doc.trolltech.com/qthelpproject.html#virtual-folders</span>
<a name="l01050"></a>01050 <span class="comment"></span>
<a name="l01051"></a>01051 <span class="comment">QHP_VIRTUAL_FOLDER = doc</span>
<a name="l01052"></a>01052 <span class="comment"></span>
<a name="l01053"></a>01053 <span class="comment"># If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to </span>
<a name="l01054"></a>01054 <span class="comment"># add. For more information please see </span>
<a name="l01055"></a>01055 <span class="comment"># http://doc.trolltech.com/qthelpproject.html#custom-filters</span>
<a name="l01056"></a>01056 <span class="comment"></span>
<a name="l01057"></a>01057 <span class="comment">QHP_CUST_FILTER_NAME = </span>
<a name="l01058"></a>01058 <span class="comment"></span>
<a name="l01059"></a>01059 <span class="comment"># The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the </span>
<a name="l01060"></a>01060 <span class="comment"># custom filter to add. For more information please see </span>
<a name="l01061"></a>01061 <span class="comment"># <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> </span>
<a name="l01062"></a>01062 <span class="comment"># Qt Help Project / Custom Filters</a>.</span>
<a name="l01063"></a>01063 <span class="comment"></span>
<a name="l01064"></a>01064 <span class="comment">QHP_CUST_FILTER_ATTRS = </span>
<a name="l01065"></a>01065 <span class="comment"></span>
<a name="l01066"></a>01066 <span class="comment"># The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this </span>
<a name="l01067"></a>01067 <span class="comment"># project's </span>
<a name="l01068"></a>01068 <span class="comment"># filter section matches. </span>
<a name="l01069"></a>01069 <span class="comment"># <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> </span>
<a name="l01070"></a>01070 <span class="comment"># Qt Help Project / Filter Attributes</a>.</span>
<a name="l01071"></a>01071 <span class="comment"></span>
<a name="l01072"></a>01072 <span class="comment">QHP_SECT_FILTER_ATTRS = </span>
<a name="l01073"></a>01073 <span class="comment"></span>
<a name="l01074"></a>01074 <span class="comment"># If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can </span>
<a name="l01075"></a>01075 <span class="comment"># be used to specify the location of Qt's qhelpgenerator. </span>
<a name="l01076"></a>01076 <span class="comment"># If non-empty doxygen will try to run qhelpgenerator on the generated </span>
<a name="l01077"></a>01077 <span class="comment"># .qhp file.</span>
<a name="l01078"></a>01078 <span class="comment"></span>
<a name="l01079"></a>01079 <span class="comment">QHG_LOCATION = </span>
<a name="l01080"></a>01080 <span class="comment"></span>
<a name="l01081"></a>01081 <span class="comment"># If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files </span>
<a name="l01082"></a>01082 <span class="comment"># will be generated, which together with the HTML files, form an Eclipse help </span>
<a name="l01083"></a>01083 <span class="comment"># plugin. To install this plugin and make it available under the help contents </span>
<a name="l01084"></a>01084 <span class="comment"># menu in Eclipse, the contents of the directory containing the HTML and XML </span>
<a name="l01085"></a>01085 <span class="comment"># files needs to be copied into the plugins directory of eclipse. The name of </span>
<a name="l01086"></a>01086 <span class="comment"># the directory within the plugins directory should be the same as </span>
<a name="l01087"></a>01087 <span class="comment"># the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before </span>
<a name="l01088"></a>01088 <span class="comment"># the help appears.</span>
<a name="l01089"></a>01089 <span class="comment"></span>
<a name="l01090"></a>01090 <span class="comment">GENERATE_ECLIPSEHELP = NO</span>
<a name="l01091"></a>01091 <span class="comment"></span>
<a name="l01092"></a>01092 <span class="comment"># A unique identifier for the eclipse help plugin. When installing the plugin </span>
<a name="l01093"></a>01093 <span class="comment"># the directory name containing the HTML and XML files should also have </span>
<a name="l01094"></a>01094 <span class="comment"># this name.</span>
<a name="l01095"></a>01095 <span class="comment"></span>
<a name="l01096"></a>01096 <span class="comment">ECLIPSE_DOC_ID = org.doxygen.Project</span>
<a name="l01097"></a>01097 <span class="comment"></span>
<a name="l01098"></a>01098 <span class="comment"># The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) </span>
<a name="l01099"></a>01099 <span class="comment"># at top of each HTML page. The value NO (the default) enables the index and </span>
<a name="l01100"></a>01100 <span class="comment"># the value YES disables it. Since the tabs have the same information as the </span>
<a name="l01101"></a>01101 <span class="comment"># navigation tree you can set this option to NO if you already set </span>
<a name="l01102"></a>01102 <span class="comment"># GENERATE_TREEVIEW to YES.</span>
<a name="l01103"></a>01103 <span class="comment"></span>
<a name="l01104"></a>01104 <span class="comment">DISABLE_INDEX = NO</span>
<a name="l01105"></a>01105 <span class="comment"></span>
<a name="l01106"></a>01106 <span class="comment"># The GENERATE_TREEVIEW tag is used to specify whether a tree-like index </span>
<a name="l01107"></a>01107 <span class="comment"># structure should be generated to display hierarchical information. </span>
<a name="l01108"></a>01108 <span class="comment"># If the tag value is set to YES, a side panel will be generated </span>
<a name="l01109"></a>01109 <span class="comment"># containing a tree-like index structure (just like the one that </span>
<a name="l01110"></a>01110 <span class="comment"># is generated for HTML Help). For this to work a browser that supports </span>
<a name="l01111"></a>01111 <span class="comment"># JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). </span>
<a name="l01112"></a>01112 <span class="comment"># Windows users are probably better off using the HTML help feature. </span>
<a name="l01113"></a>01113 <span class="comment"># Since the tree basically has the same information as the tab index you </span>
<a name="l01114"></a>01114 <span class="comment"># could consider to set DISABLE_INDEX to NO when enabling this option.</span>
<a name="l01115"></a>01115 <span class="comment"></span>
<a name="l01116"></a>01116 <span class="comment">GENERATE_TREEVIEW = NO</span>
<a name="l01117"></a>01117 <span class="comment"></span>
<a name="l01118"></a>01118 <span class="comment"># The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values </span>
<a name="l01119"></a>01119 <span class="comment"># (range [0,1..20]) that doxygen will group on one line in the generated HTML </span>
<a name="l01120"></a>01120 <span class="comment"># documentation. Note that a value of 0 will completely suppress the enum </span>
<a name="l01121"></a>01121 <span class="comment"># values from appearing in the overview section.</span>
<a name="l01122"></a>01122 <span class="comment"></span>
<a name="l01123"></a>01123 <span class="comment">ENUM_VALUES_PER_LINE = 4</span>
<a name="l01124"></a>01124 <span class="comment"></span>
<a name="l01125"></a>01125 <span class="comment"># By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, </span>
<a name="l01126"></a>01126 <span class="comment"># and Class Hierarchy pages using a tree view instead of an ordered list.</span>
<a name="l01127"></a>01127 <span class="comment"></span>
<a name="l01128"></a>01128 <span class="comment">USE_INLINE_TREES = NO</span>
<a name="l01129"></a>01129 <span class="comment"></span>
<a name="l01130"></a>01130 <span class="comment"># If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be </span>
<a name="l01131"></a>01131 <span class="comment"># used to set the initial width (in pixels) of the frame in which the tree </span>
<a name="l01132"></a>01132 <span class="comment"># is shown.</span>
<a name="l01133"></a>01133 <span class="comment"></span>
<a name="l01134"></a>01134 <span class="comment">TREEVIEW_WIDTH = 250</span>
<a name="l01135"></a>01135 <span class="comment"></span>
<a name="l01136"></a>01136 <span class="comment"># When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open </span>
<a name="l01137"></a>01137 <span class="comment"># links to external symbols imported via tag files in a separate window.</span>
<a name="l01138"></a>01138 <span class="comment"></span>
<a name="l01139"></a>01139 <span class="comment">EXT_LINKS_IN_WINDOW = NO</span>
<a name="l01140"></a>01140 <span class="comment"></span>
<a name="l01141"></a>01141 <span class="comment"># Use this tag to change the font size of Latex formulas included </span>
<a name="l01142"></a>01142 <span class="comment"># as images in the HTML documentation. The default is 10. Note that </span>
<a name="l01143"></a>01143 <span class="comment"># when you change the font size after a successful doxygen run you need </span>
<a name="l01144"></a>01144 <span class="comment"># to manually remove any form_*.png images from the HTML output directory </span>
<a name="l01145"></a>01145 <span class="comment"># to force them to be regenerated.</span>
<a name="l01146"></a>01146 <span class="comment"></span>
<a name="l01147"></a>01147 <span class="comment">FORMULA_FONTSIZE = 10</span>
<a name="l01148"></a>01148 <span class="comment"></span>
<a name="l01149"></a>01149 <span class="comment"># Use the FORMULA_TRANPARENT tag to determine whether or not the images </span>
<a name="l01150"></a>01150 <span class="comment"># generated for formulas are transparent PNGs. Transparent PNGs are </span>
<a name="l01151"></a>01151 <span class="comment"># not supported properly for IE 6.0, but are supported on all modern browsers. </span>
<a name="l01152"></a>01152 <span class="comment"># Note that when changing this option you need to delete any form_*.png files </span>
<a name="l01153"></a>01153 <span class="comment"># in the HTML output before the changes have effect.</span>
<a name="l01154"></a>01154 <span class="comment"></span>
<a name="l01155"></a>01155 <span class="comment">FORMULA_TRANSPARENT = YES</span>
<a name="l01156"></a>01156 <span class="comment"></span>
<a name="l01157"></a>01157 <span class="comment"># Enable the USE_MATHJAX option to render LaTeX formulas using MathJax </span>
<a name="l01158"></a>01158 <span class="comment"># (see http://www.mathjax.org) which uses client side Javascript for the </span>
<a name="l01159"></a>01159 <span class="comment"># rendering instead of using prerendered bitmaps. Use this if you do not </span>
<a name="l01160"></a>01160 <span class="comment"># have LaTeX installed or if you want to formulas look prettier in the HTML </span>
<a name="l01161"></a>01161 <span class="comment"># output. When enabled you also need to install MathJax separately and </span>
<a name="l01162"></a>01162 <span class="comment"># configure the path to it using the MATHJAX_RELPATH option.</span>
<a name="l01163"></a>01163 <span class="comment"></span>
<a name="l01164"></a>01164 <span class="comment">USE_MATHJAX = NO</span>
<a name="l01165"></a>01165 <span class="comment"></span>
<a name="l01166"></a>01166 <span class="comment"># When MathJax is enabled you need to specify the location relative to the </span>
<a name="l01167"></a>01167 <span class="comment"># HTML output directory using the MATHJAX_RELPATH option. The destination </span>
<a name="l01168"></a>01168 <span class="comment"># directory should contain the MathJax.js script. For instance, if the mathjax </span>
<a name="l01169"></a>01169 <span class="comment"># directory is located at the same level as the HTML output directory, then </span>
<a name="l01170"></a>01170 <span class="comment"># MATHJAX_RELPATH should be ../mathjax. The default value points to the </span>
<a name="l01171"></a>01171 <span class="comment"># mathjax.org site, so you can quickly see the result without installing </span>
<a name="l01172"></a>01172 <span class="comment"># MathJax, but it is strongly recommended to install a local copy of MathJax </span>
<a name="l01173"></a>01173 <span class="comment"># before deployment.</span>
<a name="l01174"></a>01174 <span class="comment"></span>
<a name="l01175"></a>01175 <span class="comment">MATHJAX_RELPATH = http://www.mathjax.org/mathjax</span>
<a name="l01176"></a>01176 <span class="comment"></span>
<a name="l01177"></a>01177 <span class="comment"># The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension </span>
<a name="l01178"></a>01178 <span class="comment"># names that should be enabled during MathJax rendering.</span>
<a name="l01179"></a>01179 <span class="comment"></span>
<a name="l01180"></a>01180 <span class="comment">MATHJAX_EXTENSIONS = </span>
<a name="l01181"></a>01181 <span class="comment"></span>
<a name="l01182"></a>01182 <span class="comment"># When the SEARCHENGINE tag is enabled doxygen will generate a search box </span>
<a name="l01183"></a>01183 <span class="comment"># for the HTML output. The underlying search engine uses javascript </span>
<a name="l01184"></a>01184 <span class="comment"># and DHTML and should work on any modern browser. Note that when using </span>
<a name="l01185"></a>01185 <span class="comment"># HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets </span>
<a name="l01186"></a>01186 <span class="comment"># (GENERATE_DOCSET) there is already a search function so this one should </span>
<a name="l01187"></a>01187 <span class="comment"># typically be disabled. For large projects the javascript based search engine </span>
<a name="l01188"></a>01188 <span class="comment"># can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.</span>
<a name="l01189"></a>01189 <span class="comment"></span>
<a name="l01190"></a>01190 <span class="comment">SEARCHENGINE = NO</span>
<a name="l01191"></a>01191 <span class="comment"></span>
<a name="l01192"></a>01192 <span class="comment"># When the SERVER_BASED_SEARCH tag is enabled the search engine will be </span>
<a name="l01193"></a>01193 <span class="comment"># implemented using a PHP enabled web server instead of at the web client </span>
<a name="l01194"></a>01194 <span class="comment"># using Javascript. Doxygen will generate the search PHP script and index </span>
<a name="l01195"></a>01195 <span class="comment"># file to put on the web server. The advantage of the server </span>
<a name="l01196"></a>01196 <span class="comment"># based approach is that it scales better to large projects and allows </span>
<a name="l01197"></a>01197 <span class="comment"># full text search. The disadvantages are that it is more difficult to setup </span>
<a name="l01198"></a>01198 <span class="comment"># and does not have live searching capabilities.</span>
<a name="l01199"></a>01199 <span class="comment"></span>
<a name="l01200"></a>01200 <span class="comment">SERVER_BASED_SEARCH = NO</span>
<a name="l01201"></a>01201 <span class="comment"></span>
<a name="l01202"></a>01202 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l01203"></a>01203 <span class="comment"># configuration options related to the LaTeX output</span>
<a name="l01204"></a>01204 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l01205"></a>01205 <span class="comment"></span>
<a name="l01206"></a>01206 <span class="comment"># If the GENERATE_LATEX tag is set to YES (the default) Doxygen will </span>
<a name="l01207"></a>01207 <span class="comment"># generate Latex output.</span>
<a name="l01208"></a>01208 <span class="comment"></span>
<a name="l01209"></a>01209 <span class="comment">GENERATE_LATEX = NO</span>
<a name="l01210"></a>01210 <span class="comment"></span>
<a name="l01211"></a>01211 <span class="comment"># The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. </span>
<a name="l01212"></a>01212 <span class="comment"># If a relative path is entered the value of OUTPUT_DIRECTORY will be </span>
<a name="l01213"></a>01213 <span class="comment"># put in front of it. If left blank `latex' will be used as the default path.</span>
<a name="l01214"></a>01214 <span class="comment"></span>
<a name="l01215"></a>01215 <span class="comment">LATEX_OUTPUT = latex</span>
<a name="l01216"></a>01216 <span class="comment"></span>
<a name="l01217"></a>01217 <span class="comment"># The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be </span>
<a name="l01218"></a>01218 <span class="comment"># invoked. If left blank `latex' will be used as the default command name. </span>
<a name="l01219"></a>01219 <span class="comment"># Note that when enabling USE_PDFLATEX this option is only used for </span>
<a name="l01220"></a>01220 <span class="comment"># generating bitmaps for formulas in the HTML output, but not in the </span>
<a name="l01221"></a>01221 <span class="comment"># Makefile that is written to the output directory.</span>
<a name="l01222"></a>01222 <span class="comment"></span>
<a name="l01223"></a>01223 <span class="comment">LATEX_CMD_NAME = latex</span>
<a name="l01224"></a>01224 <span class="comment"></span>
<a name="l01225"></a>01225 <span class="comment"># The MAKEINDEX_CMD_NAME tag can be used to specify the command name to </span>
<a name="l01226"></a>01226 <span class="comment"># generate index for LaTeX. If left blank `makeindex' will be used as the </span>
<a name="l01227"></a>01227 <span class="comment"># default command name.</span>
<a name="l01228"></a>01228 <span class="comment"></span>
<a name="l01229"></a>01229 <span class="comment">MAKEINDEX_CMD_NAME = makeindex</span>
<a name="l01230"></a>01230 <span class="comment"></span>
<a name="l01231"></a>01231 <span class="comment"># If the COMPACT_LATEX tag is set to YES Doxygen generates more compact </span>
<a name="l01232"></a>01232 <span class="comment"># LaTeX documents. This may be useful for small projects and may help to </span>
<a name="l01233"></a>01233 <span class="comment"># save some trees in general.</span>
<a name="l01234"></a>01234 <span class="comment"></span>
<a name="l01235"></a>01235 <span class="comment">COMPACT_LATEX = NO</span>
<a name="l01236"></a>01236 <span class="comment"></span>
<a name="l01237"></a>01237 <span class="comment"># The PAPER_TYPE tag can be used to set the paper type that is used </span>
<a name="l01238"></a>01238 <span class="comment"># by the printer. Possible values are: a4, letter, legal and </span>
<a name="l01239"></a>01239 <span class="comment"># executive. If left blank a4wide will be used.</span>
<a name="l01240"></a>01240 <span class="comment"></span>
<a name="l01241"></a>01241 <span class="comment">PAPER_TYPE = a4wide</span>
<a name="l01242"></a>01242 <span class="comment"></span>
<a name="l01243"></a>01243 <span class="comment"># The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX </span>
<a name="l01244"></a>01244 <span class="comment"># packages that should be included in the LaTeX output.</span>
<a name="l01245"></a>01245 <span class="comment"></span>
<a name="l01246"></a>01246 <span class="comment">EXTRA_PACKAGES = </span>
<a name="l01247"></a>01247 <span class="comment"></span>
<a name="l01248"></a>01248 <span class="comment"># The LATEX_HEADER tag can be used to specify a personal LaTeX header for </span>
<a name="l01249"></a>01249 <span class="comment"># the generated latex document. The header should contain everything until </span>
<a name="l01250"></a>01250 <span class="comment"># the first chapter. If it is left blank doxygen will generate a </span>
<a name="l01251"></a>01251 <span class="comment"># standard header. Notice: only use this tag if you know what you are doing!</span>
<a name="l01252"></a>01252 <span class="comment"></span>
<a name="l01253"></a>01253 <span class="comment">LATEX_HEADER = </span>
<a name="l01254"></a>01254 <span class="comment"></span>
<a name="l01255"></a>01255 <span class="comment"># The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for </span>
<a name="l01256"></a>01256 <span class="comment"># the generated latex document. The footer should contain everything after </span>
<a name="l01257"></a>01257 <span class="comment"># the last chapter. If it is left blank doxygen will generate a </span>
<a name="l01258"></a>01258 <span class="comment"># standard footer. Notice: only use this tag if you know what you are doing!</span>
<a name="l01259"></a>01259 <span class="comment"></span>
<a name="l01260"></a>01260 <span class="comment">LATEX_FOOTER = </span>
<a name="l01261"></a>01261 <span class="comment"></span>
<a name="l01262"></a>01262 <span class="comment"># If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated </span>
<a name="l01263"></a>01263 <span class="comment"># is prepared for conversion to pdf (using ps2pdf). The pdf file will </span>
<a name="l01264"></a>01264 <span class="comment"># contain links (just like the HTML output) instead of page references </span>
<a name="l01265"></a>01265 <span class="comment"># This makes the output suitable for online browsing using a pdf viewer.</span>
<a name="l01266"></a>01266 <span class="comment"></span>
<a name="l01267"></a>01267 <span class="comment">PDF_HYPERLINKS = NO</span>
<a name="l01268"></a>01268 <span class="comment"></span>
<a name="l01269"></a>01269 <span class="comment"># If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of </span>
<a name="l01270"></a>01270 <span class="comment"># plain latex in the generated Makefile. Set this option to YES to get a </span>
<a name="l01271"></a>01271 <span class="comment"># higher quality PDF documentation.</span>
<a name="l01272"></a>01272 <span class="comment"></span>
<a name="l01273"></a>01273 <span class="comment">USE_PDFLATEX = YES</span>
<a name="l01274"></a>01274 <span class="comment"></span>
<a name="l01275"></a>01275 <span class="comment"># If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. </span>
<a name="l01276"></a>01276 <span class="comment"># command to the generated LaTeX files. This will instruct LaTeX to keep </span>
<a name="l01277"></a>01277 <span class="comment"># running if errors occur, instead of asking the user for help. </span>
<a name="l01278"></a>01278 <span class="comment"># This option is also used when generating formulas in HTML.</span>
<a name="l01279"></a>01279 <span class="comment"></span>
<a name="l01280"></a>01280 <span class="comment">LATEX_BATCHMODE = NO</span>
<a name="l01281"></a>01281 <span class="comment"></span>
<a name="l01282"></a>01282 <span class="comment"># If LATEX_HIDE_INDICES is set to YES then doxygen will not </span>
<a name="l01283"></a>01283 <span class="comment"># include the index chapters (such as File Index, Compound Index, etc.) </span>
<a name="l01284"></a>01284 <span class="comment"># in the output.</span>
<a name="l01285"></a>01285 <span class="comment"></span>
<a name="l01286"></a>01286 <span class="comment">LATEX_HIDE_INDICES = NO</span>
<a name="l01287"></a>01287 <span class="comment"></span>
<a name="l01288"></a>01288 <span class="comment"># If LATEX_SOURCE_CODE is set to YES then doxygen will include </span>
<a name="l01289"></a>01289 <span class="comment"># source code with syntax highlighting in the LaTeX output. </span>
<a name="l01290"></a>01290 <span class="comment"># Note that which sources are shown also depends on other settings </span>
<a name="l01291"></a>01291 <span class="comment"># such as SOURCE_BROWSER.</span>
<a name="l01292"></a>01292 <span class="comment"></span>
<a name="l01293"></a>01293 <span class="comment">LATEX_SOURCE_CODE = NO</span>
<a name="l01294"></a>01294 <span class="comment"></span>
<a name="l01295"></a>01295 <span class="comment"># The LATEX_BIB_STYLE tag can be used to specify the style to use for the </span>
<a name="l01296"></a>01296 <span class="comment"># bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See </span>
<a name="l01297"></a>01297 <span class="comment"># http://en.wikipedia.org/wiki/BibTeX for more info.</span>
<a name="l01298"></a>01298 <span class="comment"></span>
<a name="l01299"></a>01299 <span class="comment">LATEX_BIB_STYLE = plain</span>
<a name="l01300"></a>01300 <span class="comment"></span>
<a name="l01301"></a>01301 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l01302"></a>01302 <span class="comment"># configuration options related to the RTF output</span>
<a name="l01303"></a>01303 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l01304"></a>01304 <span class="comment"></span>
<a name="l01305"></a>01305 <span class="comment"># If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output </span>
<a name="l01306"></a>01306 <span class="comment"># The RTF output is optimized for Word 97 and may not look very pretty with </span>
<a name="l01307"></a>01307 <span class="comment"># other RTF readers or editors.</span>
<a name="l01308"></a>01308 <span class="comment"></span>
<a name="l01309"></a>01309 <span class="comment">GENERATE_RTF = NO</span>
<a name="l01310"></a>01310 <span class="comment"></span>
<a name="l01311"></a>01311 <span class="comment"># The RTF_OUTPUT tag is used to specify where the RTF docs will be put. </span>
<a name="l01312"></a>01312 <span class="comment"># If a relative path is entered the value of OUTPUT_DIRECTORY will be </span>
<a name="l01313"></a>01313 <span class="comment"># put in front of it. If left blank `rtf' will be used as the default path.</span>
<a name="l01314"></a>01314 <span class="comment"></span>
<a name="l01315"></a>01315 <span class="comment">RTF_OUTPUT = glm.rtf</span>
<a name="l01316"></a>01316 <span class="comment"></span>
<a name="l01317"></a>01317 <span class="comment"># If the COMPACT_RTF tag is set to YES Doxygen generates more compact </span>
<a name="l01318"></a>01318 <span class="comment"># RTF documents. This may be useful for small projects and may help to </span>
<a name="l01319"></a>01319 <span class="comment"># save some trees in general.</span>
<a name="l01320"></a>01320 <span class="comment"></span>
<a name="l01321"></a>01321 <span class="comment">COMPACT_RTF = NO</span>
<a name="l01322"></a>01322 <span class="comment"></span>
<a name="l01323"></a>01323 <span class="comment"># If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated </span>
<a name="l01324"></a>01324 <span class="comment"># will contain hyperlink fields. The RTF file will </span>
<a name="l01325"></a>01325 <span class="comment"># contain links (just like the HTML output) instead of page references. </span>
<a name="l01326"></a>01326 <span class="comment"># This makes the output suitable for online browsing using WORD or other </span>
<a name="l01327"></a>01327 <span class="comment"># programs which support those fields. </span>
<a name="l01328"></a>01328 <span class="comment"># Note: wordpad (write) and others do not support links.</span>
<a name="l01329"></a>01329 <span class="comment"></span>
<a name="l01330"></a>01330 <span class="comment">RTF_HYPERLINKS = YES</span>
<a name="l01331"></a>01331 <span class="comment"></span>
<a name="l01332"></a>01332 <span class="comment"># Load style sheet definitions from file. Syntax is similar to doxygen's </span>
<a name="l01333"></a>01333 <span class="comment"># config file, i.e. a series of assignments. You only have to provide </span>
<a name="l01334"></a>01334 <span class="comment"># replacements, missing definitions are set to their default value.</span>
<a name="l01335"></a>01335 <span class="comment"></span>
<a name="l01336"></a>01336 <span class="comment">RTF_STYLESHEET_FILE = </span>
<a name="l01337"></a>01337 <span class="comment"></span>
<a name="l01338"></a>01338 <span class="comment"># Set optional variables used in the generation of an rtf document. </span>
<a name="l01339"></a>01339 <span class="comment"># Syntax is similar to doxygen's config file.</span>
<a name="l01340"></a>01340 <span class="comment"></span>
<a name="l01341"></a>01341 <span class="comment">RTF_EXTENSIONS_FILE = </span>
<a name="l01342"></a>01342 <span class="comment"></span>
<a name="l01343"></a>01343 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l01344"></a>01344 <span class="comment"># configuration options related to the man page output</span>
<a name="l01345"></a>01345 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l01346"></a>01346 <span class="comment"></span>
<a name="l01347"></a>01347 <span class="comment"># If the GENERATE_MAN tag is set to YES (the default) Doxygen will </span>
<a name="l01348"></a>01348 <span class="comment"># generate man pages</span>
<a name="l01349"></a>01349 <span class="comment"></span>
<a name="l01350"></a>01350 <span class="comment">GENERATE_MAN = NO</span>
<a name="l01351"></a>01351 <span class="comment"></span>
<a name="l01352"></a>01352 <span class="comment"># The MAN_OUTPUT tag is used to specify where the man pages will be put. </span>
<a name="l01353"></a>01353 <span class="comment"># If a relative path is entered the value of OUTPUT_DIRECTORY will be </span>
<a name="l01354"></a>01354 <span class="comment"># put in front of it. If left blank `man' will be used as the default path.</span>
<a name="l01355"></a>01355 <span class="comment"></span>
<a name="l01356"></a>01356 <span class="comment">MAN_OUTPUT = man</span>
<a name="l01357"></a>01357 <span class="comment"></span>
<a name="l01358"></a>01358 <span class="comment"># The MAN_EXTENSION tag determines the extension that is added to </span>
<a name="l01359"></a>01359 <span class="comment"># the generated man pages (default is the subroutine's section .3)</span>
<a name="l01360"></a>01360 <span class="comment"></span>
<a name="l01361"></a>01361 <span class="comment">MAN_EXTENSION = .3</span>
<a name="l01362"></a>01362 <span class="comment"></span>
<a name="l01363"></a>01363 <span class="comment"># If the MAN_LINKS tag is set to YES and Doxygen generates man output, </span>
<a name="l01364"></a>01364 <span class="comment"># then it will generate one additional man file for each entity </span>
<a name="l01365"></a>01365 <span class="comment"># documented in the real man page(s). These additional files </span>
<a name="l01366"></a>01366 <span class="comment"># only source the real man page, but without them the man command </span>
<a name="l01367"></a>01367 <span class="comment"># would be unable to find the correct page. The default is NO.</span>
<a name="l01368"></a>01368 <span class="comment"></span>
<a name="l01369"></a>01369 <span class="comment">MAN_LINKS = NO</span>
<a name="l01370"></a>01370 <span class="comment"></span>
<a name="l01371"></a>01371 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l01372"></a>01372 <span class="comment"># configuration options related to the XML output</span>
<a name="l01373"></a>01373 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l01374"></a>01374 <span class="comment"></span>
<a name="l01375"></a>01375 <span class="comment"># If the GENERATE_XML tag is set to YES Doxygen will </span>
<a name="l01376"></a>01376 <span class="comment"># generate an XML file that captures the structure of </span>
<a name="l01377"></a>01377 <span class="comment"># the code including all documentation.</span>
<a name="l01378"></a>01378 <span class="comment"></span>
<a name="l01379"></a>01379 <span class="comment">GENERATE_XML = NO</span>
<a name="l01380"></a>01380 <span class="comment"></span>
<a name="l01381"></a>01381 <span class="comment"># The XML_OUTPUT tag is used to specify where the XML pages will be put. </span>
<a name="l01382"></a>01382 <span class="comment"># If a relative path is entered the value of OUTPUT_DIRECTORY will be </span>
<a name="l01383"></a>01383 <span class="comment"># put in front of it. If left blank `xml' will be used as the default path.</span>
<a name="l01384"></a>01384 <span class="comment"></span>
<a name="l01385"></a>01385 <span class="comment">XML_OUTPUT = xml</span>
<a name="l01386"></a>01386 <span class="comment"></span>
<a name="l01387"></a>01387 <span class="comment"># The XML_SCHEMA tag can be used to specify an XML schema, </span>
<a name="l01388"></a>01388 <span class="comment"># which can be used by a validating XML parser to check the </span>
<a name="l01389"></a>01389 <span class="comment"># syntax of the XML files.</span>
<a name="l01390"></a>01390 <span class="comment"></span>
<a name="l01391"></a>01391 <span class="comment">XML_SCHEMA = </span>
<a name="l01392"></a>01392 <span class="comment"></span>
<a name="l01393"></a>01393 <span class="comment"># The XML_DTD tag can be used to specify an XML DTD, </span>
<a name="l01394"></a>01394 <span class="comment"># which can be used by a validating XML parser to check the </span>
<a name="l01395"></a>01395 <span class="comment"># syntax of the XML files.</span>
<a name="l01396"></a>01396 <span class="comment"></span>
<a name="l01397"></a>01397 <span class="comment">XML_DTD = </span>
<a name="l01398"></a>01398 <span class="comment"></span>
<a name="l01399"></a>01399 <span class="comment"># If the XML_PROGRAMLISTING tag is set to YES Doxygen will </span>
<a name="l01400"></a>01400 <span class="comment"># dump the program listings (including syntax highlighting </span>
<a name="l01401"></a>01401 <span class="comment"># and cross-referencing information) to the XML output. Note that </span>
<a name="l01402"></a>01402 <span class="comment"># enabling this will significantly increase the size of the XML output.</span>
<a name="l01403"></a>01403 <span class="comment"></span>
<a name="l01404"></a>01404 <span class="comment">XML_PROGRAMLISTING = YES</span>
<a name="l01405"></a>01405 <span class="comment"></span>
<a name="l01406"></a>01406 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l01407"></a>01407 <span class="comment"># configuration options for the AutoGen Definitions output</span>
<a name="l01408"></a>01408 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l01409"></a>01409 <span class="comment"></span>
<a name="l01410"></a>01410 <span class="comment"># If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will </span>
<a name="l01411"></a>01411 <span class="comment"># generate an AutoGen Definitions (see autogen.sf.net) file </span>
<a name="l01412"></a>01412 <span class="comment"># that captures the structure of the code including all </span>
<a name="l01413"></a>01413 <span class="comment"># documentation. Note that this feature is still experimental </span>
<a name="l01414"></a>01414 <span class="comment"># and incomplete at the moment.</span>
<a name="l01415"></a>01415 <span class="comment"></span>
<a name="l01416"></a>01416 <span class="comment">GENERATE_AUTOGEN_DEF = NO</span>
<a name="l01417"></a>01417 <span class="comment"></span>
<a name="l01418"></a>01418 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l01419"></a>01419 <span class="comment"># configuration options related to the Perl module output</span>
<a name="l01420"></a>01420 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l01421"></a>01421 <span class="comment"></span>
<a name="l01422"></a>01422 <span class="comment"># If the GENERATE_PERLMOD tag is set to YES Doxygen will </span>
<a name="l01423"></a>01423 <span class="comment"># generate a Perl module file that captures the structure of </span>
<a name="l01424"></a>01424 <span class="comment"># the code including all documentation. Note that this </span>
<a name="l01425"></a>01425 <span class="comment"># feature is still experimental and incomplete at the </span>
<a name="l01426"></a>01426 <span class="comment"># moment.</span>
<a name="l01427"></a>01427 <span class="comment"></span>
<a name="l01428"></a>01428 <span class="comment">GENERATE_PERLMOD = NO</span>
<a name="l01429"></a>01429 <span class="comment"></span>
<a name="l01430"></a>01430 <span class="comment"># If the PERLMOD_LATEX tag is set to YES Doxygen will generate </span>
<a name="l01431"></a>01431 <span class="comment"># the necessary Makefile rules, Perl scripts and LaTeX code to be able </span>
<a name="l01432"></a>01432 <span class="comment"># to generate PDF and DVI output from the Perl module output.</span>
<a name="l01433"></a>01433 <span class="comment"></span>
<a name="l01434"></a>01434 <span class="comment">PERLMOD_LATEX = NO</span>
<a name="l01435"></a>01435 <span class="comment"></span>
<a name="l01436"></a>01436 <span class="comment"># If the PERLMOD_PRETTY tag is set to YES the Perl module output will be </span>
<a name="l01437"></a>01437 <span class="comment"># nicely formatted so it can be parsed by a human reader. This is useful </span>
<a name="l01438"></a>01438 <span class="comment"># if you want to understand what is going on. On the other hand, if this </span>
<a name="l01439"></a>01439 <span class="comment"># tag is set to NO the size of the Perl module output will be much smaller </span>
<a name="l01440"></a>01440 <span class="comment"># and Perl will parse it just the same.</span>
<a name="l01441"></a>01441 <span class="comment"></span>
<a name="l01442"></a>01442 <span class="comment">PERLMOD_PRETTY = YES</span>
<a name="l01443"></a>01443 <span class="comment"></span>
<a name="l01444"></a>01444 <span class="comment"># The names of the make variables in the generated doxyrules.make file </span>
<a name="l01445"></a>01445 <span class="comment"># are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. </span>
<a name="l01446"></a>01446 <span class="comment"># This is useful so different doxyrules.make files included by the same </span>
<a name="l01447"></a>01447 <span class="comment"># Makefile don't overwrite each other's variables.</span>
<a name="l01448"></a>01448 <span class="comment"></span>
<a name="l01449"></a>01449 <span class="comment">PERLMOD_MAKEVAR_PREFIX = </span>
<a name="l01450"></a>01450 <span class="comment"></span>
<a name="l01451"></a>01451 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l01452"></a>01452 <span class="comment"># Configuration options related to the preprocessor</span>
<a name="l01453"></a>01453 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l01454"></a>01454 <span class="comment"></span>
<a name="l01455"></a>01455 <span class="comment"># If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will </span>
<a name="l01456"></a>01456 <span class="comment"># evaluate all C-preprocessor directives found in the sources and include </span>
<a name="l01457"></a>01457 <span class="comment"># files.</span>
<a name="l01458"></a>01458 <span class="comment"></span>
<a name="l01459"></a>01459 <span class="comment">ENABLE_PREPROCESSING = YES</span>
<a name="l01460"></a>01460 <span class="comment"></span>
<a name="l01461"></a>01461 <span class="comment"># If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro </span>
<a name="l01462"></a>01462 <span class="comment"># names in the source code. If set to NO (the default) only conditional </span>
<a name="l01463"></a>01463 <span class="comment"># compilation will be performed. Macro expansion can be done in a controlled </span>
<a name="l01464"></a>01464 <span class="comment"># way by setting EXPAND_ONLY_PREDEF to YES.</span>
<a name="l01465"></a>01465 <span class="comment"></span>
<a name="l01466"></a>01466 <span class="comment">MACRO_EXPANSION = NO</span>
<a name="l01467"></a>01467 <span class="comment"></span>
<a name="l01468"></a>01468 <span class="comment"># If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES </span>
<a name="l01469"></a>01469 <span class="comment"># then the macro expansion is limited to the macros specified with the </span>
<a name="l01470"></a>01470 <span class="comment"># PREDEFINED and EXPAND_AS_DEFINED tags.</span>
<a name="l01471"></a>01471 <span class="comment"></span>
<a name="l01472"></a>01472 <span class="comment">EXPAND_ONLY_PREDEF = NO</span>
<a name="l01473"></a>01473 <span class="comment"></span>
<a name="l01474"></a>01474 <span class="comment"># If the SEARCH_INCLUDES tag is set to YES (the default) the includes files </span>
<a name="l01475"></a>01475 <span class="comment"># pointed to by INCLUDE_PATH will be searched when a #include is found.</span>
<a name="l01476"></a>01476 <span class="comment"></span>
<a name="l01477"></a>01477 <span class="comment">SEARCH_INCLUDES = YES</span>
<a name="l01478"></a>01478 <span class="comment"></span>
<a name="l01479"></a>01479 <span class="comment"># The INCLUDE_PATH tag can be used to specify one or more directories that </span>
<a name="l01480"></a>01480 <span class="comment"># contain include files that are not input files but should be processed by </span>
<a name="l01481"></a>01481 <span class="comment"># the preprocessor.</span>
<a name="l01482"></a>01482 <span class="comment"></span>
<a name="l01483"></a>01483 <span class="comment">INCLUDE_PATH = </span>
<a name="l01484"></a>01484 <span class="comment"></span>
<a name="l01485"></a>01485 <span class="comment"># You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard </span>
<a name="l01486"></a>01486 <span class="comment"># patterns (like *.h and *.hpp) to filter out the header-files in the </span>
<a name="l01487"></a>01487 <span class="comment"># directories. If left blank, the patterns specified with FILE_PATTERNS will </span>
<a name="l01488"></a>01488 <span class="comment"># be used.</span>
<a name="l01489"></a>01489 <span class="comment"></span>
<a name="l01490"></a>01490 <span class="comment">INCLUDE_FILE_PATTERNS = </span>
<a name="l01491"></a>01491 <span class="comment"></span>
<a name="l01492"></a>01492 <span class="comment"># The PREDEFINED tag can be used to specify one or more macro names that </span>
<a name="l01493"></a>01493 <span class="comment"># are defined before the preprocessor is started (similar to the -D option of </span>
<a name="l01494"></a>01494 <span class="comment"># gcc). The argument of the tag is a list of macros of the form: name </span>
<a name="l01495"></a>01495 <span class="comment"># or name=definition (no spaces). If the definition and the = are </span>
<a name="l01496"></a>01496 <span class="comment"># omitted =1 is assumed. To prevent a macro definition from being </span>
<a name="l01497"></a>01497 <span class="comment"># undefined via #undef or recursively expanded use the := operator </span>
<a name="l01498"></a>01498 <span class="comment"># instead of the = operator.</span>
<a name="l01499"></a>01499 <span class="comment"></span>
<a name="l01500"></a>01500 <span class="comment">PREDEFINED = </span>
<a name="l01501"></a>01501 <span class="comment"></span>
<a name="l01502"></a>01502 <span class="comment"># If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then </span>
<a name="l01503"></a>01503 <span class="comment"># this tag can be used to specify a list of macro names that should be expanded. </span>
<a name="l01504"></a>01504 <span class="comment"># The macro definition that is found in the sources will be used. </span>
<a name="l01505"></a>01505 <span class="comment"># Use the PREDEFINED tag if you want to use a different macro definition that </span>
<a name="l01506"></a>01506 <span class="comment"># overrules the definition found in the source code.</span>
<a name="l01507"></a>01507 <span class="comment"></span>
<a name="l01508"></a>01508 <span class="comment">EXPAND_AS_DEFINED = </span>
<a name="l01509"></a>01509 <span class="comment"></span>
<a name="l01510"></a>01510 <span class="comment"># If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then </span>
<a name="l01511"></a>01511 <span class="comment"># doxygen's preprocessor will remove all references to function-like macros </span>
<a name="l01512"></a>01512 <span class="comment"># that are alone on a line, have an all uppercase name, and do not end with a </span>
<a name="l01513"></a>01513 <span class="comment"># semicolon, because these will confuse the parser if not removed.</span>
<a name="l01514"></a>01514 <span class="comment"></span>
<a name="l01515"></a>01515 <span class="comment">SKIP_FUNCTION_MACROS = YES</span>
<a name="l01516"></a>01516 <span class="comment"></span>
<a name="l01517"></a>01517 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l01518"></a>01518 <span class="comment"># Configuration::additions related to external references</span>
<a name="l01519"></a>01519 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l01520"></a>01520 <span class="comment"></span>
<a name="l01521"></a>01521 <span class="comment"># The TAGFILES option can be used to specify one or more tagfiles. </span>
<a name="l01522"></a>01522 <span class="comment"># Optionally an initial location of the external documentation </span>
<a name="l01523"></a>01523 <span class="comment"># can be added for each tagfile. The format of a tag file without </span>
<a name="l01524"></a>01524 <span class="comment"># this location is as follows: </span>
<a name="l01525"></a>01525 <span class="comment"># TAGFILES = file1 file2 ... </span>
<a name="l01526"></a>01526 <span class="comment"># Adding location for the tag files is done as follows: </span>
<a name="l01527"></a>01527 <span class="comment"># TAGFILES = file1=loc1 "file2 = loc2" ... </span>
<a name="l01528"></a>01528 <span class="comment"># where "loc1" and "loc2" can be relative or absolute paths or </span>
<a name="l01529"></a>01529 <span class="comment"># URLs. If a location is present for each tag, the installdox tool </span>
<a name="l01530"></a>01530 <span class="comment"># does not have to be run to correct the links. </span>
<a name="l01531"></a>01531 <span class="comment"># Note that each tag file must have a unique name </span>
<a name="l01532"></a>01532 <span class="comment"># (where the name does NOT include the path) </span>
<a name="l01533"></a>01533 <span class="comment"># If a tag file is not located in the directory in which doxygen </span>
<a name="l01534"></a>01534 <span class="comment"># is run, you must also specify the path to the tagfile here.</span>
<a name="l01535"></a>01535 <span class="comment"></span>
<a name="l01536"></a>01536 <span class="comment">TAGFILES = </span>
<a name="l01537"></a>01537 <span class="comment"></span>
<a name="l01538"></a>01538 <span class="comment"># When a file name is specified after GENERATE_TAGFILE, doxygen will create </span>
<a name="l01539"></a>01539 <span class="comment"># a tag file that is based on the input files it reads.</span>
<a name="l01540"></a>01540 <span class="comment"></span>
<a name="l01541"></a>01541 <span class="comment">GENERATE_TAGFILE = </span>
<a name="l01542"></a>01542 <span class="comment"></span>
<a name="l01543"></a>01543 <span class="comment"># If the ALLEXTERNALS tag is set to YES all external classes will be listed </span>
<a name="l01544"></a>01544 <span class="comment"># in the class index. If set to NO only the inherited external classes </span>
<a name="l01545"></a>01545 <span class="comment"># will be listed.</span>
<a name="l01546"></a>01546 <span class="comment"></span>
<a name="l01547"></a>01547 <span class="comment">ALLEXTERNALS = NO</span>
<a name="l01548"></a>01548 <span class="comment"></span>
<a name="l01549"></a>01549 <span class="comment"># If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed </span>
<a name="l01550"></a>01550 <span class="comment"># in the modules index. If set to NO, only the current project's groups will </span>
<a name="l01551"></a>01551 <span class="comment"># be listed.</span>
<a name="l01552"></a>01552 <span class="comment"></span>
<a name="l01553"></a>01553 <span class="comment">EXTERNAL_GROUPS = YES</span>
<a name="l01554"></a>01554 <span class="comment"></span>
<a name="l01555"></a>01555 <span class="comment"># The PERL_PATH should be the absolute path and name of the perl script </span>
<a name="l01556"></a>01556 <span class="comment"># interpreter (i.e. the result of `which perl').</span>
<a name="l01557"></a>01557 <span class="comment"></span>
<a name="l01558"></a>01558 <span class="comment">PERL_PATH = /usr/bin/perl</span>
<a name="l01559"></a>01559 <span class="comment"></span>
<a name="l01560"></a>01560 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l01561"></a>01561 <span class="comment"># Configuration options related to the dot tool</span>
<a name="l01562"></a>01562 <span class="comment">#---------------------------------------------------------------------------</span>
<a name="l01563"></a>01563 <span class="comment"></span>
<a name="l01564"></a>01564 <span class="comment"># If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will </span>
<a name="l01565"></a>01565 <span class="comment"># generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base </span>
<a name="l01566"></a>01566 <span class="comment"># or super classes. Setting the tag to NO turns the diagrams off. Note that </span>
<a name="l01567"></a>01567 <span class="comment"># this option also works with HAVE_DOT disabled, but it is recommended to </span>
<a name="l01568"></a>01568 <span class="comment"># install and use dot, since it yields more powerful graphs.</span>
<a name="l01569"></a>01569 <span class="comment"></span>
<a name="l01570"></a>01570 <span class="comment">CLASS_DIAGRAMS = YES</span>
<a name="l01571"></a>01571 <span class="comment"></span>
<a name="l01572"></a>01572 <span class="comment"># You can define message sequence charts within doxygen comments using the \msc </span>
<a name="l01573"></a>01573 <span class="comment"># command. Doxygen will then run the mscgen tool (see </span>
<a name="l01574"></a>01574 <span class="comment"># http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the </span>
<a name="l01575"></a>01575 <span class="comment"># documentation. The MSCGEN_PATH tag allows you to specify the directory where </span>
<a name="l01576"></a>01576 <span class="comment"># the mscgen tool resides. If left empty the tool is assumed to be found in the </span>
<a name="l01577"></a>01577 <span class="comment"># default search path.</span>
<a name="l01578"></a>01578 <span class="comment"></span>
<a name="l01579"></a>01579 <span class="comment">MSCGEN_PATH = </span>
<a name="l01580"></a>01580 <span class="comment"></span>
<a name="l01581"></a>01581 <span class="comment"># If set to YES, the inheritance and collaboration graphs will hide </span>
<a name="l01582"></a>01582 <span class="comment"># inheritance and usage relations if the target is undocumented </span>
<a name="l01583"></a>01583 <span class="comment"># or is not a class.</span>
<a name="l01584"></a>01584 <span class="comment"></span>
<a name="l01585"></a>01585 <span class="comment">HIDE_UNDOC_RELATIONS = YES</span>
<a name="l01586"></a>01586 <span class="comment"></span>
<a name="l01587"></a>01587 <span class="comment"># If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is </span>
<a name="l01588"></a>01588 <span class="comment"># available from the path. This tool is part of Graphviz, a graph visualization </span>
<a name="l01589"></a>01589 <span class="comment"># toolkit from AT&T and Lucent Bell Labs. The other options in this section </span>
<a name="l01590"></a>01590 <span class="comment"># have no effect if this option is set to NO (the default)</span>
<a name="l01591"></a>01591 <span class="comment"></span>
<a name="l01592"></a>01592 <span class="comment">HAVE_DOT = NO</span>
<a name="l01593"></a>01593 <span class="comment"></span>
<a name="l01594"></a>01594 <span class="comment"># The DOT_NUM_THREADS specifies the number of dot invocations doxygen is </span>
<a name="l01595"></a>01595 <span class="comment"># allowed to run in parallel. When set to 0 (the default) doxygen will </span>
<a name="l01596"></a>01596 <span class="comment"># base this on the number of processors available in the system. You can set it </span>
<a name="l01597"></a>01597 <span class="comment"># explicitly to a value larger than 0 to get control over the balance </span>
<a name="l01598"></a>01598 <span class="comment"># between CPU load and processing speed.</span>
<a name="l01599"></a>01599 <span class="comment"></span>
<a name="l01600"></a>01600 <span class="comment">DOT_NUM_THREADS = 0</span>
<a name="l01601"></a>01601 <span class="comment"></span>
<a name="l01602"></a>01602 <span class="comment"># By default doxygen will use the Helvetica font for all dot files that </span>
<a name="l01603"></a>01603 <span class="comment"># doxygen generates. When you want a differently looking font you can specify </span>
<a name="l01604"></a>01604 <span class="comment"># the font name using DOT_FONTNAME. You need to make sure dot is able to find </span>
<a name="l01605"></a>01605 <span class="comment"># the font, which can be done by putting it in a standard location or by setting </span>
<a name="l01606"></a>01606 <span class="comment"># the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the </span>
<a name="l01607"></a>01607 <span class="comment"># directory containing the font.</span>
<a name="l01608"></a>01608 <span class="comment"></span>
<a name="l01609"></a>01609 <span class="comment">DOT_FONTNAME = FreeSans</span>
<a name="l01610"></a>01610 <span class="comment"></span>
<a name="l01611"></a>01611 <span class="comment"># The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. </span>
<a name="l01612"></a>01612 <span class="comment"># The default size is 10pt.</span>
<a name="l01613"></a>01613 <span class="comment"></span>
<a name="l01614"></a>01614 <span class="comment">DOT_FONTSIZE = 10</span>
<a name="l01615"></a>01615 <span class="comment"></span>
<a name="l01616"></a>01616 <span class="comment"># By default doxygen will tell dot to use the Helvetica font. </span>
<a name="l01617"></a>01617 <span class="comment"># If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to </span>
<a name="l01618"></a>01618 <span class="comment"># set the path where dot can find it.</span>
<a name="l01619"></a>01619 <span class="comment"></span>
<a name="l01620"></a>01620 <span class="comment">DOT_FONTPATH = </span>
<a name="l01621"></a>01621 <span class="comment"></span>
<a name="l01622"></a>01622 <span class="comment"># If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen </span>
<a name="l01623"></a>01623 <span class="comment"># will generate a graph for each documented class showing the direct and </span>
<a name="l01624"></a>01624 <span class="comment"># indirect inheritance relations. Setting this tag to YES will force the </span>
<a name="l01625"></a>01625 <span class="comment"># CLASS_DIAGRAMS tag to NO.</span>
<a name="l01626"></a>01626 <span class="comment"></span>
<a name="l01627"></a>01627 <span class="comment">CLASS_GRAPH = YES</span>
<a name="l01628"></a>01628 <span class="comment"></span>
<a name="l01629"></a>01629 <span class="comment"># If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen </span>
<a name="l01630"></a>01630 <span class="comment"># will generate a graph for each documented class showing the direct and </span>
<a name="l01631"></a>01631 <span class="comment"># indirect implementation dependencies (inheritance, containment, and </span>
<a name="l01632"></a>01632 <span class="comment"># class references variables) of the class with other documented classes.</span>
<a name="l01633"></a>01633 <span class="comment"></span>
<a name="l01634"></a>01634 <span class="comment">COLLABORATION_GRAPH = YES</span>
<a name="l01635"></a>01635 <span class="comment"></span>
<a name="l01636"></a>01636 <span class="comment"># If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen </span>
<a name="l01637"></a>01637 <span class="comment"># will generate a graph for groups, showing the direct groups dependencies</span>
<a name="l01638"></a>01638 <span class="comment"></span>
<a name="l01639"></a>01639 <span class="comment">GROUP_GRAPHS = YES</span>
<a name="l01640"></a>01640 <span class="comment"></span>
<a name="l01641"></a>01641 <span class="comment"># If the UML_LOOK tag is set to YES doxygen will generate inheritance and </span>
<a name="l01642"></a>01642 <span class="comment"># collaboration diagrams in a style similar to the OMG's Unified Modeling </span>
<a name="l01643"></a>01643 <span class="comment"># Language.</span>
<a name="l01644"></a>01644 <span class="comment"></span>
<a name="l01645"></a>01645 <span class="comment">UML_LOOK = NO</span>
<a name="l01646"></a>01646 <span class="comment"></span>
<a name="l01647"></a>01647 <span class="comment"># If set to YES, the inheritance and collaboration graphs will show the </span>
<a name="l01648"></a>01648 <span class="comment"># relations between templates and their instances.</span>
<a name="l01649"></a>01649 <span class="comment"></span>
<a name="l01650"></a>01650 <span class="comment">TEMPLATE_RELATIONS = NO</span>
<a name="l01651"></a>01651 <span class="comment"></span>
<a name="l01652"></a>01652 <span class="comment"># If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT </span>
<a name="l01653"></a>01653 <span class="comment"># tags are set to YES then doxygen will generate a graph for each documented </span>
<a name="l01654"></a>01654 <span class="comment"># file showing the direct and indirect include dependencies of the file with </span>
<a name="l01655"></a>01655 <span class="comment"># other documented files.</span>
<a name="l01656"></a>01656 <span class="comment"></span>
<a name="l01657"></a>01657 <span class="comment">INCLUDE_GRAPH = YES</span>
<a name="l01658"></a>01658 <span class="comment"></span>
<a name="l01659"></a>01659 <span class="comment"># If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and </span>
<a name="l01660"></a>01660 <span class="comment"># HAVE_DOT tags are set to YES then doxygen will generate a graph for each </span>
<a name="l01661"></a>01661 <span class="comment"># documented header file showing the documented files that directly or </span>
<a name="l01662"></a>01662 <span class="comment"># indirectly include this file.</span>
<a name="l01663"></a>01663 <span class="comment"></span>
<a name="l01664"></a>01664 <span class="comment">INCLUDED_BY_GRAPH = YES</span>
<a name="l01665"></a>01665 <span class="comment"></span>
<a name="l01666"></a>01666 <span class="comment"># If the CALL_GRAPH and HAVE_DOT options are set to YES then </span>
<a name="l01667"></a>01667 <span class="comment"># doxygen will generate a call dependency graph for every global function </span>
<a name="l01668"></a>01668 <span class="comment"># or class method. Note that enabling this option will significantly increase </span>
<a name="l01669"></a>01669 <span class="comment"># the time of a run. So in most cases it will be better to enable call graphs </span>
<a name="l01670"></a>01670 <span class="comment"># for selected functions only using the \callgraph command.</span>
<a name="l01671"></a>01671 <span class="comment"></span>
<a name="l01672"></a>01672 <span class="comment">CALL_GRAPH = YES</span>
<a name="l01673"></a>01673 <span class="comment"></span>
<a name="l01674"></a>01674 <span class="comment"># If the CALLER_GRAPH and HAVE_DOT tags are set to YES then </span>
<a name="l01675"></a>01675 <span class="comment"># doxygen will generate a caller dependency graph for every global function </span>
<a name="l01676"></a>01676 <span class="comment"># or class method. Note that enabling this option will significantly increase </span>
<a name="l01677"></a>01677 <span class="comment"># the time of a run. So in most cases it will be better to enable caller </span>
<a name="l01678"></a>01678 <span class="comment"># graphs for selected functions only using the \callergraph command.</span>
<a name="l01679"></a>01679 <span class="comment"></span>
<a name="l01680"></a>01680 <span class="comment">CALLER_GRAPH = YES</span>
<a name="l01681"></a>01681 <span class="comment"></span>
<a name="l01682"></a>01682 <span class="comment"># If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen </span>
<a name="l01683"></a>01683 <span class="comment"># will generate a graphical hierarchy of all classes instead of a textual one.</span>
<a name="l01684"></a>01684 <span class="comment"></span>
<a name="l01685"></a>01685 <span class="comment">GRAPHICAL_HIERARCHY = YES</span>
<a name="l01686"></a>01686 <span class="comment"></span>
<a name="l01687"></a>01687 <span class="comment"># If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES </span>
<a name="l01688"></a>01688 <span class="comment"># then doxygen will show the dependencies a directory has on other directories </span>
<a name="l01689"></a>01689 <span class="comment"># in a graphical way. The dependency relations are determined by the #include </span>
<a name="l01690"></a>01690 <span class="comment"># relations between the files in the directories.</span>
<a name="l01691"></a>01691 <span class="comment"></span>
<a name="l01692"></a>01692 <span class="comment">DIRECTORY_GRAPH = YES</span>
<a name="l01693"></a>01693 <span class="comment"></span>
<a name="l01694"></a>01694 <span class="comment"># The DOT_IMAGE_FORMAT tag can be used to set the image format of the images </span>
<a name="l01695"></a>01695 <span class="comment"># generated by dot. Possible values are svg, png, jpg, or gif. </span>
<a name="l01696"></a>01696 <span class="comment"># If left blank png will be used. If you choose svg you need to set </span>
<a name="l01697"></a>01697 <span class="comment"># HTML_FILE_EXTENSION to xhtml in order to make the SVG files </span>
<a name="l01698"></a>01698 <span class="comment"># visible in IE 9+ (other browsers do not have this requirement).</span>
<a name="l01699"></a>01699 <span class="comment"></span>
<a name="l01700"></a>01700 <span class="comment">DOT_IMAGE_FORMAT = png</span>
<a name="l01701"></a>01701 <span class="comment"></span>
<a name="l01702"></a>01702 <span class="comment"># If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to </span>
<a name="l01703"></a>01703 <span class="comment"># enable generation of interactive SVG images that allow zooming and panning. </span>
<a name="l01704"></a>01704 <span class="comment"># Note that this requires a modern browser other than Internet Explorer. </span>
<a name="l01705"></a>01705 <span class="comment"># Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you </span>
<a name="l01706"></a>01706 <span class="comment"># need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files </span>
<a name="l01707"></a>01707 <span class="comment"># visible. Older versions of IE do not have SVG support.</span>
<a name="l01708"></a>01708 <span class="comment"></span>
<a name="l01709"></a>01709 <span class="comment">INTERACTIVE_SVG = NO</span>
<a name="l01710"></a>01710 <span class="comment"></span>
<a name="l01711"></a>01711 <span class="comment"># The tag DOT_PATH can be used to specify the path where the dot tool can be </span>
<a name="l01712"></a>01712 <span class="comment"># found. If left blank, it is assumed the dot tool can be found in the path.</span>
<a name="l01713"></a>01713 <span class="comment"></span>
<a name="l01714"></a>01714 <span class="comment">DOT_PATH = </span>
<a name="l01715"></a>01715 <span class="comment"></span>
<a name="l01716"></a>01716 <span class="comment"># The DOTFILE_DIRS tag can be used to specify one or more directories that </span>
<a name="l01717"></a>01717 <span class="comment"># contain dot files that are included in the documentation (see the </span>
<a name="l01718"></a>01718 <span class="comment"># \dotfile command).</span>
<a name="l01719"></a>01719 <span class="comment"></span>
<a name="l01720"></a>01720 <span class="comment">DOTFILE_DIRS = </span>
<a name="l01721"></a>01721 <span class="comment"></span>
<a name="l01722"></a>01722 <span class="comment"># The MSCFILE_DIRS tag can be used to specify one or more directories that </span>
<a name="l01723"></a>01723 <span class="comment"># contain msc files that are included in the documentation (see the </span>
<a name="l01724"></a>01724 <span class="comment"># \mscfile command).</span>
<a name="l01725"></a>01725 <span class="comment"></span>
<a name="l01726"></a>01726 <span class="comment">MSCFILE_DIRS = </span>
<a name="l01727"></a>01727 <span class="comment"></span>
<a name="l01728"></a>01728 <span class="comment"># The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of </span>
<a name="l01729"></a>01729 <span class="comment"># nodes that will be shown in the graph. If the number of nodes in a graph </span>
<a name="l01730"></a>01730 <span class="comment"># becomes larger than this value, doxygen will truncate the graph, which is </span>
<a name="l01731"></a>01731 <span class="comment"># visualized by representing a node as a red box. Note that doxygen if the </span>
<a name="l01732"></a>01732 <span class="comment"># number of direct children of the root node in a graph is already larger than </span>
<a name="l01733"></a>01733 <span class="comment"># DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note </span>
<a name="l01734"></a>01734 <span class="comment"># that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.</span>
<a name="l01735"></a>01735 <span class="comment"></span>
<a name="l01736"></a>01736 <span class="comment">DOT_GRAPH_MAX_NODES = 50</span>
<a name="l01737"></a>01737 <span class="comment"></span>
<a name="l01738"></a>01738 <span class="comment"># The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the </span>
<a name="l01739"></a>01739 <span class="comment"># graphs generated by dot. A depth value of 3 means that only nodes reachable </span>
<a name="l01740"></a>01740 <span class="comment"># from the root by following a path via at most 3 edges will be shown. Nodes </span>
<a name="l01741"></a>01741 <span class="comment"># that lay further from the root node will be omitted. Note that setting this </span>
<a name="l01742"></a>01742 <span class="comment"># option to 1 or 2 may greatly reduce the computation time needed for large </span>
<a name="l01743"></a>01743 <span class="comment"># code bases. Also note that the size of a graph can be further restricted by </span>
<a name="l01744"></a>01744 <span class="comment"># DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.</span>
<a name="l01745"></a>01745 <span class="comment"></span>
<a name="l01746"></a>01746 <span class="comment">MAX_DOT_GRAPH_DEPTH = 1000</span>
<a name="l01747"></a>01747 <span class="comment"></span>
<a name="l01748"></a>01748 <span class="comment"># Set the DOT_TRANSPARENT tag to YES to generate images with a transparent </span>
<a name="l01749"></a>01749 <span class="comment"># background. This is disabled by default, because dot on Windows does not </span>
<a name="l01750"></a>01750 <span class="comment"># seem to support this out of the box. Warning: Depending on the platform used, </span>
<a name="l01751"></a>01751 <span class="comment"># enabling this option may lead to badly anti-aliased labels on the edges of </span>
<a name="l01752"></a>01752 <span class="comment"># a graph (i.e. they become hard to read).</span>
<a name="l01753"></a>01753 <span class="comment"></span>
<a name="l01754"></a>01754 <span class="comment">DOT_TRANSPARENT = NO</span>
<a name="l01755"></a>01755 <span class="comment"></span>
<a name="l01756"></a>01756 <span class="comment"># Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output </span>
<a name="l01757"></a>01757 <span class="comment"># files in one run (i.e. multiple -o and -T options on the command line). This </span>
<a name="l01758"></a>01758 <span class="comment"># makes dot run faster, but since only newer versions of dot (>1.8.10) </span>
<a name="l01759"></a>01759 <span class="comment"># support this, this feature is disabled by default.</span>
<a name="l01760"></a>01760 <span class="comment"></span>
<a name="l01761"></a>01761 <span class="comment">DOT_MULTI_TARGETS = NO</span>
<a name="l01762"></a>01762 <span class="comment"></span>
<a name="l01763"></a>01763 <span class="comment"># If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will </span>
<a name="l01764"></a>01764 <span class="comment"># generate a legend page explaining the meaning of the various boxes and </span>
<a name="l01765"></a>01765 <span class="comment"># arrows in the dot generated graphs.</span>
<a name="l01766"></a>01766 <span class="comment"></span>
<a name="l01767"></a>01767 <span class="comment">GENERATE_LEGEND = YES</span>
<a name="l01768"></a>01768 <span class="comment"></span>
<a name="l01769"></a>01769 <span class="comment"># If the DOT_CLEANUP tag is set to YES (the default) Doxygen will </span>
<a name="l01770"></a>01770 <span class="comment"># remove the intermediate dot files that are used to generate </span>
<a name="l01771"></a>01771 <span class="comment"># the various graphs.</span>
<a name="l01772"></a>01772 <span class="comment"></span>
<a name="l01773"></a>01773 <span class="comment">DOT_CLEANUP = YES</span>
</pre></div></div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.0
</small></address>
</body>
</html>
|
