Lemma is an Electromagnetics API
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.

Doxyfile.in 67KB

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