home *** CD-ROM | disk | FTP | other *** search
/ ftp.fox-toolkit.org / 2014.05.ftp.fox-toolkit.org.tar / ftp.fox-toolkit.org / pub / foxdoc.cfg < prev    next >
Text File  |  2002-04-28  |  35KB  |  901 lines
  1. # Doxyfile 1.2.13.1
  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, ...]
  11. # Values that contain spaces should be placed between quotes (" ")
  12.  
  13. #---------------------------------------------------------------------------
  14. # General 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           = "FOX C++ GUI TOOLKIT Reference"
  21.  
  22. # The PROJECT_NUMBER tag can be used to enter a project or revision number.
  23. # This could be handy for archiving the generated documentation or
  24. # if some version control system is used.
  25.  
  26. PROJECT_NUMBER         = "1.2"
  27.  
  28. # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
  29. # base path where the generated documentation will be put.
  30. # If a relative path is entered, it will be relative to the location
  31. # where doxygen was started. If left blank the current directory will be used.
  32.  
  33. OUTPUT_DIRECTORY       = 
  34.  
  35. # The OUTPUT_LANGUAGE tag is used to specify the language in which all
  36. # documentation generated by doxygen is written. Doxygen will use this
  37. # information to generate all constant output in the proper language.
  38. # The default language is English, other supported languages are:
  39. # Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
  40. # German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
  41. # Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
  42.  
  43. OUTPUT_LANGUAGE        = English
  44.  
  45. # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
  46. # documentation are documented, even if no documentation was available.
  47. # Private class members and static file members will be hidden unless
  48. # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  49.  
  50. EXTRACT_ALL            = NO
  51.  
  52. # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
  53. # will be included in the documentation.
  54.  
  55. EXTRACT_PRIVATE        = NO
  56.  
  57. # If the EXTRACT_STATIC tag is set to YES all static members of a file
  58. # will be included in the documentation.
  59.  
  60. EXTRACT_STATIC         = YES
  61.  
  62. # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
  63. # defined locally in source files will be included in the documentation.
  64. # If set to NO only classes defined in header files are included.
  65.  
  66. EXTRACT_LOCAL_CLASSES  = YES
  67.  
  68. # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
  69. # undocumented members of documented classes, files or namespaces.
  70. # If set to NO (the default) these members will be included in the
  71. # various overviews, but no documentation section is generated.
  72. # This option has no effect if EXTRACT_ALL is enabled.
  73.  
  74. HIDE_UNDOC_MEMBERS     = NO
  75.  
  76. # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
  77. # undocumented classes that are normally visible in the class hierarchy.
  78. # If set to NO (the default) these class will be included in the various
  79. # overviews. This option has no effect if EXTRACT_ALL is enabled.
  80.  
  81. HIDE_UNDOC_CLASSES     = NO
  82.  
  83. # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
  84. # include brief member descriptions after the members that are listed in
  85. # the file and class documentation (similar to JavaDoc).
  86. # Set to NO to disable this.
  87.  
  88. BRIEF_MEMBER_DESC      = NO
  89.  
  90. # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
  91. # the brief description of a member or function before the detailed description.
  92. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  93. # brief descriptions will be completely suppressed.
  94.  
  95. REPEAT_BRIEF           = YES
  96.  
  97. # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  98. # Doxygen will generate a detailed section even if there is only a brief
  99. # description.
  100.  
  101. ALWAYS_DETAILED_SEC    = YES
  102.  
  103. # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
  104. # members of a class in the documentation of that class as if those members were
  105. # ordinary class members. Constructors, destructors and assignment operators of
  106. # the base classes will not be shown.
  107.  
  108. INLINE_INHERITED_MEMB  = NO
  109.  
  110. # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
  111. # path before files name in the file list and in the header files. If set
  112. # to NO the shortest path that makes the file name unique will be used.
  113.  
  114. FULL_PATH_NAMES        = NO
  115.  
  116. # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
  117. # can be used to strip a user defined part of the path. Stripping is
  118. # only done if one of the specified strings matches the left-hand part of
  119. # the path. It is allowed to use relative paths in the argument list.
  120.  
  121. STRIP_FROM_PATH        =
  122.  
  123. # The INTERNAL_DOCS tag determines if documentation
  124. # that is typed after a \internal command is included. If the tag is set
  125. # to NO (the default) then the documentation will be excluded.
  126. # Set it to YES to include the internal documentation.
  127.  
  128. INTERNAL_DOCS          = YES
  129.  
  130. # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
  131. # doxygen to hide any special comment blocks from generated source code
  132. # fragments. Normal C and C++ comments will always remain visible.
  133.  
  134. STRIP_CODE_COMMENTS    = NO
  135.  
  136. # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
  137. # file names in lower case letters. If set to YES upper case letters are also
  138. # allowed. This is useful if you have classes or files whose names only differ
  139. # in case and if your file system supports case sensitive file names. Windows
  140. # users are adviced to set this option to NO.
  141.  
  142. CASE_SENSE_NAMES       = YES
  143.  
  144. # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
  145. # (but less readable) file names. This can be useful is your file systems
  146. # doesn't support long names like on DOS, Mac, or CD-ROM.
  147.  
  148. SHORT_NAMES            = NO
  149.  
  150. # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
  151. # will show members with their full class and namespace scopes in the
  152. # documentation. If set to YES the scope will be hidden.
  153.  
  154. HIDE_SCOPE_NAMES       = NO
  155.  
  156. # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
  157. # will generate a verbatim copy of the header file for each class for
  158. # which an include is specified. Set to NO to disable this.
  159.  
  160. VERBATIM_HEADERS       = YES
  161.  
  162. # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
  163. # will put list of the files that are included by a file in the documentation
  164. # of that file.
  165.  
  166. SHOW_INCLUDE_FILES     = YES
  167.  
  168. # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
  169. # will interpret the first line (until the first dot) of a JavaDoc-style
  170. # comment as the brief description. If set to NO, the JavaDoc
  171. # comments  will behave just like the Qt-style comments (thus requiring an
  172. # explict @brief command for a brief description.
  173.  
  174. JAVADOC_AUTOBRIEF      = YES
  175.  
  176. # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
  177. # member inherits the documentation from any documented member that it
  178. # reimplements.
  179.  
  180. INHERIT_DOCS           = YES
  181.  
  182. # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
  183. # is inserted in the documentation for inline members.
  184.  
  185. INLINE_INFO            = YES
  186.  
  187. # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
  188. # will sort the (detailed) documentation of file and class members
  189. # alphabetically by member name. If set to NO the members will appear in
  190. # declaration order.
  191.  
  192. SORT_MEMBER_DOCS       = NO
  193.  
  194. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  195. # tag is set to YES, then doxygen will reuse the documentation of the first
  196. # member in the group (if any) for the other members of the group. By default
  197. # all members of a group must be documented explicitly.
  198.  
  199. DISTRIBUTE_GROUP_DOC   = NO
  200.  
  201. # The TAB_SIZE tag can be used to set the number of spaces in a tab.
  202. # Doxygen uses this value to replace tabs by spaces in code fragments.
  203.  
  204. TAB_SIZE               = 2
  205.  
  206. # The GENERATE_TODOLIST tag can be used to enable (YES) or
  207. # disable (NO) the todo list. This list is created by putting \todo
  208. # commands in the documentation.
  209.  
  210. GENERATE_TODOLIST      = YES
  211.  
  212. # The GENERATE_TESTLIST tag can be used to enable (YES) or
  213. # disable (NO) the test list. This list is created by putting \test
  214. # commands in the documentation.
  215.  
  216. GENERATE_TESTLIST      = YES
  217.  
  218. # The GENERATE_BUGLIST tag can be used to enable (YES) or
  219. # disable (NO) the bug list. This list is created by putting \bug
  220. # commands in the documentation.
  221.  
  222. GENERATE_BUGLIST       = YES
  223.  
  224. # This tag can be used to specify a number of aliases that acts
  225. # as commands in the documentation. An alias has the form "name=value".
  226. # For example adding "sideeffect=\par Side Effects:\n" will allow you to
  227. # put the command \sideeffect (or @sideeffect) in the documentation, which
  228. # will result in a user defined paragraph with heading "Side Effects:".
  229. # You can put \n's in the value part of an alias to insert newlines.
  230.  
  231. ALIASES                =
  232.  
  233. # The ENABLED_SECTIONS tag can be used to enable conditional
  234. # documentation sections, marked by \if sectionname ... \endif.
  235.  
  236. ENABLED_SECTIONS       =
  237.  
  238. # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
  239. # the initial value of a variable or define consist of for it to appear in
  240. # the documentation. If the initializer consists of more lines than specified
  241. # here it will be hidden. Use a value of 0 to hide initializers completely.
  242. # The appearance of the initializer of individual variables and defines in the
  243. # documentation can be controlled using \showinitializer or \hideinitializer
  244. # command in the documentation regardless of this setting.
  245.  
  246. MAX_INITIALIZER_LINES  = 30
  247.  
  248. # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
  249. # only. Doxygen will then generate output that is more tailored for C.
  250. # For instance some of the names that are used will be different. The list
  251. # of all members will be omitted, etc.
  252.  
  253. OPTIMIZE_OUTPUT_FOR_C  = NO
  254.  
  255. # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
  256. # at the bottom of the documentation of classes and structs. If set to YES the
  257. # list will mention the files that were used to generate the documentation.
  258.  
  259. SHOW_USED_FILES        = NO
  260.  
  261. #---------------------------------------------------------------------------
  262. # configuration options related to warning and progress messages
  263. #---------------------------------------------------------------------------
  264.  
  265. # The QUIET tag can be used to turn on/off the messages that are generated
  266. # by doxygen. Possible values are YES and NO. If left blank NO is used.
  267.  
  268. QUIET                  = YES
  269.  
  270. # The WARNINGS tag can be used to turn on/off the warning messages that are
  271. # generated by doxygen. Possible values are YES and NO. If left blank
  272. # NO is used.
  273.  
  274. WARNINGS               = YES
  275.  
  276. # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
  277. # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
  278. # automatically be disabled.
  279.  
  280. WARN_IF_UNDOCUMENTED   = YES
  281.  
  282. # The WARN_FORMAT tag determines the format of the warning messages that
  283. # doxygen can produce. The string should contain the $file, $line, and $text
  284. # tags, which will be replaced by the file and line number from which the
  285. # warning originated and the warning text.
  286.  
  287. WARN_FORMAT            =
  288.  
  289. # The WARN_LOGFILE tag can be used to specify a file to which warning
  290. # and error messages should be written. If left blank the output is written
  291. # to stderr.
  292.  
  293. WARN_LOGFILE           =
  294.  
  295. #---------------------------------------------------------------------------
  296. # configuration options related to the input files
  297. #---------------------------------------------------------------------------
  298.  
  299. # The INPUT tag can be used to specify the files and/or directories that contain
  300. # documented source files. You may enter file names like "myfile.cpp" or
  301. # directories like "/usr/src/myproject". Separate the files or directories
  302. # with spaces.
  303.  
  304. INPUT                  = ./include
  305.  
  306. # If the value of the INPUT tag contains directories, you can use the
  307. # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  308. # and *.h) to filter out the source-files in the directories. If left
  309. # blank the following patterns are tested:
  310. # *.c *.cc *.cxx *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
  311. # *.h++ *.idl
  312.  
  313. FILE_PATTERNS          = *.h
  314.  
  315. # The RECURSIVE tag can be used to turn specify whether or not subdirectories
  316. # should be searched for input files as well. Possible values are YES and NO.
  317. # If left blank NO is used.
  318.  
  319. RECURSIVE              = NO
  320.  
  321. # The EXCLUDE tag can be used to specify files and/or directories that should
  322. # excluded from the INPUT source files. This way you can easily exclude a
  323. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  324.  
  325. EXCLUDE                = xincs.h fxkeys.h fx.h
  326.  
  327. # If the value of the INPUT tag contains directories, you can use the
  328. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  329. # certain files from those directories.
  330.  
  331. EXCLUDE_PATTERNS       =
  332.  
  333. # The EXAMPLE_PATH tag can be used to specify one or more files or
  334. # directories that contain example code fragments that are included (see
  335. # the \include command).
  336.  
  337. EXAMPLE_PATH           =
  338.  
  339. # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  340. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  341. # and *.h) to filter out the source-files in the directories. If left
  342. # blank all files are included.
  343.  
  344. EXAMPLE_PATTERNS       =
  345.  
  346. # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  347. # searched for input files to be used with the \include or \dontinclude
  348. # commands irrespective of the value of the RECURSIVE tag.
  349. # Possible values are YES and NO. If left blank NO is used.
  350.  
  351. EXAMPLE_RECURSIVE      = NO
  352.  
  353. # The IMAGE_PATH tag can be used to specify one or more files or
  354. # directories that contain image that are included in the documentation (see
  355. # the \image command).
  356.  
  357. IMAGE_PATH             =
  358.  
  359. # The INPUT_FILTER tag can be used to specify a program that doxygen should
  360. # invoke to filter for each input file. Doxygen will invoke the filter program
  361. # by executing (via popen()) the command <filter> <input-file>, where <filter>
  362. # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
  363. # input file. Doxygen will then use the output that the filter program writes
  364. # to standard output.
  365.  
  366. INPUT_FILTER           = "sed -e \"/long on[A-Za-z0-9_]*/d\""
  367.  
  368. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  369. # INPUT_FILTER) will be used to filter the input files when producing source
  370. # files to browse.
  371.  
  372. FILTER_SOURCE_FILES    = NO
  373.  
  374. #---------------------------------------------------------------------------
  375. # configuration options related to source browsing
  376. #---------------------------------------------------------------------------
  377.  
  378. # If the SOURCE_BROWSER tag is set to YES then a list of source files will
  379. # be generated. Documented entities will be cross-referenced with these sources.
  380.  
  381. SOURCE_BROWSER         = NO
  382.  
  383. # Setting the INLINE_SOURCES tag to YES will include the body
  384. # of functions and classes directly in the documentation.
  385.  
  386. INLINE_SOURCES         = NO
  387.  
  388. # If the REFERENCED_BY_RELATION tag is set to YES (the default)
  389. # then for each documented function all documented
  390. # functions referencing it will be listed.
  391.  
  392. REFERENCED_BY_RELATION = YES
  393.  
  394. # If the REFERENCES_RELATION tag is set to YES (the default)
  395. # then for each documented function all documented entities
  396. # called/used by that function will be listed.
  397.  
  398. REFERENCES_RELATION    = YES
  399.  
  400. #---------------------------------------------------------------------------
  401. # configuration options related to the alphabetical class index
  402. #---------------------------------------------------------------------------
  403.  
  404. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
  405. # of all compounds will be generated. Enable this if the project
  406. # contains a lot of classes, structs, unions or interfaces.
  407.  
  408. ALPHABETICAL_INDEX     = YES
  409.  
  410. # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
  411. # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
  412. # in which this list will be split (can be a number in the range [1..20])
  413.  
  414. COLS_IN_ALPHA_INDEX    = 3
  415.  
  416. # In case all classes in a project start with a common prefix, all
  417. # classes will be put under the same header in the alphabetical index.
  418. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
  419. # should be ignored while generating the index headers.
  420.  
  421. IGNORE_PREFIX          = FX
  422.  
  423. #---------------------------------------------------------------------------
  424. # configuration options related to the HTML output
  425. #---------------------------------------------------------------------------
  426.  
  427. # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
  428. # generate HTML output.
  429.  
  430. GENERATE_HTML          = YES
  431.  
  432. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
  433. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  434. # put in front of it. If left blank `html' will be used as the default path.
  435.  
  436. HTML_OUTPUT            = ./foxdoc
  437.  
  438. # The HTML_HEADER tag can be used to specify a personal HTML header for
  439. # each generated HTML page. If it is left blank doxygen will generate a
  440. # standard header.
  441.  
  442. HTML_HEADER            = header.html
  443.  
  444. # The HTML_FOOTER tag can be used to specify a personal HTML footer for
  445. # each generated HTML page. If it is left blank doxygen will generate a
  446. # standard footer.
  447.  
  448. HTML_FOOTER            = footer.html
  449.  
  450. # The HTML_STYLESHEET tag can be used to specify a user defined cascading
  451. # style sheet that is used by each HTML page. It can be used to
  452. # fine-tune the look of the HTML output. If the tag is left blank doxygen
  453. # will generate a default style sheet
  454.  
  455. HTML_STYLESHEET        = page.css
  456.  
  457. # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
  458. # files or namespaces will be aligned in HTML using tables. If set to
  459. # NO a bullet list will be used.
  460.  
  461. HTML_ALIGN_MEMBERS     = YES
  462.  
  463. # If the GENERATE_HTMLHELP tag is set to YES, additional index files
  464. # will be generated that can be used as input for tools like the
  465. # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
  466. # of the generated HTML documentation.
  467.  
  468. GENERATE_HTMLHELP      = NO
  469.  
  470. # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
  471. # controls if a separate .chi index file is generated (YES) or that
  472. # it should be included in the master .chm file (NO).
  473.  
  474. GENERATE_CHI           = NO
  475.  
  476. # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
  477. # controls whether a binary table of contents is generated (YES) or a
  478. # normal table of contents (NO) in the .chm file.
  479.  
  480. BINARY_TOC             = NO
  481.  
  482. # The TOC_EXPAND flag can be set to YES to add extra items for group members
  483. # to the contents of the Html help documentation and to the tree view.
  484.  
  485. TOC_EXPAND             = NO
  486.  
  487. # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
  488. # top of each HTML page. The value NO (the default) enables the index and
  489. # the value YES disables it.
  490.  
  491. DISABLE_INDEX          = YES
  492.  
  493. # This tag can be used to set the number of enum values (range [1..20])
  494. # that doxygen will group on one line in the generated HTML documentation.
  495.  
  496. ENUM_VALUES_PER_LINE   = 1
  497.  
  498. # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
  499. # generated containing a tree-like index structure (just like the one that
  500. # is generated for HTML Help). For this to work a browser that supports
  501. # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
  502. # or Internet explorer 4.0+). Note that for large projects the tree generation
  503. # can take a very long time. In such cases it is better to disable this feature.
  504. # Windows users are probably better off using the HTML help feature.
  505.  
  506. GENERATE_TREEVIEW      = NO
  507.  
  508. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
  509. # used to set the initial width (in pixels) of the frame in which the tree
  510. # is shown.
  511.  
  512. TREEVIEW_WIDTH         = 250
  513.  
  514. #---------------------------------------------------------------------------
  515. # configuration options related to the LaTeX output
  516. #---------------------------------------------------------------------------
  517.  
  518. # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
  519. # generate Latex output.
  520.  
  521. GENERATE_LATEX         = NO
  522.  
  523. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
  524. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  525. # put in front of it. If left blank `latex' will be used as the default path.
  526.  
  527. LATEX_OUTPUT           =
  528.  
  529. # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
  530. # LaTeX documents. This may be useful for small projects and may help to
  531. # save some trees in general.
  532.  
  533. COMPACT_LATEX          = NO
  534.  
  535. # The PAPER_TYPE tag can be used to set the paper type that is used
  536. # by the printer. Possible values are: a4, a4wide, letter, legal and
  537. # executive. If left blank a4wide will be used.
  538.  
  539. PAPER_TYPE             = a4wide
  540.  
  541. # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
  542. # packages that should be included in the LaTeX output.
  543.  
  544. EXTRA_PACKAGES         =
  545.  
  546. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
  547. # the generated latex document. The header should contain everything until
  548. # the first chapter. If it is left blank doxygen will generate a
  549. # standard header. Notice: only use this tag if you know what you are doing!
  550.  
  551. LATEX_HEADER           =
  552.  
  553. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
  554. # is prepared for conversion to pdf (using ps2pdf). The pdf file will
  555. # contain links (just like the HTML output) instead of page references
  556. # This makes the output suitable for online browsing using a pdf viewer.
  557.  
  558. PDF_HYPERLINKS         = NO
  559.  
  560. # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
  561. # plain latex in the generated Makefile. Set this option to YES to get a
  562. # higher quality PDF documentation.
  563.  
  564. USE_PDFLATEX           = NO
  565.  
  566. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
  567. # command to the generated LaTeX files. This will instruct LaTeX to keep
  568. # running if errors occur, instead of asking the user for help.
  569. # This option is also used when generating formulas in HTML.
  570.  
  571. LATEX_BATCHMODE        = NO
  572.  
  573. #---------------------------------------------------------------------------
  574. # configuration options related to the RTF output
  575. #---------------------------------------------------------------------------
  576.  
  577. # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
  578. # The RTF output is optimised for Word 97 and may not look very pretty with
  579. # other RTF readers or editors.
  580.  
  581. GENERATE_RTF           = NO
  582.  
  583. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
  584. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  585. # put in front of it. If left blank `rtf' will be used as the default path.
  586.  
  587. RTF_OUTPUT             =
  588.  
  589. # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
  590. # RTF documents. This may be useful for small projects and may help to
  591. # save some trees in general.
  592.  
  593. COMPACT_RTF            = NO
  594.  
  595. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
  596. # will contain hyperlink fields. The RTF file will
  597. # contain links (just like the HTML output) instead of page references.
  598. # This makes the output suitable for online browsing using WORD or other
  599. # programs which support those fields.
  600. # Note: wordpad (write) and others do not support links.
  601.  
  602. RTF_HYPERLINKS         = NO
  603.  
  604. # Load stylesheet definitions from file. Syntax is similar to doxygen's
  605. # config file, i.e. a series of assigments. You only have to provide
  606. # replacements, missing definitions are set to their default value.
  607.  
  608. RTF_STYLESHEET_FILE    =
  609.  
  610. # Set optional variables used in the generation of an rtf document.
  611. # Syntax is similar to doxygen's config file.
  612.  
  613. RTF_EXTENSIONS_FILE    =
  614.  
  615. #---------------------------------------------------------------------------
  616. # configuration options related to the man page output
  617. #---------------------------------------------------------------------------
  618.  
  619. # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
  620. # generate man pages
  621.  
  622. GENERATE_MAN           = NO
  623.  
  624. # The MAN_OUTPUT tag is used to specify where the man pages will be put.
  625. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  626. # put in front of it. If left blank `man' will be used as the default path.
  627.  
  628. MAN_OUTPUT             =
  629.  
  630. # The MAN_EXTENSION tag determines the extension that is added to
  631. # the generated man pages (default is the subroutine's section .3)
  632.  
  633. MAN_EXTENSION          =
  634.  
  635. # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
  636. # then it will generate one additional man file for each entity
  637. # documented in the real man page(s). These additional files
  638. # only source the real man page, but without them the man command
  639. # would be unable to find the correct page. The default is NO.
  640.  
  641. MAN_LINKS              = NO
  642.  
  643. #---------------------------------------------------------------------------
  644. # configuration options related to the XML output
  645. #---------------------------------------------------------------------------
  646.  
  647. # If the GENERATE_XML tag is set to YES Doxygen will
  648. # generate an XML file that captures the structure of
  649. # the code including all documentation. Note that this
  650. # feature is still experimental and incomplete at the
  651. # moment.
  652.  
  653. GENERATE_XML           = NO
  654.  
  655. #---------------------------------------------------------------------------
  656. # configuration options for the AutoGen Definitions output
  657. #---------------------------------------------------------------------------
  658.  
  659. # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
  660. # generate an AutoGen Definitions (see autogen.sf.net) file
  661. # that captures the structure of the code including all
  662. # documentation. Note that this feature is still experimental
  663. # and incomplete at the moment.
  664.  
  665. GENERATE_AUTOGEN_DEF   = NO
  666.  
  667. #---------------------------------------------------------------------------
  668. # Configuration options related to the preprocessor
  669. #---------------------------------------------------------------------------
  670.  
  671. # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
  672. # evaluate all C-preprocessor directives found in the sources and include
  673. # files.
  674.  
  675. ENABLE_PREPROCESSING   = YES
  676.  
  677. # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
  678. # names in the source code. If set to NO (the default) only conditional
  679. # compilation will be performed. Macro expansion can be done in a controlled
  680. # way by setting EXPAND_ONLY_PREDEF to YES.
  681.  
  682. MACRO_EXPANSION        = YES
  683.  
  684. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
  685. # then the macro expansion is limited to the macros specified with the
  686. # PREDEFINED and EXPAND_AS_PREDEFINED tags.
  687.  
  688. EXPAND_ONLY_PREDEF     = YES
  689.  
  690. # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
  691. # in the INCLUDE_PATH (see below) will be search if a #include is found.
  692.  
  693. SEARCH_INCLUDES        = YES
  694.  
  695. # The INCLUDE_PATH tag can be used to specify one or more directories that
  696. # contain include files that are not input files but should be processed by
  697. # the preprocessor.
  698.  
  699. INCLUDE_PATH           =
  700.  
  701. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  702. # patterns (like *.h and *.hpp) to filter out the header-files in the
  703. # directories. If left blank, the patterns specified with FILE_PATTERNS will
  704. # be used.
  705.  
  706. INCLUDE_FILE_PATTERNS  =
  707.  
  708. # The PREDEFINED tag can be used to specify one or more macro names that
  709. # are defined before the preprocessor is started (similar to the -D option of
  710. # gcc). The argument of the tag is a list of macros of the form: name
  711. # or name=definition (no spaces). If the definition and the = are
  712. # omitted =1 is assumed.
  713.  
  714. PREDEFINED             = FXAPI= 
  715.  
  716. # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
  717. # this tag can be used to specify a list of macro names that should be expanded.
  718. # The macro definition that is found in the sources will be used.
  719. # Use the PREDEFINED tag if you want to use a different macro definition.
  720.  
  721. EXPAND_AS_DEFINED      =
  722.  
  723. # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
  724. # doxygen's preprocessor will remove all function-like macros that are alone
  725. # on a line and do not end with a semicolon. Such function macros are typically
  726. # used for boiler-plate code, and will confuse the parser if not removed.
  727.  
  728. SKIP_FUNCTION_MACROS   = YES
  729.  
  730. #---------------------------------------------------------------------------
  731. # Configuration::addtions related to external references
  732. #---------------------------------------------------------------------------
  733.  
  734. # The TAGFILES tag can be used to specify one or more tagfiles.
  735.  
  736. TAGFILES               =
  737.  
  738. # When a file name is specified after GENERATE_TAGFILE, doxygen will create
  739. # a tag file that is based on the input files it reads.
  740.  
  741. GENERATE_TAGFILE       =
  742.  
  743. # If the ALLEXTERNALS tag is set to YES all external classes will be listed
  744. # in the class index. If set to NO only the inherited external classes
  745. # will be listed.
  746.  
  747. ALLEXTERNALS           = NO
  748.  
  749. # The PERL_PATH should be the absolute path and name of the perl script
  750. # interpreter (i.e. the result of `which perl').
  751.  
  752. PERL_PATH              =
  753.  
  754. #---------------------------------------------------------------------------
  755. # Configuration options related to the dot tool
  756. #---------------------------------------------------------------------------
  757.  
  758. # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
  759. # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
  760. # super classes. Setting the tag to NO turns the diagrams off. Note that this
  761. # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
  762. # recommended to install and use dot, since it yield more powerful graphs.
  763.  
  764. CLASS_DIAGRAMS         = YES
  765.  
  766. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  767. # available from the path. This tool is part of Graphviz, a graph visualization
  768. # toolkit from AT&T and Lucent Bell Labs. The other options in this section
  769. # have no effect if this option is set to NO (the default)
  770.  
  771. HAVE_DOT               = NO
  772.  
  773. # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
  774. # will generate a graph for each documented class showing the direct and
  775. # indirect inheritance relations. Setting this tag to YES will force the
  776. # the CLASS_DIAGRAMS tag to NO.
  777.  
  778. CLASS_GRAPH            = YES
  779.  
  780. # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
  781. # will generate a graph for each documented class showing the direct and
  782. # indirect implementation dependencies (inheritance, containment, and
  783. # class references variables) of the class with other documented classes.
  784.  
  785. COLLABORATION_GRAPH    = YES
  786.  
  787. # If set to YES, the inheritance and collaboration graphs will show the
  788. # relations between templates and their instances.
  789.  
  790. TEMPLATE_RELATIONS     = YES
  791.  
  792. # If set to YES, the inheritance and collaboration graphs will hide
  793. # inheritance and usage relations if the target is undocumented
  794. # or is not a class.
  795.  
  796. HIDE_UNDOC_RELATIONS   = YES
  797.  
  798. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
  799. # tags are set to YES then doxygen will generate a graph for each documented
  800. # file showing the direct and indirect include dependencies of the file with
  801. # other documented files.
  802.  
  803. INCLUDE_GRAPH          = YES
  804.  
  805. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
  806. # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
  807. # documented header file showing the documented files that directly or
  808. # indirectly include this file.
  809.  
  810. INCLUDED_BY_GRAPH      = YES
  811.  
  812. # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
  813. # will graphical hierarchy of all classes instead of a textual one.
  814.  
  815. GRAPHICAL_HIERARCHY    = YES
  816.  
  817. # The tag DOT_PATH can be used to specify the path where the dot tool can be
  818. # found. If left blank, it is assumed the dot tool can be found on the path.
  819.  
  820. DOT_PATH               =
  821.  
  822. # The DOTFILE_DIRS tag can be used to specify one or more directories that
  823. # contain dot files that are included in the documentation (see the
  824. # \dotfile command).
  825.  
  826. DOTFILE_DIRS           =
  827.  
  828. # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
  829. # (in pixels) of the graphs generated by dot. If a graph becomes larger than
  830. # this value, doxygen will try to truncate the graph, so that it fits within
  831. # the specified constraint. Beware that most browsers cannot cope with very
  832. # large images.
  833.  
  834. MAX_DOT_GRAPH_WIDTH    = 1024
  835.  
  836. # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
  837. # (in pixels) of the graphs generated by dot. If a graph becomes larger than
  838. # this value, doxygen will try to truncate the graph, so that it fits within
  839. # the specified constraint. Beware that most browsers cannot cope with very
  840. # large images.
  841.  
  842. MAX_DOT_GRAPH_HEIGHT   = 1024
  843.  
  844. # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
  845. # generate a legend page explaining the meaning of the various boxes and
  846. # arrows in the dot generated graphs.
  847.  
  848. GENERATE_LEGEND        = YES
  849.  
  850. # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
  851. # remove the intermedate dot files that are used to generate
  852. # the various graphs.
  853.  
  854. DOT_CLEANUP            = YES
  855.  
  856. #---------------------------------------------------------------------------
  857. # Configuration::addtions related to the search engine
  858. #---------------------------------------------------------------------------
  859.  
  860. # The SEARCHENGINE tag specifies whether or not a search engine should be
  861. # used. If set to NO the values of all tags below this one will be ignored.
  862.  
  863. SEARCHENGINE           = NO
  864.  
  865. # The CGI_NAME tag should be the name of the CGI script that
  866. # starts the search engine (doxysearch) with the correct parameters.
  867. # A script with this name will be generated by doxygen.
  868.  
  869. CGI_NAME               =
  870.  
  871. # The CGI_URL tag should be the absolute URL to the directory where the
  872. # cgi binaries are located. See the documentation of your http daemon for
  873. # details.
  874.  
  875. CGI_URL                =
  876.  
  877. # The DOC_URL tag should be the absolute URL to the directory where the
  878. # documentation is located. If left blank the absolute path to the
  879. # documentation, with file:// prepended to it, will be used.
  880.  
  881. DOC_URL                =
  882.  
  883. # The DOC_ABSPATH tag should be the absolute path to the directory where the
  884. # documentation is located. If left blank the directory on the local machine
  885. # will be used.
  886.  
  887. DOC_ABSPATH            =
  888.  
  889. # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
  890. # is installed.
  891.  
  892. BIN_ABSPATH            =
  893.  
  894. # The EXT_DOC_PATHS tag can be used to specify one or more paths to
  895. # documentation generated for other projects. This allows doxysearch to search
  896. # the documentation for these projects as well.
  897.  
  898. EXT_DOC_PATHS          =
  899.  
  900.  
  901.