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