fluidsynth/doc/Doxyfile

247 lines
7.8 KiB
Text
Raw Normal View History

2017-07-03 17:19:03 +00:00
# Doxyfile 1.6
2003-03-11 16:56:45 +00:00
#---------------------------------------------------------------------------
2009-04-20 21:10:55 +00:00
# Project related configuration options
2003-03-11 16:56:45 +00:00
#---------------------------------------------------------------------------
2017-07-03 17:19:03 +00:00
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = libfluidsynth
2019-04-13 12:02:01 +00:00
PROJECT_NUMBER = 2.0.5
2017-07-03 17:19:03 +00:00
OUTPUT_DIRECTORY = api
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF = "The $name class" "The $name widget" "The $name file" is provides specifies contains represents a an the
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = NO
STRIP_FROM_PATH = ../
STRIP_FROM_INC_PATH = ../include/
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = YES
QT_AUTOBRIEF = NO
2009-04-20 21:10:55 +00:00
MULTILINE_CPP_IS_BRIEF = NO
2017-07-03 17:19:03 +00:00
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 8
ALIASES =
OPTIMIZE_OUTPUT_FOR_C = YES
OPTIMIZE_OUTPUT_JAVA = NO
OPTIMIZE_FOR_FORTRAN = NO
OPTIMIZE_OUTPUT_VHDL = NO
BUILTIN_STL_SUPPORT = NO
CPP_CLI_SUPPORT = NO
SIP_SUPPORT = NO
IDL_PROPERTY_SUPPORT = YES
DISTRIBUTE_GROUP_DOC = NO
SUBGROUPING = NO
TYPEDEF_HIDES_STRUCT = NO
2009-04-20 21:10:55 +00:00
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
2017-07-03 17:19:03 +00:00
EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = NO
EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = NO
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = YES
HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = NO
INLINE_INFO = YES
SORT_MEMBER_DOCS = NO
SORT_BRIEF_DOCS = NO
SORT_GROUP_NAMES = NO
SORT_BY_SCOPE_NAME = NO
GENERATE_TODOLIST = NO
GENERATE_TESTLIST = NO
GENERATE_BUGLIST = NO
GENERATE_DEPRECATEDLIST = YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
SHOW_DIRECTORIES = NO
SHOW_FILES = YES
SHOW_NAMESPACES = YES
FILE_VERSION_FILTER =
2003-03-11 16:56:45 +00:00
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
2017-07-03 17:19:03 +00:00
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = YES
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE =
2003-03-11 16:56:45 +00:00
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = ../doc/fluidsynth-v20-devdoc.txt ../include ../include/fluidsynth ../src
2017-07-03 17:19:03 +00:00
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.c *.h
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS = fluid_*.h
2017-07-03 17:19:03 +00:00
EXCLUDE_SYMBOLS =
EXAMPLE_PATH = ../doc
EXAMPLE_PATTERNS = *.c
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
2003-03-11 16:56:45 +00:00
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
2017-07-03 17:19:03 +00:00
SOURCE_BROWSER = NO
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
2009-04-20 21:10:55 +00:00
REFERENCES_LINK_SOURCE = YES
2017-07-03 17:19:03 +00:00
USE_HTAGS = NO
VERBATIM_HEADERS = NO
2003-03-11 16:56:45 +00:00
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
2017-07-03 17:19:03 +00:00
ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX =
2003-03-11 16:56:45 +00:00
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
2017-07-03 17:19:03 +00:00
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
2018-05-18 10:50:10 +00:00
HTML_EXTRA_STYLESHEET = ../doc/doxy_formula.css
2017-07-03 17:19:03 +00:00
HTML_ALIGN_MEMBERS = YES
HTML_EXTRA_FILES = ../doc/fluidsettings.xml ../doc/fluidsettings.xsl
2017-07-03 17:19:03 +00:00
GENERATE_HTMLHELP = NO
GENERATE_DOCSET = NO
DOCSET_FEEDNAME = "Doxygen generated docs"
DOCSET_BUNDLE_ID = org.doxygen.Project
HTML_DYNAMIC_SECTIONS = YES
CHM_FILE =
HHC_LOCATION =
GENERATE_CHI = NO
CHM_INDEX_ENCODING =
BINARY_TOC = NO
TOC_EXPAND = NO
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 4
GENERATE_TREEVIEW = NO
TREEVIEW_WIDTH = 250
FORMULA_FONTSIZE = 10
2003-03-11 16:56:45 +00:00
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
2017-07-03 17:19:03 +00:00
GENERATE_LATEX = NO
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
EXTRA_PACKAGES =
LATEX_HEADER =
PDF_HYPERLINKS = YES
USE_PDFLATEX = YES
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
2003-03-11 16:56:45 +00:00
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
2017-07-03 17:19:03 +00:00
GENERATE_RTF = NO
RTF_OUTPUT = rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
2003-03-11 16:56:45 +00:00
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
2017-07-03 17:19:03 +00:00
GENERATE_MAN = NO
MAN_OUTPUT = man
MAN_EXTENSION = .3
MAN_LINKS = NO
2003-03-11 16:56:45 +00:00
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
2017-07-03 17:19:03 +00:00
GENERATE_XML = NO
XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =
XML_PROGRAMLISTING = YES
2003-03-11 16:56:45 +00:00
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
2017-07-03 17:19:03 +00:00
GENERATE_AUTOGEN_DEF = NO
2003-03-11 16:56:45 +00:00
#---------------------------------------------------------------------------
2009-04-20 21:10:55 +00:00
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
2017-07-03 17:19:03 +00:00
GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
2009-04-20 21:10:55 +00:00
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
2003-03-11 16:56:45 +00:00
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
2017-07-03 17:19:03 +00:00
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED = __DOXYGEN__
2017-07-03 17:19:03 +00:00
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
2003-03-11 16:56:45 +00:00
#---------------------------------------------------------------------------
2009-04-20 21:10:55 +00:00
# Configuration::additions related to external references
2003-03-11 16:56:45 +00:00
#---------------------------------------------------------------------------
2017-07-03 17:19:03 +00:00
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
PERL_PATH = /usr/bin/perl
2003-03-11 16:56:45 +00:00
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
2017-07-03 17:19:03 +00:00
CLASS_DIAGRAMS = YES
MSCGEN_PATH =
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = NO
DOT_FONTNAME = FreeSans
DOT_FONTPATH =
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES
UML_LOOK = NO
TEMPLATE_RELATIONS = YES
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = NO
CALLER_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png
DOT_PATH =
DOTFILE_DIRS =
DOT_GRAPH_MAX_NODES = 50
MAX_DOT_GRAPH_DEPTH = 1000
DOT_TRANSPARENT = YES
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
2003-03-11 16:56:45 +00:00
#---------------------------------------------------------------------------
2009-04-20 21:10:55 +00:00
# Configuration::additions related to the search engine
2003-03-11 16:56:45 +00:00
#---------------------------------------------------------------------------
2017-07-03 17:31:02 +00:00
SEARCHENGINE = YES