3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
9 # NOTE: By default, Doxygen writes into the dox/ subdirectory of the
10 # invocation directory. If you want to put it somewhere else, for
11 # example, to write straight into a webserver directory, then override
12 # this variable in a configuration concatenated to this one: Doxygen
13 # doesn't mind variables being redefined.
15 OUTPUT_DIRECTORY = dox
16 OUTPUT_LANGUAGE = English
17 DOXYFILE_ENCODING = UTF-8
18 BRIEF_MEMBER_DESC = YES
20 ALWAYS_DETAILED_SEC = NO
22 STRIP_FROM_PATH = $(PWD)/
24 JAVADOC_AUTOBRIEF = YES
28 OPTIMIZE_OUTPUT_FOR_C = YES
29 DISTRIBUTE_GROUP_DOC = NO
30 #---------------------------------------------------------------------------
31 # Build related configuration options
32 #---------------------------------------------------------------------------
36 EXTRACT_LOCAL_CLASSES = YES
37 HIDE_UNDOC_MEMBERS = NO
38 HIDE_UNDOC_CLASSES = NO
40 CASE_SENSE_NAMES = YES
41 HIDE_SCOPE_NAMES = YES
42 SHOW_INCLUDE_FILES = YES
46 GENERATE_TODOLIST = YES
47 GENERATE_TESTLIST = YES
48 GENERATE_BUGLIST = YES
49 GENERATE_DEPRECATEDLIST= YES
51 MAX_INITIALIZER_LINES = 30
53 SHOW_DIRECTORIES = YES
54 #---------------------------------------------------------------------------
55 # configuration options related to warning and progress messages
56 #---------------------------------------------------------------------------
59 WARN_IF_UNDOCUMENTED = NO
60 WARN_IF_DOC_ERROR = NO
62 WARN_FORMAT = "$file:$line: $text"
64 #---------------------------------------------------------------------------
65 # configuration options related to the input files
66 #---------------------------------------------------------------------------
68 INPUT_ENCODING = UTF-8
73 EXCLUDE = include/includes.h \
79 EXAMPLE_RECURSIVE = NO
82 FILTER_SOURCE_FILES = NO
83 #---------------------------------------------------------------------------
84 # configuration options related to source browsing
85 #---------------------------------------------------------------------------
88 STRIP_CODE_COMMENTS = NO
89 REFERENCED_BY_RELATION = YES
90 REFERENCES_RELATION = YES
91 REFERENCES_LINK_SOURCE = YES
92 VERBATIM_HEADERS = YES
93 #---------------------------------------------------------------------------
94 # configuration options related to the alphabetical class index
95 #---------------------------------------------------------------------------
96 ALPHABETICAL_INDEX = YES
97 COLS_IN_ALPHA_INDEX = 1
99 #---------------------------------------------------------------------------
100 # configuration options related to the HTML output
101 #---------------------------------------------------------------------------
104 HTML_FILE_EXTENSION = .html
108 HTML_ALIGN_MEMBERS = YES
109 GENERATE_HTMLHELP = NO
112 ENUM_VALUES_PER_LINE = 3
113 GENERATE_TREEVIEW = NO
115 #---------------------------------------------------------------------------
116 # configuration options related to the LaTeX output
117 #---------------------------------------------------------------------------
126 LATEX_BATCHMODE = YES
127 #---------------------------------------------------------------------------
128 # configuration options related to the RTF output
129 #---------------------------------------------------------------------------
134 RTF_STYLESHEET_FILE =
135 RTF_EXTENSIONS_FILE =
136 #---------------------------------------------------------------------------
137 # configuration options related to the man page output
138 #---------------------------------------------------------------------------
143 #---------------------------------------------------------------------------
144 # configuration options related to the XML output
145 #---------------------------------------------------------------------------
147 #---------------------------------------------------------------------------
148 # configuration options related to the preprocessor
149 #---------------------------------------------------------------------------
150 ENABLE_PREPROCESSING = NO
152 EXPAND_ONLY_PREDEF = NO
153 SEARCH_INCLUDES = YES
155 INCLUDE_FILE_PATTERNS =
158 SKIP_FUNCTION_MACROS = YES
159 #---------------------------------------------------------------------------
160 # configuration::additions related to external references
161 #---------------------------------------------------------------------------
165 PERL_PATH = /usr/bin/perl
166 #---------------------------------------------------------------------------
167 # configuration options related to the dot tool
168 #---------------------------------------------------------------------------
171 HIDE_UNDOC_RELATIONS = NO
173 COLLABORATION_GRAPH = YES
175 TEMPLATE_RELATIONS = YES
177 INCLUDED_BY_GRAPH = YES
180 GRAPHICAL_HIERARCHY = YES
181 DIRECTORY_GRAPH = YES
182 DOT_IMAGE_FORMAT = png
185 DOT_GRAPH_MAX_NODES = 50
186 MAX_DOT_GRAPH_DEPTH = 0
187 GENERATE_LEGEND = YES
189 #---------------------------------------------------------------------------
190 # configuration::additions related to the search engine
191 #---------------------------------------------------------------------------