xref: /src/contrib/xz/doxygen/Doxyfile (revision ae12432049e7873ab3912643ae5d08297b8cbc49)
1# SPDX-License-Identifier: 0BSD
2
3# Run "doxygen" in this directory to generate the liblzma API documentation
4# into ../doc/api.
5#
6# Use the "update-doxygen" script for more choices:
7#   - Include the liblzma version number in the generated documentation.
8#   - Instead of API docs, docs of XZ Utils internals may be built.
9#   - Change the output directory for out-of-tree builds.
10#
11# These options were tested with Doxygen 1.9.8 and 1.13.2.
12
13PROJECT_NAME           = "liblzma (XZ Utils)"
14OUTPUT_DIRECTORY       = ../doc
15STRIP_FROM_PATH        = ../src/liblzma/api
16INPUT                  = ../src/liblzma/api
17FILE_PATTERNS          = *.c *.h
18RECURSIVE              = YES
19OPTIMIZE_OUTPUT_FOR_C  = YES
20EXTRACT_STATIC         = YES
21SORT_MEMBER_DOCS       = NO
22WARN_IF_UNDOCUMENTED   = NO
23WARN_AS_ERROR          = FAIL_ON_WARNINGS
24SOURCE_TOOLTIPS        = NO
25VERBATIM_HEADERS       = NO
26ALPHABETICAL_INDEX     = NO
27HTML_OUTPUT            = api
28HTML_COLORSTYLE_HUE    = 210
29HTML_COLORSTYLE_SAT    = 180
30HTML_COLORSTYLE_GAMMA  = 110
31HTML_DYNAMIC_MENUS     = NO
32SEARCHENGINE           = NO
33GENERATE_LATEX         = NO
34MACRO_EXPANSION        = YES
35EXPAND_ONLY_PREDEF     = YES
36PREDEFINED             = LZMA_API(type)=type \
37                         LZMA_API_IMPORT= \
38                         LZMA_API_CALL= \
39                         tuklib_attr_noreturn= \
40                         lzma_attribute(attr)= \
41                         lzma_attr_alloc_size(size)=
42
43# Debian and Ubuntu patch Doxygen so that HAVE_DOT = YES is the default.
44# Set HAVE_DOT explicitly to get consistent behavior across distributions.
45HAVE_DOT               = NO
46