Doxyfile.in 58 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419
  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 = tor
  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 = @VERSION@
  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/doxygen
  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 = NO
  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 = NO
  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 = YES
  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 = NO
  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 = YES
  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 = src/common \
  389. src/or
  390. # This tag can be used to specify the character encoding of the source files
  391. # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
  392. # also the default input encoding. Doxygen uses libiconv (or the iconv built
  393. # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
  394. # the list of possible encodings.
  395. INPUT_ENCODING = UTF-8
  396. # If the value of the INPUT tag contains directories, you can use the
  397. # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  398. # and *.h) to filter out the source-files in the directories. If left
  399. # blank the following patterns are tested:
  400. # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
  401. # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
  402. FILE_PATTERNS = *.c \
  403. *.h
  404. # The RECURSIVE tag can be used to turn specify whether or not subdirectories
  405. # should be searched for input files as well. Possible values are YES and NO.
  406. # If left blank NO is used.
  407. RECURSIVE = NO
  408. # The EXCLUDE tag can be used to specify files and/or directories that should
  409. # excluded from the INPUT source files. This way you can easily exclude a
  410. # subdirectory from a directory tree whose root is specified with the INPUT tag.
  411. EXCLUDE = tree.h
  412. # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
  413. # directories that are symbolic links (a Unix filesystem feature) are excluded
  414. # from the input.
  415. EXCLUDE_SYMLINKS = NO
  416. # If the value of the INPUT tag contains directories, you can use the
  417. # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  418. # certain files from those directories. Note that the wildcards are matched
  419. # against the file with absolute path, so to exclude all test directories
  420. # for example use the pattern */test/*
  421. EXCLUDE_PATTERNS =
  422. # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
  423. # (namespaces, classes, functions, etc.) that should be excluded from the
  424. # output. The symbol name can be a fully qualified name, a word, or if the
  425. # wildcard * is used, a substring. Examples: ANamespace, AClass,
  426. # AClass::ANamespace, ANamespace::*Test
  427. EXCLUDE_SYMBOLS =
  428. # The EXAMPLE_PATH tag can be used to specify one or more files or
  429. # directories that contain example code fragments that are included (see
  430. # the \include command).
  431. EXAMPLE_PATH =
  432. # If the value of the EXAMPLE_PATH tag contains directories, you can use the
  433. # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  434. # and *.h) to filter out the source-files in the directories. If left
  435. # blank all files are included.
  436. EXAMPLE_PATTERNS =
  437. # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  438. # searched for input files to be used with the \include or \dontinclude
  439. # commands irrespective of the value of the RECURSIVE tag.
  440. # Possible values are YES and NO. If left blank NO is used.
  441. EXAMPLE_RECURSIVE = NO
  442. # The IMAGE_PATH tag can be used to specify one or more files or
  443. # directories that contain image that are included in the documentation (see
  444. # the \image command).
  445. IMAGE_PATH =
  446. # The INPUT_FILTER tag can be used to specify a program that doxygen should
  447. # invoke to filter for each input file. Doxygen will invoke the filter program
  448. # by executing (via popen()) the command <filter> <input-file>, where <filter>
  449. # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
  450. # input file. Doxygen will then use the output that the filter program writes
  451. # to standard output. If FILTER_PATTERNS is specified, this tag will be
  452. # ignored.
  453. INPUT_FILTER =
  454. # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
  455. # basis. Doxygen will compare the file name with each pattern and apply the
  456. # filter if there is a match. The filters are a list of the form:
  457. # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
  458. # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
  459. # is applied to all files.
  460. FILTER_PATTERNS =
  461. # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  462. # INPUT_FILTER) will be used to filter the input files when producing source
  463. # files to browse (i.e. when SOURCE_BROWSER is set to YES).
  464. FILTER_SOURCE_FILES = NO
  465. #---------------------------------------------------------------------------
  466. # configuration options related to source browsing
  467. #---------------------------------------------------------------------------
  468. # If the SOURCE_BROWSER tag is set to YES then a list of source files will
  469. # be generated. Documented entities will be cross-referenced with these sources.
  470. # Note: To get rid of all source code in the generated output, make sure also
  471. # VERBATIM_HEADERS is set to NO.
  472. SOURCE_BROWSER = YES
  473. # Setting the INLINE_SOURCES tag to YES will include the body
  474. # of functions and classes directly in the documentation.
  475. INLINE_SOURCES = NO
  476. # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
  477. # doxygen to hide any special comment blocks from generated source code
  478. # fragments. Normal C and C++ comments will always remain visible.
  479. STRIP_CODE_COMMENTS = YES
  480. # If the REFERENCED_BY_RELATION tag is set to YES
  481. # then for each documented function all documented
  482. # functions referencing it will be listed.
  483. REFERENCED_BY_RELATION = YES
  484. # If the REFERENCES_RELATION tag is set to YES
  485. # then for each documented function all documented entities
  486. # called/used by that function will be listed.
  487. REFERENCES_RELATION = YES
  488. # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
  489. # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
  490. # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
  491. # link to the source code. Otherwise they will link to the documentstion.
  492. REFERENCES_LINK_SOURCE = YES
  493. # If the USE_HTAGS tag is set to YES then the references to source code
  494. # will point to the HTML generated by the htags(1) tool instead of doxygen
  495. # built-in source browser. The htags tool is part of GNU's global source
  496. # tagging system (see http://www.gnu.org/software/global/global.html). You
  497. # will need version 4.8.6 or higher.
  498. USE_HTAGS = NO
  499. # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
  500. # will generate a verbatim copy of the header file for each class for
  501. # which an include is specified. Set to NO to disable this.
  502. VERBATIM_HEADERS = YES
  503. #---------------------------------------------------------------------------
  504. # configuration options related to the alphabetical class index
  505. #---------------------------------------------------------------------------
  506. # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
  507. # of all compounds will be generated. Enable this if the project
  508. # contains a lot of classes, structs, unions or interfaces.
  509. ALPHABETICAL_INDEX = NO
  510. # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
  511. # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
  512. # in which this list will be split (can be a number in the range [1..20])
  513. COLS_IN_ALPHA_INDEX = 5
  514. # In case all classes in a project start with a common prefix, all
  515. # classes will be put under the same header in the alphabetical index.
  516. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
  517. # should be ignored while generating the index headers.
  518. IGNORE_PREFIX =
  519. #---------------------------------------------------------------------------
  520. # configuration options related to the HTML output
  521. #---------------------------------------------------------------------------
  522. # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
  523. # generate HTML output.
  524. GENERATE_HTML = YES
  525. # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
  526. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  527. # put in front of it. If left blank `html' will be used as the default path.
  528. HTML_OUTPUT = html
  529. # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
  530. # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
  531. # doxygen will generate files with .html extension.
  532. HTML_FILE_EXTENSION = .html
  533. # The HTML_HEADER tag can be used to specify a personal HTML header for
  534. # each generated HTML page. If it is left blank doxygen will generate a
  535. # standard header.
  536. HTML_HEADER =
  537. # The HTML_FOOTER tag can be used to specify a personal HTML footer for
  538. # each generated HTML page. If it is left blank doxygen will generate a
  539. # standard footer.
  540. HTML_FOOTER =
  541. # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
  542. # style sheet that is used by each HTML page. It can be used to
  543. # fine-tune the look of the HTML output. If the tag is left blank doxygen
  544. # will generate a default style sheet. Note that doxygen will try to copy
  545. # the style sheet file to the HTML output directory, so don't put your own
  546. # stylesheet in the HTML output directory as well, or it will be erased!
  547. HTML_STYLESHEET =
  548. # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
  549. # files or namespaces will be aligned in HTML using tables. If set to
  550. # NO a bullet list will be used.
  551. HTML_ALIGN_MEMBERS = YES
  552. # If the GENERATE_HTMLHELP tag is set to YES, additional index files
  553. # will be generated that can be used as input for tools like the
  554. # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
  555. # of the generated HTML documentation.
  556. GENERATE_HTMLHELP = NO
  557. # If the GENERATE_DOCSET tag is set to YES, additional index files
  558. # will be generated that can be used as input for Apple's Xcode 3
  559. # integrated development environment, introduced with OSX 10.5 (Leopard).
  560. # To create a documentation set, doxygen will generate a Makefile in the
  561. # HTML output directory. Running make will produce the docset in that
  562. # directory and running "make install" will install the docset in
  563. # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
  564. # it at startup.
  565. GENERATE_DOCSET = NO
  566. # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
  567. # feed. A documentation feed provides an umbrella under which multiple
  568. # documentation sets from a single provider (such as a company or product suite)
  569. # can be grouped.
  570. DOCSET_FEEDNAME = "Doxygen generated docs for Tor"
  571. # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
  572. # should uniquely identify the documentation set bundle. This should be a
  573. # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
  574. # will append .docset to the name.
  575. DOCSET_BUNDLE_ID = org.torproject.Tor
  576. # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
  577. # documentation will contain sections that can be hidden and shown after the
  578. # page has loaded. For this to work a browser that supports
  579. # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
  580. # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
  581. HTML_DYNAMIC_SECTIONS = NO
  582. # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
  583. # be used to specify the file name of the resulting .chm file. You
  584. # can add a path in front of the file if the result should not be
  585. # written to the html output directory.
  586. CHM_FILE =
  587. # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
  588. # be used to specify the location (absolute path including file name) of
  589. # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
  590. # the HTML help compiler on the generated index.hhp.
  591. HHC_LOCATION =
  592. # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
  593. # controls if a separate .chi index file is generated (YES) or that
  594. # it should be included in the master .chm file (NO).
  595. GENERATE_CHI = NO
  596. # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
  597. # is used to encode HtmlHelp index (hhk), content (hhc) and project file
  598. # content.
  599. CHM_INDEX_ENCODING =
  600. # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
  601. # controls whether a binary table of contents is generated (YES) or a
  602. # normal table of contents (NO) in the .chm file.
  603. BINARY_TOC = NO
  604. # The TOC_EXPAND flag can be set to YES to add extra items for group members
  605. # to the contents of the HTML help documentation and to the tree view.
  606. TOC_EXPAND = NO
  607. # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
  608. # top of each HTML page. The value NO (the default) enables the index and
  609. # the value YES disables it.
  610. DISABLE_INDEX = NO
  611. # This tag can be used to set the number of enum values (range [1..20])
  612. # that doxygen will group on one line in the generated HTML documentation.
  613. ENUM_VALUES_PER_LINE = 4
  614. # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
  615. # structure should be generated to display hierarchical information.
  616. # If the tag value is set to FRAME, a side panel will be generated
  617. # containing a tree-like index structure (just like the one that
  618. # is generated for HTML Help). For this to work a browser that supports
  619. # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
  620. # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
  621. # probably better off using the HTML help feature. Other possible values
  622. # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
  623. # and Class Hiererachy pages using a tree view instead of an ordered list;
  624. # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
  625. # disables this behavior completely. For backwards compatibility with previous
  626. # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
  627. # respectively.
  628. GENERATE_TREEVIEW = NO
  629. # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
  630. # used to set the initial width (in pixels) of the frame in which the tree
  631. # is shown.
  632. TREEVIEW_WIDTH = 250
  633. # Use this tag to change the font size of Latex formulas included
  634. # as images in the HTML documentation. The default is 10. Note that
  635. # when you change the font size after a successful doxygen run you need
  636. # to manually remove any form_*.png images from the HTML output directory
  637. # to force them to be regenerated.
  638. FORMULA_FONTSIZE = 10
  639. #---------------------------------------------------------------------------
  640. # configuration options related to the LaTeX output
  641. #---------------------------------------------------------------------------
  642. # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
  643. # generate Latex output.
  644. GENERATE_LATEX = YES
  645. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
  646. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  647. # put in front of it. If left blank `latex' will be used as the default path.
  648. LATEX_OUTPUT = latex
  649. # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  650. # invoked. If left blank `latex' will be used as the default command name.
  651. LATEX_CMD_NAME = latex
  652. # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
  653. # generate index for LaTeX. If left blank `makeindex' will be used as the
  654. # default command name.
  655. MAKEINDEX_CMD_NAME = makeindex
  656. # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
  657. # LaTeX documents. This may be useful for small projects and may help to
  658. # save some trees in general.
  659. COMPACT_LATEX = NO
  660. # The PAPER_TYPE tag can be used to set the paper type that is used
  661. # by the printer. Possible values are: a4, a4wide, letter, legal and
  662. # executive. If left blank a4wide will be used.
  663. PAPER_TYPE = a4wide
  664. # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
  665. # packages that should be included in the LaTeX output.
  666. EXTRA_PACKAGES =
  667. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
  668. # the generated latex document. The header should contain everything until
  669. # the first chapter. If it is left blank doxygen will generate a
  670. # standard header. Notice: only use this tag if you know what you are doing!
  671. LATEX_HEADER =
  672. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
  673. # is prepared for conversion to pdf (using ps2pdf). The pdf file will
  674. # contain links (just like the HTML output) instead of page references
  675. # This makes the output suitable for online browsing using a pdf viewer.
  676. PDF_HYPERLINKS = NO
  677. # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
  678. # plain latex in the generated Makefile. Set this option to YES to get a
  679. # higher quality PDF documentation.
  680. USE_PDFLATEX = NO
  681. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
  682. # command to the generated LaTeX files. This will instruct LaTeX to keep
  683. # running if errors occur, instead of asking the user for help.
  684. # This option is also used when generating formulas in HTML.
  685. LATEX_BATCHMODE = NO
  686. # If LATEX_HIDE_INDICES is set to YES then doxygen will not
  687. # include the index chapters (such as File Index, Compound Index, etc.)
  688. # in the output.
  689. LATEX_HIDE_INDICES = NO
  690. #---------------------------------------------------------------------------
  691. # configuration options related to the RTF output
  692. #---------------------------------------------------------------------------
  693. # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
  694. # The RTF output is optimized for Word 97 and may not look very pretty with
  695. # other RTF readers or editors.
  696. GENERATE_RTF = NO
  697. # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
  698. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  699. # put in front of it. If left blank `rtf' will be used as the default path.
  700. RTF_OUTPUT = rtf
  701. # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
  702. # RTF documents. This may be useful for small projects and may help to
  703. # save some trees in general.
  704. COMPACT_RTF = NO
  705. # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
  706. # will contain hyperlink fields. The RTF file will
  707. # contain links (just like the HTML output) instead of page references.
  708. # This makes the output suitable for online browsing using WORD or other
  709. # programs which support those fields.
  710. # Note: wordpad (write) and others do not support links.
  711. RTF_HYPERLINKS = NO
  712. # Load stylesheet definitions from file. Syntax is similar to doxygen's
  713. # config file, i.e. a series of assignments. You only have to provide
  714. # replacements, missing definitions are set to their default value.
  715. RTF_STYLESHEET_FILE =
  716. # Set optional variables used in the generation of an rtf document.
  717. # Syntax is similar to doxygen's config file.
  718. RTF_EXTENSIONS_FILE =
  719. #---------------------------------------------------------------------------
  720. # configuration options related to the man page output
  721. #---------------------------------------------------------------------------
  722. # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
  723. # generate man pages
  724. GENERATE_MAN = NO
  725. # The MAN_OUTPUT tag is used to specify where the man pages will be put.
  726. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  727. # put in front of it. If left blank `man' will be used as the default path.
  728. MAN_OUTPUT = man
  729. # The MAN_EXTENSION tag determines the extension that is added to
  730. # the generated man pages (default is the subroutine's section .3)
  731. MAN_EXTENSION = .3
  732. # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
  733. # then it will generate one additional man file for each entity
  734. # documented in the real man page(s). These additional files
  735. # only source the real man page, but without them the man command
  736. # would be unable to find the correct page. The default is NO.
  737. MAN_LINKS = NO
  738. #---------------------------------------------------------------------------
  739. # configuration options related to the XML output
  740. #---------------------------------------------------------------------------
  741. # If the GENERATE_XML tag is set to YES Doxygen will
  742. # generate an XML file that captures the structure of
  743. # the code including all documentation.
  744. GENERATE_XML = NO
  745. # The XML_OUTPUT tag is used to specify where the XML pages will be put.
  746. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  747. # put in front of it. If left blank `xml' will be used as the default path.
  748. XML_OUTPUT = xml
  749. # The XML_SCHEMA tag can be used to specify an XML schema,
  750. # which can be used by a validating XML parser to check the
  751. # syntax of the XML files.
  752. XML_SCHEMA =
  753. # The XML_DTD tag can be used to specify an XML DTD,
  754. # which can be used by a validating XML parser to check the
  755. # syntax of the XML files.
  756. XML_DTD =
  757. # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
  758. # dump the program listings (including syntax highlighting
  759. # and cross-referencing information) to the XML output. Note that
  760. # enabling this will significantly increase the size of the XML output.
  761. XML_PROGRAMLISTING = YES
  762. #---------------------------------------------------------------------------
  763. # configuration options for the AutoGen Definitions output
  764. #---------------------------------------------------------------------------
  765. # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
  766. # generate an AutoGen Definitions (see autogen.sf.net) file
  767. # that captures the structure of the code including all
  768. # documentation. Note that this feature is still experimental
  769. # and incomplete at the moment.
  770. GENERATE_AUTOGEN_DEF = NO
  771. #---------------------------------------------------------------------------
  772. # configuration options related to the Perl module output
  773. #---------------------------------------------------------------------------
  774. # If the GENERATE_PERLMOD tag is set to YES Doxygen will
  775. # generate a Perl module file that captures the structure of
  776. # the code including all documentation. Note that this
  777. # feature is still experimental and incomplete at the
  778. # moment.
  779. GENERATE_PERLMOD = NO
  780. # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
  781. # the necessary Makefile rules, Perl scripts and LaTeX code to be able
  782. # to generate PDF and DVI output from the Perl module output.
  783. PERLMOD_LATEX = NO
  784. # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
  785. # nicely formatted so it can be parsed by a human reader. This is useful
  786. # if you want to understand what is going on. On the other hand, if this
  787. # tag is set to NO the size of the Perl module output will be much smaller
  788. # and Perl will parse it just the same.
  789. PERLMOD_PRETTY = YES
  790. # The names of the make variables in the generated doxyrules.make file
  791. # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
  792. # This is useful so different doxyrules.make files included by the same
  793. # Makefile don't overwrite each other's variables.
  794. PERLMOD_MAKEVAR_PREFIX =
  795. #---------------------------------------------------------------------------
  796. # Configuration options related to the preprocessor
  797. #---------------------------------------------------------------------------
  798. # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
  799. # evaluate all C-preprocessor directives found in the sources and include
  800. # files.
  801. ENABLE_PREPROCESSING = YES
  802. # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
  803. # names in the source code. If set to NO (the default) only conditional
  804. # compilation will be performed. Macro expansion can be done in a controlled
  805. # way by setting EXPAND_ONLY_PREDEF to YES.
  806. MACRO_EXPANSION = NO
  807. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
  808. # then the macro expansion is limited to the macros specified with the
  809. # PREDEFINED and EXPAND_AS_DEFINED tags.
  810. EXPAND_ONLY_PREDEF = NO
  811. # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
  812. # in the INCLUDE_PATH (see below) will be search if a #include is found.
  813. SEARCH_INCLUDES = YES
  814. # The INCLUDE_PATH tag can be used to specify one or more directories that
  815. # contain include files that are not input files but should be processed by
  816. # the preprocessor.
  817. INCLUDE_PATH =
  818. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  819. # patterns (like *.h and *.hpp) to filter out the header-files in the
  820. # directories. If left blank, the patterns specified with FILE_PATTERNS will
  821. # be used.
  822. INCLUDE_FILE_PATTERNS =
  823. # The PREDEFINED tag can be used to specify one or more macro names that
  824. # are defined before the preprocessor is started (similar to the -D option of
  825. # gcc). The argument of the tag is a list of macros of the form: name
  826. # or name=definition (no spaces). If the definition and the = are
  827. # omitted =1 is assumed. To prevent a macro definition from being
  828. # undefined via #undef or recursively expanded use the := operator
  829. # instead of the = operator.
  830. PREDEFINED =
  831. # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
  832. # this tag can be used to specify a list of macro names that should be expanded.
  833. # The macro definition that is found in the sources will be used.
  834. # Use the PREDEFINED tag if you want to use a different macro definition.
  835. EXPAND_AS_DEFINED =
  836. # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
  837. # doxygen's preprocessor will remove all function-like macros that are alone
  838. # on a line, have an all uppercase name, and do not end with a semicolon. Such
  839. # function macros are typically used for boiler-plate code, and will confuse
  840. # the parser if not removed.
  841. SKIP_FUNCTION_MACROS = YES
  842. #---------------------------------------------------------------------------
  843. # Configuration::additions related to external references
  844. #---------------------------------------------------------------------------
  845. # The TAGFILES option can be used to specify one or more tagfiles.
  846. # Optionally an initial location of the external documentation
  847. # can be added for each tagfile. The format of a tag file without
  848. # this location is as follows:
  849. # TAGFILES = file1 file2 ...
  850. # Adding location for the tag files is done as follows:
  851. # TAGFILES = file1=loc1 "file2 = loc2" ...
  852. # where "loc1" and "loc2" can be relative or absolute paths or
  853. # URLs. If a location is present for each tag, the installdox tool
  854. # does not have to be run to correct the links.
  855. # Note that each tag file must have a unique name
  856. # (where the name does NOT include the path)
  857. # If a tag file is not located in the directory in which doxygen
  858. # is run, you must also specify the path to the tagfile here.
  859. TAGFILES =
  860. # When a file name is specified after GENERATE_TAGFILE, doxygen will create
  861. # a tag file that is based on the input files it reads.
  862. GENERATE_TAGFILE =
  863. # If the ALLEXTERNALS tag is set to YES all external classes will be listed
  864. # in the class index. If set to NO only the inherited external classes
  865. # will be listed.
  866. ALLEXTERNALS = NO
  867. # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
  868. # in the modules index. If set to NO, only the current project's groups will
  869. # be listed.
  870. EXTERNAL_GROUPS = YES
  871. # The PERL_PATH should be the absolute path and name of the perl script
  872. # interpreter (i.e. the result of `which perl').
  873. PERL_PATH = /usr/bin/perl
  874. #---------------------------------------------------------------------------
  875. # Configuration options related to the dot tool
  876. #---------------------------------------------------------------------------
  877. # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
  878. # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
  879. # or super classes. Setting the tag to NO turns the diagrams off. Note that
  880. # this option is superseded by the HAVE_DOT option below. This is only a
  881. # fallback. It is recommended to install and use dot, since it yields more
  882. # powerful graphs.
  883. CLASS_DIAGRAMS = YES
  884. # You can define message sequence charts within doxygen comments using the \msc
  885. # command. Doxygen will then run the mscgen tool (see
  886. # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
  887. # documentation. The MSCGEN_PATH tag allows you to specify the directory where
  888. # the mscgen tool resides. If left empty the tool is assumed to be found in the
  889. # default search path.
  890. MSCGEN_PATH =
  891. # If set to YES, the inheritance and collaboration graphs will hide
  892. # inheritance and usage relations if the target is undocumented
  893. # or is not a class.
  894. HIDE_UNDOC_RELATIONS = YES
  895. # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  896. # available from the path. This tool is part of Graphviz, a graph visualization
  897. # toolkit from AT&T and Lucent Bell Labs. The other options in this section
  898. # have no effect if this option is set to NO (the default)
  899. HAVE_DOT = NO
  900. # By default doxygen will write a font called FreeSans.ttf to the output
  901. # directory and reference it in all dot files that doxygen generates. This
  902. # font does not include all possible unicode characters however, so when you need
  903. # these (or just want a differently looking font) you can specify the font name
  904. # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
  905. # which can be done by putting it in a standard location or by setting the
  906. # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
  907. # containing the font.
  908. DOT_FONTNAME = FreeSans
  909. # By default doxygen will tell dot to use the output directory to look for the
  910. # FreeSans.ttf font (which doxygen will put there itself). If you specify a
  911. # different font using DOT_FONTNAME you can set the path where dot
  912. # can find it using this tag.
  913. DOT_FONTPATH =
  914. # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
  915. # will generate a graph for each documented class showing the direct and
  916. # indirect inheritance relations. Setting this tag to YES will force the
  917. # the CLASS_DIAGRAMS tag to NO.
  918. CLASS_GRAPH = YES
  919. # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
  920. # will generate a graph for each documented class showing the direct and
  921. # indirect implementation dependencies (inheritance, containment, and
  922. # class references variables) of the class with other documented classes.
  923. COLLABORATION_GRAPH = YES
  924. # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
  925. # will generate a graph for groups, showing the direct groups dependencies
  926. GROUP_GRAPHS = YES
  927. # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
  928. # collaboration diagrams in a style similar to the OMG's Unified Modeling
  929. # Language.
  930. UML_LOOK = NO
  931. # If set to YES, the inheritance and collaboration graphs will show the
  932. # relations between templates and their instances.
  933. TEMPLATE_RELATIONS = YES
  934. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
  935. # tags are set to YES then doxygen will generate a graph for each documented
  936. # file showing the direct and indirect include dependencies of the file with
  937. # other documented files.
  938. INCLUDE_GRAPH = YES
  939. # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
  940. # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
  941. # documented header file showing the documented files that directly or
  942. # indirectly include this file.
  943. INCLUDED_BY_GRAPH = YES
  944. # If the CALL_GRAPH and HAVE_DOT options are set to YES then
  945. # doxygen will generate a call dependency graph for every global function
  946. # or class method. Note that enabling this option will significantly increase
  947. # the time of a run. So in most cases it will be better to enable call graphs
  948. # for selected functions only using the \callgraph command.
  949. CALL_GRAPH = NO
  950. # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
  951. # doxygen will generate a caller dependency graph for every global function
  952. # or class method. Note that enabling this option will significantly increase
  953. # the time of a run. So in most cases it will be better to enable caller
  954. # graphs for selected functions only using the \callergraph command.
  955. CALLER_GRAPH = NO
  956. # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
  957. # will graphical hierarchy of all classes instead of a textual one.
  958. GRAPHICAL_HIERARCHY = YES
  959. # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
  960. # then doxygen will show the dependencies a directory has on other directories
  961. # in a graphical way. The dependency relations are determined by the #include
  962. # relations between the files in the directories.
  963. DIRECTORY_GRAPH = YES
  964. # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  965. # generated by dot. Possible values are png, jpg, or gif
  966. # If left blank png will be used.
  967. DOT_IMAGE_FORMAT = png
  968. # The tag DOT_PATH can be used to specify the path where the dot tool can be
  969. # found. If left blank, it is assumed the dot tool can be found in the path.
  970. DOT_PATH =
  971. # The DOTFILE_DIRS tag can be used to specify one or more directories that
  972. # contain dot files that are included in the documentation (see the
  973. # \dotfile command).
  974. DOTFILE_DIRS =
  975. # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
  976. # nodes that will be shown in the graph. If the number of nodes in a graph
  977. # becomes larger than this value, doxygen will truncate the graph, which is
  978. # visualized by representing a node as a red box. Note that doxygen if the
  979. # number of direct children of the root node in a graph is already larger than
  980. # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
  981. # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  982. DOT_GRAPH_MAX_NODES = 50
  983. # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
  984. # graphs generated by dot. A depth value of 3 means that only nodes reachable
  985. # from the root by following a path via at most 3 edges will be shown. Nodes
  986. # that lay further from the root node will be omitted. Note that setting this
  987. # option to 1 or 2 may greatly reduce the computation time needed for large
  988. # code bases. Also note that the size of a graph can be further restricted by
  989. # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  990. MAX_DOT_GRAPH_DEPTH = 0
  991. # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  992. # background. This is enabled by default, which results in a transparent
  993. # background. Warning: Depending on the platform used, enabling this option
  994. # may lead to badly anti-aliased labels on the edges of a graph (i.e. they
  995. # become hard to read).
  996. DOT_TRANSPARENT = NO
  997. # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
  998. # files in one run (i.e. multiple -o and -T options on the command line). This
  999. # makes dot run faster, but since only newer versions of dot (>1.8.10)
  1000. # support this, this feature is disabled by default.
  1001. DOT_MULTI_TARGETS = NO
  1002. # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
  1003. # generate a legend page explaining the meaning of the various boxes and
  1004. # arrows in the dot generated graphs.
  1005. GENERATE_LEGEND = YES
  1006. # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
  1007. # remove the intermediate dot files that are used to generate
  1008. # the various graphs.
  1009. DOT_CLEANUP = YES
  1010. #---------------------------------------------------------------------------
  1011. # Configuration::additions related to the search engine
  1012. #---------------------------------------------------------------------------
  1013. # The SEARCHENGINE tag specifies whether or not a search engine should be
  1014. # used. If set to NO the values of all tags below this one will be ignored.
  1015. SEARCHENGINE = NO