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