aboutsummaryrefslogtreecommitdiff
path: root/Doxyfile.in
diff options
context:
space:
mode:
authorJia Tan <jiat0218@gmail.com>2023-01-03 20:37:30 +0800
committerJia Tan <jiat0218@gmail.com>2023-01-20 00:51:12 +0800
commitbbf71b69ebf9d0d62a0af150a5c37d193b8159ad (patch)
tree56f437555d979d67ed3717c507174a305917427b /Doxyfile.in
parentliblzma: Highlight liblzma API headers should not be included directly. (diff)
downloadxz-bbf71b69ebf9d0d62a0af150a5c37d193b8159ad.tar.xz
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.
Diffstat (limited to '')
-rw-r--r--Doxyfile.in18
1 files changed, 9 insertions, 9 deletions
diff --git a/Doxyfile.in b/Doxyfile.in
index 1364ff2d..e3653c8e 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -20,7 +20,7 @@
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
-PROJECT_NAME = "@PACKAGE_NAME@"
+PROJECT_NAME = "@doxygen_project_name@"
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
@@ -96,7 +96,7 @@ ABBREVIATE_BRIEF =
# Doxygen will generate a detailed section even if there is only a brief
# description.
-ALWAYS_DETAILED_SEC = YES
+ALWAYS_DETAILED_SEC = NO
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
@@ -118,7 +118,7 @@ FULL_PATH_NAMES = YES
# If left blank the directory from which doxygen is run is used as the
# path to strip.
-STRIP_FROM_PATH = @top_srcdir@/src
+STRIP_FROM_PATH = @top_srcdir@/@doxygen_input_path@
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
# the path mentioned in the documentation of a class, which tells
@@ -220,18 +220,18 @@ EXTRACT_ALL = NO
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation.
-EXTRACT_PRIVATE = YES
+EXTRACT_PRIVATE = @doxygen_extract_private@
# If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation.
-EXTRACT_STATIC = YES
+EXTRACT_STATIC = @doxygen_extract_private@
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
# If set to NO only classes defined in header files are included.
-EXTRACT_LOCAL_CLASSES = YES
+EXTRACT_LOCAL_CLASSES = @doxygen_extract_private@
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
# undocumented members of documented classes, files or namespaces.
@@ -439,7 +439,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = @top_srcdir@/src
+INPUT = @top_srcdir@/@doxygen_input_path@
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -448,7 +448,7 @@ INPUT = @top_srcdir@/src
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
-FILE_PATTERNS = *.h *.c
+FILE_PATTERNS = *.c *.h
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
@@ -724,7 +724,7 @@ TREEVIEW_WIDTH = 250
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.
-GENERATE_LATEX = YES
+GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be