3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
6 # All text after a hash (#) is considered a comment and will be ignored
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 (" ")
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18 # by quotes) that should identify the project.
20 PROJECT_NAME = libevent
22 # Place all output under 'doxygen/'
24 OUTPUT_DIRECTORY = doxygen/
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.
32 JAVADOC_AUTOBRIEF = YES
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.
39 OPTIMIZE_OUTPUT_FOR_C = YES
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
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
55 STRIP_FROM_PATH = include/
57 #---------------------------------------------------------------------------
58 # configuration options related to the input files
59 #---------------------------------------------------------------------------
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
67 include/event2/buffer.h \
68 include/event2/buffer_compat.h \
69 include/event2/bufferevent.h \
70 include/event2/bufferevent_compat.h \
71 include/event2/bufferevent_ssl.h \
72 include/event2/dns.h \
73 include/event2/dns_compat.h \
74 include/event2/event.h \
75 include/event2/event_compat.h \
76 include/event2/http.h \
77 include/event2/http_compat.h \
78 include/event2/listener.h \
79 include/event2/rpc.h \
80 include/event2/rpc_compat.h \
81 include/event2/tag.h \
82 include/event2/tag_compat.h \
83 include/event2/thread.h \
86 #---------------------------------------------------------------------------
87 # configuration options related to the HTML output
88 #---------------------------------------------------------------------------
90 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
91 # generate HTML output.
95 #---------------------------------------------------------------------------
96 # configuration options related to the LaTeX output
97 #---------------------------------------------------------------------------
99 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
100 # generate Latex output.
104 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
105 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
106 # put in front of it. If left blank `latex' will be used as the default path.
110 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
111 # invoked. If left blank `latex' will be used as the default command name.
113 LATEX_CMD_NAME = latex
115 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
116 # generate index for LaTeX. If left blank `makeindex' will be used as the
117 # default command name.
119 MAKEINDEX_CMD_NAME = makeindex
121 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
122 # LaTeX documents. This may be useful for small projects and may help to
123 # save some trees in general.
127 # The PAPER_TYPE tag can be used to set the paper type that is used
128 # by the printer. Possible values are: a4, a4wide, letter, legal and
129 # executive. If left blank a4wide will be used.
133 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
134 # packages that should be included in the LaTeX output.
138 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
139 # the generated latex document. The header should contain everything until
140 # the first chapter. If it is left blank doxygen will generate a
141 # standard header. Notice: only use this tag if you know what you are doing!
145 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
146 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
147 # contain links (just like the HTML output) instead of page references
148 # This makes the output suitable for online browsing using a pdf viewer.
152 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
153 # plain latex in the generated Makefile. Set this option to YES to get a
154 # higher quality PDF documentation.
158 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
159 # command to the generated LaTeX files. This will instruct LaTeX to keep
160 # running if errors occur, instead of asking the user for help.
161 # This option is also used when generating formulas in HTML.
165 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
166 # include the index chapters (such as File Index, Compound Index, etc.)
169 LATEX_HIDE_INDICES = NO
171 #---------------------------------------------------------------------------
172 # configuration options related to the man page output
173 #---------------------------------------------------------------------------
175 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
180 # The MAN_EXTENSION tag determines the extension that is added to
181 # the generated man pages (default is the subroutine's section .3)
185 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
186 # then it will generate one additional man file for each entity
187 # documented in the real man page(s). These additional files
188 # only source the real man page, but without them the man command
189 # would be unable to find the correct page. The default is NO.
193 #---------------------------------------------------------------------------
194 # Configuration options related to the preprocessor
195 #---------------------------------------------------------------------------
197 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
198 # evaluate all C-preprocessor directives found in the sources and include
201 ENABLE_PREPROCESSING = YES
203 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
204 # names in the source code. If set to NO (the default) only conditional
205 # compilation will be performed. Macro expansion can be done in a controlled
206 # way by setting EXPAND_ONLY_PREDEF to YES.
210 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
211 # then the macro expansion is limited to the macros specified with the
212 # PREDEFINED and EXPAND_AS_DEFINED tags.
214 EXPAND_ONLY_PREDEF = NO
216 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
217 # in the INCLUDE_PATH (see below) will be search if a #include is found.
219 SEARCH_INCLUDES = YES
221 # The INCLUDE_PATH tag can be used to specify one or more directories that
222 # contain include files that are not input files but should be processed by
227 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
228 # patterns (like *.h and *.hpp) to filter out the header-files in the
229 # directories. If left blank, the patterns specified with FILE_PATTERNS will
232 INCLUDE_FILE_PATTERNS =
234 # The PREDEFINED tag can be used to specify one or more macro names that
235 # are defined before the preprocessor is started (similar to the -D option of
236 # gcc). The argument of the tag is a list of macros of the form: name
237 # or name=definition (no spaces). If the definition and the = are
238 # omitted =1 is assumed. To prevent a macro definition from being
239 # undefined via #undef or recursively expanded use the := operator
240 # instead of the = operator.
242 PREDEFINED = TAILQ_ENTRY RB_ENTRY _EVENT_DEFINED_TQENTRY _EVENT_IN_DOXYGEN
244 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
245 # this tag can be used to specify a list of macro names that should be expanded.
246 # The macro definition that is found in the sources will be used.
247 # Use the PREDEFINED tag if you want to use a different macro definition.
251 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
252 # doxygen's preprocessor will remove all function-like macros that are alone
253 # on a line, have an all uppercase name, and do not end with a semicolon. Such
254 # function macros are typically used for boiler-plate code, and will confuse
255 # the parser if not removed.
257 SKIP_FUNCTION_MACROS = YES