310 FALSE |
310 FALSE |
311 ); |
311 ); |
312 //---- |
312 //---- |
313 cl = cfg->addList( |
313 cl = cfg->addList( |
314 "EXTENSION_MAPPING", |
314 "EXTENSION_MAPPING", |
315 "Doxygen selects the parser to use depending on the extension of the files it parses.\n" |
315 "Doxygen selects the parser to use depending on the extension of the files it\n" |
316 "With this tag you can assign which parser to use for a given extension.\n" |
316 "parses. With this tag you can assign which parser to use for a given extension.\n" |
317 "Doxygen has a built-in mapping, but you can override or extend it using this tag.\n" |
317 "Doxygen has a built-in mapping, but you can override or extend it using this\n" |
318 "The format is ext=language, where ext is a file extension, and language is one of\n" |
318 "tag. The format is ext=language, where ext is a file extension, and language\n" |
319 "the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,\n" |
319 "is one of the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++,\n" |
320 "Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat\n" |
320 "D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make\n" |
321 ".inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),\n" |
321 "doxygen treat .inc files as Fortran files (default is PHP), and .f files as C\n" |
322 "use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen." |
322 "(default is Fortran), use: inc=Fortran f=C. Note that for custom extensions\n" |
|
323 "you also need to set FILE_PATTERNS otherwise the files are not read by doxygen." |
323 ); |
324 ); |
324 //---- |
325 //---- |
325 cb = cfg->addBool( |
326 cb = cfg->addBool( |
326 "BUILTIN_STL_SUPPORT", |
327 "BUILTIN_STL_SUPPORT", |
327 "If you use STL classes (i.e. std::string, std::vector, etc.) but do not want\n" |
328 "If you use STL classes (i.e. std::string, std::vector, etc.) but do not want\n" |
567 FALSE |
568 FALSE |
568 ); |
569 ); |
569 //---- |
570 //---- |
570 cb = cfg->addBool( |
571 cb = cfg->addBool( |
571 "SORT_MEMBERS_CTORS_1ST", |
572 "SORT_MEMBERS_CTORS_1ST", |
572 "If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.", |
573 "If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen\n" |
|
574 "will sort the (brief and detailed) documentation of class members so that\n" |
|
575 "constructors and destructors are listed first. If set to NO (the default)\n" |
|
576 "the constructors will appear in the respective orders defined by\n" |
|
577 "SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.\n" |
|
578 "This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO\n" |
|
579 "and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.", |
573 FALSE |
580 FALSE |
574 ); |
581 ); |
575 //---- |
582 //---- |
576 cb = cfg->addBool( |
583 cb = cfg->addBool( |
577 "SORT_GROUP_NAMES", |
584 "SORT_GROUP_NAMES", |
688 ); |
695 ); |
689 cs->setWidgetType(ConfigString::File); |
696 cs->setWidgetType(ConfigString::File); |
690 //---- |
697 //---- |
691 cs = cfg->addString( |
698 cs = cfg->addString( |
692 "LAYOUT_FILE", |
699 "LAYOUT_FILE", |
693 "The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by\n" |
700 "The LAYOUT_FILE tag can be used to specify a layout file which will be parsed\n" |
694 "doxygen. The layout file controls the global structure of the generated output files\n" |
701 "by doxygen. The layout file controls the global structure of the generated\n" |
695 "in an output format independent way. The create the layout file that represents\n" |
702 "output files in an output format independent way. The create the layout file\n" |
696 "doxygen's defaults, run doxygen with the -l option. You can optionally specify a\n" |
703 "that represents doxygen's defaults, run doxygen with the -l option.\n" |
697 "file name after the option, if omitted DoxygenLayout.xml will be used as the name\n" |
704 "You can optionally specify a file name after the option, if omitted\n" |
698 "of the layout file." |
705 "DoxygenLayout.xml will be used as the name of the layout file." |
699 ); |
706 ); |
700 cs->setWidgetType(ConfigString::File); |
707 cs->setWidgetType(ConfigString::File); |
701 //---- |
708 //---- |
702 cb = cfg->addBool( |
709 cb = cfg->addBool( |
703 "OUTPUT_INCLUDES", |
710 "OUTPUT_INCLUDES", |
1107 "stylesheet in the HTML output directory as well, or it will be erased!" |
1114 "stylesheet in the HTML output directory as well, or it will be erased!" |
1108 ); |
1115 ); |
1109 cs->setWidgetType(ConfigString::File); |
1116 cs->setWidgetType(ConfigString::File); |
1110 cs->addDependency("GENERATE_HTML"); |
1117 cs->addDependency("GENERATE_HTML"); |
1111 //---- |
1118 //---- |
|
1119 ci = cfg->addInt( |
|
1120 "HTML_COLORSTYLE_HUE", |
|
1121 "The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.\n" |
|
1122 "Doxygen will adjust the colors in the stylesheet and background images\n" |
|
1123 "according to this color. Hue is specified as an angle on a colorwheel,\n" |
|
1124 "see http://en.wikipedia.org/wiki/Hue for more information.\n" |
|
1125 "For instance the value 0 represents red, 60 is yellow, 120 is green,\n" |
|
1126 "180 is cyan, 240 is blue, 300 purple, and 360 is red again.\n" |
|
1127 "The allowed range is 0 to 359.", |
|
1128 0,359,220 |
|
1129 ); |
|
1130 ci->addDependency("GENERATE_HTML"); |
|
1131 //---- |
|
1132 ci = cfg->addInt( |
|
1133 "HTML_COLORSTYLE_SAT", |
|
1134 "The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of\n" |
|
1135 "the colors in the HTML output. For a value of 0 the output will use\n" |
|
1136 "grayscales only. A value of 255 will produce the most vivid colors.", |
|
1137 0,255,100 |
|
1138 ); |
|
1139 ci->addDependency("GENERATE_HTML"); |
|
1140 //---- |
|
1141 ci = cfg->addInt( |
|
1142 "HTML_COLORSTYLE_GAMMA", |
|
1143 "The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to\n" |
|
1144 "the luminance component of the colors in the HTML output. Values below\n" |
|
1145 "100 gradually make the output lighter, whereas values above 100 make\n" |
|
1146 "the output darker. The value divided by 100 is the actual gamma applied,\n" |
|
1147 "so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,\n" |
|
1148 "and 100 does not change the gamma.", |
|
1149 40,240,80 |
|
1150 ); |
|
1151 //---- |
1112 cb = cfg->addBool( |
1152 cb = cfg->addBool( |
1113 "HTML_TIMESTAMP", |
1153 "HTML_TIMESTAMP", |
1114 "If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML\n" |
1154 "If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML\n" |
1115 "page will contain the date and time when the page was generated. Setting\n" |
1155 "page will contain the date and time when the page was generated. Setting\n" |
1116 "this to NO can help when comparing the output of multiple runs.", |
1156 "this to NO can help when comparing the output of multiple runs.", |
1117 FALSE |
1157 TRUE |
1118 ); |
1158 ); |
1119 cb->addDependency("GENERATE_HTML"); |
1159 cb->addDependency("GENERATE_HTML"); |
1120 //---- |
1160 //---- |
1121 cb = cfg->addBool( |
1161 cb = cfg->addBool( |
1122 "HTML_ALIGN_MEMBERS", |
1162 "HTML_ALIGN_MEMBERS", |
1146 "To create a documentation set, doxygen will generate a Makefile in the\n" |
1186 "To create a documentation set, doxygen will generate a Makefile in the\n" |
1147 "HTML output directory. Running make will produce the docset in that\n" |
1187 "HTML output directory. Running make will produce the docset in that\n" |
1148 "directory and running \"make install\" will install the docset in\n" |
1188 "directory and running \"make install\" will install the docset in\n" |
1149 "~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find\n" |
1189 "~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find\n" |
1150 "it at startup.\n" |
1190 "it at startup.\n" |
1151 "See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.", |
1191 "See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html\n" |
|
1192 "for more information.", |
1152 FALSE |
1193 FALSE |
1153 ); |
1194 ); |
1154 cb->addDependency("GENERATE_HTML"); |
1195 cb->addDependency("GENERATE_HTML"); |
1155 //---- |
1196 //---- |
1156 cs = cfg->addString( |
1197 cs = cfg->addString( |
1237 ); |
1278 ); |
1238 cb->addDependency("GENERATE_HTMLHELP"); |
1279 cb->addDependency("GENERATE_HTMLHELP"); |
1239 //---- |
1280 //---- |
1240 cb = cfg->addBool( |
1281 cb = cfg->addBool( |
1241 "GENERATE_QHP", |
1282 "GENERATE_QHP", |
1242 "If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER\n" |
1283 "If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and\n" |
1243 "are set, an additional index file will be generated that can be used as input for\n" |
1284 "QHP_VIRTUAL_FOLDER are set, an additional index file will be generated\n" |
1244 "Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated\n" |
1285 "that can be used as input for Qt's qhelpgenerator to generate a\n" |
1245 "HTML documentation.", |
1286 "Qt Compressed Help (.qch) of the generated HTML documentation.", |
1246 FALSE |
1287 FALSE |
1247 ); |
1288 ); |
1248 cb->addDependency("GENERATE_HTML"); |
1289 cb->addDependency("GENERATE_HTML"); |
1249 //---- |
1290 //---- |
1250 cs = cfg->addString( |
1291 cs = cfg->addString( |
1274 cs->setDefaultValue("doc"); |
1315 cs->setDefaultValue("doc"); |
1275 cs->addDependency("GENERATE_QHP"); |
1316 cs->addDependency("GENERATE_QHP"); |
1276 //---- |
1317 //---- |
1277 cs = cfg->addString( |
1318 cs = cfg->addString( |
1278 "QHP_CUST_FILTER_NAME", |
1319 "QHP_CUST_FILTER_NAME", |
1279 "If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.\n" |
1320 "If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to\n" |
1280 "For more information please see\n" |
1321 "add. For more information please see\n" |
1281 "http://doc.trolltech.com/qthelpproject.html#custom-filters" |
1322 "http://doc.trolltech.com/qthelpproject.html#custom-filters" |
1282 ); |
1323 ); |
1283 cs->addDependency("GENERATE_QHP"); |
1324 cs->addDependency("GENERATE_QHP"); |
1284 //---- |
1325 //---- |
1285 cs = cfg->addString( |
1326 cs = cfg->addString( |
1286 "QHP_CUST_FILTER_ATTRS", |
1327 "QHP_CUST_FILTER_ATTRS", |
1287 "The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see\n" |
1328 "The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the\n" |
1288 "<a href=\"http://doc.trolltech.com/qthelpproject.html#custom-filters\">Qt Help Project / Custom Filters</a>." |
1329 "custom filter to add. For more information please see\n" |
|
1330 "<a href=\"http://doc.trolltech.com/qthelpproject.html#custom-filters\">\n" |
|
1331 "Qt Help Project / Custom Filters</a>." |
1289 ); |
1332 ); |
1290 cs->addDependency("GENERATE_QHP"); |
1333 cs->addDependency("GENERATE_QHP"); |
1291 //---- |
1334 //---- |
1292 cs = cfg->addString( |
1335 cs = cfg->addString( |
1293 "QHP_SECT_FILTER_ATTRS", |
1336 "QHP_SECT_FILTER_ATTRS", |
1294 "The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's\n" |
1337 "The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this\n" |
|
1338 "project's\n" |
1295 "filter section matches.\n" |
1339 "filter section matches.\n" |
1296 "<a href=\"http://doc.trolltech.com/qthelpproject.html#filter-attributes\">Qt Help Project / Filter Attributes</a>." |
1340 "<a href=\"http://doc.trolltech.com/qthelpproject.html#filter-attributes\">\n" |
|
1341 "Qt Help Project / Filter Attributes</a>." |
1297 ); |
1342 ); |
1298 cs->addDependency("GENERATE_QHP"); |
1343 cs->addDependency("GENERATE_QHP"); |
1299 //---- |
1344 //---- |
1300 cs = cfg->addString( |
1345 cs = cfg->addString( |
1301 "QHG_LOCATION", |
1346 "QHG_LOCATION", |
1309 //---- |
1354 //---- |
1310 cb = cfg->addBool( |
1355 cb = cfg->addBool( |
1311 "GENERATE_ECLIPSEHELP", |
1356 "GENERATE_ECLIPSEHELP", |
1312 "If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files\n" |
1357 "If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files\n" |
1313 " will be generated, which together with the HTML files, form an Eclipse help\n" |
1358 " will be generated, which together with the HTML files, form an Eclipse help\n" |
1314 " plugin. To install this plugin and make it available under the help contents\n" |
1359 "plugin. To install this plugin and make it available under the help contents\n" |
1315 "menu in Eclipse, the contents of the directory containing the HTML and XML\n" |
1360 "menu in Eclipse, the contents of the directory containing the HTML and XML\n" |
1316 "files needs to be copied into the plugins directory of eclipse. The name of\n" |
1361 "files needs to be copied into the plugins directory of eclipse. The name of\n" |
1317 "the directory within the plugins directory should be the same as\n" |
1362 "the directory within the plugins directory should be the same as\n" |
1318 "the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears.", |
1363 "the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before\n" |
|
1364 "the help appears.", |
1319 FALSE |
1365 FALSE |
1320 ); |
1366 ); |
1321 cb->addDependency("GENERATE_HTML"); |
1367 cb->addDependency("GENERATE_HTML"); |
1322 //---- |
1368 //---- |
1323 cs = cfg->addString( |
1369 cs = cfg->addString( |
1387 ); |
1433 ); |
1388 ci->addDependency("GENERATE_HTML"); |
1434 ci->addDependency("GENERATE_HTML"); |
1389 //---- |
1435 //---- |
1390 cb = cfg->addBool( |
1436 cb = cfg->addBool( |
1391 "SEARCHENGINE", |
1437 "SEARCHENGINE", |
1392 "When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript\n" |
1438 "When the SEARCHENGINE tag is enabled doxygen will generate a search box\n" |
1393 "and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should\n" |
1439 "for the HTML output. The underlying search engine uses javascript\n" |
|
1440 "and DHTML and should work on any modern browser. Note that when using\n" |
|
1441 "HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets\n" |
|
1442 "(GENERATE_DOCSET) there is already a search function so this one should\n" |
1394 "typically be disabled. For large projects the javascript based search engine\n" |
1443 "typically be disabled. For large projects the javascript based search engine\n" |
1395 "can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.", |
1444 "can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.", |
1396 TRUE |
1445 TRUE |
1397 ); |
1446 ); |
1398 cb->addDependency("GENERATE_HTML"); |
1447 cb->addDependency("GENERATE_HTML"); |
1399 //---- |
1448 //---- |
1400 cb = cfg->addBool( |
1449 cb = cfg->addBool( |
1401 "SERVER_BASED_SEARCH", |
1450 "SERVER_BASED_SEARCH", |
1402 "When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index\n" |
1451 "When the SERVER_BASED_SEARCH tag is enabled the search engine will be\n" |
1403 "file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup\n" |
1452 "implemented using a PHP enabled web server instead of at the web client\n" |
|
1453 "using Javascript. Doxygen will generate the search PHP script and index\n" |
|
1454 "file to put on the web server. The advantage of the server\n" |
|
1455 "based approach is that it scales better to large projects and allows\n" |
|
1456 "full text search. The disadvances is that it is more difficult to setup\n" |
1404 "and does not have live searching capabilities.", |
1457 "and does not have live searching capabilities.", |
1405 FALSE |
1458 FALSE |
1406 ); |
1459 ); |
1407 cb->addDependency("SEARCHENGINE"); |
1460 cb->addDependency("SEARCHENGINE"); |
1408 //--------------------------------------------------------------------------- |
1461 //--------------------------------------------------------------------------- |
1527 ); |
1580 ); |
1528 cb->addDependency("GENERATE_LATEX"); |
1581 cb->addDependency("GENERATE_LATEX"); |
1529 //---- |
1582 //---- |
1530 cb = cfg->addBool( |
1583 cb = cfg->addBool( |
1531 "LATEX_SOURCE_CODE", |
1584 "LATEX_SOURCE_CODE", |
1532 "If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.", |
1585 "If LATEX_SOURCE_CODE is set to YES then doxygen will include\n" |
|
1586 "source code with syntax highlighting in the LaTeX output.\n" |
|
1587 "Note that which sources are shown also depends on other settings\n" |
|
1588 "such as SOURCE_BROWSER.", |
1533 FALSE |
1589 FALSE |
1534 ); |
1590 ); |
1535 cb->addDependency("GENERATE_LATEX"); |
1591 cb->addDependency("GENERATE_LATEX"); |
1536 //--------------------------------------------------------------------------- |
1592 //--------------------------------------------------------------------------- |
1537 cfg->addInfo("RTF","configuration options related to the RTF output"); |
1593 cfg->addInfo("RTF","configuration options related to the RTF output"); |