Doxyfile 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230
  1. # Doxyfile 1.5.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. # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
  15. # by quotes) that should identify the project.
  16. PROJECT_NAME = libevent
  17. # Place all output under 'doxygen/'
  18. OUTPUT_DIRECTORY = doxygen/
  19. # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
  20. # will interpret the first line (until the first dot) of a JavaDoc-style
  21. # comment as the brief description. If set to NO, the JavaDoc
  22. # comments will behave just like the Qt-style comments (thus requiring an
  23. # explicit @brief command for a brief description.
  24. JAVADOC_AUTOBRIEF = YES
  25. # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
  26. # sources only. Doxygen will then generate output that is more tailored for C.
  27. # For instance, some of the names that are used will be different. The list
  28. # of all members will be omitted, etc.
  29. OPTIMIZE_OUTPUT_FOR_C = YES
  30. # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
  31. # brief documentation of file, namespace and class members alphabetically
  32. # by member name. If set to NO (the default) the members will appear in
  33. # declaration order.
  34. SORT_BRIEF_DOCS = YES
  35. #---------------------------------------------------------------------------
  36. # configuration options related to the input files
  37. #---------------------------------------------------------------------------
  38. # The INPUT tag can be used to specify the files and/or directories that contain
  39. # documented source files. You may enter file names like "myfile.cpp" or
  40. # directories like "/usr/src/myproject". Separate the files or directories
  41. # with spaces.
  42. INPUT = event.h evdns.h evhttp.h evrpc.h
  43. #---------------------------------------------------------------------------
  44. # configuration options related to the HTML output
  45. #---------------------------------------------------------------------------
  46. # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
  47. # generate HTML output.
  48. GENERATE_HTML = YES
  49. #---------------------------------------------------------------------------
  50. # configuration options related to the LaTeX output
  51. #---------------------------------------------------------------------------
  52. # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
  53. # generate Latex output.
  54. GENERATE_LATEX = YES
  55. # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
  56. # If a relative path is entered the value of OUTPUT_DIRECTORY will be
  57. # put in front of it. If left blank `latex' will be used as the default path.
  58. LATEX_OUTPUT = latex
  59. # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  60. # invoked. If left blank `latex' will be used as the default command name.
  61. LATEX_CMD_NAME = latex
  62. # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
  63. # generate index for LaTeX. If left blank `makeindex' will be used as the
  64. # default command name.
  65. MAKEINDEX_CMD_NAME = makeindex
  66. # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
  67. # LaTeX documents. This may be useful for small projects and may help to
  68. # save some trees in general.
  69. COMPACT_LATEX = NO
  70. # The PAPER_TYPE tag can be used to set the paper type that is used
  71. # by the printer. Possible values are: a4, a4wide, letter, legal and
  72. # executive. If left blank a4wide will be used.
  73. PAPER_TYPE = a4wide
  74. # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
  75. # packages that should be included in the LaTeX output.
  76. EXTRA_PACKAGES =
  77. # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
  78. # the generated latex document. The header should contain everything until
  79. # the first chapter. If it is left blank doxygen will generate a
  80. # standard header. Notice: only use this tag if you know what you are doing!
  81. LATEX_HEADER =
  82. # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
  83. # is prepared for conversion to pdf (using ps2pdf). The pdf file will
  84. # contain links (just like the HTML output) instead of page references
  85. # This makes the output suitable for online browsing using a pdf viewer.
  86. PDF_HYPERLINKS = NO
  87. # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
  88. # plain latex in the generated Makefile. Set this option to YES to get a
  89. # higher quality PDF documentation.
  90. USE_PDFLATEX = NO
  91. # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
  92. # command to the generated LaTeX files. This will instruct LaTeX to keep
  93. # running if errors occur, instead of asking the user for help.
  94. # This option is also used when generating formulas in HTML.
  95. LATEX_BATCHMODE = NO
  96. # If LATEX_HIDE_INDICES is set to YES then doxygen will not
  97. # include the index chapters (such as File Index, Compound Index, etc.)
  98. # in the output.
  99. LATEX_HIDE_INDICES = NO
  100. #---------------------------------------------------------------------------
  101. # configuration options related to the man page output
  102. #---------------------------------------------------------------------------
  103. # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
  104. # generate man pages
  105. GENERATE_MAN = YES
  106. # The MAN_EXTENSION tag determines the extension that is added to
  107. # the generated man pages (default is the subroutine's section .3)
  108. MAN_EXTENSION = .3
  109. # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
  110. # then it will generate one additional man file for each entity
  111. # documented in the real man page(s). These additional files
  112. # only source the real man page, but without them the man command
  113. # would be unable to find the correct page. The default is NO.
  114. MAN_LINKS = YES
  115. #---------------------------------------------------------------------------
  116. # Configuration options related to the preprocessor
  117. #---------------------------------------------------------------------------
  118. # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
  119. # evaluate all C-preprocessor directives found in the sources and include
  120. # files.
  121. ENABLE_PREPROCESSING = YES
  122. # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
  123. # names in the source code. If set to NO (the default) only conditional
  124. # compilation will be performed. Macro expansion can be done in a controlled
  125. # way by setting EXPAND_ONLY_PREDEF to YES.
  126. MACRO_EXPANSION = NO
  127. # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
  128. # then the macro expansion is limited to the macros specified with the
  129. # PREDEFINED and EXPAND_AS_DEFINED tags.
  130. EXPAND_ONLY_PREDEF = NO
  131. # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
  132. # in the INCLUDE_PATH (see below) will be search if a #include is found.
  133. SEARCH_INCLUDES = YES
  134. # The INCLUDE_PATH tag can be used to specify one or more directories that
  135. # contain include files that are not input files but should be processed by
  136. # the preprocessor.
  137. INCLUDE_PATH =
  138. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  139. # patterns (like *.h and *.hpp) to filter out the header-files in the
  140. # directories. If left blank, the patterns specified with FILE_PATTERNS will
  141. # be used.
  142. INCLUDE_FILE_PATTERNS =
  143. # The PREDEFINED tag can be used to specify one or more macro names that
  144. # are defined before the preprocessor is started (similar to the -D option of
  145. # gcc). The argument of the tag is a list of macros of the form: name
  146. # or name=definition (no spaces). If the definition and the = are
  147. # omitted =1 is assumed. To prevent a macro definition from being
  148. # undefined via #undef or recursively expanded use the := operator
  149. # instead of the = operator.
  150. PREDEFINED = TAILQ_ENTRY RB_ENTRY _EVENT_DEFINED_TQENTRY
  151. # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
  152. # this tag can be used to specify a list of macro names that should be expanded.
  153. # The macro definition that is found in the sources will be used.
  154. # Use the PREDEFINED tag if you want to use a different macro definition.
  155. EXPAND_AS_DEFINED =
  156. # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
  157. # doxygen's preprocessor will remove all function-like macros that are alone
  158. # on a line, have an all uppercase name, and do not end with a semicolon. Such
  159. # function macros are typically used for boiler-plate code, and will confuse
  160. # the parser if not removed.
  161. SKIP_FUNCTION_MACROS = YES