root
/
xz
mirror of https://git.tukaani.org/xz.git
1
0
Fork 0
Code Issues Releases Wiki Activity
xz/doxygen/Doxyfile

40 lines
1.3 KiB
Plaintext
Raw Permalink Normal View History

Doxygen: Simplify Doxyfile and add SPDX license identifier This omits all comments and a few non-default options that weren't needed. Now it contains no copyrighted content from Doxygen itself.
2024-04-28 18:08:00 +00:00
# SPDX-License-Identifier: 0BSD
Added a copyright notice to Doxyfile.in since it contains lots of comments from Doxygen. It seems that the Doxygen authors' intent is to not apply their copyright on generated files, but since it doesn't matter for XZ Utils at all, better safe than sorry.
2009-08-01 21:27:29 +00:00
Doxygen: Simplify Doxyfile and add SPDX license identifier This omits all comments and a few non-default options that weren't needed. Now it contains no copyrighted content from Doxygen itself.
2024-04-28 18:08:00 +00:00
# Run "doxygen" in this directory to generate the liblzma API documentation
# into ../doc/api.
Doxygen: Update Doxyfile.in from 1.4.7 to 1.8.17. A few Doxygen tags were obsolete from 1.4.7. Version 1.8.17 released in 2019, so this should be compatible with resonable modern distros. The purpose of Doxygen these days is for docs on the website, so it doesn't necessarily have to work for everyone. Just when the maintainers want to update the docs.
2022-12-20 13:39:59 +00:00
#
Doxygen: Simplify Doxyfile and add SPDX license identifier This omits all comments and a few non-default options that weren't needed. Now it contains no copyrighted content from Doxygen itself.
2024-04-28 18:08:00 +00:00
# Use the "update-doxygen" script for more choices:
# - Include the liblzma version number in the generated documentation.
# - Instead of API docs, docs of XZ Utils internals may be built.
# - Change the output directory for out-of-tree builds.
Imported to git.
2007-12-08 22:42:33 +00:00
#
Doxygen: Simplify Doxyfile and add SPDX license identifier This omits all comments and a few non-default options that weren't needed. Now it contains no copyrighted content from Doxygen itself.
2024-04-28 18:08:00 +00:00
# These options were tested with Doxygen 1.10.0.
Doxygen: Update Doxyfile.in from 1.4.7 to 1.8.17. A few Doxygen tags were obsolete from 1.4.7. Version 1.8.17 released in 2019, so this should be compatible with resonable modern distros. The purpose of Doxygen these days is for docs on the website, so it doesn't necessarily have to work for everyone. Just when the maintainers want to update the docs.
2022-12-20 13:39:59 +00:00
Doxygen: Simplify Doxyfile and add SPDX license identifier This omits all comments and a few non-default options that weren't needed. Now it contains no copyrighted content from Doxygen itself.
2024-04-28 18:08:00 +00:00
PROJECT_NAME = "liblzma (XZ Utils)"
OUTPUT_DIRECTORY = ../doc
STRIP_FROM_PATH = ../src/liblzma/api
INPUT = ../src/liblzma/api
FILE_PATTERNS = *.c *.h
RECURSIVE = YES
OPTIMIZE_OUTPUT_FOR_C = YES
EXTRACT_STATIC = YES
SORT_MEMBER_DOCS = NO
SOURCE_TOOLTIPS = NO
VERBATIM_HEADERS = NO
ALPHABETICAL_INDEX = NO
HTML_OUTPUT = api
HTML_COLORSTYLE_HUE = 210
HTML_COLORSTYLE_SAT = 180
HTML_COLORSTYLE_GAMMA = 110
HTML_DYNAMIC_MENUS = NO
Doxygen: Update Doxyfile.in from 1.4.7 to 1.8.17. A few Doxygen tags were obsolete from 1.4.7. Version 1.8.17 released in 2019, so this should be compatible with resonable modern distros. The purpose of Doxygen these days is for docs on the website, so it doesn't necessarily have to work for everyone. Just when the maintainers want to update the docs.
2022-12-20 13:39:59 +00:00
SEARCHENGINE = NO
Doxygen: Make Doxygen only produce liblzma API documentation by default. Doxygen is now configurable in autotools only with --enable-doxygen=[api|all]. The default is "api", which will only generate HTML output for liblzma API functions. The LaTex documentation output was also disabled.
2023-01-03 12:37:30 +00:00
GENERATE_LATEX = NO
Put the interesting parts of XZ Utils into the public domain. Some minor documentation cleanups were made at the same time.
2009-04-13 08:27:40 +00:00
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
PREDEFINED = LZMA_API(type)=type \
Doxygen: Add more C macro names to PREDEFINED.
2023-09-08 16:08:57 +00:00
LZMA_API_IMPORT= \
LZMA_API_CALL= \
tuklib_attr_noreturn= \
lzma_attribute(attr)= \
lzma_attr_alloc_size(size)=