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