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