Changeset 3092 in Sophya for trunk/SophyaLib/Manual
- Timestamp:
- Oct 11, 2006, 6:47:06 PM (19 years ago)
- Location:
- trunk/SophyaLib/Manual
- Files:
-
- 3 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SophyaLib/Manual/dox_sophya.conf
r976 r3092 1 # Doxyfile 1.1.1 2 # The format is: TAG = value [value, ...] 1 # Doxyfile 1.4.3 2 3 # This file describes the settings to be used by the documentation system 4 # doxygen (www.doxygen.org) for a project 5 # 6 # All text after a hash (#) is considered a comment and will be ignored 7 # The format is: 8 # TAG = value [value, ...] 9 # For lists items can also be appended using: 10 # TAG += value [value, ...] 3 11 # Values that contain spaces should be placed between quotes (" ") 4 12 5 13 #--------------------------------------------------------------------------- 6 # Generalconfiguration options7 #--------------------------------------------------------------------------- 8 9 # The PROJECT_NAME tag is a single word (or a sequence of word surrounded10 # by quotes) that should identify the project. 11 12 PROJECT_NAME = SOPHYA13 14 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 14 # Project related configuration options 15 #--------------------------------------------------------------------------- 16 17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 18 # by quotes) that should identify the project. 19 20 PROJECT_NAME = SOPHYA 21 22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 15 23 # This could be handy for archiving the generated documentation or 16 24 # if some version control system is used. 17 25 18 PROJECT_NUMBER =26 PROJECT_NUMBER = 19 27 20 28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) … … 23 31 # where doxygen was started. If left blank the current directory will be used. 24 32 25 OUTPUT_DIRECTORY = . 26 27 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 28 # documentation generated by doxygen is written. Doxygen will use this 29 # information to generate all constant output in the proper language. 33 OUTPUT_DIRECTORY = . 34 35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 36 # 4096 sub-directories (in 2 levels) under the output directory of each output 37 # format and will distribute the generated files over these directories. 38 # Enabling this option can be useful when feeding doxygen a huge amount of 39 # source files, where putting all generated files in the same directory would 40 # otherwise cause performance problems for the file system. 41 42 CREATE_SUBDIRS = NO 43 44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 45 # documentation generated by doxygen is written. Doxygen will use this 46 # information to generate all constant output in the proper language. 30 47 # The default language is English, other supported languages are: 31 # Dutch, French, Italian, Czech, Swedish, German and Japanese 32 33 OUTPUT_LANGUAGE = English 34 35 # The QUIET tag can be used to turn on/off the messages that are generated 36 # by doxygen. Possible values are YES and NO. If left blank NO is used. 37 38 QUIET = NO 39 40 # The WARNINGS tag can be used to turn on/off the warning messages that are 41 # generated by doxygen. Possible values are YES and NO. If left blank 42 # NO is used. 43 44 WARNINGS = YES 45 46 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 47 # top of each HTML page. The value NO (the default) enables the index and 48 # the value YES disables it. 49 50 DISABLE_INDEX = NO 51 52 # If the EXTRACT_ALL tag is set to YES all classes and functions will be 53 # included in the documentation, even if no documentation was available. 54 55 EXTRACT_ALL = YES 56 57 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 58 # will be included in the documentation. 59 60 EXTRACT_PRIVATE = NO 61 62 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 63 # undocumented members inside documented classes or files. 64 65 HIDE_UNDOC_MEMBERS = NO 66 67 # If the HIDE_UNDOC_CLASSESS tag is set to YES, Doxygen will hide all 68 # undocumented classes. 69 70 HIDE_UNDOC_CLASSES = NO 71 72 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 52 # Swedish, and Ukrainian. 53 54 OUTPUT_LANGUAGE = English 55 56 # This tag can be used to specify the encoding used in the generated output. 57 # The encoding is not always determined by the language that is chosen, 58 # but also whether or not the output is meant for Windows or non-Windows users. 59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 60 # forces the Windows encoding (this is the default for the Windows binary), 61 # whereas setting the tag to NO uses a Unix-style encoding (the default for 62 # all platforms other than Windows). 63 64 USE_WINDOWS_ENCODING = NO 65 66 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 73 67 # include brief member descriptions after the members that are listed in 74 # the file and class documentation (similar to JavaDoc). 68 # the file and class documentation (similar to JavaDoc). 75 69 # Set to NO to disable this. 76 70 77 BRIEF_MEMBER_DESC = YES78 79 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 80 # the brief description of a member or function before the detailed description. 71 BRIEF_MEMBER_DESC = YES 72 73 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 74 # the brief description of a member or function before the detailed description. 81 75 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 82 76 # brief descriptions will be completely suppressed. 83 77 84 REPEAT_BRIEF = YES 85 86 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 87 # Doxygen will generate a detailed section even if there is only a brief 78 REPEAT_BRIEF = YES 79 80 # This tag implements a quasi-intelligent brief description abbreviator 81 # that is used to form the text in various listings. Each string 82 # in this list, if found as the leading text of the brief description, will be 83 # stripped from the text and the result after processing the whole list, is 84 # used as the annotated text. Otherwise, the brief description is used as-is. 85 # If left blank, the following values are used ("$name" is automatically 86 # replaced with the name of the entity): "The $name class" "The $name widget" 87 # "The $name file" "is" "provides" "specifies" "contains" 88 # "represents" "a" "an" "the" 89 90 ABBREVIATE_BRIEF = 91 92 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 93 # Doxygen will generate a detailed section even if there is only a brief 88 94 # description. 89 95 90 ALWAYS_DETAILED_SEC = NO 91 92 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 93 # path before files name in the file list and in the header files. If set 96 ALWAYS_DETAILED_SEC = NO 97 98 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 99 # inherited members of a class in the documentation of that class as if those 100 # members were ordinary class members. Constructors, destructors and assignment 101 # operators of the base classes will not be shown. 102 103 INLINE_INHERITED_MEMB = NO 104 105 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 106 # path before files name in the file list and in the header files. If set 94 107 # to NO the shortest path that makes the file name unique will be used. 95 108 96 FULL_PATH_NAMES = NO 97 98 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 99 # can be used to strip a user defined part of the path. Stripping is 100 # only done if one of the specified strings matches the left-hand part of 101 # the path. 102 103 STRIP_FROM_PATH = 104 105 # The INTERNAL_DOCS tag determines if documentation 109 FULL_PATH_NAMES = NO 110 111 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 112 # can be used to strip a user-defined part of the path. Stripping is 113 # only done if one of the specified strings matches the left-hand part of 114 # the path. The tag can be used to show relative paths in the file list. 115 # If left blank the directory from which doxygen is run is used as the 116 # path to strip. 117 118 STRIP_FROM_PATH = 119 120 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 121 # the path mentioned in the documentation of a class, which tells 122 # the reader which header file to include in order to use a class. 123 # If left blank only the name of the header file containing the class 124 # definition is used. Otherwise one should specify the include paths that 125 # are normally passed to the compiler using the -I flag. 126 127 STRIP_FROM_INC_PATH = 128 129 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 130 # (but less readable) file names. This can be useful is your file systems 131 # doesn't support long names like on DOS, Mac, or CD-ROM. 132 133 SHORT_NAMES = NO 134 135 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 136 # will interpret the first line (until the first dot) of a JavaDoc-style 137 # comment as the brief description. If set to NO, the JavaDoc 138 # comments will behave just like the Qt-style comments (thus requiring an 139 # explicit @brief command for a brief description. 140 141 JAVADOC_AUTOBRIEF = YES 142 143 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 144 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 145 # comments) as a brief description. This used to be the default behaviour. 146 # The new default is to treat a multi-line C++ comment block as a detailed 147 # description. Set this tag to YES if you prefer the old behaviour instead. 148 149 MULTILINE_CPP_IS_BRIEF = NO 150 151 # If the DETAILS_AT_TOP tag is set to YES then Doxygen 152 # will output the detailed description near the top, like JavaDoc. 153 # If set to NO, the detailed description appears after the member 154 # documentation. 155 156 DETAILS_AT_TOP = YES 157 158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 159 # member inherits the documentation from any documented member that it 160 # re-implements. 161 162 INHERIT_DOCS = YES 163 164 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 165 # tag is set to YES, then doxygen will reuse the documentation of the first 166 # member in the group (if any) for the other members of the group. By default 167 # all members of a group must be documented explicitly. 168 169 DISTRIBUTE_GROUP_DOC = NO 170 171 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 172 # a new page for each member. If set to NO, the documentation of a member will 173 # be part of the file/class/namespace that contains it. 174 175 SEPARATE_MEMBER_PAGES = NO 176 177 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 178 # Doxygen uses this value to replace tabs by spaces in code fragments. 179 180 TAB_SIZE = 8 181 182 # This tag can be used to specify a number of aliases that acts 183 # as commands in the documentation. An alias has the form "name=value". 184 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 185 # put the command \sideeffect (or @sideeffect) in the documentation, which 186 # will result in a user-defined paragraph with heading "Side Effects:". 187 # You can put \n's in the value part of an alias to insert newlines. 188 189 ALIASES = 190 191 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 192 # sources only. Doxygen will then generate output that is more tailored for C. 193 # For instance, some of the names that are used will be different. The list 194 # of all members will be omitted, etc. 195 196 OPTIMIZE_OUTPUT_FOR_C = NO 197 198 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 199 # only. Doxygen will then generate output that is more tailored for Java. 200 # For instance, namespaces will be presented as packages, qualified scopes 201 # will look different, etc. 202 203 OPTIMIZE_OUTPUT_JAVA = NO 204 205 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 206 # the same type (for instance a group of public functions) to be put as a 207 # subgroup of that type (e.g. under the Public Functions section). Set it to 208 # NO to prevent subgrouping. Alternatively, this can be done per class using 209 # the \nosubgrouping command. 210 211 SUBGROUPING = YES 212 213 #--------------------------------------------------------------------------- 214 # Build related configuration options 215 #--------------------------------------------------------------------------- 216 217 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 218 # documentation are documented, even if no documentation was available. 219 # Private class members and static file members will be hidden unless 220 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 221 222 EXTRACT_ALL = YES 223 224 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 225 # will be included in the documentation. 226 227 EXTRACT_PRIVATE = NO 228 229 # If the EXTRACT_STATIC tag is set to YES all static members of a file 230 # will be included in the documentation. 231 232 EXTRACT_STATIC = NO 233 234 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 235 # defined locally in source files will be included in the documentation. 236 # If set to NO only classes defined in header files are included. 237 238 EXTRACT_LOCAL_CLASSES = NO 239 240 # This flag is only useful for Objective-C code. When set to YES local 241 # methods, which are defined in the implementation section but not in 242 # the interface are included in the documentation. 243 # If set to NO (the default) only methods in the interface are included. 244 245 EXTRACT_LOCAL_METHODS = NO 246 247 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 248 # undocumented members of documented classes, files or namespaces. 249 # If set to NO (the default) these members will be included in the 250 # various overviews, but no documentation section is generated. 251 # This option has no effect if EXTRACT_ALL is enabled. 252 253 HIDE_UNDOC_MEMBERS = NO 254 255 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 256 # undocumented classes that are normally visible in the class hierarchy. 257 # If set to NO (the default) these classes will be included in the various 258 # overviews. This option has no effect if EXTRACT_ALL is enabled. 259 260 HIDE_UNDOC_CLASSES = NO 261 262 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 263 # friend (class|struct|union) declarations. 264 # If set to NO (the default) these declarations will be included in the 265 # documentation. 266 267 HIDE_FRIEND_COMPOUNDS = NO 268 269 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 270 # documentation blocks found inside the body of a function. 271 # If set to NO (the default) these blocks will be appended to the 272 # function's detailed documentation block. 273 274 HIDE_IN_BODY_DOCS = NO 275 276 # The INTERNAL_DOCS tag determines if documentation 106 277 # that is typed after a \internal command is included. If the tag is set 107 # to NO (the default) then the documentation will be excluded. 278 # to NO (the default) then the documentation will be excluded. 108 279 # Set it to YES to include the internal documentation. 109 280 110 INTERNAL_DOCS = NO 111 112 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 113 # generate a class diagram (in Html and LaTeX) for classes with base or 114 # super classes. Setting the tag to NO turns the diagrams off. 115 116 CLASS_DIAGRAMS = YES 117 118 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 119 # be generated. Documented entities will be cross-referenced with these sources. 120 121 SOURCE_BROWSER = NO 122 123 # Setting the INLINE_SOURCES tag to YES will include the body 124 # of functions and classes directly in the documentation. 125 126 INLINE_SOURCES = NO 127 128 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 129 # doxygen to hide any special comment blocks from generated source code 130 # fragments. Normal C and C++ comments will always remain visible. 131 132 STRIP_CODE_COMMENTS = YES 133 134 # If the CASE_SENSE_NAMES tag is set to NO (the default) then Doxygen 135 # will only generate file names in lower case letters. If set to 136 # YES upper case letters are also allowed. This is useful if you have 137 # classes or files whose names only differ in case and if your file system 138 # supports case sensitive file names. 139 140 CASE_SENSE_NAMES = NO 141 142 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 143 # will generate a verbatim copy of the header file for each class for 144 # which an include is specified. Set to NO to disable this. 145 146 VERBATIM_HEADERS = YES 147 148 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 149 # will put list of the files that are included by a file in the documentation 281 INTERNAL_DOCS = NO 282 283 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 284 # file names in lower-case letters. If set to YES upper-case letters are also 285 # allowed. This is useful if you have classes or files whose names only differ 286 # in case and if your file system supports case sensitive file names. Windows 287 # and Mac users are advised to set this option to NO. 288 289 CASE_SENSE_NAMES = NO 290 291 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 292 # will show members with their full class and namespace scopes in the 293 # documentation. If set to YES the scope will be hidden. 294 295 HIDE_SCOPE_NAMES = NO 296 297 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 298 # will put a list of the files that are included by a file in the documentation 150 299 # of that file. 151 300 152 SHOW_INCLUDE_FILES = YES 153 154 # If the JAVADOC_AUTOBRIEF tag is set to YES (the default) then Doxygen 155 # will interpret the first line (until the first dot) of a JavaDoc-style 156 # comment as the brief description. If set to NO, the Javadoc-style will 157 # behave just like the Qt-style comments. 158 159 JAVADOC_AUTOBRIEF = YES 160 161 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 162 # member inherits the documentation from any documented member that it 163 # reimplements. 164 165 INHERIT_DOCS = YES 166 167 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 301 SHOW_INCLUDE_FILES = YES 302 303 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 168 304 # is inserted in the documentation for inline members. 169 305 170 INLINE_INFO = YES171 172 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 306 INLINE_INFO = YES 307 308 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 173 309 # will sort the (detailed) documentation of file and class members 174 # alphabetically by member name. If set to NO the members will appear in 310 # alphabetically by member name. If set to NO the members will appear in 175 311 # declaration order. 176 312 177 SORT_MEMBER_DOCS = YES 178 179 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 180 # Doxygen uses this value to replace tabs by spaces in code fragments. 181 182 TAB_SIZE = 8 313 SORT_MEMBER_DOCS = NO 314 315 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 316 # brief documentation of file, namespace and class members alphabetically 317 # by member name. If set to NO (the default) the members will appear in 318 # declaration order. 319 320 SORT_BRIEF_DOCS = NO 321 322 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 323 # sorted by fully-qualified names, including namespaces. If set to 324 # NO (the default), the class list will be sorted only by class name, 325 # not including the namespace part. 326 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 327 # Note: This option applies only to the class list, not to the 328 # alphabetical list. 329 330 SORT_BY_SCOPE_NAME = NO 331 332 # The GENERATE_TODOLIST tag can be used to enable (YES) or 333 # disable (NO) the todo list. This list is created by putting \todo 334 # commands in the documentation. 335 336 GENERATE_TODOLIST = YES 337 338 # The GENERATE_TESTLIST tag can be used to enable (YES) or 339 # disable (NO) the test list. This list is created by putting \test 340 # commands in the documentation. 341 342 GENERATE_TESTLIST = YES 343 344 # The GENERATE_BUGLIST tag can be used to enable (YES) or 345 # disable (NO) the bug list. This list is created by putting \bug 346 # commands in the documentation. 347 348 GENERATE_BUGLIST = YES 349 350 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 351 # disable (NO) the deprecated list. This list is created by putting 352 # \deprecated commands in the documentation. 353 354 GENERATE_DEPRECATEDLIST= YES 355 356 # The ENABLED_SECTIONS tag can be used to enable conditional 357 # documentation sections, marked by \if sectionname ... \endif. 358 359 ENABLED_SECTIONS = 360 361 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 362 # the initial value of a variable or define consists of for it to appear in 363 # the documentation. If the initializer consists of more lines than specified 364 # here it will be hidden. Use a value of 0 to hide initializers completely. 365 # The appearance of the initializer of individual variables and defines in the 366 # documentation can be controlled using \showinitializer or \hideinitializer 367 # command in the documentation regardless of this setting. 368 369 MAX_INITIALIZER_LINES = 30 370 371 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 372 # at the bottom of the documentation of classes and structs. If set to YES the 373 # list will mention the files that were used to generate the documentation. 374 375 SHOW_USED_FILES = YES 376 377 # If the sources in your project are distributed over multiple directories 378 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 379 # in the documentation. 380 381 SHOW_DIRECTORIES = YES 382 383 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 384 # doxygen should invoke to get the current version for each file (typically from the 385 # version control system). Doxygen will invoke the program by executing (via 386 # popen()) the command <command> <input-file>, where <command> is the value of 387 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 388 # provided by doxygen. Whatever the progam writes to standard output 389 # is used as the file version. See the manual for examples. 390 391 FILE_VERSION_FILTER = 392 393 #--------------------------------------------------------------------------- 394 # configuration options related to warning and progress messages 395 #--------------------------------------------------------------------------- 396 397 # The QUIET tag can be used to turn on/off the messages that are generated 398 # by doxygen. Possible values are YES and NO. If left blank NO is used. 399 400 QUIET = NO 401 402 # The WARNINGS tag can be used to turn on/off the warning messages that are 403 # generated by doxygen. Possible values are YES and NO. If left blank 404 # NO is used. 405 406 WARNINGS = YES 407 408 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 409 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 410 # automatically be disabled. 411 412 WARN_IF_UNDOCUMENTED = YES 413 414 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 415 # potential errors in the documentation, such as not documenting some 416 # parameters in a documented function, or documenting parameters that 417 # don't exist or using markup commands wrongly. 418 419 WARN_IF_DOC_ERROR = YES 420 421 # This WARN_NO_PARAMDOC option can be abled to get warnings for 422 # functions that are documented, but have no documentation for their parameters 423 # or return value. If set to NO (the default) doxygen will only warn about 424 # wrong or incomplete parameter documentation, but not about the absence of 425 # documentation. 426 427 WARN_NO_PARAMDOC = NO 428 429 # The WARN_FORMAT tag determines the format of the warning messages that 430 # doxygen can produce. The string should contain the $file, $line, and $text 431 # tags, which will be replaced by the file and line number from which the 432 # warning originated and the warning text. Optionally the format may contain 433 # $version, which will be replaced by the version of the file (if it could 434 # be obtained via FILE_VERSION_FILTER) 435 436 WARN_FORMAT = "$file:$line: $text" 437 438 # The WARN_LOGFILE tag can be used to specify a file to which warning 439 # and error messages should be written. If left blank the output is written 440 # to stderr. 441 442 WARN_LOGFILE = 183 443 184 444 #--------------------------------------------------------------------------- … … 191 451 # with spaces. 192 452 193 INPUT =453 INPUT = 194 454 195 455 # If the value of the INPUT tag contains directories, you can use the 196 456 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 197 457 # and *.h) to filter out the source-files in the directories. If left 198 # blank all files are included. 199 200 FILE_PATTERNS = *.h *.cc *.c *.f *.cc *.C 201 202 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 203 # should be searched for input files as well. Possible values are YES and NO. 458 # blank the following patterns are tested: 459 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 460 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm 461 462 FILE_PATTERNS = *.h \ 463 *.cc \ 464 *.c \ 465 *.f \ 466 *.cc \ 467 *.C 468 469 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 470 # should be searched for input files as well. Possible values are YES and NO. 204 471 # If left blank NO is used. 205 472 206 RECURSIVE = NO207 208 # The EXCLUDE tag can be used to specify files and/or directories that should 473 RECURSIVE = NO 474 475 # The EXCLUDE tag can be used to specify files and/or directories that should 209 476 # excluded from the INPUT source files. This way you can easily exclude a 210 477 # subdirectory from a directory tree whose root is specified with the INPUT tag. 211 478 212 EXCLUDE = 213 214 # If the value of the INPUT tag contains directories, you can use the 215 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 479 EXCLUDE = 480 481 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 482 # directories that are symbolic links (a Unix filesystem feature) are excluded 483 # from the input. 484 485 EXCLUDE_SYMLINKS = NO 486 487 # If the value of the INPUT tag contains directories, you can use the 488 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 216 489 # certain files from those directories. 217 490 218 EXCLUDE_PATTERNS =491 EXCLUDE_PATTERNS = 219 492 220 493 # The EXAMPLE_PATH tag can be used to specify one or more files or … … 222 495 # the \include command). 223 496 224 EXAMPLE_PATH =225 226 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 497 EXAMPLE_PATH = 498 499 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 227 500 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 228 501 # and *.h) to filter out the source-files in the directories. If left 229 502 # blank all files are included. 230 503 231 EXAMPLE_PATTERNS = 504 EXAMPLE_PATTERNS = 505 506 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 507 # searched for input files to be used with the \include or \dontinclude 508 # commands irrespective of the value of the RECURSIVE tag. 509 # Possible values are YES and NO. If left blank NO is used. 510 511 EXAMPLE_RECURSIVE = NO 232 512 233 513 # The IMAGE_PATH tag can be used to specify one or more files or … … 235 515 # the \image command). 236 516 237 IMAGE_PATH =238 239 # The INPUT_FILTER tag can be used to specify a program that doxygen should 517 IMAGE_PATH = 518 519 # The INPUT_FILTER tag can be used to specify a program that doxygen should 240 520 # invoke to filter for each input file. Doxygen will invoke the filter program 241 # by executing (via popen()) the command <filter> <input-file>, where <filter> 242 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 243 # input file. Doxygen will then use the output that the filter program writes 244 # to standard output. 245 246 INPUT_FILTER = ./dox_filter 521 # by executing (via popen()) the command <filter> <input-file>, where <filter> 522 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 523 # input file. Doxygen will then use the output that the filter program writes 524 # to standard output. If FILTER_PATTERNS is specified, this tag will be 525 # ignored. 526 527 INPUT_FILTER = ./dox_filter 528 529 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 530 # basis. Doxygen will compare the file name with each pattern and apply the 531 # filter if there is a match. The filters are a list of the form: 532 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 533 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 534 # is applied to all files. 535 536 FILTER_PATTERNS = 537 538 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 539 # INPUT_FILTER) will be used to filter the input files when producing source 540 # files to browse (i.e. when SOURCE_BROWSER is set to YES). 541 542 FILTER_SOURCE_FILES = NO 543 544 #--------------------------------------------------------------------------- 545 # configuration options related to source browsing 546 #--------------------------------------------------------------------------- 547 548 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 549 # be generated. Documented entities will be cross-referenced with these sources. 550 # Note: To get rid of all source code in the generated output, make sure also 551 # VERBATIM_HEADERS is set to NO. 552 553 SOURCE_BROWSER = NO 554 555 # Setting the INLINE_SOURCES tag to YES will include the body 556 # of functions and classes directly in the documentation. 557 558 INLINE_SOURCES = NO 559 560 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 561 # doxygen to hide any special comment blocks from generated source code 562 # fragments. Normal C and C++ comments will always remain visible. 563 564 STRIP_CODE_COMMENTS = YES 565 566 # If the REFERENCED_BY_RELATION tag is set to YES (the default) 567 # then for each documented function all documented 568 # functions referencing it will be listed. 569 570 REFERENCED_BY_RELATION = YES 571 572 # If the REFERENCES_RELATION tag is set to YES (the default) 573 # then for each documented function all documented entities 574 # called/used by that function will be listed. 575 576 REFERENCES_RELATION = YES 577 578 # If the USE_HTAGS tag is set to YES then the references to source code 579 # will point to the HTML generated by the htags(1) tool instead of doxygen 580 # built-in source browser. The htags tool is part of GNU's global source 581 # tagging system (see http://www.gnu.org/software/global/global.html). You 582 # will need version 4.8.6 or higher. 583 584 USE_HTAGS = NO 585 586 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 587 # will generate a verbatim copy of the header file for each class for 588 # which an include is specified. Set to NO to disable this. 589 590 VERBATIM_HEADERS = YES 591 592 #--------------------------------------------------------------------------- 593 # configuration options related to the alphabetical class index 594 #--------------------------------------------------------------------------- 595 596 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 597 # of all compounds will be generated. Enable this if the project 598 # contains a lot of classes, structs, unions or interfaces. 599 600 ALPHABETICAL_INDEX = YES 601 602 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 603 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 604 # in which this list will be split (can be a number in the range [1..20]) 605 606 COLS_IN_ALPHA_INDEX = 3 607 608 # In case all classes in a project start with a common prefix, all 609 # classes will be put under the same header in the alphabetical index. 610 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 611 # should be ignored while generating the index headers. 612 613 IGNORE_PREFIX = SOPHYA:: 247 614 248 615 #--------------------------------------------------------------------------- … … 250 617 #--------------------------------------------------------------------------- 251 618 252 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 253 # generate HTML output 254 255 GENERATE_HTML = YES256 257 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 258 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 619 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 620 # generate HTML output. 621 622 GENERATE_HTML = YES 623 624 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 625 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 259 626 # put in front of it. If left blank `html' will be used as the default path. 260 627 261 HTML_OUTPUT = html 628 HTML_OUTPUT = html 629 630 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 631 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 632 # doxygen will generate files with .html extension. 633 634 HTML_FILE_EXTENSION = .html 262 635 263 636 # The HTML_HEADER tag can be used to specify a personal HTML header for … … 265 638 # standard header. 266 639 267 HTML_HEADER =640 HTML_HEADER = 268 641 269 642 # The HTML_FOOTER tag can be used to specify a personal HTML footer for … … 271 644 # standard footer. 272 645 273 HTML_FOOTER =274 275 # The HTML_STYLESHEET tag can be used to specify a user defined cascading646 HTML_FOOTER = 647 648 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 276 649 # style sheet that is used by each HTML page. It can be used to 277 # fine-tune the look of the HTML output. If the tag is left blank doxygen 278 # will generate a default style sheet 279 280 HTML_STYLESHEET = 281 282 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 283 # files or namespaces will be aligned in HTML using tables. If set to 650 # fine-tune the look of the HTML output. If the tag is left blank doxygen 651 # will generate a default style sheet. Note that doxygen will try to copy 652 # the style sheet file to the HTML output directory, so don't put your own 653 # stylesheet in the HTML output directory as well, or it will be erased! 654 655 HTML_STYLESHEET = 656 657 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 658 # files or namespaces will be aligned in HTML using tables. If set to 284 659 # NO a bullet list will be used. 285 660 286 HTML_ALIGN_MEMBERS = YES287 288 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 289 # will be generated that can be used as input for tools like the 290 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 661 HTML_ALIGN_MEMBERS = YES 662 663 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 664 # will be generated that can be used as input for tools like the 665 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 291 666 # of the generated HTML documentation. 292 667 293 GENERATE_HTMLHELP = NO 294 295 #--------------------------------------------------------------------------- 296 # configuration options related to the alphabetical class index 297 #--------------------------------------------------------------------------- 298 299 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 300 # of all compounds will be generated. Enable this if the project 301 # contains a lot of classes, structs, unions or interfaces. 302 303 ALPHABETICAL_INDEX = YES 304 305 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 306 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 307 # in which this list will be split (can be a number in the range [1..20]) 308 309 COLS_IN_ALPHA_INDEX = 3 310 311 # In case all classes in a project start with a common prefix, all 312 # classes will be put under the same header in the alphabetical index. 313 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 314 # should be ignored while generating the index headers. 315 316 IGNORE_PREFIX = SOPHYA:: 668 GENERATE_HTMLHELP = NO 669 670 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 671 # be used to specify the file name of the resulting .chm file. You 672 # can add a path in front of the file if the result should not be 673 # written to the html output directory. 674 675 CHM_FILE = 676 677 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 678 # be used to specify the location (absolute path including file name) of 679 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 680 # the HTML help compiler on the generated index.hhp. 681 682 HHC_LOCATION = 683 684 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 685 # controls if a separate .chi index file is generated (YES) or that 686 # it should be included in the master .chm file (NO). 687 688 GENERATE_CHI = NO 689 690 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 691 # controls whether a binary table of contents is generated (YES) or a 692 # normal table of contents (NO) in the .chm file. 693 694 BINARY_TOC = NO 695 696 # The TOC_EXPAND flag can be set to YES to add extra items for group members 697 # to the contents of the HTML help documentation and to the tree view. 698 699 TOC_EXPAND = NO 700 701 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 702 # top of each HTML page. The value NO (the default) enables the index and 703 # the value YES disables it. 704 705 DISABLE_INDEX = NO 706 707 # This tag can be used to set the number of enum values (range [1..20]) 708 # that doxygen will group on one line in the generated HTML documentation. 709 710 ENUM_VALUES_PER_LINE = 4 711 712 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 713 # generated containing a tree-like index structure (just like the one that 714 # is generated for HTML Help). For this to work a browser that supports 715 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 716 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 717 # probably better off using the HTML help feature. 718 719 GENERATE_TREEVIEW = NO 720 721 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 722 # used to set the initial width (in pixels) of the frame in which the tree 723 # is shown. 724 725 TREEVIEW_WIDTH = 250 317 726 318 727 #--------------------------------------------------------------------------- … … 320 729 #--------------------------------------------------------------------------- 321 730 322 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 731 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 323 732 # generate Latex output. 324 733 325 GENERATE_LATEX = YES326 327 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 328 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 734 GENERATE_LATEX = YES 735 736 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 737 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 329 738 # put in front of it. If left blank `latex' will be used as the default path. 330 739 331 LATEX_OUTPUT = latex 332 333 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 334 # LaTeX documents. This may be useful for small projects and may help to 740 LATEX_OUTPUT = latex 741 742 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 743 # invoked. If left blank `latex' will be used as the default command name. 744 745 LATEX_CMD_NAME = latex 746 747 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 748 # generate index for LaTeX. If left blank `makeindex' will be used as the 749 # default command name. 750 751 MAKEINDEX_CMD_NAME = makeindex 752 753 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 754 # LaTeX documents. This may be useful for small projects and may help to 335 755 # save some trees in general. 336 756 337 COMPACT_LATEX = NO338 339 # The PAPER_TYPE tag can be used to set the paper type that is used 757 COMPACT_LATEX = NO 758 759 # The PAPER_TYPE tag can be used to set the paper type that is used 340 760 # by the printer. Possible values are: a4, a4wide, letter, legal and 341 761 # executive. If left blank a4wide will be used. 342 762 343 PAPER_TYPE = a4wide344 345 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 763 PAPER_TYPE = a4wide 764 765 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 346 766 # packages that should be included in the LaTeX output. 347 767 348 EXTRA_PACKAGES =768 EXTRA_PACKAGES = 349 769 350 770 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 351 # the generated latex document. The header should contain everything until 771 # the generated latex document. The header should contain everything until 352 772 # the first chapter. If it is left blank doxygen will generate a 353 773 # standard header. Notice: only use this tag if you know what you are doing! 354 774 355 LATEX_HEADER =356 357 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 358 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 359 # contain links (just like the HTML output) instead of page references 775 LATEX_HEADER = 776 777 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 778 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 779 # contain links (just like the HTML output) instead of page references 360 780 # This makes the output suitable for online browsing using a pdf viewer. 361 781 362 PDF_HYPERLINKS = NO 363 364 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode. 365 # command to the generated LaTeX files. This will instruct LaTeX to keep 366 # running if errors occur, instead of asking the user for help. 782 PDF_HYPERLINKS = NO 783 784 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 785 # plain latex in the generated Makefile. Set this option to YES to get a 786 # higher quality PDF documentation. 787 788 USE_PDFLATEX = NO 789 790 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 791 # command to the generated LaTeX files. This will instruct LaTeX to keep 792 # running if errors occur, instead of asking the user for help. 367 793 # This option is also used when generating formulas in HTML. 368 # LATEX_BATCHMODE = NO 794 795 LATEX_BATCHMODE = NO 796 797 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 798 # include the index chapters (such as File Index, Compound Index, etc.) 799 # in the output. 800 801 LATEX_HIDE_INDICES = NO 369 802 370 803 #--------------------------------------------------------------------------- … … 372 805 #--------------------------------------------------------------------------- 373 806 374 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 375 # For now this is experimental and is disabled by default. The RTF output 376 # is optimised for Word 97 and may not look too pretty with other readers 377 # or editors. 378 379 #GENERATE_RTF = YES 380 GENERATE_RTF = NO 381 382 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 383 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 807 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 808 # The RTF output is optimized for Word 97 and may not look very pretty with 809 # other RTF readers or editors. 810 811 GENERATE_RTF = NO 812 813 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 814 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 384 815 # put in front of it. If left blank `rtf' will be used as the default path. 385 816 386 RTF_OUTPUT = rtf387 388 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 389 # RTF documents. This may be useful for small projects and may help to 817 RTF_OUTPUT = rtf 818 819 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 820 # RTF documents. This may be useful for small projects and may help to 390 821 # save some trees in general. 391 822 392 COMPACT_RTF = NO393 394 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 395 # will contain hyperlink fields. The RTF file will 396 # contain links (just like the HTML output) instead of page references. 397 # This makes the output suitable for online browsing using a WORD or other.398 # programs which support those fields. 823 COMPACT_RTF = NO 824 825 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 826 # will contain hyperlink fields. The RTF file will 827 # contain links (just like the HTML output) instead of page references. 828 # This makes the output suitable for online browsing using WORD or other 829 # programs which support those fields. 399 830 # Note: wordpad (write) and others do not support links. 400 831 401 RTF_HYPERLINKS = NO 832 RTF_HYPERLINKS = NO 833 834 # Load stylesheet definitions from file. Syntax is similar to doxygen's 835 # config file, i.e. a series of assignments. You only have to provide 836 # replacements, missing definitions are set to their default value. 837 838 RTF_STYLESHEET_FILE = 839 840 # Set optional variables used in the generation of an rtf document. 841 # Syntax is similar to doxygen's config file. 842 843 RTF_EXTENSIONS_FILE = 844 402 845 #--------------------------------------------------------------------------- 403 846 # configuration options related to the man page output 404 847 #--------------------------------------------------------------------------- 405 848 406 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 849 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 407 850 # generate man pages 408 851 409 # GENERATE_MAN = YES 410 GENERATE_MAN = NO 411 412 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 413 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 852 GENERATE_MAN = NO 853 854 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 855 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 414 856 # put in front of it. If left blank `man' will be used as the default path. 415 857 416 MAN_OUTPUT = man417 418 # The MAN_EXTENSION tag determines the extension that is added to 858 MAN_OUTPUT = man 859 860 # The MAN_EXTENSION tag determines the extension that is added to 419 861 # the generated man pages (default is the subroutine's section .3) 420 862 421 MAN_EXTENSION = .3 422 423 #--------------------------------------------------------------------------- 424 # Configuration options related to the preprocessor 425 #--------------------------------------------------------------------------- 426 427 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 428 # evaluate all C-preprocessor directives found in the sources and include 863 MAN_EXTENSION = .3 864 865 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 866 # then it will generate one additional man file for each entity 867 # documented in the real man page(s). These additional files 868 # only source the real man page, but without them the man command 869 # would be unable to find the correct page. The default is NO. 870 871 MAN_LINKS = NO 872 873 #--------------------------------------------------------------------------- 874 # configuration options related to the XML output 875 #--------------------------------------------------------------------------- 876 877 # If the GENERATE_XML tag is set to YES Doxygen will 878 # generate an XML file that captures the structure of 879 # the code including all documentation. 880 881 GENERATE_XML = NO 882 883 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 884 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 885 # put in front of it. If left blank `xml' will be used as the default path. 886 887 XML_OUTPUT = xml 888 889 # The XML_SCHEMA tag can be used to specify an XML schema, 890 # which can be used by a validating XML parser to check the 891 # syntax of the XML files. 892 893 XML_SCHEMA = 894 895 # The XML_DTD tag can be used to specify an XML DTD, 896 # which can be used by a validating XML parser to check the 897 # syntax of the XML files. 898 899 XML_DTD = 900 901 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 902 # dump the program listings (including syntax highlighting 903 # and cross-referencing information) to the XML output. Note that 904 # enabling this will significantly increase the size of the XML output. 905 906 XML_PROGRAMLISTING = YES 907 908 #--------------------------------------------------------------------------- 909 # configuration options for the AutoGen Definitions output 910 #--------------------------------------------------------------------------- 911 912 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 913 # generate an AutoGen Definitions (see autogen.sf.net) file 914 # that captures the structure of the code including all 915 # documentation. Note that this feature is still experimental 916 # and incomplete at the moment. 917 918 GENERATE_AUTOGEN_DEF = NO 919 920 #--------------------------------------------------------------------------- 921 # configuration options related to the Perl module output 922 #--------------------------------------------------------------------------- 923 924 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 925 # generate a Perl module file that captures the structure of 926 # the code including all documentation. Note that this 927 # feature is still experimental and incomplete at the 928 # moment. 929 930 GENERATE_PERLMOD = NO 931 932 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 933 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 934 # to generate PDF and DVI output from the Perl module output. 935 936 PERLMOD_LATEX = NO 937 938 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 939 # nicely formatted so it can be parsed by a human reader. This is useful 940 # if you want to understand what is going on. On the other hand, if this 941 # tag is set to NO the size of the Perl module output will be much smaller 942 # and Perl will parse it just the same. 943 944 PERLMOD_PRETTY = YES 945 946 # The names of the make variables in the generated doxyrules.make file 947 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 948 # This is useful so different doxyrules.make files included by the same 949 # Makefile don't overwrite each other's variables. 950 951 PERLMOD_MAKEVAR_PREFIX = 952 953 #--------------------------------------------------------------------------- 954 # Configuration options related to the preprocessor 955 #--------------------------------------------------------------------------- 956 957 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 958 # evaluate all C-preprocessor directives found in the sources and include 429 959 # files. 430 960 431 ENABLE_PREPROCESSING = YES432 433 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 961 ENABLE_PREPROCESSING = YES 962 963 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 434 964 # names in the source code. If set to NO (the default) only conditional 435 # compilation will be performed. 436 437 MACRO_EXPANSION = NO 438 439 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 965 # compilation will be performed. Macro expansion can be done in a controlled 966 # way by setting EXPAND_ONLY_PREDEF to YES. 967 968 MACRO_EXPANSION = NO 969 970 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 971 # then the macro expansion is limited to the macros specified with the 972 # PREDEFINED and EXPAND_AS_PREDEFINED tags. 973 974 EXPAND_ONLY_PREDEF = NO 975 976 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 440 977 # in the INCLUDE_PATH (see below) will be search if a #include is found. 441 978 442 SEARCH_INCLUDES = YES443 444 # The INCLUDE_PATH tag can be used to specify one or more directories that 445 # contain include files that are not input files but should be processed by 979 SEARCH_INCLUDES = YES 980 981 # The INCLUDE_PATH tag can be used to specify one or more directories that 982 # contain include files that are not input files but should be processed by 446 983 # the preprocessor. 447 984 448 INCLUDE_PATH = 449 450 # The PREDEFINED tag can be used to specify one or more macro names that 451 # are defined before the preprocessor is started (similar to the -D option of 452 # gcc). The argument of the tag is a list of macros of the form: name 985 INCLUDE_PATH = 986 987 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 988 # patterns (like *.h and *.hpp) to filter out the header-files in the 989 # directories. If left blank, the patterns specified with FILE_PATTERNS will 990 # be used. 991 992 INCLUDE_FILE_PATTERNS = 993 994 # The PREDEFINED tag can be used to specify one or more macro names that 995 # are defined before the preprocessor is started (similar to the -D option of 996 # gcc). The argument of the tag is a list of macros of the form: name 453 997 # or name=definition (no spaces). If the definition and the = are 454 # omitted =1 is assumed. 455 456 PREDEFINED = 457 458 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 459 # then the macro expansion is limited to the macros specified with the 460 # PREDEFINED tag. 461 462 EXPAND_ONLY_PREDEF = NO 463 464 #--------------------------------------------------------------------------- 465 # Configuration options related to external references 466 #--------------------------------------------------------------------------- 467 468 # The TAGFILES tag can be used to specify one or more tagfiles. 469 470 TAGFILES = 471 472 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 998 # omitted =1 is assumed. To prevent a macro definition from being 999 # undefined via #undef or recursively expanded use the := operator 1000 # instead of the = operator. 1001 1002 PREDEFINED = 1003 1004 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1005 # this tag can be used to specify a list of macro names that should be expanded. 1006 # The macro definition that is found in the sources will be used. 1007 # Use the PREDEFINED tag if you want to use a different macro definition. 1008 1009 EXPAND_AS_DEFINED = 1010 1011 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1012 # doxygen's preprocessor will remove all function-like macros that are alone 1013 # on a line, have an all uppercase name, and do not end with a semicolon. Such 1014 # function macros are typically used for boiler-plate code, and will confuse 1015 # the parser if not removed. 1016 1017 SKIP_FUNCTION_MACROS = YES 1018 1019 #--------------------------------------------------------------------------- 1020 # Configuration::additions related to external references 1021 #--------------------------------------------------------------------------- 1022 1023 # The TAGFILES option can be used to specify one or more tagfiles. 1024 # Optionally an initial location of the external documentation 1025 # can be added for each tagfile. The format of a tag file without 1026 # this location is as follows: 1027 # TAGFILES = file1 file2 ... 1028 # Adding location for the tag files is done as follows: 1029 # TAGFILES = file1=loc1 "file2 = loc2" ... 1030 # where "loc1" and "loc2" can be relative or absolute paths or 1031 # URLs. If a location is present for each tag, the installdox tool 1032 # does not have to be run to correct the links. 1033 # Note that each tag file must have a unique name 1034 # (where the name does NOT include the path) 1035 # If a tag file is not located in the directory in which doxygen 1036 # is run, you must also specify the path to the tagfile here. 1037 1038 TAGFILES = 1039 1040 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 473 1041 # a tag file that is based on the input files it reads. 474 1042 475 GENERATE_TAGFILE =476 477 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 478 # in the class index. If set to NO only the inherited external classes 1043 GENERATE_TAGFILE = 1044 1045 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 1046 # in the class index. If set to NO only the inherited external classes 479 1047 # will be listed. 480 1048 481 ALLEXTERNALS = NO 482 483 # The PERL_PATH should be the absolute path and name of the perl script 1049 ALLEXTERNALS = NO 1050 1051 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1052 # in the modules index. If set to NO, only the current project's groups will 1053 # be listed. 1054 1055 EXTERNAL_GROUPS = YES 1056 1057 # The PERL_PATH should be the absolute path and name of the perl script 484 1058 # interpreter (i.e. the result of `which perl'). 485 1059 486 PERL_PATH = /usr/bin/perl 487 488 #--------------------------------------------------------------------------- 489 # Configuration options related to the dot tool 490 #--------------------------------------------------------------------------- 491 492 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 493 # available from the path. This tool is part of Graphviz, a graph visualization 494 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 1060 PERL_PATH = /usr/bin/perl 1061 1062 #--------------------------------------------------------------------------- 1063 # Configuration options related to the dot tool 1064 #--------------------------------------------------------------------------- 1065 1066 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1067 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1068 # or super classes. Setting the tag to NO turns the diagrams off. Note that 1069 # this option is superseded by the HAVE_DOT option below. This is only a 1070 # fallback. It is recommended to install and use dot, since it yields more 1071 # powerful graphs. 1072 1073 CLASS_DIAGRAMS = YES 1074 1075 # If set to YES, the inheritance and collaboration graphs will hide 1076 # inheritance and usage relations if the target is undocumented 1077 # or is not a class. 1078 1079 HIDE_UNDOC_RELATIONS = YES 1080 1081 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1082 # available from the path. This tool is part of Graphviz, a graph visualization 1083 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 495 1084 # have no effect if this option is set to NO (the default) 496 1085 497 HAVE_DOT = NO 498 499 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 500 # will generate a graph for each documented class showing the direct and 501 # indirect implementation dependencies (inheritance, containment, and 1086 HAVE_DOT = NO 1087 1088 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1089 # will generate a graph for each documented class showing the direct and 1090 # indirect inheritance relations. Setting this tag to YES will force the 1091 # the CLASS_DIAGRAMS tag to NO. 1092 1093 CLASS_GRAPH = YES 1094 1095 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1096 # will generate a graph for each documented class showing the direct and 1097 # indirect implementation dependencies (inheritance, containment, and 502 1098 # class references variables) of the class with other documented classes. 503 1099 504 COLLABORATION_GRAPH = YES 505 506 # If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to 507 # YES then doxygen will generate a graph for each documented file showing 508 # the direct and indirect include dependencies of the file with other 509 # documented files. 510 511 INCLUDE_GRAPH = YES 512 513 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1100 COLLABORATION_GRAPH = YES 1101 1102 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1103 # will generate a graph for groups, showing the direct groups dependencies 1104 1105 GROUP_GRAPHS = YES 1106 1107 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1108 # collaboration diagrams in a style similar to the OMG's Unified Modeling 1109 # Language. 1110 1111 UML_LOOK = NO 1112 1113 # If set to YES, the inheritance and collaboration graphs will show the 1114 # relations between templates and their instances. 1115 1116 TEMPLATE_RELATIONS = NO 1117 1118 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1119 # tags are set to YES then doxygen will generate a graph for each documented 1120 # file showing the direct and indirect include dependencies of the file with 1121 # other documented files. 1122 1123 INCLUDE_GRAPH = YES 1124 1125 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1126 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1127 # documented header file showing the documented files that directly or 1128 # indirectly include this file. 1129 1130 INCLUDED_BY_GRAPH = YES 1131 1132 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 1133 # generate a call dependency graph for every global function or class method. 1134 # Note that enabling this option will significantly increase the time of a run. 1135 # So in most cases it will be better to enable call graphs for selected 1136 # functions only using the \callgraph command. 1137 1138 CALL_GRAPH = NO 1139 1140 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 514 1141 # will graphical hierarchy of all classes instead of a textual one. 515 1142 516 GRAPHICAL_HIERARCHY = YES 517 518 #--------------------------------------------------------------------------- 519 # Configuration options related to the search engine 1143 GRAPHICAL_HIERARCHY = YES 1144 1145 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1146 # then doxygen will show the dependencies a directory has on other directories 1147 # in a graphical way. The dependency relations are determined by the #include 1148 # relations between the files in the directories. 1149 1150 DIRECTORY_GRAPH = YES 1151 1152 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1153 # generated by dot. Possible values are png, jpg, or gif 1154 # If left blank png will be used. 1155 1156 DOT_IMAGE_FORMAT = png 1157 1158 # The tag DOT_PATH can be used to specify the path where the dot tool can be 1159 # found. If left blank, it is assumed the dot tool can be found in the path. 1160 1161 DOT_PATH = 1162 1163 # The DOTFILE_DIRS tag can be used to specify one or more directories that 1164 # contain dot files that are included in the documentation (see the 1165 # \dotfile command). 1166 1167 DOTFILE_DIRS = 1168 1169 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 1170 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 1171 # this value, doxygen will try to truncate the graph, so that it fits within 1172 # the specified constraint. Beware that most browsers cannot cope with very 1173 # large images. 1174 1175 MAX_DOT_GRAPH_WIDTH = 1024 1176 1177 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 1178 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 1179 # this value, doxygen will try to truncate the graph, so that it fits within 1180 # the specified constraint. Beware that most browsers cannot cope with very 1181 # large images. 1182 1183 MAX_DOT_GRAPH_HEIGHT = 1024 1184 1185 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1186 # graphs generated by dot. A depth value of 3 means that only nodes reachable 1187 # from the root by following a path via at most 3 edges will be shown. Nodes 1188 # that lay further from the root node will be omitted. Note that setting this 1189 # option to 1 or 2 may greatly reduce the computation time needed for large 1190 # code bases. Also note that a graph may be further truncated if the graph's 1191 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH 1192 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 1193 # the graph is not depth-constrained. 1194 1195 MAX_DOT_GRAPH_DEPTH = 0 1196 1197 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1198 # background. This is disabled by default, which results in a white background. 1199 # Warning: Depending on the platform used, enabling this option may lead to 1200 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to 1201 # read). 1202 1203 DOT_TRANSPARENT = NO 1204 1205 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1206 # files in one run (i.e. multiple -o and -T options on the command line). This 1207 # makes dot run faster, but since only newer versions of dot (>1.8.10) 1208 # support this, this feature is disabled by default. 1209 1210 DOT_MULTI_TARGETS = NO 1211 1212 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1213 # generate a legend page explaining the meaning of the various boxes and 1214 # arrows in the dot generated graphs. 1215 1216 GENERATE_LEGEND = YES 1217 1218 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1219 # remove the intermediate dot files that are used to generate 1220 # the various graphs. 1221 1222 DOT_CLEANUP = YES 1223 1224 #--------------------------------------------------------------------------- 1225 # Configuration::additions related to the search engine 520 1226 #--------------------------------------------------------------------------- 521 1227 … … 523 1229 # used. If set to NO the values of all tags below this one will be ignored. 524 1230 525 SEARCHENGINE = NO 526 527 # The CGI_NAME tag should be the name of the CGI script that 528 # starts the search engine (doxysearch) with the correct parameters. 529 # A script with this name will be generated by doxygen. 530 531 CGI_NAME = search.cgi 532 533 # The CGI_URL tag should be the absolute URL to the directory where the 534 # cgi binaries are located. See the documentation of your http daemon for 535 # details. 536 537 CGI_URL = 538 539 # The DOC_URL tag should be the absolute URL to the directory where the 540 # documentation is located. If left blank the absolute path to the 541 # documentation, with file:// prepended to it, will be used. 542 543 DOC_URL = 544 545 # The DOC_ABSPATH tag should be the absolute path to the directory where the 546 # documentation is located. If left blank the directory on the local machine 547 # will be used. 548 549 DOC_ABSPATH = 550 551 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary 552 # is installed. 553 554 #BIN_ABSPATH = 555 556 # The EXT_DOC_PATHS tag can be used to specify one or more paths to 557 # documentation generated for other projects. This allows doxysearch to search 558 # the documentation for these projects as well. 559 560 EXT_DOC_PATHS = 1231 SEARCHENGINE = NO -
trunk/SophyaLib/Manual/piapp.tex
r3046 r3092 72 72 \vspace{1cm} 73 73 \begin{center} 74 {\bf \Large piapp Version: 4.0 (V\_ Jul2006) }74 {\bf \Large piapp Version: 4.0 (V\_Sep2006) } 75 75 \end{center} 76 76 \titrebp{5} -
trunk/SophyaLib/Manual/sophya.tex
r3061 r3092 49 49 \vspace{1cm} 50 50 \begin{center} 51 {\bf \Large Sophya Version: 2.0 (V\_ Jul2006) }51 {\bf \Large Sophya Version: 2.0 (V\_Sep2006) } 52 52 \end{center} 53 53 \titrebp{1} … … 2012 2012 OS & compiler \\ 2013 2013 \hline 2014 Linux & g++ (3.x 4.0) \\2014 Linux & g++ (3.x \, 4.0) \\ 2015 2015 Linux (SCL) & icc - Intel compiler (9.0) \\ 2016 MacOSX/Darwin 10.3 \, 10.4 & g++ (3.3 4.0)\\ 2016 MacOSX/Darwin (PowerPC) 10.3 \, 10.4 & g++ (3.3 \, 4.0)\\ 2017 MacOSX/Darwin (Intel) 10.4 & g++ (4.0)\\ 2017 2018 HP/Compaq/DEC Tru64 ( OSF1) & cxx (6.1 6.3) \\ 2018 2019 SGI IRIX64 & CC (7.3) \\
Note:
See TracChangeset
for help on using the changeset viewer.