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