1# Doxyfile 1.4.4 2 3#--------------------------------------------------------------------------- 4# Project related configuration options 5#--------------------------------------------------------------------------- 6PROJECT_NAME = $(PACKAGE) 7PROJECT_NUMBER = $(VERSION) 8OUTPUT_DIRECTORY = $(top_builddir)/doc/ 9CREATE_SUBDIRS = NO 10OUTPUT_LANGUAGE = English 11USE_WINDOWS_ENCODING = NO 12BRIEF_MEMBER_DESC = YES 13REPEAT_BRIEF = YES 14ABBREVIATE_BRIEF = 15ALWAYS_DETAILED_SEC = NO 16INLINE_INHERITED_MEMB = NO 17FULL_PATH_NAMES = YES 18STRIP_FROM_PATH = 19STRIP_FROM_INC_PATH = 20SHORT_NAMES = NO 21JAVADOC_AUTOBRIEF = YES 22MULTILINE_CPP_IS_BRIEF = NO 23DETAILS_AT_TOP = NO 24INHERIT_DOCS = YES 25DISTRIBUTE_GROUP_DOC = NO 26SEPARATE_MEMBER_PAGES = NO 27TAB_SIZE = 8 28ALIASES = 29OPTIMIZE_OUTPUT_FOR_C = YES 30OPTIMIZE_OUTPUT_JAVA = NO 31SUBGROUPING = YES 32#--------------------------------------------------------------------------- 33# Build related configuration options 34#--------------------------------------------------------------------------- 35EXTRACT_ALL = NO 36EXTRACT_PRIVATE = NO 37EXTRACT_STATIC = NO 38EXTRACT_LOCAL_CLASSES = NO 39EXTRACT_LOCAL_METHODS = NO 40HIDE_UNDOC_MEMBERS = NO 41HIDE_UNDOC_CLASSES = NO 42HIDE_FRIEND_COMPOUNDS = NO 43HIDE_IN_BODY_DOCS = NO 44INTERNAL_DOCS = NO 45CASE_SENSE_NAMES = YES 46HIDE_SCOPE_NAMES = NO 47SHOW_INCLUDE_FILES = YES 48INLINE_INFO = YES 49SORT_MEMBER_DOCS = NO 50SORT_BRIEF_DOCS = NO 51SORT_BY_SCOPE_NAME = NO 52GENERATE_TODOLIST = YES 53GENERATE_TESTLIST = YES 54GENERATE_BUGLIST = YES 55GENERATE_DEPRECATEDLIST= YES 56ENABLED_SECTIONS = 57MAX_INITIALIZER_LINES = 30 58SHOW_USED_FILES = YES 59SHOW_DIRECTORIES = YES 60FILE_VERSION_FILTER = 61#--------------------------------------------------------------------------- 62# configuration options related to warning and progress messages 63#--------------------------------------------------------------------------- 64QUIET = NO 65WARNINGS = YES 66WARN_IF_UNDOCUMENTED = YES 67WARN_IF_DOC_ERROR = YES 68WARN_NO_PARAMDOC = NO 69WARN_FORMAT = "$file:$line: $text" 70WARN_LOGFILE = 71#--------------------------------------------------------------------------- 72# configuration options related to the input files 73#--------------------------------------------------------------------------- 74INPUT = $(top_srcdir)/include/ 75FILE_PATTERNS = *.h 76RECURSIVE = YES 77EXCLUDE = 78EXCLUDE_SYMLINKS = NO 79EXCLUDE_PATTERNS = 80EXAMPLE_PATH = 81EXAMPLE_PATTERNS = 82EXAMPLE_RECURSIVE = NO 83IMAGE_PATH = 84INPUT_FILTER = 85FILTER_PATTERNS = 86FILTER_SOURCE_FILES = NO 87#--------------------------------------------------------------------------- 88# configuration options related to source browsing 89#--------------------------------------------------------------------------- 90SOURCE_BROWSER = NO 91INLINE_SOURCES = NO 92STRIP_CODE_COMMENTS = YES 93REFERENCED_BY_RELATION = NO 94REFERENCES_RELATION = NO 95USE_HTAGS = NO 96VERBATIM_HEADERS = NO 97#--------------------------------------------------------------------------- 98# configuration options related to the alphabetical class index 99#--------------------------------------------------------------------------- 100ALPHABETICAL_INDEX = NO 101COLS_IN_ALPHA_INDEX = 5 102IGNORE_PREFIX = 103#--------------------------------------------------------------------------- 104# configuration options related to the HTML output 105#--------------------------------------------------------------------------- 106GENERATE_HTML = YES 107HTML_OUTPUT = html 108HTML_FILE_EXTENSION = .html 109HTML_HEADER = 110HTML_FOOTER = 111HTML_STYLESHEET = 112HTML_ALIGN_MEMBERS = YES 113GENERATE_HTMLHELP = NO 114CHM_FILE = 115HHC_LOCATION = 116GENERATE_CHI = NO 117BINARY_TOC = NO 118TOC_EXPAND = NO 119DISABLE_INDEX = NO 120ENUM_VALUES_PER_LINE = 1 121GENERATE_TREEVIEW = NO 122TREEVIEW_WIDTH = 250 123#--------------------------------------------------------------------------- 124# configuration options related to the LaTeX output 125#--------------------------------------------------------------------------- 126GENERATE_LATEX = NO 127LATEX_OUTPUT = latex 128LATEX_CMD_NAME = latex 129MAKEINDEX_CMD_NAME = makeindex 130COMPACT_LATEX = NO 131PAPER_TYPE = a4wide 132EXTRA_PACKAGES = 133LATEX_HEADER = 134PDF_HYPERLINKS = NO 135USE_PDFLATEX = NO 136LATEX_BATCHMODE = NO 137LATEX_HIDE_INDICES = NO 138#--------------------------------------------------------------------------- 139# configuration options related to the RTF output 140#--------------------------------------------------------------------------- 141GENERATE_RTF = NO 142RTF_OUTPUT = rtf 143COMPACT_RTF = NO 144RTF_HYPERLINKS = NO 145RTF_STYLESHEET_FILE = 146RTF_EXTENSIONS_FILE = 147#--------------------------------------------------------------------------- 148# configuration options related to the man page output 149#--------------------------------------------------------------------------- 150GENERATE_MAN = NO 151MAN_OUTPUT = man 152MAN_EXTENSION = .3 153MAN_LINKS = NO 154#--------------------------------------------------------------------------- 155# configuration options related to the XML output 156#--------------------------------------------------------------------------- 157GENERATE_XML = NO 158XML_OUTPUT = xml 159XML_SCHEMA = 160XML_DTD = 161XML_PROGRAMLISTING = YES 162#--------------------------------------------------------------------------- 163# configuration options for the AutoGen Definitions output 164#--------------------------------------------------------------------------- 165GENERATE_AUTOGEN_DEF = NO 166#--------------------------------------------------------------------------- 167# configuration options related to the Perl module output 168#--------------------------------------------------------------------------- 169GENERATE_PERLMOD = NO 170PERLMOD_LATEX = NO 171PERLMOD_PRETTY = YES 172PERLMOD_MAKEVAR_PREFIX = 173#--------------------------------------------------------------------------- 174# Configuration options related to the preprocessor 175#--------------------------------------------------------------------------- 176ENABLE_PREPROCESSING = YES 177MACRO_EXPANSION = YES 178EXPAND_ONLY_PREDEF = YES 179SEARCH_INCLUDES = YES 180INCLUDE_PATH = 181INCLUDE_FILE_PATTERNS = 182PREDEFINED = "YAML_DECLARE(type)=type" 183EXPAND_AS_DEFINED = 184SKIP_FUNCTION_MACROS = YES 185#--------------------------------------------------------------------------- 186# Configuration::additions related to external references 187#--------------------------------------------------------------------------- 188TAGFILES = 189GENERATE_TAGFILE = 190ALLEXTERNALS = NO 191EXTERNAL_GROUPS = YES 192PERL_PATH = /usr/bin/perl 193#--------------------------------------------------------------------------- 194# Configuration options related to the dot tool 195#--------------------------------------------------------------------------- 196CLASS_DIAGRAMS = NO 197HIDE_UNDOC_RELATIONS = YES 198HAVE_DOT = NO 199CLASS_GRAPH = YES 200COLLABORATION_GRAPH = YES 201GROUP_GRAPHS = YES 202UML_LOOK = NO 203TEMPLATE_RELATIONS = NO 204INCLUDE_GRAPH = YES 205INCLUDED_BY_GRAPH = YES 206CALL_GRAPH = NO 207GRAPHICAL_HIERARCHY = YES 208DIRECTORY_GRAPH = YES 209DOT_IMAGE_FORMAT = png 210DOT_PATH = 211DOTFILE_DIRS = 212MAX_DOT_GRAPH_WIDTH = 1024 213MAX_DOT_GRAPH_HEIGHT = 1024 214MAX_DOT_GRAPH_DEPTH = 0 215DOT_TRANSPARENT = NO 216DOT_MULTI_TARGETS = NO 217GENERATE_LEGEND = YES 218DOT_CLEANUP = YES 219#--------------------------------------------------------------------------- 220# Configuration::additions related to the search engine 221#--------------------------------------------------------------------------- 222SEARCHENGINE = NO 223