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