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