libevent/Doxyfile

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