blob: 245ff0770f95ada9fa6a80ef11b31fbbd1d7f22f [file] [log] [blame]
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001# Doxyfile 1.7.5.1
Alexandre Lision51140e12013-12-02 10:54:09 -05002
3# This file describes the settings to be used by the documentation system
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05004# doxygen (www.doxygen.org) for a project.
Alexandre Lision51140e12013-12-02 10:54:09 -05005#
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05006# All text after a hash (#) is considered a comment and will be ignored.
Alexandre Lision51140e12013-12-02 10:54:09 -05007# The format is:
8# TAG = value [value, ...]
9# For lists items can also be appended using:
10# TAG += value [value, ...]
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -050011# Values that contain spaces should be placed between quotes (" ").
Alexandre Lision51140e12013-12-02 10:54:09 -050012
13#---------------------------------------------------------------------------
14# Project related configuration options
15#---------------------------------------------------------------------------
16
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -050017# This tag specifies the encoding used for all characters in the config file
18# that follow. The default is UTF-8 which is also the encoding used for all
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20# iconv built into libc) for the transcoding. See
21# http://www.gnu.org/software/libiconv for the list of possible encodings.
Alexandre Lision51140e12013-12-02 10:54:09 -050022
23DOXYFILE_ENCODING = UTF-8
24
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -050025# The PROJECT_NAME tag is a single word (or sequence of words) that should
26# identify the project. Note that if you do not use Doxywizard you need
27# to put quotes around the project name if it contains spaces.
Alexandre Lision51140e12013-12-02 10:54:09 -050028
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -050029PROJECT_NAME = "ZRTP and SRTP implementation"
Alexandre Lision51140e12013-12-02 10:54:09 -050030
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -050031# The PROJECT_NUMBER tag can be used to enter a project or revision number.
32# This could be handy for archiving the generated documentation or
Alexandre Lision51140e12013-12-02 10:54:09 -050033# if some version control system is used.
34
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -050035PROJECT_NUMBER =
Alexandre Lision51140e12013-12-02 10:54:09 -050036
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -050037# Using the PROJECT_BRIEF tag one can provide an optional one line description
38# for a project that appears at the top of each page and should give viewer
39# a quick idea about the purpose of the project. Keep the description short.
40
41PROJECT_BRIEF =
42
43# With the PROJECT_LOGO tag one can specify an logo or icon that is
44# included in the documentation. The maximum height of the logo should not
45# exceed 55 pixels and the maximum width should not exceed 200 pixels.
46# Doxygen will copy the logo to the output directory.
47
48PROJECT_LOGO =
49
50# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
51# base path where the generated documentation will be put.
52# If a relative path is entered, it will be relative to the location
Alexandre Lision51140e12013-12-02 10:54:09 -050053# where doxygen was started. If left blank the current directory will be used.
54
55OUTPUT_DIRECTORY = .
56
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -050057# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
58# 4096 sub-directories (in 2 levels) under the output directory of each output
59# format and will distribute the generated files over these directories.
60# Enabling this option can be useful when feeding doxygen a huge amount of
61# source files, where putting all generated files in the same directory would
Alexandre Lision51140e12013-12-02 10:54:09 -050062# otherwise cause performance problems for the file system.
63
64CREATE_SUBDIRS = NO
65
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -050066# The OUTPUT_LANGUAGE tag is used to specify the language in which all
67# documentation generated by doxygen is written. Doxygen will use this
68# information to generate all constant output in the proper language.
69# The default language is English, other supported languages are:
70# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
71# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
Alexandre Lision51140e12013-12-02 10:54:09 -050076
77OUTPUT_LANGUAGE = English
78
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -050079# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
80# include brief member descriptions after the members that are listed in
81# the file and class documentation (similar to JavaDoc).
Alexandre Lision51140e12013-12-02 10:54:09 -050082# Set to NO to disable this.
83
84BRIEF_MEMBER_DESC = YES
85
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -050086# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
87# the brief description of a member or function before the detailed description.
88# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
Alexandre Lision51140e12013-12-02 10:54:09 -050089# brief descriptions will be completely suppressed.
90
91REPEAT_BRIEF = YES
92
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -050093# This tag implements a quasi-intelligent brief description abbreviator
94# that is used to form the text in various listings. Each string
95# in this list, if found as the leading text of the brief description, will be
96# stripped from the text and the result after processing the whole list, is
97# used as the annotated text. Otherwise, the brief description is used as-is.
98# If left blank, the following values are used ("$name" is automatically
99# replaced with the name of the entity): "The $name class" "The $name widget"
100# "The $name file" "is" "provides" "specifies" "contains"
Alexandre Lision51140e12013-12-02 10:54:09 -0500101# "represents" "a" "an" "the"
102
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500103ABBREVIATE_BRIEF =
Alexandre Lision51140e12013-12-02 10:54:09 -0500104
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500105# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
106# Doxygen will generate a detailed section even if there is only a brief
Alexandre Lision51140e12013-12-02 10:54:09 -0500107# description.
108
109ALWAYS_DETAILED_SEC = NO
110
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500111# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
112# inherited members of a class in the documentation of that class as if those
113# members were ordinary class members. Constructors, destructors and assignment
Alexandre Lision51140e12013-12-02 10:54:09 -0500114# operators of the base classes will not be shown.
115
116INLINE_INHERITED_MEMB = NO
117
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500118# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
119# path before files name in the file list and in the header files. If set
Alexandre Lision51140e12013-12-02 10:54:09 -0500120# to NO the shortest path that makes the file name unique will be used.
121
122FULL_PATH_NAMES = NO
123
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500124# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
125# can be used to strip a user-defined part of the path. Stripping is
126# only done if one of the specified strings matches the left-hand part of
127# the path. The tag can be used to show relative paths in the file list.
128# If left blank the directory from which doxygen is run is used as the
Alexandre Lision51140e12013-12-02 10:54:09 -0500129# path to strip.
130
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500131STRIP_FROM_PATH =
Alexandre Lision51140e12013-12-02 10:54:09 -0500132
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500133# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
134# the path mentioned in the documentation of a class, which tells
135# the reader which header file to include in order to use a class.
136# If left blank only the name of the header file containing the class
137# definition is used. Otherwise one should specify the include paths that
Alexandre Lision51140e12013-12-02 10:54:09 -0500138# are normally passed to the compiler using the -I flag.
139
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500140STRIP_FROM_INC_PATH =
Alexandre Lision51140e12013-12-02 10:54:09 -0500141
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500142# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
143# (but less readable) file names. This can be useful if your file system
Alexandre Lision51140e12013-12-02 10:54:09 -0500144# doesn't support long names like on DOS, Mac, or CD-ROM.
145
146SHORT_NAMES = NO
147
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500148# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
149# will interpret the first line (until the first dot) of a JavaDoc-style
150# comment as the brief description. If set to NO, the JavaDoc
151# comments will behave just like regular Qt-style comments
Alexandre Lision51140e12013-12-02 10:54:09 -0500152# (thus requiring an explicit @brief command for a brief description.)
153
154JAVADOC_AUTOBRIEF = YES
155
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500156# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
157# interpret the first line (until the first dot) of a Qt-style
158# comment as the brief description. If set to NO, the comments
159# will behave just like regular Qt-style comments (thus requiring
Alexandre Lision51140e12013-12-02 10:54:09 -0500160# an explicit \brief command for a brief description.)
161
162QT_AUTOBRIEF = NO
163
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500164# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
165# treat a multi-line C++ special comment block (i.e. a block of //! or ///
166# comments) as a brief description. This used to be the default behaviour.
167# The new default is to treat a multi-line C++ comment block as a detailed
Alexandre Lision51140e12013-12-02 10:54:09 -0500168# description. Set this tag to YES if you prefer the old behaviour instead.
169
170MULTILINE_CPP_IS_BRIEF = NO
171
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500172# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
173# member inherits the documentation from any documented member that it
Alexandre Lision51140e12013-12-02 10:54:09 -0500174# re-implements.
175
176INHERIT_DOCS = NO
177
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500178# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
179# a new page for each member. If set to NO, the documentation of a member will
Alexandre Lision51140e12013-12-02 10:54:09 -0500180# be part of the file/class/namespace that contains it.
181
182SEPARATE_MEMBER_PAGES = NO
183
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500184# The TAB_SIZE tag can be used to set the number of spaces in a tab.
Alexandre Lision51140e12013-12-02 10:54:09 -0500185# Doxygen uses this value to replace tabs by spaces in code fragments.
186
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500187TAB_SIZE = 4
Alexandre Lision51140e12013-12-02 10:54:09 -0500188
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500189# This tag can be used to specify a number of aliases that acts
190# as commands in the documentation. An alias has the form "name=value".
191# For example adding "sideeffect=\par Side Effects:\n" will allow you to
192# put the command \sideeffect (or @sideeffect) in the documentation, which
193# will result in a user-defined paragraph with heading "Side Effects:".
Alexandre Lision51140e12013-12-02 10:54:09 -0500194# You can put \n's in the value part of an alias to insert newlines.
195
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500196ALIASES =
Alexandre Lision51140e12013-12-02 10:54:09 -0500197
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500198# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
199# sources only. Doxygen will then generate output that is more tailored for C.
200# For instance, some of the names that are used will be different. The list
Alexandre Lision51140e12013-12-02 10:54:09 -0500201# of all members will be omitted, etc.
202
203OPTIMIZE_OUTPUT_FOR_C = NO
204
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500205# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
206# sources only. Doxygen will then generate output that is more tailored for
207# Java. For instance, namespaces will be presented as packages, qualified
208# scopes will look different, etc.
Alexandre Lision51140e12013-12-02 10:54:09 -0500209
210OPTIMIZE_OUTPUT_JAVA = NO
211
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500212# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
213# sources only. Doxygen will then generate output that is more tailored for
214# Fortran.
215
216OPTIMIZE_FOR_FORTRAN = NO
217
218# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
219# sources. Doxygen will then generate output that is tailored for
220# VHDL.
221
222OPTIMIZE_OUTPUT_VHDL = NO
223
224# Doxygen selects the parser to use depending on the extension of the files it
225# parses. With this tag you can assign which parser to use for a given extension.
226# Doxygen has a built-in mapping, but you can override or extend it using this
227# tag. The format is ext=language, where ext is a file extension, and language
228# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
229# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
230# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
231# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
232# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
233
234EXTENSION_MAPPING =
235
236# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
237# to include (a tag file for) the STL sources as input, then you should
238# set this tag to YES in order to let doxygen match functions declarations and
239# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
240# func(std::string) {}). This also makes the inheritance and collaboration
Alexandre Lision51140e12013-12-02 10:54:09 -0500241# diagrams that involve STL classes more complete and accurate.
242
243BUILTIN_STL_SUPPORT = NO
244
245# If you use Microsoft's C++/CLI language, you should set this option to YES to
246# enable parsing support.
247
248CPP_CLI_SUPPORT = NO
249
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500250# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
251# Doxygen will parse them like normal C++ but will assume all classes use public
252# instead of private inheritance when no explicit protection keyword is present.
253
254SIP_SUPPORT = NO
255
256# For Microsoft's IDL there are propget and propput attributes to indicate getter
257# and setter methods for a property. Setting this option to YES (the default)
258# will make doxygen replace the get and set methods by a property in the
259# documentation. This will only work if the methods are indeed getting or
260# setting a simple type. If this is not the case, or you want to show the
261# methods anyway, you should set this option to NO.
262
263IDL_PROPERTY_SUPPORT = YES
264
265# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
266# tag is set to YES, then doxygen will reuse the documentation of the first
267# member in the group (if any) for the other members of the group. By default
Alexandre Lision51140e12013-12-02 10:54:09 -0500268# all members of a group must be documented explicitly.
269
270DISTRIBUTE_GROUP_DOC = NO
271
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500272# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
273# the same type (for instance a group of public functions) to be put as a
274# subgroup of that type (e.g. under the Public Functions section). Set it to
275# NO to prevent subgrouping. Alternatively, this can be done per class using
Alexandre Lision51140e12013-12-02 10:54:09 -0500276# the \nosubgrouping command.
277
278SUBGROUPING = YES
279
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500280# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
281# unions are shown inside the group in which they are included (e.g. using
282# @ingroup) instead of on a separate page (for HTML and Man pages) or
283# section (for LaTeX and RTF).
284
285INLINE_GROUPED_CLASSES = NO
286
287# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
288# unions with only public data fields will be shown inline in the documentation
289# of the scope in which they are defined (i.e. file, namespace, or group
290# documentation), provided this scope is documented. If set to NO (the default),
291# structs, classes, and unions are shown on a separate page (for HTML and Man
292# pages) or section (for LaTeX and RTF).
293
294INLINE_SIMPLE_STRUCTS = NO
295
296# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
297# is documented as struct, union, or enum with the name of the typedef. So
298# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
299# with name TypeT. When disabled the typedef will appear as a member of a file,
300# namespace, or class. And the struct will be named TypeS. This can typically
301# be useful for C code in case the coding convention dictates that all compound
302# types are typedef'ed and only the typedef is referenced, never the tag name.
303
304TYPEDEF_HIDES_STRUCT = NO
305
306# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
307# determine which symbols to keep in memory and which to flush to disk.
308# When the cache is full, less often used symbols will be written to disk.
309# For small to medium size projects (<1000 input files) the default value is
310# probably good enough. For larger projects a too small cache size can cause
311# doxygen to be busy swapping symbols to and from disk most of the time
312# causing a significant performance penalty.
313# If the system has enough physical memory increasing the cache will improve the
314# performance by keeping more symbols in memory. Note that the value works on
315# a logarithmic scale so increasing the size by one will roughly double the
316# memory usage. The cache size is given by this formula:
317# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
318# corresponding to a cache size of 2^16 = 65536 symbols
319
320SYMBOL_CACHE_SIZE = 0
321
Alexandre Lision51140e12013-12-02 10:54:09 -0500322#---------------------------------------------------------------------------
323# Build related configuration options
324#---------------------------------------------------------------------------
325
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500326# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
327# documentation are documented, even if no documentation was available.
328# Private class members and static file members will be hidden unless
Alexandre Lision51140e12013-12-02 10:54:09 -0500329# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
330
331EXTRACT_ALL = YES
332
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500333# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
Alexandre Lision51140e12013-12-02 10:54:09 -0500334# will be included in the documentation.
335
336EXTRACT_PRIVATE = NO
337
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500338# If the EXTRACT_STATIC tag is set to YES all static members of a file
Alexandre Lision51140e12013-12-02 10:54:09 -0500339# will be included in the documentation.
340
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500341EXTRACT_STATIC = YES
Alexandre Lision51140e12013-12-02 10:54:09 -0500342
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500343# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
344# defined locally in source files will be included in the documentation.
Alexandre Lision51140e12013-12-02 10:54:09 -0500345# If set to NO only classes defined in header files are included.
346
347EXTRACT_LOCAL_CLASSES = YES
348
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500349# This flag is only useful for Objective-C code. When set to YES local
350# methods, which are defined in the implementation section but not in
351# the interface are included in the documentation.
Alexandre Lision51140e12013-12-02 10:54:09 -0500352# If set to NO (the default) only methods in the interface are included.
353
354EXTRACT_LOCAL_METHODS = NO
355
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500356# If this flag is set to YES, the members of anonymous namespaces will be
357# extracted and appear in the documentation as a namespace called
358# 'anonymous_namespace{file}', where file will be replaced with the base
359# name of the file that contains the anonymous namespace. By default
360# anonymous namespaces are hidden.
Alexandre Lision51140e12013-12-02 10:54:09 -0500361
362EXTRACT_ANON_NSPACES = NO
363
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500364# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
365# undocumented members of documented classes, files or namespaces.
366# If set to NO (the default) these members will be included in the
367# various overviews, but no documentation section is generated.
Alexandre Lision51140e12013-12-02 10:54:09 -0500368# This option has no effect if EXTRACT_ALL is enabled.
369
370HIDE_UNDOC_MEMBERS = NO
371
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500372# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
373# undocumented classes that are normally visible in the class hierarchy.
374# If set to NO (the default) these classes will be included in the various
Alexandre Lision51140e12013-12-02 10:54:09 -0500375# overviews. This option has no effect if EXTRACT_ALL is enabled.
376
377HIDE_UNDOC_CLASSES = NO
378
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500379# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
380# friend (class|struct|union) declarations.
381# If set to NO (the default) these declarations will be included in the
Alexandre Lision51140e12013-12-02 10:54:09 -0500382# documentation.
383
384HIDE_FRIEND_COMPOUNDS = NO
385
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500386# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
387# documentation blocks found inside the body of a function.
388# If set to NO (the default) these blocks will be appended to the
Alexandre Lision51140e12013-12-02 10:54:09 -0500389# function's detailed documentation block.
390
391HIDE_IN_BODY_DOCS = NO
392
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500393# The INTERNAL_DOCS tag determines if documentation
394# that is typed after a \internal command is included. If the tag is set
395# to NO (the default) then the documentation will be excluded.
Alexandre Lision51140e12013-12-02 10:54:09 -0500396# Set it to YES to include the internal documentation.
397
398INTERNAL_DOCS = NO
399
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500400# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
401# file names in lower-case letters. If set to YES upper-case letters are also
402# allowed. This is useful if you have classes or files whose names only differ
403# in case and if your file system supports case sensitive file names. Windows
Alexandre Lision51140e12013-12-02 10:54:09 -0500404# and Mac users are advised to set this option to NO.
405
406CASE_SENSE_NAMES = NO
407
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500408# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
409# will show members with their full class and namespace scopes in the
Alexandre Lision51140e12013-12-02 10:54:09 -0500410# documentation. If set to YES the scope will be hidden.
411
412HIDE_SCOPE_NAMES = NO
413
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500414# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
415# will put a list of the files that are included by a file in the documentation
Alexandre Lision51140e12013-12-02 10:54:09 -0500416# of that file.
417
418SHOW_INCLUDE_FILES = YES
419
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500420# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
421# will list include files with double quotes in the documentation
422# rather than with sharp brackets.
423
424FORCE_LOCAL_INCLUDES = NO
425
426# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
Alexandre Lision51140e12013-12-02 10:54:09 -0500427# is inserted in the documentation for inline members.
428
429INLINE_INFO = YES
430
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500431# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
432# will sort the (detailed) documentation of file and class members
433# alphabetically by member name. If set to NO the members will appear in
Alexandre Lision51140e12013-12-02 10:54:09 -0500434# declaration order.
435
436SORT_MEMBER_DOCS = YES
437
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500438# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
439# brief documentation of file, namespace and class members alphabetically
440# by member name. If set to NO (the default) the members will appear in
Alexandre Lision51140e12013-12-02 10:54:09 -0500441# declaration order.
442
443SORT_BRIEF_DOCS = NO
444
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500445# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
446# will sort the (brief and detailed) documentation of class members so that
447# constructors and destructors are listed first. If set to NO (the default)
448# the constructors will appear in the respective orders defined by
449# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
450# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
451# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
452
453SORT_MEMBERS_CTORS_1ST = NO
454
455# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
456# hierarchy of group names into alphabetical order. If set to NO (the default)
457# the group names will appear in their defined order.
458
459SORT_GROUP_NAMES = NO
460
461# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
462# sorted by fully-qualified names, including namespaces. If set to
463# NO (the default), the class list will be sorted only by class name,
464# not including the namespace part.
Alexandre Lision51140e12013-12-02 10:54:09 -0500465# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500466# Note: This option applies only to the class list, not to the
Alexandre Lision51140e12013-12-02 10:54:09 -0500467# alphabetical list.
468
469SORT_BY_SCOPE_NAME = NO
470
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500471# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
472# do proper type resolution of all parameters of a function it will reject a
473# match between the prototype and the implementation of a member function even
474# if there is only one candidate or it is obvious which candidate to choose
475# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
476# will still accept a match between prototype and implementation in such cases.
477
478STRICT_PROTO_MATCHING = NO
479
480# The GENERATE_TODOLIST tag can be used to enable (YES) or
481# disable (NO) the todo list. This list is created by putting \todo
Alexandre Lision51140e12013-12-02 10:54:09 -0500482# commands in the documentation.
483
484GENERATE_TODOLIST = YES
485
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500486# The GENERATE_TESTLIST tag can be used to enable (YES) or
487# disable (NO) the test list. This list is created by putting \test
Alexandre Lision51140e12013-12-02 10:54:09 -0500488# commands in the documentation.
489
490GENERATE_TESTLIST = YES
491
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500492# The GENERATE_BUGLIST tag can be used to enable (YES) or
493# disable (NO) the bug list. This list is created by putting \bug
Alexandre Lision51140e12013-12-02 10:54:09 -0500494# commands in the documentation.
495
496GENERATE_BUGLIST = YES
497
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500498# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
499# disable (NO) the deprecated list. This list is created by putting
Alexandre Lision51140e12013-12-02 10:54:09 -0500500# \deprecated commands in the documentation.
501
502GENERATE_DEPRECATEDLIST= YES
503
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500504# The ENABLED_SECTIONS tag can be used to enable conditional
Alexandre Lision51140e12013-12-02 10:54:09 -0500505# documentation sections, marked by \if sectionname ... \endif.
506
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500507ENABLED_SECTIONS =
Alexandre Lision51140e12013-12-02 10:54:09 -0500508
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500509# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
510# the initial value of a variable or macro consists of for it to appear in
511# the documentation. If the initializer consists of more lines than specified
512# here it will be hidden. Use a value of 0 to hide initializers completely.
513# The appearance of the initializer of individual variables and macros in the
514# documentation can be controlled using \showinitializer or \hideinitializer
Alexandre Lision51140e12013-12-02 10:54:09 -0500515# command in the documentation regardless of this setting.
516
517MAX_INITIALIZER_LINES = 30
518
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500519# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
520# at the bottom of the documentation of classes and structs. If set to YES the
Alexandre Lision51140e12013-12-02 10:54:09 -0500521# list will mention the files that were used to generate the documentation.
522
523SHOW_USED_FILES = YES
524
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500525# If the sources in your project are distributed over multiple directories
526# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
Alexandre Lision51140e12013-12-02 10:54:09 -0500527# in the documentation. The default is NO.
528
529SHOW_DIRECTORIES = NO
530
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500531# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
532# This will remove the Files entry from the Quick Index and from the
533# Folder Tree View (if specified). The default is YES.
534
535SHOW_FILES = YES
536
537# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
538# Namespaces page.
539# This will remove the Namespaces entry from the Quick Index
540# and from the Folder Tree View (if specified). The default is YES.
541
542SHOW_NAMESPACES = YES
543
544# The FILE_VERSION_FILTER tag can be used to specify a program or script that
545# doxygen should invoke to get the current version for each file (typically from
546# the version control system). Doxygen will invoke the program by executing (via
547# popen()) the command <command> <input-file>, where <command> is the value of
548# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
549# provided by doxygen. Whatever the program writes to standard output
Alexandre Lision51140e12013-12-02 10:54:09 -0500550# is used as the file version. See the manual for examples.
551
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500552FILE_VERSION_FILTER =
553
554# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
555# by doxygen. The layout file controls the global structure of the generated
556# output files in an output format independent way. The create the layout file
557# that represents doxygen's defaults, run doxygen with the -l option.
558# You can optionally specify a file name after the option, if omitted
559# DoxygenLayout.xml will be used as the name of the layout file.
560
561LAYOUT_FILE =
562
563# The CITE_BIB_FILES tag can be used to specify one or more bib files
564# containing the references data. This must be a list of .bib files. The
565# .bib extension is automatically appended if omitted. Using this command
566# requires the bibtex tool to be installed. See also
567# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
568# of the bibliography can be controlled using LATEX_BIB_STYLE.
569
570CITE_BIB_FILES =
Alexandre Lision51140e12013-12-02 10:54:09 -0500571
572#---------------------------------------------------------------------------
573# configuration options related to warning and progress messages
574#---------------------------------------------------------------------------
575
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500576# The QUIET tag can be used to turn on/off the messages that are generated
Alexandre Lision51140e12013-12-02 10:54:09 -0500577# by doxygen. Possible values are YES and NO. If left blank NO is used.
578
579QUIET = NO
580
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500581# The WARNINGS tag can be used to turn on/off the warning messages that are
582# generated by doxygen. Possible values are YES and NO. If left blank
Alexandre Lision51140e12013-12-02 10:54:09 -0500583# NO is used.
584
585WARNINGS = YES
586
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500587# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
588# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
Alexandre Lision51140e12013-12-02 10:54:09 -0500589# automatically be disabled.
590
591WARN_IF_UNDOCUMENTED = YES
592
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500593# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
594# potential errors in the documentation, such as not documenting some
595# parameters in a documented function, or documenting parameters that
Alexandre Lision51140e12013-12-02 10:54:09 -0500596# don't exist or using markup commands wrongly.
597
598WARN_IF_DOC_ERROR = YES
599
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500600# The WARN_NO_PARAMDOC option can be enabled to get warnings for
601# functions that are documented, but have no documentation for their parameters
602# or return value. If set to NO (the default) doxygen will only warn about
603# wrong or incomplete parameter documentation, but not about the absence of
Alexandre Lision51140e12013-12-02 10:54:09 -0500604# documentation.
605
606WARN_NO_PARAMDOC = NO
607
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500608# The WARN_FORMAT tag determines the format of the warning messages that
609# doxygen can produce. The string should contain the $file, $line, and $text
610# tags, which will be replaced by the file and line number from which the
611# warning originated and the warning text. Optionally the format may contain
612# $version, which will be replaced by the version of the file (if it could
Alexandre Lision51140e12013-12-02 10:54:09 -0500613# be obtained via FILE_VERSION_FILTER)
614
615WARN_FORMAT = "$file:$line: $text"
616
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500617# The WARN_LOGFILE tag can be used to specify a file to which warning
618# and error messages should be written. If left blank the output is written
Alexandre Lision51140e12013-12-02 10:54:09 -0500619# to stderr.
620
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500621WARN_LOGFILE =
Alexandre Lision51140e12013-12-02 10:54:09 -0500622
623#---------------------------------------------------------------------------
624# configuration options related to the input files
625#---------------------------------------------------------------------------
626
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500627# The INPUT tag can be used to specify the files and/or directories that contain
628# documented source files. You may enter file names like "myfile.cpp" or
629# directories like "/usr/src/myproject". Separate the files or directories
Alexandre Lision51140e12013-12-02 10:54:09 -0500630# with spaces.
631
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500632INPUT = ../zrtp \
633 ../zrtp/libzrtpcpp \
634 ../zrtp/crypto \
635 ../srtp \
636 ../srtp/crypto \
637 ../clients/ccrtp
Alexandre Lision51140e12013-12-02 10:54:09 -0500638
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500639# This tag can be used to specify the character encoding of the source files
640# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
641# also the default input encoding. Doxygen uses libiconv (or the iconv built
642# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
643# the list of possible encodings.
Alexandre Lision51140e12013-12-02 10:54:09 -0500644
645INPUT_ENCODING = UTF-8
646
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500647# If the value of the INPUT tag contains directories, you can use the
648# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
649# and *.h) to filter out the source-files in the directories. If left
650# blank the following patterns are tested:
651# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
652# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
653# *.f90 *.f *.for *.vhd *.vhdl
Alexandre Lision51140e12013-12-02 10:54:09 -0500654
655FILE_PATTERNS = *.h
656
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500657# The RECURSIVE tag can be used to turn specify whether or not subdirectories
658# should be searched for input files as well. Possible values are YES and NO.
Alexandre Lision51140e12013-12-02 10:54:09 -0500659# If left blank NO is used.
660
661RECURSIVE = NO
662
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500663# The EXCLUDE tag can be used to specify files and/or directories that should
664# excluded from the INPUT source files. This way you can easily exclude a
Alexandre Lision51140e12013-12-02 10:54:09 -0500665# subdirectory from a directory tree whose root is specified with the INPUT tag.
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500666# Note that relative paths are relative to directory from which doxygen is run.
Alexandre Lision51140e12013-12-02 10:54:09 -0500667
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500668EXCLUDE =
Alexandre Lision51140e12013-12-02 10:54:09 -0500669
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500670# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
671# directories that are symbolic links (a Unix file system feature) are excluded
Alexandre Lision51140e12013-12-02 10:54:09 -0500672# from the input.
673
674EXCLUDE_SYMLINKS = NO
675
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500676# If the value of the INPUT tag contains directories, you can use the
677# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
678# certain files from those directories. Note that the wildcards are matched
679# against the file with absolute path, so to exclude all test directories
Alexandre Lision51140e12013-12-02 10:54:09 -0500680# for example use the pattern */test/*
681
682EXCLUDE_PATTERNS = config.h \
683 macros.h \
684 namespace.h
685
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500686# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
687# (namespaces, classes, functions, etc.) that should be excluded from the
688# output. The symbol name can be a fully qualified name, a word, or if the
689# wildcard * is used, a substring. Examples: ANamespace, AClass,
690# AClass::ANamespace, ANamespace::*Test
Alexandre Lision51140e12013-12-02 10:54:09 -0500691
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500692EXCLUDE_SYMBOLS =
Alexandre Lision51140e12013-12-02 10:54:09 -0500693
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500694# The EXAMPLE_PATH tag can be used to specify one or more files or
695# directories that contain example code fragments that are included (see
Alexandre Lision51140e12013-12-02 10:54:09 -0500696# the \include command).
697
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500698EXAMPLE_PATH =
Alexandre Lision51140e12013-12-02 10:54:09 -0500699
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500700# If the value of the EXAMPLE_PATH tag contains directories, you can use the
701# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
702# and *.h) to filter out the source-files in the directories. If left
Alexandre Lision51140e12013-12-02 10:54:09 -0500703# blank all files are included.
704
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500705EXAMPLE_PATTERNS =
Alexandre Lision51140e12013-12-02 10:54:09 -0500706
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500707# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
708# searched for input files to be used with the \include or \dontinclude
709# commands irrespective of the value of the RECURSIVE tag.
Alexandre Lision51140e12013-12-02 10:54:09 -0500710# Possible values are YES and NO. If left blank NO is used.
711
712EXAMPLE_RECURSIVE = NO
713
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500714# The IMAGE_PATH tag can be used to specify one or more files or
715# directories that contain image that are included in the documentation (see
Alexandre Lision51140e12013-12-02 10:54:09 -0500716# the \image command).
717
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500718IMAGE_PATH =
Alexandre Lision51140e12013-12-02 10:54:09 -0500719
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500720# The INPUT_FILTER tag can be used to specify a program that doxygen should
721# invoke to filter for each input file. Doxygen will invoke the filter program
722# by executing (via popen()) the command <filter> <input-file>, where <filter>
723# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
724# input file. Doxygen will then use the output that the filter program writes
725# to standard output.
726# If FILTER_PATTERNS is specified, this tag will be
Alexandre Lision51140e12013-12-02 10:54:09 -0500727# ignored.
728
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500729INPUT_FILTER =
Alexandre Lision51140e12013-12-02 10:54:09 -0500730
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500731# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
732# basis.
733# Doxygen will compare the file name with each pattern and apply the
734# filter if there is a match.
735# The filters are a list of the form:
736# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
737# info on how filters are used. If FILTER_PATTERNS is empty or if
738# non of the patterns match the file name, INPUT_FILTER is applied.
Alexandre Lision51140e12013-12-02 10:54:09 -0500739
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500740FILTER_PATTERNS =
Alexandre Lision51140e12013-12-02 10:54:09 -0500741
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500742# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
743# INPUT_FILTER) will be used to filter the input files when producing source
Alexandre Lision51140e12013-12-02 10:54:09 -0500744# files to browse (i.e. when SOURCE_BROWSER is set to YES).
745
746FILTER_SOURCE_FILES = NO
747
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500748# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
749# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
750# and it is also possible to disable source filtering for a specific pattern
751# using *.ext= (so without naming a filter). This option only has effect when
752# FILTER_SOURCE_FILES is enabled.
753
754FILTER_SOURCE_PATTERNS =
755
Alexandre Lision51140e12013-12-02 10:54:09 -0500756#---------------------------------------------------------------------------
757# configuration options related to source browsing
758#---------------------------------------------------------------------------
759
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500760# If the SOURCE_BROWSER tag is set to YES then a list of source files will
761# be generated. Documented entities will be cross-referenced with these sources.
762# Note: To get rid of all source code in the generated output, make sure also
763# VERBATIM_HEADERS is set to NO.
Alexandre Lision51140e12013-12-02 10:54:09 -0500764
765SOURCE_BROWSER = NO
766
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500767# Setting the INLINE_SOURCES tag to YES will include the body
Alexandre Lision51140e12013-12-02 10:54:09 -0500768# of functions and classes directly in the documentation.
769
770INLINE_SOURCES = NO
771
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500772# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
773# doxygen to hide any special comment blocks from generated source code
Alexandre Lision51140e12013-12-02 10:54:09 -0500774# fragments. Normal C and C++ comments will always remain visible.
775
776STRIP_CODE_COMMENTS = YES
777
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500778# If the REFERENCED_BY_RELATION tag is set to YES
779# then for each documented function all documented
Alexandre Lision51140e12013-12-02 10:54:09 -0500780# functions referencing it will be listed.
781
782REFERENCED_BY_RELATION = YES
783
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500784# If the REFERENCES_RELATION tag is set to YES
785# then for each documented function all documented entities
Alexandre Lision51140e12013-12-02 10:54:09 -0500786# called/used by that function will be listed.
787
788REFERENCES_RELATION = YES
789
790# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
791# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
792# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500793# link to the source code.
794# Otherwise they will link to the documentation.
Alexandre Lision51140e12013-12-02 10:54:09 -0500795
796REFERENCES_LINK_SOURCE = YES
797
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500798# If the USE_HTAGS tag is set to YES then the references to source code
799# will point to the HTML generated by the htags(1) tool instead of doxygen
800# built-in source browser. The htags tool is part of GNU's global source
801# tagging system (see http://www.gnu.org/software/global/global.html). You
Alexandre Lision51140e12013-12-02 10:54:09 -0500802# will need version 4.8.6 or higher.
803
804USE_HTAGS = NO
805
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500806# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
807# will generate a verbatim copy of the header file for each class for
Alexandre Lision51140e12013-12-02 10:54:09 -0500808# which an include is specified. Set to NO to disable this.
809
810VERBATIM_HEADERS = YES
811
812#---------------------------------------------------------------------------
813# configuration options related to the alphabetical class index
814#---------------------------------------------------------------------------
815
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500816# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
817# of all compounds will be generated. Enable this if the project
Alexandre Lision51140e12013-12-02 10:54:09 -0500818# contains a lot of classes, structs, unions or interfaces.
819
820ALPHABETICAL_INDEX = YES
821
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500822# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
823# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
Alexandre Lision51140e12013-12-02 10:54:09 -0500824# in which this list will be split (can be a number in the range [1..20])
825
826COLS_IN_ALPHA_INDEX = 5
827
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500828# In case all classes in a project start with a common prefix, all
829# classes will be put under the same header in the alphabetical index.
830# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
Alexandre Lision51140e12013-12-02 10:54:09 -0500831# should be ignored while generating the index headers.
832
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500833IGNORE_PREFIX =
Alexandre Lision51140e12013-12-02 10:54:09 -0500834
835#---------------------------------------------------------------------------
836# configuration options related to the HTML output
837#---------------------------------------------------------------------------
838
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500839# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
Alexandre Lision51140e12013-12-02 10:54:09 -0500840# generate HTML output.
841
842GENERATE_HTML = YES
843
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500844# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
845# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Alexandre Lision51140e12013-12-02 10:54:09 -0500846# put in front of it. If left blank `html' will be used as the default path.
847
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500848HTML_OUTPUT =
Alexandre Lision51140e12013-12-02 10:54:09 -0500849
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500850# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
851# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
Alexandre Lision51140e12013-12-02 10:54:09 -0500852# doxygen will generate files with .html extension.
853
854HTML_FILE_EXTENSION = .html
855
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500856# The HTML_HEADER tag can be used to specify a personal HTML header for
857# each generated HTML page. If it is left blank doxygen will generate a
858# standard header. Note that when using a custom header you are responsible
859# for the proper inclusion of any scripts and style sheets that doxygen
860# needs, which is dependent on the configuration options used.
861# It is adviced to generate a default header using "doxygen -w html
862# header.html footer.html stylesheet.css YourConfigFile" and then modify
863# that header. Note that the header is subject to change so you typically
864# have to redo this when upgrading to a newer version of doxygen or when
865# changing the value of configuration settings such as GENERATE_TREEVIEW!
Alexandre Lision51140e12013-12-02 10:54:09 -0500866
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500867HTML_HEADER =
Alexandre Lision51140e12013-12-02 10:54:09 -0500868
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500869# The HTML_FOOTER tag can be used to specify a personal HTML footer for
870# each generated HTML page. If it is left blank doxygen will generate a
Alexandre Lision51140e12013-12-02 10:54:09 -0500871# standard footer.
872
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500873HTML_FOOTER =
Alexandre Lision51140e12013-12-02 10:54:09 -0500874
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500875# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
876# style sheet that is used by each HTML page. It can be used to
877# fine-tune the look of the HTML output. If the tag is left blank doxygen
878# will generate a default style sheet. Note that doxygen will try to copy
879# the style sheet file to the HTML output directory, so don't put your own
Alexandre Lision51140e12013-12-02 10:54:09 -0500880# stylesheet in the HTML output directory as well, or it will be erased!
881
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500882HTML_STYLESHEET =
Alexandre Lision51140e12013-12-02 10:54:09 -0500883
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500884# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
885# other source files which should be copied to the HTML output directory. Note
886# that these files will be copied to the base HTML output directory. Use the
887# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
888# files. In the HTML_STYLESHEET file, use the file name only. Also note that
889# the files will be copied as-is; there are no commands or markers available.
890
891HTML_EXTRA_FILES =
892
893# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
894# Doxygen will adjust the colors in the stylesheet and background images
895# according to this color. Hue is specified as an angle on a colorwheel,
896# see http://en.wikipedia.org/wiki/Hue for more information.
897# For instance the value 0 represents red, 60 is yellow, 120 is green,
898# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
899# The allowed range is 0 to 359.
900
901HTML_COLORSTYLE_HUE = 220
902
903# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
904# the colors in the HTML output. For a value of 0 the output will use
905# grayscales only. A value of 255 will produce the most vivid colors.
906
907HTML_COLORSTYLE_SAT = 100
908
909# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
910# the luminance component of the colors in the HTML output. Values below
911# 100 gradually make the output lighter, whereas values above 100 make
912# the output darker. The value divided by 100 is the actual gamma applied,
913# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
914# and 100 does not change the gamma.
915
916HTML_COLORSTYLE_GAMMA = 80
917
918# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
919# page will contain the date and time when the page was generated. Setting
920# this to NO can help when comparing the output of multiple runs.
921
922HTML_TIMESTAMP = NO
923
924# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
925# files or namespaces will be aligned in HTML using tables. If set to
Alexandre Lision51140e12013-12-02 10:54:09 -0500926# NO a bullet list will be used.
927
928HTML_ALIGN_MEMBERS = YES
929
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500930# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
931# documentation will contain sections that can be hidden and shown after the
932# page has loaded. For this to work a browser that supports
933# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
Alexandre Lision51140e12013-12-02 10:54:09 -0500934# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
935
936HTML_DYNAMIC_SECTIONS = NO
937
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500938# If the GENERATE_DOCSET tag is set to YES, additional index files
939# will be generated that can be used as input for Apple's Xcode 3
940# integrated development environment, introduced with OSX 10.5 (Leopard).
941# To create a documentation set, doxygen will generate a Makefile in the
942# HTML output directory. Running make will produce the docset in that
943# directory and running "make install" will install the docset in
944# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
945# it at startup.
946# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
947# for more information.
948
949GENERATE_DOCSET = NO
950
951# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
952# feed. A documentation feed provides an umbrella under which multiple
953# documentation sets from a single provider (such as a company or product suite)
954# can be grouped.
955
956DOCSET_FEEDNAME = "Doxygen generated docs"
957
958# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
959# should uniquely identify the documentation set bundle. This should be a
960# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
961# will append .docset to the name.
962
963DOCSET_BUNDLE_ID = org.doxygen.Project
964
965# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
966# the documentation publisher. This should be a reverse domain-name style
967# string, e.g. com.mycompany.MyDocSet.documentation.
968
969DOCSET_PUBLISHER_ID = org.doxygen.Publisher
970
971# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
972
973DOCSET_PUBLISHER_NAME = Publisher
974
975# If the GENERATE_HTMLHELP tag is set to YES, additional index files
976# will be generated that can be used as input for tools like the
977# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
978# of the generated HTML documentation.
979
980GENERATE_HTMLHELP = YES
981
982# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
983# be used to specify the file name of the resulting .chm file. You
984# can add a path in front of the file if the result should not be
Alexandre Lision51140e12013-12-02 10:54:09 -0500985# written to the html output directory.
986
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500987CHM_FILE =
Alexandre Lision51140e12013-12-02 10:54:09 -0500988
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500989# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
990# be used to specify the location (absolute path including file name) of
991# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
Alexandre Lision51140e12013-12-02 10:54:09 -0500992# the HTML help compiler on the generated index.hhp.
993
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500994HHC_LOCATION =
Alexandre Lision51140e12013-12-02 10:54:09 -0500995
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -0500996# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
997# controls if a separate .chi index file is generated (YES) or that
Alexandre Lision51140e12013-12-02 10:54:09 -0500998# it should be included in the master .chm file (NO).
999
1000GENERATE_CHI = NO
1001
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001002# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1003# is used to encode HtmlHelp index (hhk), content (hhc) and project file
1004# content.
1005
1006CHM_INDEX_ENCODING =
1007
1008# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1009# controls whether a binary table of contents is generated (YES) or a
Alexandre Lision51140e12013-12-02 10:54:09 -05001010# normal table of contents (NO) in the .chm file.
1011
1012BINARY_TOC = NO
1013
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001014# The TOC_EXPAND flag can be set to YES to add extra items for group members
Alexandre Lision51140e12013-12-02 10:54:09 -05001015# to the contents of the HTML help documentation and to the tree view.
1016
1017TOC_EXPAND = NO
1018
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001019# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1020# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1021# that can be used as input for Qt's qhelpgenerator to generate a
1022# Qt Compressed Help (.qch) of the generated HTML documentation.
1023
1024GENERATE_QHP = NO
1025
1026# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1027# be used to specify the file name of the resulting .qch file.
1028# The path specified is relative to the HTML output folder.
1029
1030QCH_FILE =
1031
1032# The QHP_NAMESPACE tag specifies the namespace to use when generating
1033# Qt Help Project output. For more information please see
1034# http://doc.trolltech.com/qthelpproject.html#namespace
1035
1036QHP_NAMESPACE = org.doxygen.Project
1037
1038# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1039# Qt Help Project output. For more information please see
1040# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1041
1042QHP_VIRTUAL_FOLDER = doc
1043
1044# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1045# add. For more information please see
1046# http://doc.trolltech.com/qthelpproject.html#custom-filters
1047
1048QHP_CUST_FILTER_NAME =
1049
1050# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1051# custom filter to add. For more information please see
1052# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1053# Qt Help Project / Custom Filters</a>.
1054
1055QHP_CUST_FILTER_ATTRS =
1056
1057# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1058# project's
1059# filter section matches.
1060# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1061# Qt Help Project / Filter Attributes</a>.
1062
1063QHP_SECT_FILTER_ATTRS =
1064
1065# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1066# be used to specify the location of Qt's qhelpgenerator.
1067# If non-empty doxygen will try to run qhelpgenerator on the generated
1068# .qhp file.
1069
1070QHG_LOCATION =
1071
1072# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1073# will be generated, which together with the HTML files, form an Eclipse help
1074# plugin. To install this plugin and make it available under the help contents
1075# menu in Eclipse, the contents of the directory containing the HTML and XML
1076# files needs to be copied into the plugins directory of eclipse. The name of
1077# the directory within the plugins directory should be the same as
1078# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1079# the help appears.
1080
1081GENERATE_ECLIPSEHELP = NO
1082
1083# A unique identifier for the eclipse help plugin. When installing the plugin
1084# the directory name containing the HTML and XML files should also have
1085# this name.
1086
1087ECLIPSE_DOC_ID = org.doxygen.Project
1088
1089# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1090# top of each HTML page. The value NO (the default) enables the index and
Alexandre Lision51140e12013-12-02 10:54:09 -05001091# the value YES disables it.
1092
1093DISABLE_INDEX = NO
1094
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001095# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1096# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1097# documentation. Note that a value of 0 will completely suppress the enum
1098# values from appearing in the overview section.
Alexandre Lision51140e12013-12-02 10:54:09 -05001099
1100ENUM_VALUES_PER_LINE = 4
1101
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001102# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1103# structure should be generated to display hierarchical information.
1104# If the tag value is set to YES, a side panel will be generated
1105# containing a tree-like index structure (just like the one that
1106# is generated for HTML Help). For this to work a browser that supports
1107# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1108# Windows users are probably better off using the HTML help feature.
Alexandre Lision51140e12013-12-02 10:54:09 -05001109
1110GENERATE_TREEVIEW = NO
1111
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001112# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1113# and Class Hierarchy pages using a tree view instead of an ordered list.
1114
1115USE_INLINE_TREES = NO
1116
1117# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1118# used to set the initial width (in pixels) of the frame in which the tree
Alexandre Lision51140e12013-12-02 10:54:09 -05001119# is shown.
1120
1121TREEVIEW_WIDTH = 250
1122
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001123# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1124# links to external symbols imported via tag files in a separate window.
1125
1126EXT_LINKS_IN_WINDOW = NO
1127
1128# Use this tag to change the font size of Latex formulas included
1129# as images in the HTML documentation. The default is 10. Note that
1130# when you change the font size after a successful doxygen run you need
1131# to manually remove any form_*.png images from the HTML output directory
1132# to force them to be regenerated.
1133
1134FORMULA_FONTSIZE = 10
1135
1136# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1137# generated for formulas are transparent PNGs. Transparent PNGs are
1138# not supported properly for IE 6.0, but are supported on all modern browsers.
1139# Note that when changing this option you need to delete any form_*.png files
1140# in the HTML output before the changes have effect.
1141
1142FORMULA_TRANSPARENT = YES
1143
1144# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1145# (see http://www.mathjax.org) which uses client side Javascript for the
1146# rendering instead of using prerendered bitmaps. Use this if you do not
1147# have LaTeX installed or if you want to formulas look prettier in the HTML
1148# output. When enabled you also need to install MathJax separately and
1149# configure the path to it using the MATHJAX_RELPATH option.
1150
1151USE_MATHJAX = NO
1152
1153# When MathJax is enabled you need to specify the location relative to the
1154# HTML output directory using the MATHJAX_RELPATH option. The destination
1155# directory should contain the MathJax.js script. For instance, if the mathjax
1156# directory is located at the same level as the HTML output directory, then
1157# MATHJAX_RELPATH should be ../mathjax. The default value points to the
1158# mathjax.org site, so you can quickly see the result without installing
1159# MathJax, but it is strongly recommended to install a local copy of MathJax
1160# before deployment.
1161
1162MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1163
1164# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1165# names that should be enabled during MathJax rendering.
1166
1167MATHJAX_EXTENSIONS =
1168
1169# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1170# for the HTML output. The underlying search engine uses javascript
1171# and DHTML and should work on any modern browser. Note that when using
1172# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1173# (GENERATE_DOCSET) there is already a search function so this one should
1174# typically be disabled. For large projects the javascript based search engine
1175# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1176
1177SEARCHENGINE = NO
1178
1179# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1180# implemented using a PHP enabled web server instead of at the web client
1181# using Javascript. Doxygen will generate the search PHP script and index
1182# file to put on the web server. The advantage of the server
1183# based approach is that it scales better to large projects and allows
1184# full text search. The disadvantages are that it is more difficult to setup
1185# and does not have live searching capabilities.
1186
1187SERVER_BASED_SEARCH = NO
1188
Alexandre Lision51140e12013-12-02 10:54:09 -05001189#---------------------------------------------------------------------------
1190# configuration options related to the LaTeX output
1191#---------------------------------------------------------------------------
1192
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001193# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
Alexandre Lision51140e12013-12-02 10:54:09 -05001194# generate Latex output.
1195
1196GENERATE_LATEX = NO
1197
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001198# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1199# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Alexandre Lision51140e12013-12-02 10:54:09 -05001200# put in front of it. If left blank `latex' will be used as the default path.
1201
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001202LATEX_OUTPUT =
Alexandre Lision51140e12013-12-02 10:54:09 -05001203
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001204# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
Alexandre Lision51140e12013-12-02 10:54:09 -05001205# invoked. If left blank `latex' will be used as the default command name.
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001206# Note that when enabling USE_PDFLATEX this option is only used for
1207# generating bitmaps for formulas in the HTML output, but not in the
1208# Makefile that is written to the output directory.
Alexandre Lision51140e12013-12-02 10:54:09 -05001209
1210LATEX_CMD_NAME = latex
1211
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001212# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1213# generate index for LaTeX. If left blank `makeindex' will be used as the
Alexandre Lision51140e12013-12-02 10:54:09 -05001214# default command name.
1215
1216MAKEINDEX_CMD_NAME = makeindex
1217
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001218# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1219# LaTeX documents. This may be useful for small projects and may help to
Alexandre Lision51140e12013-12-02 10:54:09 -05001220# save some trees in general.
1221
1222COMPACT_LATEX = NO
1223
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001224# The PAPER_TYPE tag can be used to set the paper type that is used
1225# by the printer. Possible values are: a4, letter, legal and
Alexandre Lision51140e12013-12-02 10:54:09 -05001226# executive. If left blank a4wide will be used.
1227
1228PAPER_TYPE = a4
1229
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001230# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
Alexandre Lision51140e12013-12-02 10:54:09 -05001231# packages that should be included in the LaTeX output.
1232
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001233EXTRA_PACKAGES =
Alexandre Lision51140e12013-12-02 10:54:09 -05001234
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001235# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1236# the generated latex document. The header should contain everything until
1237# the first chapter. If it is left blank doxygen will generate a
Alexandre Lision51140e12013-12-02 10:54:09 -05001238# standard header. Notice: only use this tag if you know what you are doing!
1239
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001240LATEX_HEADER =
Alexandre Lision51140e12013-12-02 10:54:09 -05001241
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001242# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1243# the generated latex document. The footer should contain everything after
1244# the last chapter. If it is left blank doxygen will generate a
1245# standard footer. Notice: only use this tag if you know what you are doing!
1246
1247LATEX_FOOTER =
1248
1249# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1250# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1251# contain links (just like the HTML output) instead of page references
Alexandre Lision51140e12013-12-02 10:54:09 -05001252# This makes the output suitable for online browsing using a pdf viewer.
1253
1254PDF_HYPERLINKS = NO
1255
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001256# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1257# plain latex in the generated Makefile. Set this option to YES to get a
Alexandre Lision51140e12013-12-02 10:54:09 -05001258# higher quality PDF documentation.
1259
1260USE_PDFLATEX = NO
1261
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001262# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1263# command to the generated LaTeX files. This will instruct LaTeX to keep
1264# running if errors occur, instead of asking the user for help.
Alexandre Lision51140e12013-12-02 10:54:09 -05001265# This option is also used when generating formulas in HTML.
1266
1267LATEX_BATCHMODE = NO
1268
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001269# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1270# include the index chapters (such as File Index, Compound Index, etc.)
Alexandre Lision51140e12013-12-02 10:54:09 -05001271# in the output.
1272
1273LATEX_HIDE_INDICES = NO
1274
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001275# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1276# source code with syntax highlighting in the LaTeX output.
1277# Note that which sources are shown also depends on other settings
1278# such as SOURCE_BROWSER.
1279
1280LATEX_SOURCE_CODE = NO
1281
1282# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1283# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1284# http://en.wikipedia.org/wiki/BibTeX for more info.
1285
1286LATEX_BIB_STYLE = plain
1287
Alexandre Lision51140e12013-12-02 10:54:09 -05001288#---------------------------------------------------------------------------
1289# configuration options related to the RTF output
1290#---------------------------------------------------------------------------
1291
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001292# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1293# The RTF output is optimized for Word 97 and may not look very pretty with
Alexandre Lision51140e12013-12-02 10:54:09 -05001294# other RTF readers or editors.
1295
1296GENERATE_RTF = NO
1297
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001298# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1299# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Alexandre Lision51140e12013-12-02 10:54:09 -05001300# put in front of it. If left blank `rtf' will be used as the default path.
1301
1302RTF_OUTPUT = rtf
1303
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001304# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1305# RTF documents. This may be useful for small projects and may help to
Alexandre Lision51140e12013-12-02 10:54:09 -05001306# save some trees in general.
1307
1308COMPACT_RTF = NO
1309
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001310# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1311# will contain hyperlink fields. The RTF file will
1312# contain links (just like the HTML output) instead of page references.
1313# This makes the output suitable for online browsing using WORD or other
1314# programs which support those fields.
Alexandre Lision51140e12013-12-02 10:54:09 -05001315# Note: wordpad (write) and others do not support links.
1316
1317RTF_HYPERLINKS = NO
1318
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001319# Load stylesheet definitions from file. Syntax is similar to doxygen's
1320# config file, i.e. a series of assignments. You only have to provide
Alexandre Lision51140e12013-12-02 10:54:09 -05001321# replacements, missing definitions are set to their default value.
1322
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001323RTF_STYLESHEET_FILE =
Alexandre Lision51140e12013-12-02 10:54:09 -05001324
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001325# Set optional variables used in the generation of an rtf document.
Alexandre Lision51140e12013-12-02 10:54:09 -05001326# Syntax is similar to doxygen's config file.
1327
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001328RTF_EXTENSIONS_FILE =
Alexandre Lision51140e12013-12-02 10:54:09 -05001329
1330#---------------------------------------------------------------------------
1331# configuration options related to the man page output
1332#---------------------------------------------------------------------------
1333
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001334# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
Alexandre Lision51140e12013-12-02 10:54:09 -05001335# generate man pages
1336
1337GENERATE_MAN = NO
1338
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001339# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1340# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Alexandre Lision51140e12013-12-02 10:54:09 -05001341# put in front of it. If left blank `man' will be used as the default path.
1342
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001343MAN_OUTPUT =
Alexandre Lision51140e12013-12-02 10:54:09 -05001344
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001345# The MAN_EXTENSION tag determines the extension that is added to
Alexandre Lision51140e12013-12-02 10:54:09 -05001346# the generated man pages (default is the subroutine's section .3)
1347
1348MAN_EXTENSION = .3
1349
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001350# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1351# then it will generate one additional man file for each entity
1352# documented in the real man page(s). These additional files
1353# only source the real man page, but without them the man command
Alexandre Lision51140e12013-12-02 10:54:09 -05001354# would be unable to find the correct page. The default is NO.
1355
1356MAN_LINKS = NO
1357
1358#---------------------------------------------------------------------------
1359# configuration options related to the XML output
1360#---------------------------------------------------------------------------
1361
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001362# If the GENERATE_XML tag is set to YES Doxygen will
1363# generate an XML file that captures the structure of
Alexandre Lision51140e12013-12-02 10:54:09 -05001364# the code including all documentation.
1365
1366GENERATE_XML = NO
1367
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001368# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1369# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Alexandre Lision51140e12013-12-02 10:54:09 -05001370# put in front of it. If left blank `xml' will be used as the default path.
1371
1372XML_OUTPUT = xml
1373
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001374# The XML_SCHEMA tag can be used to specify an XML schema,
1375# which can be used by a validating XML parser to check the
Alexandre Lision51140e12013-12-02 10:54:09 -05001376# syntax of the XML files.
1377
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001378XML_SCHEMA =
Alexandre Lision51140e12013-12-02 10:54:09 -05001379
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001380# The XML_DTD tag can be used to specify an XML DTD,
1381# which can be used by a validating XML parser to check the
Alexandre Lision51140e12013-12-02 10:54:09 -05001382# syntax of the XML files.
1383
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001384XML_DTD =
Alexandre Lision51140e12013-12-02 10:54:09 -05001385
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001386# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1387# dump the program listings (including syntax highlighting
1388# and cross-referencing information) to the XML output. Note that
Alexandre Lision51140e12013-12-02 10:54:09 -05001389# enabling this will significantly increase the size of the XML output.
1390
1391XML_PROGRAMLISTING = YES
1392
1393#---------------------------------------------------------------------------
1394# configuration options for the AutoGen Definitions output
1395#---------------------------------------------------------------------------
1396
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001397# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1398# generate an AutoGen Definitions (see autogen.sf.net) file
1399# that captures the structure of the code including all
1400# documentation. Note that this feature is still experimental
Alexandre Lision51140e12013-12-02 10:54:09 -05001401# and incomplete at the moment.
1402
1403GENERATE_AUTOGEN_DEF = NO
1404
1405#---------------------------------------------------------------------------
1406# configuration options related to the Perl module output
1407#---------------------------------------------------------------------------
1408
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001409# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1410# generate a Perl module file that captures the structure of
1411# the code including all documentation. Note that this
1412# feature is still experimental and incomplete at the
Alexandre Lision51140e12013-12-02 10:54:09 -05001413# moment.
1414
1415GENERATE_PERLMOD = NO
1416
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001417# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1418# the necessary Makefile rules, Perl scripts and LaTeX code to be able
Alexandre Lision51140e12013-12-02 10:54:09 -05001419# to generate PDF and DVI output from the Perl module output.
1420
1421PERLMOD_LATEX = NO
1422
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001423# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1424# nicely formatted so it can be parsed by a human reader.
1425# This is useful
1426# if you want to understand what is going on.
1427# On the other hand, if this
1428# tag is set to NO the size of the Perl module output will be much smaller
Alexandre Lision51140e12013-12-02 10:54:09 -05001429# and Perl will parse it just the same.
1430
1431PERLMOD_PRETTY = YES
1432
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001433# The names of the make variables in the generated doxyrules.make file
1434# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1435# This is useful so different doxyrules.make files included by the same
Alexandre Lision51140e12013-12-02 10:54:09 -05001436# Makefile don't overwrite each other's variables.
1437
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001438PERLMOD_MAKEVAR_PREFIX =
Alexandre Lision51140e12013-12-02 10:54:09 -05001439
1440#---------------------------------------------------------------------------
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001441# Configuration options related to the preprocessor
Alexandre Lision51140e12013-12-02 10:54:09 -05001442#---------------------------------------------------------------------------
1443
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001444# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1445# evaluate all C-preprocessor directives found in the sources and include
Alexandre Lision51140e12013-12-02 10:54:09 -05001446# files.
1447
1448ENABLE_PREPROCESSING = YES
1449
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001450# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1451# names in the source code. If set to NO (the default) only conditional
1452# compilation will be performed. Macro expansion can be done in a controlled
Alexandre Lision51140e12013-12-02 10:54:09 -05001453# way by setting EXPAND_ONLY_PREDEF to YES.
1454
1455MACRO_EXPANSION = YES
1456
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001457# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1458# then the macro expansion is limited to the macros specified with the
Alexandre Lision51140e12013-12-02 10:54:09 -05001459# PREDEFINED and EXPAND_AS_DEFINED tags.
1460
1461EXPAND_ONLY_PREDEF = NO
1462
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001463# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1464# pointed to by INCLUDE_PATH will be searched when a #include is found.
Alexandre Lision51140e12013-12-02 10:54:09 -05001465
1466SEARCH_INCLUDES = YES
1467
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001468# The INCLUDE_PATH tag can be used to specify one or more directories that
1469# contain include files that are not input files but should be processed by
Alexandre Lision51140e12013-12-02 10:54:09 -05001470# the preprocessor.
1471
1472INCLUDE_PATH = .
1473
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001474# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1475# patterns (like *.h and *.hpp) to filter out the header-files in the
1476# directories. If left blank, the patterns specified with FILE_PATTERNS will
Alexandre Lision51140e12013-12-02 10:54:09 -05001477# be used.
1478
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001479INCLUDE_FILE_PATTERNS =
Alexandre Lision51140e12013-12-02 10:54:09 -05001480
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001481# The PREDEFINED tag can be used to specify one or more macro names that
1482# are defined before the preprocessor is started (similar to the -D option of
1483# gcc). The argument of the tag is a list of macros of the form: name
1484# or name=definition (no spaces). If the definition and the = are
1485# omitted =1 is assumed. To prevent a macro definition from being
1486# undefined via #undef or recursively expanded use the := operator
Alexandre Lision51140e12013-12-02 10:54:09 -05001487# instead of the = operator.
1488
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001489PREDEFINED =
Alexandre Lision51140e12013-12-02 10:54:09 -05001490
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001491# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1492# this tag can be used to specify a list of macro names that should be expanded.
1493# The macro definition that is found in the sources will be used.
1494# Use the PREDEFINED tag if you want to use a different macro definition that
1495# overrules the definition found in the source code.
Alexandre Lision51140e12013-12-02 10:54:09 -05001496
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001497EXPAND_AS_DEFINED =
Alexandre Lision51140e12013-12-02 10:54:09 -05001498
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001499# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1500# doxygen's preprocessor will remove all references to function-like macros
1501# that are alone on a line, have an all uppercase name, and do not end with a
1502# semicolon, because these will confuse the parser if not removed.
Alexandre Lision51140e12013-12-02 10:54:09 -05001503
1504SKIP_FUNCTION_MACROS = YES
1505
1506#---------------------------------------------------------------------------
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001507# Configuration::additions related to external references
Alexandre Lision51140e12013-12-02 10:54:09 -05001508#---------------------------------------------------------------------------
1509
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001510# The TAGFILES option can be used to specify one or more tagfiles.
1511# Optionally an initial location of the external documentation
1512# can be added for each tagfile. The format of a tag file without
1513# this location is as follows:
1514#
1515# TAGFILES = file1 file2 ...
1516# Adding location for the tag files is done as follows:
1517#
1518# TAGFILES = file1=loc1 "file2 = loc2" ...
1519# where "loc1" and "loc2" can be relative or absolute paths or
1520# URLs. If a location is present for each tag, the installdox tool
Alexandre Lision51140e12013-12-02 10:54:09 -05001521# does not have to be run to correct the links.
1522# Note that each tag file must have a unique name
1523# (where the name does NOT include the path)
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001524# If a tag file is not located in the directory in which doxygen
Alexandre Lision51140e12013-12-02 10:54:09 -05001525# is run, you must also specify the path to the tagfile here.
1526
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001527TAGFILES =
Alexandre Lision51140e12013-12-02 10:54:09 -05001528
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001529# When a file name is specified after GENERATE_TAGFILE, doxygen will create
Alexandre Lision51140e12013-12-02 10:54:09 -05001530# a tag file that is based on the input files it reads.
1531
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001532GENERATE_TAGFILE =
Alexandre Lision51140e12013-12-02 10:54:09 -05001533
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001534# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1535# in the class index. If set to NO only the inherited external classes
Alexandre Lision51140e12013-12-02 10:54:09 -05001536# will be listed.
1537
1538ALLEXTERNALS = NO
1539
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001540# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1541# in the modules index. If set to NO, only the current project's groups will
Alexandre Lision51140e12013-12-02 10:54:09 -05001542# be listed.
1543
1544EXTERNAL_GROUPS = YES
1545
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001546# The PERL_PATH should be the absolute path and name of the perl script
Alexandre Lision51140e12013-12-02 10:54:09 -05001547# interpreter (i.e. the result of `which perl').
1548
1549PERL_PATH = /usr/bin/perl
1550
1551#---------------------------------------------------------------------------
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001552# Configuration options related to the dot tool
Alexandre Lision51140e12013-12-02 10:54:09 -05001553#---------------------------------------------------------------------------
1554
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001555# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1556# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1557# or super classes. Setting the tag to NO turns the diagrams off. Note that
1558# this option also works with HAVE_DOT disabled, but it is recommended to
1559# install and use dot, since it yields more powerful graphs.
Alexandre Lision51140e12013-12-02 10:54:09 -05001560
1561CLASS_DIAGRAMS = YES
1562
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001563# You can define message sequence charts within doxygen comments using the \msc
1564# command. Doxygen will then run the mscgen tool (see
1565# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1566# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1567# the mscgen tool resides. If left empty the tool is assumed to be found in the
1568# default search path.
Alexandre Lision51140e12013-12-02 10:54:09 -05001569
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001570MSCGEN_PATH =
Alexandre Lision51140e12013-12-02 10:54:09 -05001571
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001572# If set to YES, the inheritance and collaboration graphs will hide
1573# inheritance and usage relations if the target is undocumented
Alexandre Lision51140e12013-12-02 10:54:09 -05001574# or is not a class.
1575
1576HIDE_UNDOC_RELATIONS = YES
1577
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001578# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1579# available from the path. This tool is part of Graphviz, a graph visualization
1580# toolkit from AT&T and Lucent Bell Labs. The other options in this section
Alexandre Lision51140e12013-12-02 10:54:09 -05001581# have no effect if this option is set to NO (the default)
1582
1583HAVE_DOT = YES
1584
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001585# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1586# allowed to run in parallel. When set to 0 (the default) doxygen will
1587# base this on the number of processors available in the system. You can set it
1588# explicitly to a value larger than 0 to get control over the balance
1589# between CPU load and processing speed.
1590
1591DOT_NUM_THREADS = 0
1592
1593# By default doxygen will use the Helvetica font for all dot files that
1594# doxygen generates. When you want a differently looking font you can specify
1595# the font name using DOT_FONTNAME. You need to make sure dot is able to find
1596# the font, which can be done by putting it in a standard location or by setting
1597# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1598# directory containing the font.
1599
1600DOT_FONTNAME = Helvetica
1601
1602# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1603# The default size is 10pt.
1604
1605DOT_FONTSIZE = 10
1606
1607# By default doxygen will tell dot to use the Helvetica font.
1608# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1609# set the path where dot can find it.
1610
1611DOT_FONTPATH =
1612
1613# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1614# will generate a graph for each documented class showing the direct and
1615# indirect inheritance relations. Setting this tag to YES will force the
Alexandre Lision51140e12013-12-02 10:54:09 -05001616# the CLASS_DIAGRAMS tag to NO.
1617
1618CLASS_GRAPH = YES
1619
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001620# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1621# will generate a graph for each documented class showing the direct and
1622# indirect implementation dependencies (inheritance, containment, and
Alexandre Lision51140e12013-12-02 10:54:09 -05001623# class references variables) of the class with other documented classes.
1624
1625COLLABORATION_GRAPH = YES
1626
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001627# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
Alexandre Lision51140e12013-12-02 10:54:09 -05001628# will generate a graph for groups, showing the direct groups dependencies
1629
1630GROUP_GRAPHS = YES
1631
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001632# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1633# collaboration diagrams in a style similar to the OMG's Unified Modeling
Alexandre Lision51140e12013-12-02 10:54:09 -05001634# Language.
1635
1636UML_LOOK = YES
1637
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001638# If set to YES, the inheritance and collaboration graphs will show the
Alexandre Lision51140e12013-12-02 10:54:09 -05001639# relations between templates and their instances.
1640
1641TEMPLATE_RELATIONS = YES
1642
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001643# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1644# tags are set to YES then doxygen will generate a graph for each documented
1645# file showing the direct and indirect include dependencies of the file with
Alexandre Lision51140e12013-12-02 10:54:09 -05001646# other documented files.
1647
1648INCLUDE_GRAPH = YES
1649
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001650# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1651# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1652# documented header file showing the documented files that directly or
Alexandre Lision51140e12013-12-02 10:54:09 -05001653# indirectly include this file.
1654
1655INCLUDED_BY_GRAPH = YES
1656
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001657# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1658# doxygen will generate a call dependency graph for every global function
1659# or class method. Note that enabling this option will significantly increase
1660# the time of a run. So in most cases it will be better to enable call graphs
1661# for selected functions only using the \callgraph command.
Alexandre Lision51140e12013-12-02 10:54:09 -05001662
1663CALL_GRAPH = NO
1664
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001665# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1666# doxygen will generate a caller dependency graph for every global function
1667# or class method. Note that enabling this option will significantly increase
1668# the time of a run. So in most cases it will be better to enable caller
1669# graphs for selected functions only using the \callergraph command.
Alexandre Lision51140e12013-12-02 10:54:09 -05001670
1671CALLER_GRAPH = NO
1672
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001673# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1674# will generate a graphical hierarchy of all classes instead of a textual one.
Alexandre Lision51140e12013-12-02 10:54:09 -05001675
1676GRAPHICAL_HIERARCHY = YES
1677
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001678# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1679# then doxygen will show the dependencies a directory has on other directories
Alexandre Lision51140e12013-12-02 10:54:09 -05001680# in a graphical way. The dependency relations are determined by the #include
1681# relations between the files in the directories.
1682
1683DIRECTORY_GRAPH = YES
1684
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001685# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1686# generated by dot. Possible values are svg, png, jpg, or gif.
1687# If left blank png will be used. If you choose svg you need to set
1688# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1689# visible in IE 9+ (other browsers do not have this requirement).
Alexandre Lision51140e12013-12-02 10:54:09 -05001690
1691DOT_IMAGE_FORMAT = png
1692
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001693# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1694# enable generation of interactive SVG images that allow zooming and panning.
1695# Note that this requires a modern browser other than Internet Explorer.
1696# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1697# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1698# visible. Older versions of IE do not have SVG support.
1699
1700INTERACTIVE_SVG = NO
1701
1702# The tag DOT_PATH can be used to specify the path where the dot tool can be
Alexandre Lision51140e12013-12-02 10:54:09 -05001703# found. If left blank, it is assumed the dot tool can be found in the path.
1704
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001705DOT_PATH =
Alexandre Lision51140e12013-12-02 10:54:09 -05001706
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001707# The DOTFILE_DIRS tag can be used to specify one or more directories that
1708# contain dot files that are included in the documentation (see the
Alexandre Lision51140e12013-12-02 10:54:09 -05001709# \dotfile command).
1710
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001711DOTFILE_DIRS =
Alexandre Lision51140e12013-12-02 10:54:09 -05001712
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001713# The MSCFILE_DIRS tag can be used to specify one or more directories that
1714# contain msc files that are included in the documentation (see the
1715# \mscfile command).
1716
1717MSCFILE_DIRS =
1718
1719# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1720# nodes that will be shown in the graph. If the number of nodes in a graph
1721# becomes larger than this value, doxygen will truncate the graph, which is
1722# visualized by representing a node as a red box. Note that doxygen if the
1723# number of direct children of the root node in a graph is already larger than
1724# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
Alexandre Lision51140e12013-12-02 10:54:09 -05001725# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1726
1727DOT_GRAPH_MAX_NODES = 50
1728
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001729# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1730# graphs generated by dot. A depth value of 3 means that only nodes reachable
1731# from the root by following a path via at most 3 edges will be shown. Nodes
1732# that lay further from the root node will be omitted. Note that setting this
1733# option to 1 or 2 may greatly reduce the computation time needed for large
1734# code bases. Also note that the size of a graph can be further restricted by
Alexandre Lision51140e12013-12-02 10:54:09 -05001735# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1736
1737MAX_DOT_GRAPH_DEPTH = 0
1738
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001739# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1740# background. This is disabled by default, because dot on Windows does not
1741# seem to support this out of the box. Warning: Depending on the platform used,
1742# enabling this option may lead to badly anti-aliased labels on the edges of
1743# a graph (i.e. they become hard to read).
Alexandre Lision51140e12013-12-02 10:54:09 -05001744
1745DOT_TRANSPARENT = NO
1746
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001747# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1748# files in one run (i.e. multiple -o and -T options on the command line). This
1749# makes dot run faster, but since only newer versions of dot (>1.8.10)
Alexandre Lision51140e12013-12-02 10:54:09 -05001750# support this, this feature is disabled by default.
1751
1752DOT_MULTI_TARGETS = NO
1753
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001754# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1755# generate a legend page explaining the meaning of the various boxes and
Alexandre Lision51140e12013-12-02 10:54:09 -05001756# arrows in the dot generated graphs.
1757
1758GENERATE_LEGEND = YES
1759
Alexandre Lision7fd5d3d2013-12-04 13:06:40 -05001760# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1761# remove the intermediate dot files that are used to generate
Alexandre Lision51140e12013-12-02 10:54:09 -05001762# the various graphs.
1763
1764DOT_CLEANUP = YES