michael@0: # Doxyfile 1.5.1 michael@0: michael@0: # This file describes the settings to be used by the documentation system michael@0: # doxygen (www.doxygen.org) for a project michael@0: # michael@0: # All text after a hash (#) is considered a comment and will be ignored michael@0: # The format is: michael@0: # TAG = value [value, ...] michael@0: # For lists items can also be appended using: michael@0: # TAG += value [value, ...] michael@0: # Values that contain spaces should be placed between quotes (" ") michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # Project related configuration options michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # The PROJECT_NAME tag is a single word (or a sequence of words surrounded michael@0: # by quotes) that should identify the project. michael@0: michael@0: PROJECT_NAME = libevent michael@0: michael@0: # Place all output under 'doxygen/' michael@0: michael@0: OUTPUT_DIRECTORY = doxygen/ michael@0: michael@0: # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen michael@0: # will interpret the first line (until the first dot) of a JavaDoc-style michael@0: # comment as the brief description. If set to NO, the JavaDoc michael@0: # comments will behave just like the Qt-style comments (thus requiring an michael@0: # explicit @brief command for a brief description. michael@0: michael@0: JAVADOC_AUTOBRIEF = YES michael@0: michael@0: # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C michael@0: # sources only. Doxygen will then generate output that is more tailored for C. michael@0: # For instance, some of the names that are used will be different. The list michael@0: # of all members will be omitted, etc. michael@0: michael@0: OPTIMIZE_OUTPUT_FOR_C = YES michael@0: michael@0: # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the michael@0: # brief documentation of file, namespace and class members alphabetically michael@0: # by member name. If set to NO (the default) the members will appear in michael@0: # declaration order. michael@0: michael@0: SORT_BRIEF_DOCS = YES michael@0: michael@0: # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag michael@0: # can be used to strip a user-defined part of the path. Stripping is michael@0: # only done if one of the specified strings matches the left-hand part of michael@0: # the path. The tag can be used to show relative paths in the file list. michael@0: # If left blank the directory from which doxygen is run is used as the michael@0: # path to strip. michael@0: michael@0: STRIP_FROM_PATH = include/ michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # configuration options related to the input files michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # The INPUT tag can be used to specify the files and/or directories that contain michael@0: # documented source files. You may enter file names like "myfile.cpp" or michael@0: # directories like "/usr/src/myproject". Separate the files or directories michael@0: # with spaces. michael@0: michael@0: INPUT = \ michael@0: include/event2/buffer.h \ michael@0: include/event2/buffer_compat.h \ michael@0: include/event2/bufferevent.h \ michael@0: include/event2/bufferevent_compat.h \ michael@0: include/event2/bufferevent_ssl.h \ michael@0: include/event2/dns.h \ michael@0: include/event2/dns_compat.h \ michael@0: include/event2/event.h \ michael@0: include/event2/event_compat.h \ michael@0: include/event2/http.h \ michael@0: include/event2/http_compat.h \ michael@0: include/event2/listener.h \ michael@0: include/event2/rpc.h \ michael@0: include/event2/rpc_compat.h \ michael@0: include/event2/tag.h \ michael@0: include/event2/tag_compat.h \ michael@0: include/event2/thread.h \ michael@0: include/event2/util.h michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # configuration options related to the HTML output michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # If the GENERATE_HTML tag is set to YES (the default) Doxygen will michael@0: # generate HTML output. michael@0: michael@0: GENERATE_HTML = YES michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # configuration options related to the LaTeX output michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will michael@0: # generate Latex output. michael@0: michael@0: GENERATE_LATEX = YES michael@0: michael@0: # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. michael@0: # If a relative path is entered the value of OUTPUT_DIRECTORY will be michael@0: # put in front of it. If left blank `latex' will be used as the default path. michael@0: michael@0: LATEX_OUTPUT = latex michael@0: michael@0: # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be michael@0: # invoked. If left blank `latex' will be used as the default command name. michael@0: michael@0: LATEX_CMD_NAME = latex michael@0: michael@0: # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to michael@0: # generate index for LaTeX. If left blank `makeindex' will be used as the michael@0: # default command name. michael@0: michael@0: MAKEINDEX_CMD_NAME = makeindex michael@0: michael@0: # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact michael@0: # LaTeX documents. This may be useful for small projects and may help to michael@0: # save some trees in general. michael@0: michael@0: COMPACT_LATEX = NO michael@0: michael@0: # The PAPER_TYPE tag can be used to set the paper type that is used michael@0: # by the printer. Possible values are: a4, a4wide, letter, legal and michael@0: # executive. If left blank a4wide will be used. michael@0: michael@0: PAPER_TYPE = a4wide michael@0: michael@0: # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX michael@0: # packages that should be included in the LaTeX output. michael@0: michael@0: EXTRA_PACKAGES = michael@0: michael@0: # The LATEX_HEADER tag can be used to specify a personal LaTeX header for michael@0: # the generated latex document. The header should contain everything until michael@0: # the first chapter. If it is left blank doxygen will generate a michael@0: # standard header. Notice: only use this tag if you know what you are doing! michael@0: michael@0: LATEX_HEADER = michael@0: michael@0: # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated michael@0: # is prepared for conversion to pdf (using ps2pdf). The pdf file will michael@0: # contain links (just like the HTML output) instead of page references michael@0: # This makes the output suitable for online browsing using a pdf viewer. michael@0: michael@0: PDF_HYPERLINKS = NO michael@0: michael@0: # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of michael@0: # plain latex in the generated Makefile. Set this option to YES to get a michael@0: # higher quality PDF documentation. michael@0: michael@0: USE_PDFLATEX = YES michael@0: michael@0: # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. michael@0: # command to the generated LaTeX files. This will instruct LaTeX to keep michael@0: # running if errors occur, instead of asking the user for help. michael@0: # This option is also used when generating formulas in HTML. michael@0: michael@0: LATEX_BATCHMODE = NO michael@0: michael@0: # If LATEX_HIDE_INDICES is set to YES then doxygen will not michael@0: # include the index chapters (such as File Index, Compound Index, etc.) michael@0: # in the output. michael@0: michael@0: LATEX_HIDE_INDICES = NO michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # configuration options related to the man page output michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # If the GENERATE_MAN tag is set to YES (the default) Doxygen will michael@0: # generate man pages michael@0: michael@0: GENERATE_MAN = NO michael@0: michael@0: # The MAN_EXTENSION tag determines the extension that is added to michael@0: # the generated man pages (default is the subroutine's section .3) michael@0: michael@0: MAN_EXTENSION = .3 michael@0: michael@0: # If the MAN_LINKS tag is set to YES and Doxygen generates man output, michael@0: # then it will generate one additional man file for each entity michael@0: # documented in the real man page(s). These additional files michael@0: # only source the real man page, but without them the man command michael@0: # would be unable to find the correct page. The default is NO. michael@0: michael@0: MAN_LINKS = YES michael@0: michael@0: #--------------------------------------------------------------------------- michael@0: # Configuration options related to the preprocessor michael@0: #--------------------------------------------------------------------------- michael@0: michael@0: # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will michael@0: # evaluate all C-preprocessor directives found in the sources and include michael@0: # files. michael@0: michael@0: ENABLE_PREPROCESSING = YES michael@0: michael@0: # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro michael@0: # names in the source code. If set to NO (the default) only conditional michael@0: # compilation will be performed. Macro expansion can be done in a controlled michael@0: # way by setting EXPAND_ONLY_PREDEF to YES. michael@0: michael@0: MACRO_EXPANSION = NO michael@0: michael@0: # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES michael@0: # then the macro expansion is limited to the macros specified with the michael@0: # PREDEFINED and EXPAND_AS_DEFINED tags. michael@0: michael@0: EXPAND_ONLY_PREDEF = NO michael@0: michael@0: # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files michael@0: # in the INCLUDE_PATH (see below) will be search if a #include is found. michael@0: michael@0: SEARCH_INCLUDES = YES michael@0: michael@0: # The INCLUDE_PATH tag can be used to specify one or more directories that michael@0: # contain include files that are not input files but should be processed by michael@0: # the preprocessor. michael@0: michael@0: INCLUDE_PATH = michael@0: michael@0: # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard michael@0: # patterns (like *.h and *.hpp) to filter out the header-files in the michael@0: # directories. If left blank, the patterns specified with FILE_PATTERNS will michael@0: # be used. michael@0: michael@0: INCLUDE_FILE_PATTERNS = michael@0: michael@0: # The PREDEFINED tag can be used to specify one or more macro names that michael@0: # are defined before the preprocessor is started (similar to the -D option of michael@0: # gcc). The argument of the tag is a list of macros of the form: name michael@0: # or name=definition (no spaces). If the definition and the = are michael@0: # omitted =1 is assumed. To prevent a macro definition from being michael@0: # undefined via #undef or recursively expanded use the := operator michael@0: # instead of the = operator. michael@0: michael@0: PREDEFINED = TAILQ_ENTRY RB_ENTRY _EVENT_DEFINED_TQENTRY _EVENT_IN_DOXYGEN michael@0: michael@0: # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then michael@0: # this tag can be used to specify a list of macro names that should be expanded. michael@0: # The macro definition that is found in the sources will be used. michael@0: # Use the PREDEFINED tag if you want to use a different macro definition. michael@0: michael@0: EXPAND_AS_DEFINED = michael@0: michael@0: # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then michael@0: # doxygen's preprocessor will remove all function-like macros that are alone michael@0: # on a line, have an all uppercase name, and do not end with a semicolon. Such michael@0: # function macros are typically used for boiler-plate code, and will confuse michael@0: # the parser if not removed. michael@0: michael@0: SKIP_FUNCTION_MACROS = YES