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