mirror of
https://github.com/aaru-dps/libaaruformat.git
synced 2025-12-16 19:24:40 +00:00
324 lines
11 KiB
Plaintext
324 lines
11 KiB
Plaintext
# Doxyfile for libaaruformat
|
|
# This file is part of the Aaru Data Preservation Suite.
|
|
# Copyright (c) 2019-2025 Natalia Portillo.
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Project related configuration options
|
|
#---------------------------------------------------------------------------
|
|
DOXYFILE_ENCODING = UTF-8
|
|
PROJECT_NAME = "libaaruformat"
|
|
PROJECT_NUMBER = @PROJECT_VERSION@
|
|
PROJECT_BRIEF = "Aaru Data Preservation Suite - Format Library"
|
|
PROJECT_LOGO =
|
|
OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT_DIR@
|
|
CREATE_SUBDIRS = NO
|
|
ALLOW_UNICODE_NAMES = NO
|
|
OUTPUT_LANGUAGE = English
|
|
BRIEF_MEMBER_DESC = YES
|
|
REPEAT_BRIEF = YES
|
|
ABBREVIATE_BRIEF =
|
|
ALWAYS_DETAILED_SEC = NO
|
|
INLINE_INHERITED_MEMB = NO
|
|
FULL_PATH_NAMES = YES
|
|
STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@
|
|
STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include
|
|
SHORT_NAMES = NO
|
|
JAVADOC_AUTOBRIEF = YES
|
|
JAVADOC_BANNER = NO
|
|
QT_AUTOBRIEF = NO
|
|
MULTILINE_CPP_IS_BRIEF = NO
|
|
PYTHON_DOCSTRING = YES
|
|
INHERIT_DOCS = YES
|
|
SEPARATE_MEMBER_PAGES = NO
|
|
TAB_SIZE = 4
|
|
OPTIMIZE_OUTPUT_FOR_C = YES
|
|
OPTIMIZE_OUTPUT_JAVA = NO
|
|
OPTIMIZE_FOR_FORTRAN = NO
|
|
OPTIMIZE_OUTPUT_VHDL = NO
|
|
OPTIMIZE_OUTPUT_SLICE = NO
|
|
MARKDOWN_SUPPORT = YES
|
|
TOC_INCLUDE_HEADINGS = 5
|
|
MARKDOWN_ID_STYLE = DOXYGEN
|
|
AUTOLINK_SUPPORT = YES
|
|
BUILTIN_STL_SUPPORT = NO
|
|
CPP_CLI_SUPPORT = NO
|
|
SIP_SUPPORT = NO
|
|
IDL_PROPERTY_SUPPORT = YES
|
|
DISTRIBUTE_GROUP_DOC = NO
|
|
GROUP_NESTED_COMPOUNDS = NO
|
|
SUBGROUPING = YES
|
|
INLINE_GROUPED_CLASSES = NO
|
|
INLINE_SIMPLE_STRUCTS = NO
|
|
TYPEDEF_HIDES_STRUCT = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Build related configuration options
|
|
#---------------------------------------------------------------------------
|
|
EXTRACT_ALL = YES
|
|
EXTRACT_PRIVATE = NO
|
|
EXTRACT_PRIV_VIRTUAL = NO
|
|
EXTRACT_PACKAGE = NO
|
|
EXTRACT_STATIC = YES
|
|
EXTRACT_LOCAL_CLASSES = YES
|
|
EXTRACT_LOCAL_METHODS = NO
|
|
EXTRACT_ANON_NSPACES = NO
|
|
RESOLVE_UNNAMED_PARAMS = YES
|
|
HIDE_UNDOC_MEMBERS = NO
|
|
HIDE_UNDOC_CLASSES = NO
|
|
HIDE_FRIEND_COMPOUNDS = NO
|
|
HIDE_IN_BODY_DOCS = NO
|
|
INTERNAL_DOCS = NO
|
|
CASE_SENSE_NAMES = YES
|
|
HIDE_SCOPE_NAMES = NO
|
|
HIDE_COMPOUND_REFERENCE= NO
|
|
SHOW_HEADERFILE = YES
|
|
SHOW_INCLUDE_FILES = YES
|
|
SHOW_GROUPED_MEMB_INC = NO
|
|
FORCE_LOCAL_INCLUDES = NO
|
|
INLINE_INFO = YES
|
|
SORT_MEMBER_DOCS = YES
|
|
SORT_BRIEF_DOCS = NO
|
|
SORT_MEMBERS_CTORS_1ST = NO
|
|
SORT_GROUP_NAMES = NO
|
|
SORT_BY_SCOPE_NAME = NO
|
|
STRICT_PROTO_MATCHING = NO
|
|
GENERATE_TODOLIST = YES
|
|
GENERATE_TESTLIST = YES
|
|
GENERATE_BUGLIST = YES
|
|
GENERATE_DEPRECATEDLIST= YES
|
|
ENABLED_SECTIONS =
|
|
MAX_INITIALIZER_LINES = 30
|
|
SHOW_USED_FILES = YES
|
|
SHOW_FILES = YES
|
|
SHOW_NAMESPACES = YES
|
|
FILE_VERSION_FILTER =
|
|
LAYOUT_FILE =
|
|
CITE_BIB_FILES =
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to warning and progress messages
|
|
#---------------------------------------------------------------------------
|
|
QUIET = NO
|
|
WARNINGS = YES
|
|
WARN_IF_UNDOCUMENTED = YES
|
|
WARN_IF_DOC_ERROR = YES
|
|
WARN_IF_INCOMPLETE_DOC = YES
|
|
WARN_NO_PARAMDOC = NO
|
|
WARN_IF_UNDOC_ENUM_VAL = NO
|
|
WARN_AS_ERROR = NO
|
|
WARN_FORMAT = "$file:$line: $text"
|
|
WARN_LINE_FORMAT = "at line $line of file $file"
|
|
WARN_LOGFILE =
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the input files
|
|
#---------------------------------------------------------------------------
|
|
INPUT = @CMAKE_SOURCE_DIR@/include \
|
|
@CMAKE_SOURCE_DIR@/src \
|
|
@CMAKE_SOURCE_DIR@/README.md
|
|
INPUT_ENCODING = UTF-8
|
|
INPUT_FILE_ENCODING =
|
|
FILE_PATTERNS = *.c \
|
|
*.cc \
|
|
*.cxx \
|
|
*.cpp \
|
|
*.c++ \
|
|
*.h \
|
|
*.hh \
|
|
*.hxx \
|
|
*.hpp \
|
|
*.h++ \
|
|
*.md
|
|
RECURSIVE = YES
|
|
EXCLUDE =
|
|
EXCLUDE_SYMLINKS = NO
|
|
EXCLUDE_PATTERNS = */3rdparty/* \
|
|
*/build/* \
|
|
*/cmake-build-*/* \
|
|
*/tests/*
|
|
EXCLUDE_SYMBOLS =
|
|
EXAMPLE_PATH =
|
|
EXAMPLE_PATTERNS = *
|
|
EXAMPLE_RECURSIVE = NO
|
|
IMAGE_PATH =
|
|
INPUT_FILTER =
|
|
FILTER_PATTERNS =
|
|
FILTER_SOURCE_FILES = NO
|
|
FILTER_SOURCE_PATTERNS =
|
|
USE_MDFILE_AS_MAINPAGE = README.md
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to source browsing
|
|
#---------------------------------------------------------------------------
|
|
SOURCE_BROWSER = YES
|
|
INLINE_SOURCES = NO
|
|
STRIP_CODE_COMMENTS = YES
|
|
REFERENCED_BY_RELATION = YES
|
|
REFERENCES_RELATION = YES
|
|
REFERENCES_LINK_SOURCE = YES
|
|
SOURCE_TOOLTIPS = YES
|
|
USE_HTAGS = NO
|
|
VERBATIM_HEADERS = YES
|
|
CLANG_ASSISTED_PARSING = NO
|
|
CLANG_ADD_INC_PATHS = YES
|
|
CLANG_OPTIONS =
|
|
CLANG_DATABASE_PATH =
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the alphabetical class index
|
|
#---------------------------------------------------------------------------
|
|
ALPHABETICAL_INDEX = YES
|
|
IGNORE_PREFIX =
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the HTML output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_HTML = YES
|
|
HTML_OUTPUT = html
|
|
HTML_FILE_EXTENSION = .html
|
|
HTML_HEADER =
|
|
HTML_FOOTER =
|
|
HTML_STYLESHEET =
|
|
HTML_EXTRA_STYLESHEET =
|
|
HTML_EXTRA_FILES =
|
|
HTML_COLORSTYLE = AUTO_LIGHT
|
|
HTML_COLORSTYLE_HUE = 220
|
|
HTML_COLORSTYLE_SAT = 100
|
|
HTML_COLORSTYLE_GAMMA = 80
|
|
HTML_DYNAMIC_MENUS = YES
|
|
HTML_DYNAMIC_SECTIONS = NO
|
|
HTML_CODE_FOLDING = YES
|
|
HTML_COPY_CLIPBOARD = YES
|
|
HTML_PROJECT_COOKIE =
|
|
HTML_INDEX_NUM_ENTRIES = 100
|
|
GENERATE_DOCSET = NO
|
|
GENERATE_HTMLHELP = NO
|
|
GENERATE_CHI = NO
|
|
GENERATE_QHP = NO
|
|
GENERATE_ECLIPSEHELP = NO
|
|
DISABLE_INDEX = NO
|
|
GENERATE_TREEVIEW = YES
|
|
FULL_SIDEBAR = NO
|
|
ENUM_VALUES_PER_LINE = 4
|
|
TREEVIEW_WIDTH = 250
|
|
EXT_LINKS_IN_WINDOW = NO
|
|
OBFUSCATE_EMAILS = YES
|
|
HTML_FORMULA_FORMAT = png
|
|
FORMULA_FONTSIZE = 10
|
|
FORMULA_MACROFILE =
|
|
USE_MATHJAX = NO
|
|
SEARCHENGINE = YES
|
|
SERVER_BASED_SEARCH = NO
|
|
EXTERNAL_SEARCH = NO
|
|
SEARCHENGINE_URL =
|
|
SEARCHDATA_FILE = searchdata.xml
|
|
EXTERNAL_SEARCH_ID =
|
|
EXTRA_SEARCH_MAPPINGS =
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the LaTeX output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_LATEX = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the RTF output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_RTF = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the man page output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_MAN = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the XML output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_XML = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the DOCBOOK output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_DOCBOOK = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options for the AutoGen Definitions output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_AUTOGEN_DEF = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to Sqlite3 output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_SQLITE3 = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the Perl module output
|
|
#---------------------------------------------------------------------------
|
|
GENERATE_PERLMOD = NO
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to the preprocessor
|
|
#---------------------------------------------------------------------------
|
|
ENABLE_PREPROCESSING = YES
|
|
MACRO_EXPANSION = YES
|
|
EXPAND_ONLY_PREDEF = NO
|
|
SEARCH_INCLUDES = YES
|
|
INCLUDE_PATH = @CMAKE_SOURCE_DIR@/include
|
|
INCLUDE_FILE_PATTERNS =
|
|
PREDEFINED = AARU_EXPORT= \
|
|
AARU_CALL= \
|
|
DOXYGEN_SHOULD_SKIP_THIS
|
|
EXPAND_AS_DEFINED =
|
|
SKIP_FUNCTION_MACROS = YES
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to external references
|
|
#---------------------------------------------------------------------------
|
|
TAGFILES =
|
|
GENERATE_TAGFILE =
|
|
ALLEXTERNALS = NO
|
|
EXTERNAL_GROUPS = YES
|
|
EXTERNAL_PAGES = YES
|
|
|
|
#---------------------------------------------------------------------------
|
|
# Configuration options related to diagram generator tools
|
|
#---------------------------------------------------------------------------
|
|
HIDE_UNDOC_RELATIONS = YES
|
|
HAVE_DOT = NO
|
|
DOT_NUM_THREADS = 0
|
|
DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
|
|
DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
|
|
DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
|
|
DOT_FONTPATH =
|
|
CLASS_GRAPH = YES
|
|
COLLABORATION_GRAPH = YES
|
|
GROUP_GRAPHS = YES
|
|
UML_LOOK = NO
|
|
UML_LIMIT_NUM_FIELDS = 10
|
|
DOT_UML_DETAILS = NO
|
|
DOT_WRAP_THRESHOLD = 17
|
|
TEMPLATE_RELATIONS = NO
|
|
INCLUDE_GRAPH = YES
|
|
INCLUDED_BY_GRAPH = YES
|
|
CALL_GRAPH = NO
|
|
CALLER_GRAPH = NO
|
|
GRAPHICAL_HIERARCHY = YES
|
|
DIRECTORY_GRAPH = YES
|
|
DIR_GRAPH_MAX_DEPTH = 1
|
|
DOT_IMAGE_FORMAT = png
|
|
INTERACTIVE_SVG = NO
|
|
DOT_PATH =
|
|
DOTFILE_DIRS =
|
|
DIA_PATH =
|
|
DIAFILE_DIRS =
|
|
PLANTUML_JAR_PATH =
|
|
PLANTUML_CFG_FILE =
|
|
PLANTUML_INCLUDE_PATH =
|
|
DOT_GRAPH_MAX_NODES = 50
|
|
MAX_DOT_GRAPH_DEPTH = 0
|
|
DOT_MULTI_TARGETS = NO
|
|
GENERATE_LEGEND = YES
|
|
DOT_CLEANUP = YES
|
|
MSCGEN_TOOL =
|
|
MSCFILE_DIRS =
|
|
|