xref: /freebsd/contrib/xz/doxygen/Doxyfile (revision 3b35e7ee8de9b0260149a2b77e87a2b9c7a36244)
1*3b35e7eeSXin LI# SPDX-License-Identifier: 0BSD
2c917796cSXin LI
3*3b35e7eeSXin LI# Run "doxygen" in this directory to generate the liblzma API documentation
4*3b35e7eeSXin LI# into ../doc/api.
5c917796cSXin LI#
6*3b35e7eeSXin LI# Use the "update-doxygen" script for more choices:
7*3b35e7eeSXin LI#   - Include the liblzma version number in the generated documentation.
8*3b35e7eeSXin LI#   - Instead of API docs, docs of XZ Utils internals may be built.
9*3b35e7eeSXin LI#   - Change the output directory for out-of-tree builds.
10c917796cSXin LI#
11*3b35e7eeSXin LI# These options were tested with Doxygen 1.10.0.
12c917796cSXin LI
13c917796cSXin LIPROJECT_NAME           = "liblzma (XZ Utils)"
14c917796cSXin LIOUTPUT_DIRECTORY       = ../doc
15c917796cSXin LISTRIP_FROM_PATH        = ../src/liblzma/api
16c917796cSXin LIINPUT                  = ../src/liblzma/api
17*3b35e7eeSXin LIFILE_PATTERNS          = *.c *.h
18c917796cSXin LIRECURSIVE              = YES
19*3b35e7eeSXin LIOPTIMIZE_OUTPUT_FOR_C  = YES
20*3b35e7eeSXin LIEXTRACT_STATIC         = YES
21*3b35e7eeSXin LISORT_MEMBER_DOCS       = NO
22c917796cSXin LISOURCE_TOOLTIPS        = NO
23c917796cSXin LIVERBATIM_HEADERS       = NO
24c917796cSXin LIALPHABETICAL_INDEX     = NO
25c917796cSXin LIHTML_OUTPUT            = api
26c917796cSXin LIHTML_COLORSTYLE_HUE    = 210
27c917796cSXin LIHTML_COLORSTYLE_SAT    = 180
28c917796cSXin LIHTML_COLORSTYLE_GAMMA  = 110
29c917796cSXin LIHTML_DYNAMIC_MENUS     = NO
30c917796cSXin LISEARCHENGINE           = NO
31c917796cSXin LIGENERATE_LATEX         = NO
32c917796cSXin LIMACRO_EXPANSION        = YES
33c917796cSXin LIEXPAND_ONLY_PREDEF     = YES
34c917796cSXin LIPREDEFINED             = LZMA_API(type)=type \
35ca6a6373SXin LI                         LZMA_API_IMPORT= \
36ca6a6373SXin LI                         LZMA_API_CALL= \
37ca6a6373SXin LI                         tuklib_attr_noreturn= \
38ca6a6373SXin LI                         lzma_attribute(attr)= \
39ca6a6373SXin LI                         lzma_attr_alloc_size(size)=
40