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