1 #---------------------------------------------------------------------------
3 INPUT = $(EXAMPLE_DIR)/include/docca/
5 #---------------------------------------------------------------------------
6 # Project related configuration options
7 #---------------------------------------------------------------------------
8 DOXYFILE_ENCODING = UTF-8
11 PROJECT_BRIEF = Documentation Library
15 ALLOW_UNICODE_NAMES = NO
16 OUTPUT_LANGUAGE = English
17 BRIEF_MEMBER_DESC = YES
20 ALWAYS_DETAILED_SEC = YES
21 INLINE_INHERITED_MEMB = YES
23 #STRIP_FROM_PATH = $(EXAMPLE_DIR)/include/docca
24 #STRIP_FROM_INC_PATH = $(EXAMPLE_DIR)/include/docca
27 JAVADOC_AUTOBRIEF = YES
29 MULTILINE_CPP_IS_BRIEF = YES
31 SEPARATE_MEMBER_PAGES = NO
35 OPTIMIZE_OUTPUT_FOR_C = NO
36 OPTIMIZE_OUTPUT_JAVA = NO
37 OPTIMIZE_FOR_FORTRAN = NO
38 OPTIMIZE_OUTPUT_VHDL = NO
40 MARKDOWN_SUPPORT = YES
41 AUTOLINK_SUPPORT = YES
42 BUILTIN_STL_SUPPORT = NO
45 IDL_PROPERTY_SUPPORT = YES
46 DISTRIBUTE_GROUP_DOC = YES
47 GROUP_NESTED_COMPOUNDS = NO
49 INLINE_GROUPED_CLASSES = NO
50 INLINE_SIMPLE_STRUCTS = NO
51 TYPEDEF_HIDES_STRUCT = NO
54 #---------------------------------------------------------------------------
55 # Build related configuration options
56 #---------------------------------------------------------------------------
61 EXTRACT_LOCAL_CLASSES = NO
62 EXTRACT_LOCAL_METHODS = NO
63 EXTRACT_ANON_NSPACES = NO
64 HIDE_UNDOC_MEMBERS = NO
65 HIDE_UNDOC_CLASSES = NO
66 HIDE_FRIEND_COMPOUNDS = NO
67 HIDE_IN_BODY_DOCS = NO
69 CASE_SENSE_NAMES = YES
71 HIDE_COMPOUND_REFERENCE= NO
72 SHOW_INCLUDE_FILES = NO
73 SHOW_GROUPED_MEMB_INC = NO
74 FORCE_LOCAL_INCLUDES = NO
78 SORT_MEMBERS_CTORS_1ST = YES
80 SORT_BY_SCOPE_NAME = NO
81 STRICT_PROTO_MATCHING = NO
82 GENERATE_TODOLIST = NO
83 GENERATE_TESTLIST = NO
85 GENERATE_DEPRECATEDLIST= NO
87 MAX_INITIALIZER_LINES = 30
95 #---------------------------------------------------------------------------
96 # Configuration options related to warning and progress messages
97 #---------------------------------------------------------------------------
100 WARN_IF_UNDOCUMENTED = YES
101 WARN_IF_DOC_ERROR = YES
102 WARN_NO_PARAMDOC = NO
104 WARN_FORMAT = "$file:$line: $text"
107 #---------------------------------------------------------------------------
108 # Configuration options related to the input files
109 #---------------------------------------------------------------------------
111 INPUT_ENCODING = UTF-8
115 EXCLUDE_SYMLINKS = NO
120 EXAMPLE_RECURSIVE = YES
124 FILTER_SOURCE_FILES = NO
125 FILTER_SOURCE_PATTERNS =
126 USE_MDFILE_AS_MAINPAGE =
128 #---------------------------------------------------------------------------
129 # Configuration options related to source browsing
130 #---------------------------------------------------------------------------
133 STRIP_CODE_COMMENTS = YES
134 REFERENCED_BY_RELATION = NO
135 REFERENCES_RELATION = NO
136 REFERENCES_LINK_SOURCE = YES
137 SOURCE_TOOLTIPS = YES
139 VERBATIM_HEADERS = YES
140 CLANG_ASSISTED_PARSING = NO
143 #---------------------------------------------------------------------------
144 # Configuration options related to the alphabetical class index
145 #---------------------------------------------------------------------------
146 ALPHABETICAL_INDEX = YES
147 COLS_IN_ALPHA_INDEX = 1
150 #---------------------------------------------------------------------------
151 # Configuration options related to the HTML output
152 #---------------------------------------------------------------------------
155 HTML_FILE_EXTENSION = .html
159 HTML_EXTRA_STYLESHEET =
161 HTML_COLORSTYLE_HUE = 220
162 HTML_COLORSTYLE_SAT = 100
163 HTML_COLORSTYLE_GAMMA = 80
165 HTML_DYNAMIC_SECTIONS = NO
166 HTML_INDEX_NUM_ENTRIES = 100
168 DOCSET_FEEDNAME = "Doxygen generated docs"
169 DOCSET_BUNDLE_ID = org.doxygen.Project
170 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
171 DOCSET_PUBLISHER_NAME = Publisher
172 GENERATE_HTMLHELP = NO
181 QHP_NAMESPACE = org.doxygen.Project
182 QHP_VIRTUAL_FOLDER = doc
183 QHP_CUST_FILTER_NAME =
184 QHP_CUST_FILTER_ATTRS =
185 QHP_SECT_FILTER_ATTRS =
187 GENERATE_ECLIPSEHELP = NO
188 ECLIPSE_DOC_ID = org.doxygen.Project
190 GENERATE_TREEVIEW = NO
191 ENUM_VALUES_PER_LINE = 4
193 EXT_LINKS_IN_WINDOW = NO
194 FORMULA_FONTSIZE = 10
195 FORMULA_TRANSPARENT = YES
197 MATHJAX_FORMAT = HTML-CSS
198 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
202 SERVER_BASED_SEARCH = NO
205 SEARCHDATA_FILE = searchdata.xml
207 EXTRA_SEARCH_MAPPINGS =
209 #---------------------------------------------------------------------------
210 # Configuration options related to the LaTeX output
211 #---------------------------------------------------------------------------
214 LATEX_CMD_NAME = latex
215 MAKEINDEX_CMD_NAME = makeindex
221 LATEX_EXTRA_STYLESHEET =
226 LATEX_HIDE_INDICES = NO
227 LATEX_SOURCE_CODE = NO
228 LATEX_BIB_STYLE = plain
231 #---------------------------------------------------------------------------
232 # Configuration options related to the RTF output
233 #---------------------------------------------------------------------------
238 RTF_STYLESHEET_FILE =
239 RTF_EXTENSIONS_FILE =
242 #---------------------------------------------------------------------------
243 # Configuration options related to the man page output
244 #---------------------------------------------------------------------------
251 #---------------------------------------------------------------------------
252 # Configuration options related to the XML output
253 #---------------------------------------------------------------------------
255 XML_OUTPUT = $(XML_OUTPUT)
256 XML_PROGRAMLISTING = YES
258 #---------------------------------------------------------------------------
259 # Configuration options related to the DOCBOOK output
260 #---------------------------------------------------------------------------
261 GENERATE_DOCBOOK = NO
262 DOCBOOK_OUTPUT = docbook
263 DOCBOOK_PROGRAMLISTING = NO
265 #---------------------------------------------------------------------------
266 # Configuration options for the AutoGen Definitions output
267 #---------------------------------------------------------------------------
268 GENERATE_AUTOGEN_DEF = NO
269 GENERATE_PERLMOD = NO
272 PERLMOD_MAKEVAR_PREFIX =
274 #---------------------------------------------------------------------------
275 # Configuration options related to the preprocessor
276 #---------------------------------------------------------------------------
277 ENABLE_PREPROCESSING = YES
278 MACRO_EXPANSION = YES
279 EXPAND_ONLY_PREDEF = YES
280 SEARCH_INCLUDES = YES
282 INCLUDE_FILE_PATTERNS =
283 PREDEFINED = DOXYGEN \
288 SKIP_FUNCTION_MACROS = YES
290 #---------------------------------------------------------------------------
291 # Configuration options related to external references
292 #---------------------------------------------------------------------------
296 EXTERNAL_GROUPS = YES
298 PERL_PATH = /usr/bin/perl
300 #---------------------------------------------------------------------------
301 # Configuration options related to the dot tool
302 #---------------------------------------------------------------------------
306 HIDE_UNDOC_RELATIONS = YES
309 DOT_FONTNAME = Helvetica
313 COLLABORATION_GRAPH = YES
316 UML_LIMIT_NUM_FIELDS = 10
317 TEMPLATE_RELATIONS = NO
319 INCLUDED_BY_GRAPH = YES
322 GRAPHICAL_HIERARCHY = YES
323 DIRECTORY_GRAPH = YES
324 DOT_IMAGE_FORMAT = png
331 PLANTUML_INCLUDE_PATH =
332 DOT_GRAPH_MAX_NODES = 50
333 MAX_DOT_GRAPH_DEPTH = 0
335 DOT_MULTI_TARGETS = NO
336 GENERATE_LEGEND = YES