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/rpc.h include/event2/rpc_struct.h \ 67 include/event2/dns.h include/event2/dns_struct.h \ 68 include/event2/dns_compat.h \ 69 include/event2/http.h include/event2/http_struct.h \ 70 include/event2/http_compat.h 71 72#--------------------------------------------------------------------------- 73# configuration options related to the HTML output 74#--------------------------------------------------------------------------- 75 76# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 77# generate HTML output. 78 79GENERATE_HTML = YES 80 81#--------------------------------------------------------------------------- 82# configuration options related to the LaTeX output 83#--------------------------------------------------------------------------- 84 85# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 86# generate Latex output. 87 88GENERATE_LATEX = YES 89 90# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 91# If a relative path is entered the value of OUTPUT_DIRECTORY will be 92# put in front of it. If left blank `latex' will be used as the default path. 93 94LATEX_OUTPUT = latex 95 96# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 97# invoked. If left blank `latex' will be used as the default command name. 98 99LATEX_CMD_NAME = latex 100 101# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 102# generate index for LaTeX. If left blank `makeindex' will be used as the 103# default command name. 104 105MAKEINDEX_CMD_NAME = makeindex 106 107# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 108# LaTeX documents. This may be useful for small projects and may help to 109# save some trees in general. 110 111COMPACT_LATEX = NO 112 113# The PAPER_TYPE tag can be used to set the paper type that is used 114# by the printer. Possible values are: a4, a4wide, letter, legal and 115# executive. If left blank a4wide will be used. 116 117PAPER_TYPE = a4wide 118 119# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 120# packages that should be included in the LaTeX output. 121 122EXTRA_PACKAGES = 123 124# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 125# the generated latex document. The header should contain everything until 126# the first chapter. If it is left blank doxygen will generate a 127# standard header. Notice: only use this tag if you know what you are doing! 128 129LATEX_HEADER = 130 131# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 132# is prepared for conversion to pdf (using ps2pdf). The pdf file will 133# contain links (just like the HTML output) instead of page references 134# This makes the output suitable for online browsing using a pdf viewer. 135 136PDF_HYPERLINKS = NO 137 138# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 139# plain latex in the generated Makefile. Set this option to YES to get a 140# higher quality PDF documentation. 141 142USE_PDFLATEX = NO 143 144# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 145# command to the generated LaTeX files. This will instruct LaTeX to keep 146# running if errors occur, instead of asking the user for help. 147# This option is also used when generating formulas in HTML. 148 149LATEX_BATCHMODE = NO 150 151# If LATEX_HIDE_INDICES is set to YES then doxygen will not 152# include the index chapters (such as File Index, Compound Index, etc.) 153# in the output. 154 155LATEX_HIDE_INDICES = NO 156 157#--------------------------------------------------------------------------- 158# configuration options related to the man page output 159#--------------------------------------------------------------------------- 160 161# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 162# generate man pages 163 164GENERATE_MAN = YES 165 166# The MAN_EXTENSION tag determines the extension that is added to 167# the generated man pages (default is the subroutine's section .3) 168 169MAN_EXTENSION = .3 170 171# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 172# then it will generate one additional man file for each entity 173# documented in the real man page(s). These additional files 174# only source the real man page, but without them the man command 175# would be unable to find the correct page. The default is NO. 176 177MAN_LINKS = YES 178 179#--------------------------------------------------------------------------- 180# Configuration options related to the preprocessor 181#--------------------------------------------------------------------------- 182 183# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 184# evaluate all C-preprocessor directives found in the sources and include 185# files. 186 187ENABLE_PREPROCESSING = YES 188 189# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 190# names in the source code. If set to NO (the default) only conditional 191# compilation will be performed. Macro expansion can be done in a controlled 192# way by setting EXPAND_ONLY_PREDEF to YES. 193 194MACRO_EXPANSION = NO 195 196# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 197# then the macro expansion is limited to the macros specified with the 198# PREDEFINED and EXPAND_AS_DEFINED tags. 199 200EXPAND_ONLY_PREDEF = NO 201 202# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 203# in the INCLUDE_PATH (see below) will be search if a #include is found. 204 205SEARCH_INCLUDES = YES 206 207# The INCLUDE_PATH tag can be used to specify one or more directories that 208# contain include files that are not input files but should be processed by 209# the preprocessor. 210 211INCLUDE_PATH = 212 213# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 214# patterns (like *.h and *.hpp) to filter out the header-files in the 215# directories. If left blank, the patterns specified with FILE_PATTERNS will 216# be used. 217 218INCLUDE_FILE_PATTERNS = 219 220# The PREDEFINED tag can be used to specify one or more macro names that 221# are defined before the preprocessor is started (similar to the -D option of 222# gcc). The argument of the tag is a list of macros of the form: name 223# or name=definition (no spaces). If the definition and the = are 224# omitted =1 is assumed. To prevent a macro definition from being 225# undefined via #undef or recursively expanded use the := operator 226# instead of the = operator. 227 228PREDEFINED = TAILQ_ENTRY RB_ENTRY _EVENT_DEFINED_TQENTRY 229 230# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 231# this tag can be used to specify a list of macro names that should be expanded. 232# The macro definition that is found in the sources will be used. 233# Use the PREDEFINED tag if you want to use a different macro definition. 234 235EXPAND_AS_DEFINED = 236 237# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 238# doxygen's preprocessor will remove all function-like macros that are alone 239# on a line, have an all uppercase name, and do not end with a semicolon. Such 240# function macros are typically used for boiler-plate code, and will confuse 241# the parser if not removed. 242 243SKIP_FUNCTION_MACROS = YES 244