xref: /freebsd/contrib/xz/doxygen/Doxyfile (revision e9ac41698b2f322d55ccf9da50a3596edb2c1800)
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.10.0.
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
22SOURCE_TOOLTIPS        = NO
23VERBATIM_HEADERS       = NO
24ALPHABETICAL_INDEX     = NO
25HTML_OUTPUT            = api
26HTML_COLORSTYLE_HUE    = 210
27HTML_COLORSTYLE_SAT    = 180
28HTML_COLORSTYLE_GAMMA  = 110
29HTML_DYNAMIC_MENUS     = NO
30SEARCHENGINE           = NO
31GENERATE_LATEX         = NO
32MACRO_EXPANSION        = YES
33EXPAND_ONLY_PREDEF     = YES
34PREDEFINED             = LZMA_API(type)=type \
35                         LZMA_API_IMPORT= \
36                         LZMA_API_CALL= \
37                         tuklib_attr_noreturn= \
38                         lzma_attribute(attr)= \
39                         lzma_attr_alloc_size(size)=
40