Home | History | Annotate | Line # | Download | only in doxygen
      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 
     13 PROJECT_NAME           = "liblzma (XZ Utils)"
     14 OUTPUT_DIRECTORY       = ../doc
     15 STRIP_FROM_PATH        = ../src/liblzma/api
     16 INPUT                  = ../src/liblzma/api
     17 FILE_PATTERNS          = *.c *.h
     18 RECURSIVE              = YES
     19 OPTIMIZE_OUTPUT_FOR_C  = YES
     20 EXTRACT_STATIC         = YES
     21 SORT_MEMBER_DOCS       = NO
     22 WARN_IF_UNDOCUMENTED   = NO
     23 WARN_AS_ERROR          = FAIL_ON_WARNINGS
     24 SOURCE_TOOLTIPS        = NO
     25 VERBATIM_HEADERS       = NO
     26 ALPHABETICAL_INDEX     = NO
     27 HTML_OUTPUT            = api
     28 HTML_COLORSTYLE_HUE    = 210
     29 HTML_COLORSTYLE_SAT    = 180
     30 HTML_COLORSTYLE_GAMMA  = 110
     31 HTML_DYNAMIC_MENUS     = NO
     32 SEARCHENGINE           = NO
     33 GENERATE_LATEX         = NO
     34 MACRO_EXPANSION        = YES
     35 EXPAND_ONLY_PREDEF     = YES
     36 PREDEFINED             = 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.
     45 HAVE_DOT               = NO
     46