1# Doxyfile 1.5.1 2 3# This file describes the settings to be used by the documentation system 4# doxygen (www.doxygen.org) for a project 5# 6# All text after a hash (#) is considered a comment and will be ignored 7# The format is: 8# TAG = value [value, ...] 9# For lists items can also be appended using: 10# TAG += value [value, ...] 11# Values that contain spaces should be placed between quotes (" ") 12 13#--------------------------------------------------------------------------- 14# Project related configuration options 15#--------------------------------------------------------------------------- 16 17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 18# by quotes) that should identify the project. 19 20PROJECT_NAME = libevent 21 22# Place all output under 'doxygen/' 23 24OUTPUT_DIRECTORY = doxygen/ 25 26# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 27# will interpret the first line (until the first dot) of a JavaDoc-style 28# comment as the brief description. If set to NO, the JavaDoc 29# comments will behave just like the Qt-style comments (thus requiring an 30# explicit @brief command for a brief description. 31 32JAVADOC_AUTOBRIEF = YES 33 34# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 35# sources only. Doxygen will then generate output that is more tailored for C. 36# For instance, some of the names that are used will be different. The list 37# of all members will be omitted, etc. 38 39OPTIMIZE_OUTPUT_FOR_C = YES 40 41# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 42# brief documentation of file, namespace and class members alphabetically 43# by member name. If set to NO (the default) the members will appear in 44# declaration order. 45 46SORT_BRIEF_DOCS = YES 47 48#--------------------------------------------------------------------------- 49# configuration options related to the input files 50#--------------------------------------------------------------------------- 51 52# The INPUT tag can be used to specify the files and/or directories that contain 53# documented source files. You may enter file names like "myfile.cpp" or 54# directories like "/usr/src/myproject". Separate the files or directories 55# with spaces. 56 57INPUT = event.h evdns.h evhttp.h evrpc.h \ 58 include/event2/event.h include/event2/event_struct.h \ 59 include/event2/event_compat.h \ 60 include/event2/buffer_compat.h \ 61 include/event2/buffer.h include/event2/thread.h \ 62 include/event2/tag.h include/event2/bufferevent.h \ 63 include/event2/bufferevent_struct.h \ 64 include/event2/bufferevent_compat.h \ 65 include/event2/util.h \ 66 include/event2/dns.h include/event2/dns_struct.h \ 67 include/event2/dns_compat.h \ 68 include/event2/http.h include/event2/http_struct.h \ 69 include/event2/http_compat.h 70 71#--------------------------------------------------------------------------- 72# configuration options related to the HTML output 73#--------------------------------------------------------------------------- 74 75# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 76# generate HTML output. 77 78GENERATE_HTML = YES 79 80#--------------------------------------------------------------------------- 81# configuration options related to the LaTeX output 82#--------------------------------------------------------------------------- 83 84# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 85# generate Latex output. 86 87GENERATE_LATEX = YES 88 89# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 90# If a relative path is entered the value of OUTPUT_DIRECTORY will be 91# put in front of it. If left blank `latex' will be used as the default path. 92 93LATEX_OUTPUT = latex 94 95# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 96# invoked. If left blank `latex' will be used as the default command name. 97 98LATEX_CMD_NAME = latex 99 100# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 101# generate index for LaTeX. If left blank `makeindex' will be used as the 102# default command name. 103 104MAKEINDEX_CMD_NAME = makeindex 105 106# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 107# LaTeX documents. This may be useful for small projects and may help to 108# save some trees in general. 109 110COMPACT_LATEX = NO 111 112# The PAPER_TYPE tag can be used to set the paper type that is used 113# by the printer. Possible values are: a4, a4wide, letter, legal and 114# executive. If left blank a4wide will be used. 115 116PAPER_TYPE = a4wide 117 118# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 119# packages that should be included in the LaTeX output. 120 121EXTRA_PACKAGES = 122 123# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 124# the generated latex document. The header should contain everything until 125# the first chapter. If it is left blank doxygen will generate a 126# standard header. Notice: only use this tag if you know what you are doing! 127 128LATEX_HEADER = 129 130# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 131# is prepared for conversion to pdf (using ps2pdf). The pdf file will 132# contain links (just like the HTML output) instead of page references 133# This makes the output suitable for online browsing using a pdf viewer. 134 135PDF_HYPERLINKS = NO 136 137# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 138# plain latex in the generated Makefile. Set this option to YES to get a 139# higher quality PDF documentation. 140 141USE_PDFLATEX = NO 142 143# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 144# command to the generated LaTeX files. This will instruct LaTeX to keep 145# running if errors occur, instead of asking the user for help. 146# This option is also used when generating formulas in HTML. 147 148LATEX_BATCHMODE = NO 149 150# If LATEX_HIDE_INDICES is set to YES then doxygen will not 151# include the index chapters (such as File Index, Compound Index, etc.) 152# in the output. 153 154LATEX_HIDE_INDICES = NO 155 156#--------------------------------------------------------------------------- 157# configuration options related to the man page output 158#--------------------------------------------------------------------------- 159 160# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 161# generate man pages 162 163GENERATE_MAN = YES 164 165# The MAN_EXTENSION tag determines the extension that is added to 166# the generated man pages (default is the subroutine's section .3) 167 168MAN_EXTENSION = .3 169 170# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 171# then it will generate one additional man file for each entity 172# documented in the real man page(s). These additional files 173# only source the real man page, but without them the man command 174# would be unable to find the correct page. The default is NO. 175 176MAN_LINKS = YES 177 178#--------------------------------------------------------------------------- 179# Configuration options related to the preprocessor 180#--------------------------------------------------------------------------- 181 182# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 183# evaluate all C-preprocessor directives found in the sources and include 184# files. 185 186ENABLE_PREPROCESSING = YES 187 188# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 189# names in the source code. If set to NO (the default) only conditional 190# compilation will be performed. Macro expansion can be done in a controlled 191# way by setting EXPAND_ONLY_PREDEF to YES. 192 193MACRO_EXPANSION = NO 194 195# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 196# then the macro expansion is limited to the macros specified with the 197# PREDEFINED and EXPAND_AS_DEFINED tags. 198 199EXPAND_ONLY_PREDEF = NO 200 201# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 202# in the INCLUDE_PATH (see below) will be search if a #include is found. 203 204SEARCH_INCLUDES = YES 205 206# The INCLUDE_PATH tag can be used to specify one or more directories that 207# contain include files that are not input files but should be processed by 208# the preprocessor. 209 210INCLUDE_PATH = 211 212# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 213# patterns (like *.h and *.hpp) to filter out the header-files in the 214# directories. If left blank, the patterns specified with FILE_PATTERNS will 215# be used. 216 217INCLUDE_FILE_PATTERNS = 218 219# The PREDEFINED tag can be used to specify one or more macro names that 220# are defined before the preprocessor is started (similar to the -D option of 221# gcc). The argument of the tag is a list of macros of the form: name 222# or name=definition (no spaces). If the definition and the = are 223# omitted =1 is assumed. To prevent a macro definition from being 224# undefined via #undef or recursively expanded use the := operator 225# instead of the = operator. 226 227PREDEFINED = TAILQ_ENTRY RB_ENTRY _EVENT_DEFINED_TQENTRY 228 229# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 230# this tag can be used to specify a list of macro names that should be expanded. 231# The macro definition that is found in the sources will be used. 232# Use the PREDEFINED tag if you want to use a different macro definition. 233 234EXPAND_AS_DEFINED = 235 236# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 237# doxygen's preprocessor will remove all function-like macros that are alone 238# on a line, have an all uppercase name, and do not end with a semicolon. Such 239# function macros are typically used for boiler-plate code, and will confuse 240# the parser if not removed. 241 242SKIP_FUNCTION_MACROS = YES 243