Small OpenGL based c++ rendering library
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Doxyfile 58KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417
  1. # Doxyfile 1.5.6
  2. # This file describes the settings to be used by the documentation system
  3. # doxygen (www.doxygen.org) for a project
  4. #
  5. # All text after a hash (#) is considered a comment and will be ignored
  6. # The format is:
  7. # TAG = value [value, ...]
  8. # For lists items can also be appended using:
  9. # TAG += value [value, ...]
  10. # Values that contain spaces should be placed between quotes (" ")
  11. #---------------------------------------------------------------------------
  12. # Project related configuration options
  13. #---------------------------------------------------------------------------
  14. # This tag specifies the encoding used for all characters in the config file
  15. # that follow. The default is UTF-8 which is also the encoding used for all
  16. # text before the first occurrence of this tag. Doxygen uses libiconv (or the
  17. # iconv built into libc) for the transcoding. See
  18. # http://www.gnu.org/software/libiconv for the list of possible encodings.
  19. DOXYFILE_ENCODING = UTF-8
  20. # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
  21. # by quotes) that should identify the project.
  22. PROJECT_NAME = libsegl
  23. # The PROJECT_NUMBER tag can be used to enter a project or revision number.
  24. # This could be handy for archiving the generated documentation or
  25. # if some version control system is used.
  26. PROJECT_NUMBER =
  27. # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
  28. # base path where the generated documentation will be put.
  29. # If a relative path is entered, it will be relative to the location
  30. # where doxygen was started. If left blank the current directory will be used.
  31. OUTPUT_DIRECTORY = doc/
  32. # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
  33. # 4096 sub-directories (in 2 levels) under the output directory of each output
  34. # format and will distribute the generated files over these directories.
  35. # Enabling this option can be useful when feeding doxygen a huge amount of
  36. # source files, where putting all generated files in the same directory would
  37. # otherwise cause performance problems for the file system.
  38. CREATE_SUBDIRS = NO
  39. # The OUTPUT_LANGUAGE tag is used to specify the language in which all
  40. # documentation generated by doxygen is written. Doxygen will use this
  41. # information to generate all constant output in the proper language.
  42. # The default language is English, other supported languages are:
  43. # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
  44. # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
  45. # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
  46. # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
  47. # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
  48. # and Ukrainian.
  49. OUTPUT_LANGUAGE = English
  50. # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
  51. # include brief member descriptions after the members that are listed in
  52. # the file and class documentation (similar to JavaDoc).
  53. # Set to NO to disable this.
  54. BRIEF_MEMBER_DESC = YES
  55. # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
  56. # the brief description of a member or function before the detailed description.
  57. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  58. # brief descriptions will be completely suppressed.
  59. REPEAT_BRIEF = YES
  60. # This tag implements a quasi-intelligent brief description abbreviator
  61. # that is used to form the text in various listings. Each string
  62. # in this list, if found as the leading text of the brief description, will be
  63. # stripped from the text and the result after processing the whole list, is
  64. # used as the annotated text. Otherwise, the brief description is used as-is.
  65. # If left blank, the following values are used ("$name" is automatically
  66. # replaced with the name of the entity): "The $name class" "The $name widget"
  67. # "The $name file" "is" "provides" "specifies" "contains"
  68. # "represents" "a" "an" "the"
  69. ABBREVIATE_BRIEF =
  70. # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  71. # Doxygen will generate a detailed section even if there is only a brief
  72. # description.
  73. ALWAYS_DETAILED_SEC = NO
  74. # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
  75. # inherited members of a class in the documentation of that class as if those
  76. # members were ordinary class members. Constructors, destructors and assignment
  77. # operators of the base classes will not be shown.
  78. INLINE_INHERITED_MEMB = NO
  79. # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
  80. # path before files name in the file list and in the header files. If set
  81. # to NO the shortest path that makes the file name unique will be used.
  82. FULL_PATH_NAMES = YES
  83. # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
  84. # can be used to strip a user-defined part of the path. Stripping is
  85. # only done if one of the specified strings matches the left-hand part of
  86. # the path. The tag can be used to show relative paths in the file list.
  87. # If left blank the directory from which doxygen is run is used as the
  88. # path to strip.
  89. STRIP_FROM_PATH =
  90. # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
  91. # the path mentioned in the documentation of a class, which tells
  92. # the reader which header file to include in order to use a class.
  93. # If left blank only the name of the header file containing the class
  94. # definition is used. Otherwise one should specify the include paths that
  95. # are normally passed to the compiler using the -I flag.
  96. STRIP_FROM_INC_PATH =
  97. # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
  98. # (but less readable) file names. This can be useful is your file systems
  99. # doesn't support long names like on DOS, Mac, or CD-ROM.
  100. SHORT_NAMES = NO
  101. # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
  102. # will interpret the first line (until the first dot) of a JavaDoc-style
  103. # comment as the brief description. If set to NO, the JavaDoc
  104. # comments will behave just like regular Qt-style comments
  105. # (thus requiring an explicit @brief command for a brief description.)
  106. JAVADOC_AUTOBRIEF = NO
  107. # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
  108. # interpret the first line (until the first dot) of a Qt-style
  109. # comment as the brief description. If set to NO, the comments
  110. # will behave just like regular Qt-style comments (thus requiring
  111. # an explicit \brief command for a brief description.)
  112. QT_AUTOBRIEF = NO
  113. # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
  114. # treat a multi-line C++ special comment block (i.e. a block of //! or ///
  115. # comments) as a brief description. This used to be the default behaviour.
  116. # The new default is to treat a multi-line C++ comment block as a detailed
  117. # description. Set this tag to YES if you prefer the old behaviour instead.
  118. MULTILINE_CPP_IS_BRIEF = NO
  119. # If the DETAILS_AT_TOP tag is set to YES then Doxygen
  120. # will output the detailed description near the top, like JavaDoc.
  121. # If set to NO, the detailed description appears after the member
  122. # documentation.
  123. DETAILS_AT_TOP = NO
  124. # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
  125. # member inherits the documentation from any documented member that it
  126. # re-implements.
  127. INHERIT_DOCS = YES
  128. # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
  129. # a new page for each member. If set to NO, the documentation of a member will
  130. # be part of the file/class/namespace that contains it.
  131. SEPARATE_MEMBER_PAGES = NO
  132. # The TAB_SIZE tag can be used to set the number of spaces in a tab.
  133. # Doxygen uses this value to replace tabs by spaces in code fragments.
  134. TAB_SIZE = 8
  135. # This tag can be used to specify a number of aliases that acts
  136. # as commands in the documentation. An alias has the form "name=value".
  137. # For example adding "sideeffect=\par Side Effects:\n" will allow you to
  138. # put the command \sideeffect (or @sideeffect) in the documentation, which
  139. # will result in a user-defined paragraph with heading "Side Effects:".
  140. # You can put \n's in the value part of an alias to insert newlines.
  141. ALIASES =
  142. # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
  143. # sources only. Doxygen will then generate output that is more tailored for C.
  144. # For instance, some of the names that are used will be different. The list
  145. # of all members will be omitted, etc.
  146. OPTIMIZE_OUTPUT_FOR_C = NO
  147. # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
  148. # sources only. Doxygen will then generate output that is more tailored for
  149. # Java. For instance, namespaces will be presented as packages, qualified
  150. # scopes will look different, etc.
  151. OPTIMIZE_OUTPUT_JAVA = NO
  152. # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
  153. # sources only. Doxygen will then generate output that is more tailored for
  154. # Fortran.
  155. OPTIMIZE_FOR_FORTRAN = NO
  156. # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
  157. # sources. Doxygen will then generate output that is tailored for
  158. # VHDL.
  159. OPTIMIZE_OUTPUT_VHDL = NO
  160. # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
  161. # to include (a tag file for) the STL sources as input, then you should
  162. # set this tag to YES in order to let doxygen match functions declarations and
  163. # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
  164. # func(std::string) {}). This also make the inheritance and collaboration
  165. # diagrams that involve STL classes more complete and accurate.
  166. BUILTIN_STL_SUPPORT = NO
  167. # If you use Microsoft's C++/CLI language, you should set this option to YES to
  168. # enable parsing support.
  169. CPP_CLI_SUPPORT = NO
  170. # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
  171. # Doxygen will parse them like normal C++ but will assume all classes use public
  172. # instead of private inheritance when no explicit protection keyword is present.
  173. SIP_SUPPORT = NO
  174. # For Microsoft's IDL there are propget and propput attributes to indicate getter
  175. # and setter methods for a property. Setting this option to YES (the default)
  176. # will make doxygen to replace the get and set methods by a property in the
  177. # documentation. This will only work if the methods are indeed getting or
  178. # setting a simple type. If this is not the case, or you want to show the
  179. # methods anyway, you should set this option to NO.
  180. IDL_PROPERTY_SUPPORT = YES
  181. # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  182. # tag is set to YES, then doxygen will reuse the documentation of the first
  183. # member in the group (if any) for the other members of the group. By default
  184. # all members of a group must be documented explicitly.
  185. DISTRIBUTE_GROUP_DOC = NO
  186. # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
  187. # the same type (for instance a group of public functions) to be put as a
  188. # subgroup of that type (e.g. under the Public Functions section). Set it to
  189. # NO to prevent subgrouping. Alternatively, this can be done per class using
  190. # the \nosubgrouping command.
  191. SUBGROUPING = YES
  192. # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
  193. # is documented as struct, union, or enum with the name of the typedef. So
  194. # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
  195. # with name TypeT. When disabled the typedef will appear as a member of a file,
  196. # namespace, or class. And the struct will be named TypeS. This can typically
  197. # be useful for C code in case the coding convention dictates that all compound
  198. # types are typedef'ed and only the typedef is referenced, never the tag name.
  199. TYPEDEF_HIDES_STRUCT = NO
  200. #---------------------------------------------------------------------------
  201. # Build related configuration options
  202. #---------------------------------------------------------------------------
  203. # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
  204. # documentation are documented, even if no documentation was available.
  205. # Private class members and static file members will be hidden unless
  206. # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  207. EXTRACT_ALL = NO
  208. # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
  209. # will be included in the documentation.
  210. EXTRACT_PRIVATE = NO
  211. # If the EXTRACT_STATIC tag is set to YES all static members of a file
  212. # will be included in the documentation.
  213. EXTRACT_STATIC = NO
  214. # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
  215. # defined locally in source files will be included in the documentation.
  216. # If set to NO only classes defined in header files are included.
  217. EXTRACT_LOCAL_CLASSES = YES
  218. # This flag is only useful for Objective-C code. When set to YES local
  219. # methods, which are defined in the implementation section but not in
  220. # the interface are included in the documentation.
  221. # If set to NO (the default) only methods in the interface are included.
  222. EXTRACT_LOCAL_METHODS = NO
  223. # If this flag is set to YES, the members of anonymous namespaces will be
  224. # extracted and appear in the documentation as a namespace called
  225. # 'anonymous_namespace{file}', where file will be replaced with the base
  226. # name of the file that contains the anonymous namespace. By default
  227. # anonymous namespace are hidden.
  228. EXTRACT_ANON_NSPACES = NO
  229. # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
  230. # undocumented members of documented classes, files or namespaces.
  231. # If set to NO (the default) these members will be included in the
  232. # various overviews, but no documentation section is generated.
  233. # This option has no effect if EXTRACT_ALL is enabled.
  234. HIDE_UNDOC_MEMBERS = NO
  235. # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
  236. # undocumented classes that are normally visible in the class hierarchy.
  237. # If set to NO (the default) these classes will be included in the various
  238. # overviews. This option has no effect if EXTRACT_ALL is enabled.
  239. HIDE_UNDOC_CLASSES = NO
  240. # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
  241. # friend (class|struct|union) declarations.
  242. # If set to NO (the default) these declarations will be included in the
  243. # documentation.
  244. HIDE_FRIEND_COMPOUNDS = NO
  245. # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
  246. # documentation blocks found inside the body of a function.
  247. # If set to NO (the default) these blocks will be appended to the
  248. # function's detailed documentation block.
  249. HIDE_IN_BODY_DOCS = NO
  250. # The INTERNAL_DOCS tag determines if documentation
  251. # that is typed after a \internal command is included. If the tag is set
  252. # to NO (the default) then the documentation will be excluded.
  253. # Set it to YES to include the internal documentation.
  254. INTERNAL_DOCS = NO
  255. # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
  256. # file names in lower-case letters. If set to YES upper-case letters are also
  257. # allowed. This is useful if you have classes or files whose names only differ
  258. # in case and if your file system supports case sensitive file names. Windows
  259. # and Mac users are advised to set this option to NO.
  260. CASE_SENSE_NAMES = YES
  261. # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
  262. # will show members with their full class and namespace scopes in the
  263. # documentation. If set to YES the scope will be hidden.
  264. HIDE_SCOPE_NAMES = NO
  265. # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
  266. # will put a list of the files that are included by a file in the documentation
  267. # of that file.
  268. SHOW_INCLUDE_FILES = YES
  269. # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
  270. # is inserted in the documentation for inline members.
  271. INLINE_INFO = YES
  272. # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
  273. # will sort the (detailed) documentation of file and class members
  274. # alphabetically by member name. If set to NO the members will appear in
  275. # declaration order.
  276. SORT_MEMBER_DOCS = YES
  277. # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
  278. # brief documentation of file, namespace and class members alphabetically
  279. # by member name. If set to NO (the default) the members will appear in
  280. # declaration order.
  281. SORT_BRIEF_DOCS = NO
  282. # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
  283. # hierarchy of group names into alphabetical order. If set to NO (the default)
  284. # the group names will appear in their defined order.
  285. SORT_GROUP_NAMES = NO
  286. # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
  287. # sorted by fully-qualified names, including namespaces. If set to
  288. # NO (the default), the class list will be sorted only by class name,
  289. # not including the namespace part.
  290. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
  291. # Note: This option applies only to the class list, not to the
  292. # alphabetical list.
  293. SORT_BY_SCOPE_NAME = NO
  294. # The GENERATE_TODOLIST tag can be used to enable (YES) or
  295. # disable (NO) the todo list. This list is created by putting \todo
  296. # commands in the documentation.
  297. GENERATE_TODOLIST = YES
  298. # The GENERATE_TESTLIST tag can be used to enable (YES) or
  299. # disable (NO) the test list. This list is created by putting \test
  300. # commands in the documentation.
  301. GENERATE_TESTLIST = YES
  302. # The GENERATE_BUGLIST tag can be used to enable (YES) or
  303. # disable (NO) the bug list. This list is created by putting \bug
  304. # commands in the documentation.
  305. GENERATE_BUGLIST = YES
  306. # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
  307. # disable (NO) the deprecated list. This list is created by putting
  308. # \deprecated commands in the documentation.
  309. GENERATE_DEPRECATEDLIST= YES
  310. # The ENABLED_SECTIONS tag can be used to enable conditional
  311. # documentation sections, marked by \if sectionname ... \endif.
  312. ENABLED_SECTIONS =
  313. # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
  314. # the initial value of a variable or define consists of for it to appear in
  315. # the documentation. If the initializer consists of more lines than specified
  316. # here it will be hidden. Use a value of 0 to hide initializers completely.
  317. # The appearance of the initializer of individual variables and defines in the
  318. # documentation can be controlled using \showinitializer or \hideinitializer
  319. # command in the documentation regardless of this setting.
  320. MAX_INITIALIZER_LINES = 30
  321. # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
  322. # at the bottom of the documentation of classes and structs. If set to YES the
  323. # list will mention the files that were used to generate the documentation.
  324. SHOW_USED_FILES = YES
  325. # If the sources in your project are distributed over multiple directories
  326. # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
  327. # in the documentation. The default is NO.
  328. SHOW_DIRECTORIES = NO
  329. # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
  330. # This will remove the Files entry from the Quick Index and from the
  331. # Folder Tree View (if specified). The default is YES.
  332. SHOW_FILES = YES
  333. # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
  334. # Namespaces page. This will remove the Namespaces entry from the Quick Index
  335. # and from the Folder Tree View (if specified). The default is YES.
  336. SHOW_NAMESPACES = YES
  337. # The FILE_VERSION_FILTER tag can be used to specify a program or script that
  338. # doxygen should invoke to get the current version for each file (typically from
  339. # the version control system). Doxygen will invoke the program by executing (via
  340. # popen()) the command <command> <input-file>, where <command> is the value of
  341. # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
  342. # provided by doxygen. Whatever the program writes to standard output
  343. # is used as the file version. See the manual for examples.
  344. FILE_VERSION_FILTER =
  345. #---------------------------------------------------------------------------
  346. # configuration options related to warning and progress messages
  347. #---------------------------------------------------------------------------
  348. # The QUIET tag can be used to turn on/off the messages that are generated
  349. # by doxygen. Possible values are YES and NO. If left blank NO is used.
  350. QUIET = NO
  351. # The WARNINGS tag can be used to turn on/off the warning messages that are
  352. # generated by doxygen. Possible values are YES and NO. If left blank
  353. # NO is used.
  354. WARNINGS = YES
  355. # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
  356. # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
  357. # automatically be disabled.
  358. WARN_IF_UNDOCUMENTED = YES
  359. # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
  360. # potential errors in the documentation, such as not documenting some
  361. # parameters in a documented function, or documenting parameters that
  362. # don't exist or using markup commands wrongly.
  363. WARN_IF_DOC_ERROR = YES
  364. # This WARN_NO_PARAMDOC option can be abled to get warnings for
  365. # functions that are documented, but have no documentation for their parameters
  366. # or return value. If set to NO (the default) doxygen will only warn about
  367. # wrong or incomplete parameter documentation, but not about the absence of
  368. # documentation.
  369. WARN_NO_PARAMDOC = NO
  370. # The WARN_FORMAT tag determines the format of the warning messages that
  371. # doxygen can produce. The string should contain the $file, $line, and $text
  372. # tags, which will be replaced by the file and line number from which the
  373. # warning originated and the warning text. Optionally the format may contain
  374. # $version, which will be replaced by the version of the file (if it could
  375. # be obtained via FILE_VERSION_FILTER)
  376. WARN_FORMAT = "$file:$line: $text"
  377. # The WARN_LOGFILE tag can be used to specify a file to which warning
  378. # and error messages should be written. If left blank the output is written
  379. # to stderr.
  380. WARN_LOGFILE =
  381. #---------------------------------------------------------------------------
  382. # configuration options related to the input files
  383. #---------------------------------------------------------------------------
  384. # The INPUT tag can be used to specify the files and/or directories that contain
  385. # documented source files. You may enter file names like "myfile.cpp" or
  386. # directories like "/usr/src/myproject". Separate the files or directories
  387. # with spaces.
  388. INPUT = . model glmenu
  389. # This tag can be used to specify the character encoding of the source files
  390. # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
  391. # also the default input encoding. Doxygen uses libiconv (or the iconv built
  392. # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
  393. # the list of possible encodings.
  394. INPUT_ENCODING = UTF-8
  395. # If the value of the INPUT tag contains directories, you can use the
  396. # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  397. # and *.h) to filter out the source-files in the directories. If left
  398. # blank the following patterns are tested:
  399. # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
  400. # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
  401. FILE_PATTERNS = *.h *.cpp
  402. # The RECURSIVE tag can be used to turn specify whether or not subdirectories
  403. # should be searched for input files as well. Possible values are YES and NO.
  404. # If left blank NO is used.
  405. RECURSIVE = YES
  406. # The EXCLUDE tag can be used to specify files and/or directories that should
  407. # excluded from the INPUT source files. This way you can easily exclude a
  408. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  409. EXCLUDE =
  410. # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
  411. # directories that are symbolic links (a Unix filesystem feature) are excluded
  412. # from the input.
  413. EXCLUDE_SYMLINKS = NO
  414. # If the value of the INPUT tag contains directories, you can use the
  415. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  416. # certain files from those directories. Note that the wildcards are matched
  417. # against the file with absolute path, so to exclude all test directories
  418. # for example use the pattern */test/*
  419. EXCLUDE_PATTERNS =
  420. # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
  421. # (namespaces, classes, functions, etc.) that should be excluded from the
  422. # output. The symbol name can be a fully qualified name, a word, or if the
  423. # wildcard * is used, a substring. Examples: ANamespace, AClass,
  424. # AClass::ANamespace, ANamespace::*Test
  425. EXCLUDE_SYMBOLS =
  426. # The EXAMPLE_PATH tag can be used to specify one or more files or
  427. # directories that contain example code fragments that are included (see
  428. # the \include command).
  429. EXAMPLE_PATH =
  430. # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  431. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  432. # and *.h) to filter out the source-files in the directories. If left
  433. # blank all files are included.
  434. EXAMPLE_PATTERNS =
  435. # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  436. # searched for input files to be used with the \include or \dontinclude
  437. # commands irrespective of the value of the RECURSIVE tag.
  438. # Possible values are YES and NO. If left blank NO is used.
  439. EXAMPLE_RECURSIVE = NO
  440. # The IMAGE_PATH tag can be used to specify one or more files or
  441. # directories that contain image that are included in the documentation (see
  442. # the \image command).
  443. IMAGE_PATH =
  444. # The INPUT_FILTER tag can be used to specify a program that doxygen should
  445. # invoke to filter for each input file. Doxygen will invoke the filter program
  446. # by executing (via popen()) the command <filter> <input-file>, where <filter>
  447. # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
  448. # input file. Doxygen will then use the output that the filter program writes
  449. # to standard output. If FILTER_PATTERNS is specified, this tag will be
  450. # ignored.
  451. INPUT_FILTER =
  452. # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
  453. # basis. Doxygen will compare the file name with each pattern and apply the
  454. # filter if there is a match. The filters are a list of the form:
  455. # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
  456. # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
  457. # is applied to all files.
  458. FILTER_PATTERNS =
  459. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  460. # INPUT_FILTER) will be used to filter the input files when producing source
  461. # files to browse (i.e. when SOURCE_BROWSER is set to YES).
  462. FILTER_SOURCE_FILES = NO
  463. #---------------------------------------------------------------------------
  464. # configuration options related to source browsing
  465. #---------------------------------------------------------------------------
  466. # If the SOURCE_BROWSER tag is set to YES then a list of source files will
  467. # be generated. Documented entities will be cross-referenced with these sources.
  468. # Note: To get rid of all source code in the generated output, make sure also
  469. # VERBATIM_HEADERS is set to NO.
  470. SOURCE_BROWSER = YES
  471. # Setting the INLINE_SOURCES tag to YES will include the body
  472. # of functions and classes directly in the documentation.
  473. INLINE_SOURCES = NO
  474. # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
  475. # doxygen to hide any special comment blocks from generated source code
  476. # fragments. Normal C and C++ comments will always remain visible.
  477. STRIP_CODE_COMMENTS = YES
  478. # If the REFERENCED_BY_RELATION tag is set to YES
  479. # then for each documented function all documented
  480. # functions referencing it will be listed.
  481. REFERENCED_BY_RELATION = NO
  482. # If the REFERENCES_RELATION tag is set to YES
  483. # then for each documented function all documented entities
  484. # called/used by that function will be listed.
  485. REFERENCES_RELATION = NO
  486. # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
  487. # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
  488. # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
  489. # link to the source code. Otherwise they will link to the documentstion.
  490. REFERENCES_LINK_SOURCE = YES
  491. # If the USE_HTAGS tag is set to YES then the references to source code
  492. # will point to the HTML generated by the htags(1) tool instead of doxygen
  493. # built-in source browser. The htags tool is part of GNU's global source
  494. # tagging system (see http://www.gnu.org/software/global/global.html). You
  495. # will need version 4.8.6 or higher.
  496. USE_HTAGS = NO
  497. # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
  498. # will generate a verbatim copy of the header file for each class for
  499. # which an include is specified. Set to NO to disable this.
  500. VERBATIM_HEADERS = YES
  501. #---------------------------------------------------------------------------
  502. # configuration options related to the alphabetical class index
  503. #---------------------------------------------------------------------------
  504. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
  505. # of all compounds will be generated. Enable this if the project
  506. # contains a lot of classes, structs, unions or interfaces.
  507. ALPHABETICAL_INDEX = NO
  508. # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
  509. # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
  510. # in which this list will be split (can be a number in the range [1..20])
  511. COLS_IN_ALPHA_INDEX = 5
  512. # In case all classes in a project start with a common prefix, all
  513. # classes will be put under the same header in the alphabetical index.
  514. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
  515. # should be ignored while generating the index headers.
  516. IGNORE_PREFIX =
  517. #---------------------------------------------------------------------------
  518. # configuration options related to the HTML output
  519. #---------------------------------------------------------------------------
  520. # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
  521. # generate HTML output.
  522. GENERATE_HTML = YES
  523. # The HTML_OUTPUT tag is used to specify where the HTML 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 `html' will be used as the default path.
  526. HTML_OUTPUT = html
  527. # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
  528. # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
  529. # doxygen will generate files with .html extension.
  530. HTML_FILE_EXTENSION = .html
  531. # The HTML_HEADER tag can be used to specify a personal HTML header for
  532. # each generated HTML page. If it is left blank doxygen will generate a
  533. # standard header.
  534. HTML_HEADER =
  535. # The HTML_FOOTER tag can be used to specify a personal HTML footer for
  536. # each generated HTML page. If it is left blank doxygen will generate a
  537. # standard footer.
  538. HTML_FOOTER =
  539. # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
  540. # style sheet that is used by each HTML page. It can be used to
  541. # fine-tune the look of the HTML output. If the tag is left blank doxygen
  542. # will generate a default style sheet. Note that doxygen will try to copy
  543. # the style sheet file to the HTML output directory, so don't put your own
  544. # stylesheet in the HTML output directory as well, or it will be erased!
  545. HTML_STYLESHEET =
  546. # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
  547. # files or namespaces will be aligned in HTML using tables. If set to
  548. # NO a bullet list will be used.
  549. HTML_ALIGN_MEMBERS = YES
  550. # If the GENERATE_HTMLHELP tag is set to YES, additional index files
  551. # will be generated that can be used as input for tools like the
  552. # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
  553. # of the generated HTML documentation.
  554. GENERATE_HTMLHELP = YES
  555. # If the GENERATE_DOCSET tag is set to YES, additional index files
  556. # will be generated that can be used as input for Apple's Xcode 3
  557. # integrated development environment, introduced with OSX 10.5 (Leopard).
  558. # To create a documentation set, doxygen will generate a Makefile in the
  559. # HTML output directory. Running make will produce the docset in that
  560. # directory and running "make install" will install the docset in
  561. # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
  562. # it at startup.
  563. GENERATE_DOCSET = NO
  564. # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
  565. # feed. A documentation feed provides an umbrella under which multiple
  566. # documentation sets from a single provider (such as a company or product suite)
  567. # can be grouped.
  568. DOCSET_FEEDNAME = "Doxygen generated docs"
  569. # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
  570. # should uniquely identify the documentation set bundle. This should be a
  571. # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
  572. # will append .docset to the name.
  573. DOCSET_BUNDLE_ID = org.doxygen.Project
  574. # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
  575. # documentation will contain sections that can be hidden and shown after the
  576. # page has loaded. For this to work a browser that supports
  577. # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
  578. # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
  579. HTML_DYNAMIC_SECTIONS = NO
  580. # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
  581. # be used to specify the file name of the resulting .chm file. You
  582. # can add a path in front of the file if the result should not be
  583. # written to the html output directory.
  584. CHM_FILE = doc/libsegl.chm
  585. # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
  586. # be used to specify the location (absolute path including file name) of
  587. # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
  588. # the HTML help compiler on the generated index.hhp.
  589. HHC_LOCATION =
  590. # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
  591. # controls if a separate .chi index file is generated (YES) or that
  592. # it should be included in the master .chm file (NO).
  593. GENERATE_CHI = NO
  594. # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
  595. # is used to encode HtmlHelp index (hhk), content (hhc) and project file
  596. # content.
  597. CHM_INDEX_ENCODING =
  598. # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
  599. # controls whether a binary table of contents is generated (YES) or a
  600. # normal table of contents (NO) in the .chm file.
  601. BINARY_TOC = NO
  602. # The TOC_EXPAND flag can be set to YES to add extra items for group members
  603. # to the contents of the HTML help documentation and to the tree view.
  604. TOC_EXPAND = NO
  605. # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
  606. # top of each HTML page. The value NO (the default) enables the index and
  607. # the value YES disables it.
  608. DISABLE_INDEX = NO
  609. # This tag can be used to set the number of enum values (range [1..20])
  610. # that doxygen will group on one line in the generated HTML documentation.
  611. ENUM_VALUES_PER_LINE = 4
  612. # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
  613. # structure should be generated to display hierarchical information.
  614. # If the tag value is set to FRAME, a side panel will be generated
  615. # containing a tree-like index structure (just like the one that
  616. # is generated for HTML Help). For this to work a browser that supports
  617. # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
  618. # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
  619. # probably better off using the HTML help feature. Other possible values
  620. # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
  621. # and Class Hiererachy pages using a tree view instead of an ordered list;
  622. # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
  623. # disables this behavior completely. For backwards compatibility with previous
  624. # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
  625. # respectively.
  626. GENERATE_TREEVIEW = NONE
  627. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
  628. # used to set the initial width (in pixels) of the frame in which the tree
  629. # is shown.
  630. TREEVIEW_WIDTH = 250
  631. # Use this tag to change the font size of Latex formulas included
  632. # as images in the HTML documentation. The default is 10. Note that
  633. # when you change the font size after a successful doxygen run you need
  634. # to manually remove any form_*.png images from the HTML output directory
  635. # to force them to be regenerated.
  636. FORMULA_FONTSIZE = 10
  637. #---------------------------------------------------------------------------
  638. # configuration options related to the LaTeX output
  639. #---------------------------------------------------------------------------
  640. # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
  641. # generate Latex output.
  642. GENERATE_LATEX = YES
  643. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
  644. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  645. # put in front of it. If left blank `latex' will be used as the default path.
  646. LATEX_OUTPUT = latex
  647. # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  648. # invoked. If left blank `latex' will be used as the default command name.
  649. LATEX_CMD_NAME = latex
  650. # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
  651. # generate index for LaTeX. If left blank `makeindex' will be used as the
  652. # default command name.
  653. MAKEINDEX_CMD_NAME = makeindex
  654. # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
  655. # LaTeX documents. This may be useful for small projects and may help to
  656. # save some trees in general.
  657. COMPACT_LATEX = NO
  658. # The PAPER_TYPE tag can be used to set the paper type that is used
  659. # by the printer. Possible values are: a4, a4wide, letter, legal and
  660. # executive. If left blank a4wide will be used.
  661. PAPER_TYPE = a4wide
  662. # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
  663. # packages that should be included in the LaTeX output.
  664. EXTRA_PACKAGES =
  665. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
  666. # the generated latex document. The header should contain everything until
  667. # the first chapter. If it is left blank doxygen will generate a
  668. # standard header. Notice: only use this tag if you know what you are doing!
  669. LATEX_HEADER =
  670. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
  671. # is prepared for conversion to pdf (using ps2pdf). The pdf file will
  672. # contain links (just like the HTML output) instead of page references
  673. # This makes the output suitable for online browsing using a pdf viewer.
  674. PDF_HYPERLINKS = YES
  675. # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
  676. # plain latex in the generated Makefile. Set this option to YES to get a
  677. # higher quality PDF documentation.
  678. USE_PDFLATEX = YES
  679. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
  680. # command to the generated LaTeX files. This will instruct LaTeX to keep
  681. # running if errors occur, instead of asking the user for help.
  682. # This option is also used when generating formulas in HTML.
  683. LATEX_BATCHMODE = NO
  684. # If LATEX_HIDE_INDICES is set to YES then doxygen will not
  685. # include the index chapters (such as File Index, Compound Index, etc.)
  686. # in the output.
  687. LATEX_HIDE_INDICES = NO
  688. #---------------------------------------------------------------------------
  689. # configuration options related to the RTF output
  690. #---------------------------------------------------------------------------
  691. # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
  692. # The RTF output is optimized for Word 97 and may not look very pretty with
  693. # other RTF readers or editors.
  694. GENERATE_RTF = NO
  695. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
  696. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  697. # put in front of it. If left blank `rtf' will be used as the default path.
  698. RTF_OUTPUT = rtf
  699. # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
  700. # RTF documents. This may be useful for small projects and may help to
  701. # save some trees in general.
  702. COMPACT_RTF = NO
  703. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
  704. # will contain hyperlink fields. The RTF file will
  705. # contain links (just like the HTML output) instead of page references.
  706. # This makes the output suitable for online browsing using WORD or other
  707. # programs which support those fields.
  708. # Note: wordpad (write) and others do not support links.
  709. RTF_HYPERLINKS = NO
  710. # Load stylesheet definitions from file. Syntax is similar to doxygen's
  711. # config file, i.e. a series of assignments. You only have to provide
  712. # replacements, missing definitions are set to their default value.
  713. RTF_STYLESHEET_FILE =
  714. # Set optional variables used in the generation of an rtf document.
  715. # Syntax is similar to doxygen's config file.
  716. RTF_EXTENSIONS_FILE =
  717. #---------------------------------------------------------------------------
  718. # configuration options related to the man page output
  719. #---------------------------------------------------------------------------
  720. # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
  721. # generate man pages
  722. GENERATE_MAN = NO
  723. # The MAN_OUTPUT tag is used to specify where the man pages will be put.
  724. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  725. # put in front of it. If left blank `man' will be used as the default path.
  726. MAN_OUTPUT = man
  727. # The MAN_EXTENSION tag determines the extension that is added to
  728. # the generated man pages (default is the subroutine's section .3)
  729. MAN_EXTENSION = .3
  730. # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
  731. # then it will generate one additional man file for each entity
  732. # documented in the real man page(s). These additional files
  733. # only source the real man page, but without them the man command
  734. # would be unable to find the correct page. The default is NO.
  735. MAN_LINKS = NO
  736. #---------------------------------------------------------------------------
  737. # configuration options related to the XML output
  738. #---------------------------------------------------------------------------
  739. # If the GENERATE_XML tag is set to YES Doxygen will
  740. # generate an XML file that captures the structure of
  741. # the code including all documentation.
  742. GENERATE_XML = NO
  743. # The XML_OUTPUT tag is used to specify where the XML pages will be put.
  744. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  745. # put in front of it. If left blank `xml' will be used as the default path.
  746. XML_OUTPUT = xml
  747. # The XML_SCHEMA tag can be used to specify an XML schema,
  748. # which can be used by a validating XML parser to check the
  749. # syntax of the XML files.
  750. XML_SCHEMA =
  751. # The XML_DTD tag can be used to specify an XML DTD,
  752. # which can be used by a validating XML parser to check the
  753. # syntax of the XML files.
  754. XML_DTD =
  755. # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
  756. # dump the program listings (including syntax highlighting
  757. # and cross-referencing information) to the XML output. Note that
  758. # enabling this will significantly increase the size of the XML output.
  759. XML_PROGRAMLISTING = YES
  760. #---------------------------------------------------------------------------
  761. # configuration options for the AutoGen Definitions output
  762. #---------------------------------------------------------------------------
  763. # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
  764. # generate an AutoGen Definitions (see autogen.sf.net) file
  765. # that captures the structure of the code including all
  766. # documentation. Note that this feature is still experimental
  767. # and incomplete at the moment.
  768. GENERATE_AUTOGEN_DEF = NO
  769. #---------------------------------------------------------------------------
  770. # configuration options related to the Perl module output
  771. #---------------------------------------------------------------------------
  772. # If the GENERATE_PERLMOD tag is set to YES Doxygen will
  773. # generate a Perl module file that captures the structure of
  774. # the code including all documentation. Note that this
  775. # feature is still experimental and incomplete at the
  776. # moment.
  777. GENERATE_PERLMOD = NO
  778. # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
  779. # the necessary Makefile rules, Perl scripts and LaTeX code to be able
  780. # to generate PDF and DVI output from the Perl module output.
  781. PERLMOD_LATEX = NO
  782. # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
  783. # nicely formatted so it can be parsed by a human reader. This is useful
  784. # if you want to understand what is going on. On the other hand, if this
  785. # tag is set to NO the size of the Perl module output will be much smaller
  786. # and Perl will parse it just the same.
  787. PERLMOD_PRETTY = YES
  788. # The names of the make variables in the generated doxyrules.make file
  789. # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
  790. # This is useful so different doxyrules.make files included by the same
  791. # Makefile don't overwrite each other's variables.
  792. PERLMOD_MAKEVAR_PREFIX =
  793. #---------------------------------------------------------------------------
  794. # Configuration options related to the preprocessor
  795. #---------------------------------------------------------------------------
  796. # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
  797. # evaluate all C-preprocessor directives found in the sources and include
  798. # files.
  799. ENABLE_PREPROCESSING = YES
  800. # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
  801. # names in the source code. If set to NO (the default) only conditional
  802. # compilation will be performed. Macro expansion can be done in a controlled
  803. # way by setting EXPAND_ONLY_PREDEF to YES.
  804. MACRO_EXPANSION = NO
  805. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
  806. # then the macro expansion is limited to the macros specified with the
  807. # PREDEFINED and EXPAND_AS_DEFINED tags.
  808. EXPAND_ONLY_PREDEF = NO
  809. # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
  810. # in the INCLUDE_PATH (see below) will be search if a #include is found.
  811. SEARCH_INCLUDES = YES
  812. # The INCLUDE_PATH tag can be used to specify one or more directories that
  813. # contain include files that are not input files but should be processed by
  814. # the preprocessor.
  815. INCLUDE_PATH =
  816. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  817. # patterns (like *.h and *.hpp) to filter out the header-files in the
  818. # directories. If left blank, the patterns specified with FILE_PATTERNS will
  819. # be used.
  820. INCLUDE_FILE_PATTERNS =
  821. # The PREDEFINED tag can be used to specify one or more macro names that
  822. # are defined before the preprocessor is started (similar to the -D option of
  823. # gcc). The argument of the tag is a list of macros of the form: name
  824. # or name=definition (no spaces). If the definition and the = are
  825. # omitted =1 is assumed. To prevent a macro definition from being
  826. # undefined via #undef or recursively expanded use the := operator
  827. # instead of the = operator.
  828. PREDEFINED =
  829. # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
  830. # this tag can be used to specify a list of macro names that should be expanded.
  831. # The macro definition that is found in the sources will be used.
  832. # Use the PREDEFINED tag if you want to use a different macro definition.
  833. EXPAND_AS_DEFINED =
  834. # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
  835. # doxygen's preprocessor will remove all function-like macros that are alone
  836. # on a line, have an all uppercase name, and do not end with a semicolon. Such
  837. # function macros are typically used for boiler-plate code, and will confuse
  838. # the parser if not removed.
  839. SKIP_FUNCTION_MACROS = YES
  840. #---------------------------------------------------------------------------
  841. # Configuration::additions related to external references
  842. #---------------------------------------------------------------------------
  843. # The TAGFILES option can be used to specify one or more tagfiles.
  844. # Optionally an initial location of the external documentation
  845. # can be added for each tagfile. The format of a tag file without
  846. # this location is as follows:
  847. # TAGFILES = file1 file2 ...
  848. # Adding location for the tag files is done as follows:
  849. # TAGFILES = file1=loc1 "file2 = loc2" ...
  850. # where "loc1" and "loc2" can be relative or absolute paths or
  851. # URLs. If a location is present for each tag, the installdox tool
  852. # does not have to be run to correct the links.
  853. # Note that each tag file must have a unique name
  854. # (where the name does NOT include the path)
  855. # If a tag file is not located in the directory in which doxygen
  856. # is run, you must also specify the path to the tagfile here.
  857. TAGFILES =
  858. # When a file name is specified after GENERATE_TAGFILE, doxygen will create
  859. # a tag file that is based on the input files it reads.
  860. GENERATE_TAGFILE =
  861. # If the ALLEXTERNALS tag is set to YES all external classes will be listed
  862. # in the class index. If set to NO only the inherited external classes
  863. # will be listed.
  864. ALLEXTERNALS = NO
  865. # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
  866. # in the modules index. If set to NO, only the current project's groups will
  867. # be listed.
  868. EXTERNAL_GROUPS = YES
  869. # The PERL_PATH should be the absolute path and name of the perl script
  870. # interpreter (i.e. the result of `which perl').
  871. PERL_PATH = /usr/bin/perl
  872. #---------------------------------------------------------------------------
  873. # Configuration options related to the dot tool
  874. #---------------------------------------------------------------------------
  875. # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
  876. # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
  877. # or super classes. Setting the tag to NO turns the diagrams off. Note that
  878. # this option is superseded by the HAVE_DOT option below. This is only a
  879. # fallback. It is recommended to install and use dot, since it yields more
  880. # powerful graphs.
  881. CLASS_DIAGRAMS = YES
  882. # You can define message sequence charts within doxygen comments using the \msc
  883. # command. Doxygen will then run the mscgen tool (see
  884. # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
  885. # documentation. The MSCGEN_PATH tag allows you to specify the directory where
  886. # the mscgen tool resides. If left empty the tool is assumed to be found in the
  887. # default search path.
  888. MSCGEN_PATH =
  889. # If set to YES, the inheritance and collaboration graphs will hide
  890. # inheritance and usage relations if the target is undocumented
  891. # or is not a class.
  892. HIDE_UNDOC_RELATIONS = YES
  893. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  894. # available from the path. This tool is part of Graphviz, a graph visualization
  895. # toolkit from AT&T and Lucent Bell Labs. The other options in this section
  896. # have no effect if this option is set to NO (the default)
  897. HAVE_DOT = NO
  898. # By default doxygen will write a font called FreeSans.ttf to the output
  899. # directory and reference it in all dot files that doxygen generates. This
  900. # font does not include all possible unicode characters however, so when you need
  901. # these (or just want a differently looking font) you can specify the font name
  902. # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
  903. # which can be done by putting it in a standard location or by setting the
  904. # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
  905. # containing the font.
  906. DOT_FONTNAME = FreeSans
  907. # By default doxygen will tell dot to use the output directory to look for the
  908. # FreeSans.ttf font (which doxygen will put there itself). If you specify a
  909. # different font using DOT_FONTNAME you can set the path where dot
  910. # can find it using this tag.
  911. DOT_FONTPATH =
  912. # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
  913. # will generate a graph for each documented class showing the direct and
  914. # indirect inheritance relations. Setting this tag to YES will force the
  915. # the CLASS_DIAGRAMS tag to NO.
  916. CLASS_GRAPH = YES
  917. # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
  918. # will generate a graph for each documented class showing the direct and
  919. # indirect implementation dependencies (inheritance, containment, and
  920. # class references variables) of the class with other documented classes.
  921. COLLABORATION_GRAPH = YES
  922. # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
  923. # will generate a graph for groups, showing the direct groups dependencies
  924. GROUP_GRAPHS = YES
  925. # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
  926. # collaboration diagrams in a style similar to the OMG's Unified Modeling
  927. # Language.
  928. UML_LOOK = NO
  929. # If set to YES, the inheritance and collaboration graphs will show the
  930. # relations between templates and their instances.
  931. TEMPLATE_RELATIONS = NO
  932. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
  933. # tags are set to YES then doxygen will generate a graph for each documented
  934. # file showing the direct and indirect include dependencies of the file with
  935. # other documented files.
  936. INCLUDE_GRAPH = YES
  937. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
  938. # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
  939. # documented header file showing the documented files that directly or
  940. # indirectly include this file.
  941. INCLUDED_BY_GRAPH = YES
  942. # If the CALL_GRAPH and HAVE_DOT options are set to YES then
  943. # doxygen will generate a call dependency graph for every global function
  944. # or class method. Note that enabling this option will significantly increase
  945. # the time of a run. So in most cases it will be better to enable call graphs
  946. # for selected functions only using the \callgraph command.
  947. CALL_GRAPH = NO
  948. # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
  949. # doxygen will generate a caller dependency graph for every global function
  950. # or class method. Note that enabling this option will significantly increase
  951. # the time of a run. So in most cases it will be better to enable caller
  952. # graphs for selected functions only using the \callergraph command.
  953. CALLER_GRAPH = NO
  954. # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
  955. # will graphical hierarchy of all classes instead of a textual one.
  956. GRAPHICAL_HIERARCHY = YES
  957. # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
  958. # then doxygen will show the dependencies a directory has on other directories
  959. # in a graphical way. The dependency relations are determined by the #include
  960. # relations between the files in the directories.
  961. DIRECTORY_GRAPH = YES
  962. # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  963. # generated by dot. Possible values are png, jpg, or gif
  964. # If left blank png will be used.
  965. DOT_IMAGE_FORMAT = png
  966. # The tag DOT_PATH can be used to specify the path where the dot tool can be
  967. # found. If left blank, it is assumed the dot tool can be found in the path.
  968. DOT_PATH =
  969. # The DOTFILE_DIRS tag can be used to specify one or more directories that
  970. # contain dot files that are included in the documentation (see the
  971. # \dotfile command).
  972. DOTFILE_DIRS =
  973. # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
  974. # nodes that will be shown in the graph. If the number of nodes in a graph
  975. # becomes larger than this value, doxygen will truncate the graph, which is
  976. # visualized by representing a node as a red box. Note that doxygen if the
  977. # number of direct children of the root node in a graph is already larger than
  978. # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
  979. # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  980. DOT_GRAPH_MAX_NODES = 50
  981. # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
  982. # graphs generated by dot. A depth value of 3 means that only nodes reachable
  983. # from the root by following a path via at most 3 edges will be shown. Nodes
  984. # that lay further from the root node will be omitted. Note that setting this
  985. # option to 1 or 2 may greatly reduce the computation time needed for large
  986. # code bases. Also note that the size of a graph can be further restricted by
  987. # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  988. MAX_DOT_GRAPH_DEPTH = 0
  989. # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  990. # background. This is enabled by default, which results in a transparent
  991. # background. Warning: Depending on the platform used, enabling this option
  992. # may lead to badly anti-aliased labels on the edges of a graph (i.e. they
  993. # become hard to read).
  994. DOT_TRANSPARENT = YES
  995. # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
  996. # files in one run (i.e. multiple -o and -T options on the command line). This
  997. # makes dot run faster, but since only newer versions of dot (>1.8.10)
  998. # support this, this feature is disabled by default.
  999. DOT_MULTI_TARGETS = NO
  1000. # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
  1001. # generate a legend page explaining the meaning of the various boxes and
  1002. # arrows in the dot generated graphs.
  1003. GENERATE_LEGEND = YES
  1004. # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
  1005. # remove the intermediate dot files that are used to generate
  1006. # the various graphs.
  1007. DOT_CLEANUP = YES
  1008. #---------------------------------------------------------------------------
  1009. # Configuration::additions related to the search engine
  1010. #---------------------------------------------------------------------------
  1011. # The SEARCHENGINE tag specifies whether or not a search engine should be
  1012. # used. If set to NO the values of all tags below this one will be ignored.
  1013. SEARCHENGINE = NO