193dcc084Schristos# Doxyfile 1.5.1 293dcc084Schristos 393dcc084Schristos# This file describes the settings to be used by the documentation system 493dcc084Schristos# doxygen (www.doxygen.org) for a project 593dcc084Schristos# 693dcc084Schristos# All text after a hash (#) is considered a comment and will be ignored 793dcc084Schristos# The format is: 893dcc084Schristos# TAG = value [value, ...] 993dcc084Schristos# For lists items can also be appended using: 1093dcc084Schristos# TAG += value [value, ...] 1193dcc084Schristos# Values that contain spaces should be placed between quotes (" ") 1293dcc084Schristos 1393dcc084Schristos#--------------------------------------------------------------------------- 1493dcc084Schristos# Project related configuration options 1593dcc084Schristos#--------------------------------------------------------------------------- 1693dcc084Schristos 1793dcc084Schristos# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 1893dcc084Schristos# by quotes) that should identify the project. 1993dcc084Schristos 20*4109d450SchristosPROJECT_NAME = $(PROJECT)-$(VERSION) 2193dcc084Schristos 2293dcc084Schristos# Place all output under 'doxygen/' 2393dcc084Schristos 24*4109d450SchristosOUTPUT_DIRECTORY = $(DOCDIR) 2593dcc084Schristos 2693dcc084Schristos# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 2793dcc084Schristos# will interpret the first line (until the first dot) of a JavaDoc-style 2893dcc084Schristos# comment as the brief description. If set to NO, the JavaDoc 2993dcc084Schristos# comments will behave just like the Qt-style comments (thus requiring an 3093dcc084Schristos# explicit @brief command for a brief description. 3193dcc084Schristos 3293dcc084SchristosJAVADOC_AUTOBRIEF = YES 3393dcc084Schristos 3493dcc084Schristos# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 3593dcc084Schristos# sources only. Doxygen will then generate output that is more tailored for C. 3693dcc084Schristos# For instance, some of the names that are used will be different. The list 3793dcc084Schristos# of all members will be omitted, etc. 3893dcc084Schristos 3993dcc084SchristosOPTIMIZE_OUTPUT_FOR_C = YES 4093dcc084Schristos 4193dcc084Schristos# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 4293dcc084Schristos# brief documentation of file, namespace and class members alphabetically 4393dcc084Schristos# by member name. If set to NO (the default) the members will appear in 4493dcc084Schristos# declaration order. 4593dcc084Schristos 4693dcc084SchristosSORT_BRIEF_DOCS = YES 4793dcc084Schristos 4893dcc084Schristos# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 4993dcc084Schristos# can be used to strip a user-defined part of the path. Stripping is 5093dcc084Schristos# only done if one of the specified strings matches the left-hand part of 5193dcc084Schristos# the path. The tag can be used to show relative paths in the file list. 5293dcc084Schristos# If left blank the directory from which doxygen is run is used as the 5393dcc084Schristos# path to strip. 5493dcc084Schristos 5593dcc084SchristosSTRIP_FROM_PATH = include/ 5693dcc084Schristos 5793dcc084Schristos#--------------------------------------------------------------------------- 5893dcc084Schristos# configuration options related to the input files 5993dcc084Schristos#--------------------------------------------------------------------------- 6093dcc084Schristos 6193dcc084Schristos# The INPUT tag can be used to specify the files and/or directories that contain 6293dcc084Schristos# documented source files. You may enter file names like "myfile.cpp" or 6393dcc084Schristos# directories like "/usr/src/myproject". Separate the files or directories 6493dcc084Schristos# with spaces. 6593dcc084Schristos 6693dcc084SchristosINPUT = \ 67*4109d450Schristos $(SRCDIR)/include/event2/buffer.h \ 68*4109d450Schristos $(SRCDIR)/include/event2/buffer_compat.h \ 69*4109d450Schristos $(SRCDIR)/include/event2/bufferevent.h \ 70*4109d450Schristos $(SRCDIR)/include/event2/bufferevent_compat.h \ 71*4109d450Schristos $(SRCDIR)/include/event2/bufferevent_ssl.h \ 72*4109d450Schristos $(SRCDIR)/include/event2/dns.h \ 73*4109d450Schristos $(SRCDIR)/include/event2/dns_compat.h \ 74*4109d450Schristos $(SRCDIR)/include/event2/event.h \ 75*4109d450Schristos $(SRCDIR)/include/event2/event_compat.h \ 76*4109d450Schristos $(SRCDIR)/include/event2/http.h \ 77*4109d450Schristos $(SRCDIR)/include/event2/http_compat.h \ 78*4109d450Schristos $(SRCDIR)/include/event2/listener.h \ 79*4109d450Schristos $(SRCDIR)/include/event2/rpc.h \ 80*4109d450Schristos $(SRCDIR)/include/event2/rpc_compat.h \ 81*4109d450Schristos $(SRCDIR)/include/event2/tag.h \ 82*4109d450Schristos $(SRCDIR)/include/event2/tag_compat.h \ 83*4109d450Schristos $(SRCDIR)/include/event2/thread.h \ 84*4109d450Schristos $(SRCDIR)/include/event2/util.h 8593dcc084Schristos 8693dcc084Schristos#--------------------------------------------------------------------------- 8793dcc084Schristos# configuration options related to the HTML output 8893dcc084Schristos#--------------------------------------------------------------------------- 8993dcc084Schristos 9093dcc084Schristos# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 9193dcc084Schristos# generate HTML output. 9293dcc084Schristos 93*4109d450SchristosGENERATE_HTML = $(GENERATE_HTML) 9493dcc084Schristos 9593dcc084Schristos#--------------------------------------------------------------------------- 9693dcc084Schristos# configuration options related to the LaTeX output 9793dcc084Schristos#--------------------------------------------------------------------------- 9893dcc084Schristos 9993dcc084Schristos# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 10093dcc084Schristos# generate Latex output. 10193dcc084Schristos 102*4109d450SchristosGENERATE_LATEX = $(GENERATE_LATEX) 10393dcc084Schristos 10493dcc084Schristos# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 10593dcc084Schristos# If a relative path is entered the value of OUTPUT_DIRECTORY will be 10693dcc084Schristos# put in front of it. If left blank `latex' will be used as the default path. 10793dcc084Schristos 10893dcc084SchristosLATEX_OUTPUT = latex 10993dcc084Schristos 11093dcc084Schristos# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 11193dcc084Schristos# invoked. If left blank `latex' will be used as the default command name. 11293dcc084Schristos 11393dcc084SchristosLATEX_CMD_NAME = latex 11493dcc084Schristos 11593dcc084Schristos# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 11693dcc084Schristos# generate index for LaTeX. If left blank `makeindex' will be used as the 11793dcc084Schristos# default command name. 11893dcc084Schristos 11993dcc084SchristosMAKEINDEX_CMD_NAME = makeindex 12093dcc084Schristos 12193dcc084Schristos# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 12293dcc084Schristos# LaTeX documents. This may be useful for small projects and may help to 12393dcc084Schristos# save some trees in general. 12493dcc084Schristos 12593dcc084SchristosCOMPACT_LATEX = NO 12693dcc084Schristos 12793dcc084Schristos# The PAPER_TYPE tag can be used to set the paper type that is used 12893dcc084Schristos# by the printer. Possible values are: a4, a4wide, letter, legal and 12993dcc084Schristos# executive. If left blank a4wide will be used. 13093dcc084Schristos 13193dcc084SchristosPAPER_TYPE = a4wide 13293dcc084Schristos 13393dcc084Schristos# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 13493dcc084Schristos# packages that should be included in the LaTeX output. 13593dcc084Schristos 13693dcc084SchristosEXTRA_PACKAGES = 13793dcc084Schristos 13893dcc084Schristos# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 13993dcc084Schristos# the generated latex document. The header should contain everything until 14093dcc084Schristos# the first chapter. If it is left blank doxygen will generate a 14193dcc084Schristos# standard header. Notice: only use this tag if you know what you are doing! 14293dcc084Schristos 14393dcc084SchristosLATEX_HEADER = 14493dcc084Schristos 14593dcc084Schristos# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 14693dcc084Schristos# is prepared for conversion to pdf (using ps2pdf). The pdf file will 14793dcc084Schristos# contain links (just like the HTML output) instead of page references 14893dcc084Schristos# This makes the output suitable for online browsing using a pdf viewer. 14993dcc084Schristos 15093dcc084SchristosPDF_HYPERLINKS = NO 15193dcc084Schristos 15293dcc084Schristos# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 15393dcc084Schristos# plain latex in the generated Makefile. Set this option to YES to get a 15493dcc084Schristos# higher quality PDF documentation. 15593dcc084Schristos 15693dcc084SchristosUSE_PDFLATEX = YES 15793dcc084Schristos 15893dcc084Schristos# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 15993dcc084Schristos# command to the generated LaTeX files. This will instruct LaTeX to keep 16093dcc084Schristos# running if errors occur, instead of asking the user for help. 16193dcc084Schristos# This option is also used when generating formulas in HTML. 16293dcc084Schristos 16393dcc084SchristosLATEX_BATCHMODE = NO 16493dcc084Schristos 16593dcc084Schristos# If LATEX_HIDE_INDICES is set to YES then doxygen will not 16693dcc084Schristos# include the index chapters (such as File Index, Compound Index, etc.) 16793dcc084Schristos# in the output. 16893dcc084Schristos 16993dcc084SchristosLATEX_HIDE_INDICES = NO 17093dcc084Schristos 17193dcc084Schristos#--------------------------------------------------------------------------- 17293dcc084Schristos# configuration options related to the man page output 17393dcc084Schristos#--------------------------------------------------------------------------- 17493dcc084Schristos 17593dcc084Schristos# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 17693dcc084Schristos# generate man pages 17793dcc084Schristos 178*4109d450SchristosGENERATE_MAN = $(GENERATE_MAN) 17993dcc084Schristos 18093dcc084Schristos# The MAN_EXTENSION tag determines the extension that is added to 18193dcc084Schristos# the generated man pages (default is the subroutine's section .3) 18293dcc084Schristos 18393dcc084SchristosMAN_EXTENSION = .3 18493dcc084Schristos 18593dcc084Schristos# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 18693dcc084Schristos# then it will generate one additional man file for each entity 18793dcc084Schristos# documented in the real man page(s). These additional files 18893dcc084Schristos# only source the real man page, but without them the man command 18993dcc084Schristos# would be unable to find the correct page. The default is NO. 19093dcc084Schristos 19193dcc084SchristosMAN_LINKS = YES 19293dcc084Schristos 19393dcc084Schristos#--------------------------------------------------------------------------- 19493dcc084Schristos# Configuration options related to the preprocessor 19593dcc084Schristos#--------------------------------------------------------------------------- 19693dcc084Schristos 19793dcc084Schristos# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 19893dcc084Schristos# evaluate all C-preprocessor directives found in the sources and include 19993dcc084Schristos# files. 20093dcc084Schristos 20193dcc084SchristosENABLE_PREPROCESSING = YES 20293dcc084Schristos 20393dcc084Schristos# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 20493dcc084Schristos# names in the source code. If set to NO (the default) only conditional 20593dcc084Schristos# compilation will be performed. Macro expansion can be done in a controlled 20693dcc084Schristos# way by setting EXPAND_ONLY_PREDEF to YES. 20793dcc084Schristos 20893dcc084SchristosMACRO_EXPANSION = NO 20993dcc084Schristos 21093dcc084Schristos# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 21193dcc084Schristos# then the macro expansion is limited to the macros specified with the 21293dcc084Schristos# PREDEFINED and EXPAND_AS_DEFINED tags. 21393dcc084Schristos 21493dcc084SchristosEXPAND_ONLY_PREDEF = NO 21593dcc084Schristos 21693dcc084Schristos# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 21793dcc084Schristos# in the INCLUDE_PATH (see below) will be search if a #include is found. 21893dcc084Schristos 21993dcc084SchristosSEARCH_INCLUDES = YES 22093dcc084Schristos 22193dcc084Schristos# The INCLUDE_PATH tag can be used to specify one or more directories that 22293dcc084Schristos# contain include files that are not input files but should be processed by 22393dcc084Schristos# the preprocessor. 22493dcc084Schristos 22593dcc084SchristosINCLUDE_PATH = 22693dcc084Schristos 22793dcc084Schristos# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 22893dcc084Schristos# patterns (like *.h and *.hpp) to filter out the header-files in the 22993dcc084Schristos# directories. If left blank, the patterns specified with FILE_PATTERNS will 23093dcc084Schristos# be used. 23193dcc084Schristos 23293dcc084SchristosINCLUDE_FILE_PATTERNS = 23393dcc084Schristos 23493dcc084Schristos# The PREDEFINED tag can be used to specify one or more macro names that 23593dcc084Schristos# are defined before the preprocessor is started (similar to the -D option of 23693dcc084Schristos# gcc). The argument of the tag is a list of macros of the form: name 23793dcc084Schristos# or name=definition (no spaces). If the definition and the = are 23893dcc084Schristos# omitted =1 is assumed. To prevent a macro definition from being 23993dcc084Schristos# undefined via #undef or recursively expanded use the := operator 24093dcc084Schristos# instead of the = operator. 24193dcc084Schristos 242615c371fSchristosPREDEFINED = TAILQ_ENTRY RB_ENTRY EVENT_DEFINED_TQENTRY_ EVENT_IN_DOXYGEN_ 24393dcc084Schristos 24493dcc084Schristos# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 24593dcc084Schristos# this tag can be used to specify a list of macro names that should be expanded. 24693dcc084Schristos# The macro definition that is found in the sources will be used. 24793dcc084Schristos# Use the PREDEFINED tag if you want to use a different macro definition. 24893dcc084Schristos 24993dcc084SchristosEXPAND_AS_DEFINED = 25093dcc084Schristos 25193dcc084Schristos# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 25293dcc084Schristos# doxygen's preprocessor will remove all function-like macros that are alone 25393dcc084Schristos# on a line, have an all uppercase name, and do not end with a semicolon. Such 25493dcc084Schristos# function macros are typically used for boiler-plate code, and will confuse 25593dcc084Schristos# the parser if not removed. 25693dcc084Schristos 25793dcc084SchristosSKIP_FUNCTION_MACROS = YES 258