blob: 48861d2385f7cbb32ff19195b0a347bc35ed231b [file] [log] [blame]
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001# Doxyfile 1.5.9
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project
5#
6# All text after a hash (#) is considered a comment and will be ignored
7# The format is:
8# TAG = value [value, ...]
9# For lists items can also be appended using:
10# TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ")
Christopher Dunne0d72242007-06-14 17:58:59 +000012
13#---------------------------------------------------------------------------
14# Project related configuration options
15#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000016
17# 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.
22
23DOXYFILE_ENCODING = UTF-8
24
25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26# by quotes) that should identify the project.
27
Baptiste Lepilleur35503e52010-02-22 04:37:31 +000028PROJECT_NAME = "JsonCpp"
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000029
30# The PROJECT_NUMBER tag can be used to enter a project or revision number.
31# This could be handy for archiving the generated documentation or
32# if some version control system is used.
33
Baptiste Lepilleur35503e52010-02-22 04:37:31 +000034PROJECT_NUMBER = %JSONCPP_VERSION%
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000035
36# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37# base path where the generated documentation will be put.
38# If a relative path is entered, it will be relative to the location
39# where doxygen was started. If left blank the current directory will be used.
40
Christopher Dunne0d72242007-06-14 17:58:59 +000041OUTPUT_DIRECTORY = %DOC_TOPDIR%
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000042
43# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44# 4096 sub-directories (in 2 levels) under the output directory of each output
45# format and will distribute the generated files over these directories.
46# Enabling this option can be useful when feeding doxygen a huge amount of
47# source files, where putting all generated files in the same directory would
48# otherwise cause performance problems for the file system.
49
Christopher Dunne0d72242007-06-14 17:58:59 +000050CREATE_SUBDIRS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000051
52# The OUTPUT_LANGUAGE tag is used to specify the language in which all
53# documentation generated by doxygen is written. Doxygen will use this
54# information to generate all constant output in the proper language.
55# The default language is English, other supported languages are:
56# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
58# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
62
Christopher Dunne0d72242007-06-14 17:58:59 +000063OUTPUT_LANGUAGE = English
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000064
65# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66# include brief member descriptions after the members that are listed in
67# the file and class documentation (similar to JavaDoc).
68# Set to NO to disable this.
69
Christopher Dunne0d72242007-06-14 17:58:59 +000070BRIEF_MEMBER_DESC = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000071
72# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73# the brief description of a member or function before the detailed description.
74# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75# brief descriptions will be completely suppressed.
76
Christopher Dunne0d72242007-06-14 17:58:59 +000077REPEAT_BRIEF = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +000078
79# This tag implements a quasi-intelligent brief description abbreviator
80# that is used to form the text in various listings. Each string
81# in this list, if found as the leading text of the brief description, will be
82# stripped from the text and the result after processing the whole list, is
83# used as the annotated text. Otherwise, the brief description is used as-is.
84# If left blank, the following values are used ("$name" is automatically
85# replaced with the name of the entity): "The $name class" "The $name widget"
86# "The $name file" "is" "provides" "specifies" "contains"
87# "represents" "a" "an" "the"
88
Christopher Dunne0d72242007-06-14 17:58:59 +000089ABBREVIATE_BRIEF = "The $name class" \
90 "The $name widget" \
91 "The $name file" \
92 is \
93 provides \
94 specifies \
95 contains \
96 represents \
97 a \
98 an \
99 the
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000100
101# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
102# Doxygen will generate a detailed section even if there is only a brief
103# description.
104
Christopher Dunne0d72242007-06-14 17:58:59 +0000105ALWAYS_DETAILED_SEC = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000106
107# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
108# inherited members of a class in the documentation of that class as if those
109# members were ordinary class members. Constructors, destructors and assignment
110# operators of the base classes will not be shown.
111
Christopher Dunne0d72242007-06-14 17:58:59 +0000112INLINE_INHERITED_MEMB = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000113
114# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
115# path before files name in the file list and in the header files. If set
116# to NO the shortest path that makes the file name unique will be used.
117
Christopher Dunne0d72242007-06-14 17:58:59 +0000118FULL_PATH_NAMES = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000119
120# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
121# can be used to strip a user-defined part of the path. Stripping is
122# only done if one of the specified strings matches the left-hand part of
123# the path. The tag can be used to show relative paths in the file list.
124# If left blank the directory from which doxygen is run is used as the
125# path to strip.
126
Christopher Dunne0d72242007-06-14 17:58:59 +0000127STRIP_FROM_PATH = %TOPDIR%
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000128
129# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
130# the path mentioned in the documentation of a class, which tells
131# the reader which header file to include in order to use a class.
132# If left blank only the name of the header file containing the class
133# definition is used. Otherwise one should specify the include paths that
134# are normally passed to the compiler using the -I flag.
135
Christopher Dunne0d72242007-06-14 17:58:59 +0000136STRIP_FROM_INC_PATH = %TOPDIR%/include
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000137
138# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
139# (but less readable) file names. This can be useful is your file systems
140# doesn't support long names like on DOS, Mac, or CD-ROM.
141
Christopher Dunne0d72242007-06-14 17:58:59 +0000142SHORT_NAMES = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000143
144# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
145# will interpret the first line (until the first dot) of a JavaDoc-style
146# comment as the brief description. If set to NO, the JavaDoc
147# comments will behave just like regular Qt-style comments
148# (thus requiring an explicit @brief command for a brief description.)
149
150JAVADOC_AUTOBRIEF = YES
151
152# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
153# interpret the first line (until the first dot) of a Qt-style
154# comment as the brief description. If set to NO, the comments
155# will behave just like regular Qt-style comments (thus requiring
156# an explicit \brief command for a brief description.)
157
158QT_AUTOBRIEF = NO
159
160# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
161# treat a multi-line C++ special comment block (i.e. a block of //! or ///
162# comments) as a brief description. This used to be the default behaviour.
163# The new default is to treat a multi-line C++ comment block as a detailed
164# description. Set this tag to YES if you prefer the old behaviour instead.
165
Christopher Dunne0d72242007-06-14 17:58:59 +0000166MULTILINE_CPP_IS_BRIEF = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000167
168# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
169# member inherits the documentation from any documented member that it
170# re-implements.
171
Christopher Dunne0d72242007-06-14 17:58:59 +0000172INHERIT_DOCS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000173
174# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
175# a new page for each member. If set to NO, the documentation of a member will
176# be part of the file/class/namespace that contains it.
177
Christopher Dunne0d72242007-06-14 17:58:59 +0000178SEPARATE_MEMBER_PAGES = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000179
180# The TAB_SIZE tag can be used to set the number of spaces in a tab.
181# Doxygen uses this value to replace tabs by spaces in code fragments.
182
Christopher Dunne0d72242007-06-14 17:58:59 +0000183TAB_SIZE = 3
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000184
185# This tag can be used to specify a number of aliases that acts
186# as commands in the documentation. An alias has the form "name=value".
187# For example adding "sideeffect=\par Side Effects:\n" will allow you to
188# put the command \sideeffect (or @sideeffect) in the documentation, which
189# will result in a user-defined paragraph with heading "Side Effects:".
190# You can put \n's in the value part of an alias to insert newlines.
191
192ALIASES = "testCaseSetup=\link CppUT::TestCase::setUp() setUp()\endlink" \
193 "testCaseRun=\link CppUT::TestCase::run() run()\endlink" \
194 "testCaseTearDown=\link CppUT::TestCase::tearDown() tearDown()\endlink" \
195 "json_ref=<a HREF='http://www.json.org/'>JSON (JavaScript Object Notation)</a>"
196
197# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
198# sources only. Doxygen will then generate output that is more tailored for C.
199# For instance, some of the names that are used will be different. The list
200# of all members will be omitted, etc.
201
Christopher Dunne0d72242007-06-14 17:58:59 +0000202OPTIMIZE_OUTPUT_FOR_C = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000203
204# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
205# sources only. Doxygen will then generate output that is more tailored for
206# Java. For instance, namespaces will be presented as packages, qualified
207# scopes will look different, etc.
208
Christopher Dunne0d72242007-06-14 17:58:59 +0000209OPTIMIZE_OUTPUT_JAVA = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000210
211# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
212# sources only. Doxygen will then generate output that is more tailored for
213# Fortran.
214
215OPTIMIZE_FOR_FORTRAN = NO
216
217# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
218# sources. Doxygen will then generate output that is tailored for
219# VHDL.
220
221OPTIMIZE_OUTPUT_VHDL = NO
222
223# Doxygen selects the parser to use depending on the extension of the files it parses.
224# With this tag you can assign which parser to use for a given extension.
225# Doxygen has a built-in mapping, but you can override or extend it using this tag.
226# The format is ext=language, where ext is a file extension, and language is one of
227# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
228# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
229# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
230# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
231
232EXTENSION_MAPPING =
233
234# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
235# to include (a tag file for) the STL sources as input, then you should
236# set this tag to YES in order to let doxygen match functions declarations and
237# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
238# func(std::string) {}). This also make the inheritance and collaboration
239# diagrams that involve STL classes more complete and accurate.
240
241BUILTIN_STL_SUPPORT = YES
242
243# If you use Microsoft's C++/CLI language, you should set this option to YES to
244# enable parsing support.
245
246CPP_CLI_SUPPORT = NO
247
248# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
249# Doxygen will parse them like normal C++ but will assume all classes use public
250# instead of private inheritance when no explicit protection keyword is present.
251
252SIP_SUPPORT = NO
253
254# For Microsoft's IDL there are propget and propput attributes to indicate getter
255# and setter methods for a property. Setting this option to YES (the default)
256# will make doxygen to replace the get and set methods by a property in the
257# documentation. This will only work if the methods are indeed getting or
258# setting a simple type. If this is not the case, or you want to show the
259# methods anyway, you should set this option to NO.
260
261IDL_PROPERTY_SUPPORT = YES
262
263# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
264# tag is set to YES, then doxygen will reuse the documentation of the first
265# member in the group (if any) for the other members of the group. By default
266# all members of a group must be documented explicitly.
267
268DISTRIBUTE_GROUP_DOC = NO
269
270# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
271# the same type (for instance a group of public functions) to be put as a
272# subgroup of that type (e.g. under the Public Functions section). Set it to
273# NO to prevent subgrouping. Alternatively, this can be done per class using
274# the \nosubgrouping command.
275
Christopher Dunne0d72242007-06-14 17:58:59 +0000276SUBGROUPING = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000277
278# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
279# is documented as struct, union, or enum with the name of the typedef. So
280# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
281# with name TypeT. When disabled the typedef will appear as a member of a file,
282# namespace, or class. And the struct will be named TypeS. This can typically
283# be useful for C code in case the coding convention dictates that all compound
284# types are typedef'ed and only the typedef is referenced, never the tag name.
285
286TYPEDEF_HIDES_STRUCT = NO
287
288# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
289# determine which symbols to keep in memory and which to flush to disk.
290# When the cache is full, less often used symbols will be written to disk.
291# For small to medium size projects (<1000 input files) the default value is
292# probably good enough. For larger projects a too small cache size can cause
293# doxygen to be busy swapping symbols to and from disk most of the time
294# causing a significant performance penality.
295# If the system has enough physical memory increasing the cache will improve the
296# performance by keeping more symbols in memory. Note that the value works on
297# a logarithmic scale so increasing the size by one will rougly double the
298# memory usage. The cache size is given by this formula:
299# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
300# corresponding to a cache size of 2^16 = 65536 symbols
301
302SYMBOL_CACHE_SIZE = 0
303
Christopher Dunne0d72242007-06-14 17:58:59 +0000304#---------------------------------------------------------------------------
305# Build related configuration options
306#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000307
308# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
309# documentation are documented, even if no documentation was available.
310# Private class members and static file members will be hidden unless
311# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
312
Christopher Dunne0d72242007-06-14 17:58:59 +0000313EXTRACT_ALL = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000314
315# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
316# will be included in the documentation.
317
Christopher Dunne0d72242007-06-14 17:58:59 +0000318EXTRACT_PRIVATE = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000319
320# If the EXTRACT_STATIC tag is set to YES all static members of a file
321# will be included in the documentation.
322
Christopher Dunne0d72242007-06-14 17:58:59 +0000323EXTRACT_STATIC = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000324
325# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
326# defined locally in source files will be included in the documentation.
327# If set to NO only classes defined in header files are included.
328
Christopher Dunne0d72242007-06-14 17:58:59 +0000329EXTRACT_LOCAL_CLASSES = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000330
331# This flag is only useful for Objective-C code. When set to YES local
332# methods, which are defined in the implementation section but not in
333# the interface are included in the documentation.
334# If set to NO (the default) only methods in the interface are included.
335
Christopher Dunne0d72242007-06-14 17:58:59 +0000336EXTRACT_LOCAL_METHODS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000337
338# If this flag is set to YES, the members of anonymous namespaces will be
339# extracted and appear in the documentation as a namespace called
340# 'anonymous_namespace{file}', where file will be replaced with the base
341# name of the file that contains the anonymous namespace. By default
342# anonymous namespace are hidden.
343
344EXTRACT_ANON_NSPACES = NO
345
346# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
347# undocumented members of documented classes, files or namespaces.
348# If set to NO (the default) these members will be included in the
349# various overviews, but no documentation section is generated.
350# This option has no effect if EXTRACT_ALL is enabled.
351
Christopher Dunne0d72242007-06-14 17:58:59 +0000352HIDE_UNDOC_MEMBERS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000353
354# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
355# undocumented classes that are normally visible in the class hierarchy.
356# If set to NO (the default) these classes will be included in the various
357# overviews. This option has no effect if EXTRACT_ALL is enabled.
358
Christopher Dunne0d72242007-06-14 17:58:59 +0000359HIDE_UNDOC_CLASSES = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000360
361# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
362# friend (class|struct|union) declarations.
363# If set to NO (the default) these declarations will be included in the
364# documentation.
365
Christopher Dunne0d72242007-06-14 17:58:59 +0000366HIDE_FRIEND_COMPOUNDS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000367
368# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
369# documentation blocks found inside the body of a function.
370# If set to NO (the default) these blocks will be appended to the
371# function's detailed documentation block.
372
Christopher Dunne0d72242007-06-14 17:58:59 +0000373HIDE_IN_BODY_DOCS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000374
375# The INTERNAL_DOCS tag determines if documentation
376# that is typed after a \internal command is included. If the tag is set
377# to NO (the default) then the documentation will be excluded.
378# Set it to YES to include the internal documentation.
379
Christopher Dunne0d72242007-06-14 17:58:59 +0000380INTERNAL_DOCS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000381
382# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
383# file names in lower-case letters. If set to YES upper-case letters are also
384# allowed. This is useful if you have classes or files whose names only differ
385# in case and if your file system supports case sensitive file names. Windows
386# and Mac users are advised to set this option to NO.
387
Christopher Dunne0d72242007-06-14 17:58:59 +0000388CASE_SENSE_NAMES = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000389
390# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
391# will show members with their full class and namespace scopes in the
392# documentation. If set to YES the scope will be hidden.
393
Christopher Dunne0d72242007-06-14 17:58:59 +0000394HIDE_SCOPE_NAMES = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000395
396# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
397# will put a list of the files that are included by a file in the documentation
398# of that file.
399
Christopher Dunne0d72242007-06-14 17:58:59 +0000400SHOW_INCLUDE_FILES = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000401
402# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
403# is inserted in the documentation for inline members.
404
Christopher Dunne0d72242007-06-14 17:58:59 +0000405INLINE_INFO = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000406
407# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
408# will sort the (detailed) documentation of file and class members
409# alphabetically by member name. If set to NO the members will appear in
410# declaration order.
411
Christopher Dunne0d72242007-06-14 17:58:59 +0000412SORT_MEMBER_DOCS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000413
414# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
415# brief documentation of file, namespace and class members alphabetically
416# by member name. If set to NO (the default) the members will appear in
417# declaration order.
418
Christopher Dunne0d72242007-06-14 17:58:59 +0000419SORT_BRIEF_DOCS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000420
421# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
422# hierarchy of group names into alphabetical order. If set to NO (the default)
423# the group names will appear in their defined order.
424
425SORT_GROUP_NAMES = NO
426
427# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
428# sorted by fully-qualified names, including namespaces. If set to
429# NO (the default), the class list will be sorted only by class name,
430# not including the namespace part.
431# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
432# Note: This option applies only to the class list, not to the
433# alphabetical list.
434
435SORT_BY_SCOPE_NAME = YES
436
437# The GENERATE_TODOLIST tag can be used to enable (YES) or
438# disable (NO) the todo list. This list is created by putting \todo
439# commands in the documentation.
440
Christopher Dunne0d72242007-06-14 17:58:59 +0000441GENERATE_TODOLIST = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000442
443# The GENERATE_TESTLIST tag can be used to enable (YES) or
444# disable (NO) the test list. This list is created by putting \test
445# commands in the documentation.
446
447GENERATE_TESTLIST = NO
448
449# The GENERATE_BUGLIST tag can be used to enable (YES) or
450# disable (NO) the bug list. This list is created by putting \bug
451# commands in the documentation.
452
453GENERATE_BUGLIST = NO
454
455# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
456# disable (NO) the deprecated list. This list is created by putting
457# \deprecated commands in the documentation.
458
Christopher Dunne0d72242007-06-14 17:58:59 +0000459GENERATE_DEPRECATEDLIST= YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000460
461# The ENABLED_SECTIONS tag can be used to enable conditional
462# documentation sections, marked by \if sectionname ... \endif.
463
Christopher Dunne0d72242007-06-14 17:58:59 +0000464ENABLED_SECTIONS =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000465
466# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
467# the initial value of a variable or define consists of for it to appear in
468# the documentation. If the initializer consists of more lines than specified
469# here it will be hidden. Use a value of 0 to hide initializers completely.
470# The appearance of the initializer of individual variables and defines in the
471# documentation can be controlled using \showinitializer or \hideinitializer
472# command in the documentation regardless of this setting.
473
Christopher Dunne0d72242007-06-14 17:58:59 +0000474MAX_INITIALIZER_LINES = 30
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000475
476# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
477# at the bottom of the documentation of classes and structs. If set to YES the
478# list will mention the files that were used to generate the documentation.
479
Christopher Dunne0d72242007-06-14 17:58:59 +0000480SHOW_USED_FILES = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000481
482# If the sources in your project are distributed over multiple directories
483# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
484# in the documentation. The default is NO.
485
Christopher Dunne0d72242007-06-14 17:58:59 +0000486SHOW_DIRECTORIES = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000487
488# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
489# This will remove the Files entry from the Quick Index and from the
490# Folder Tree View (if specified). The default is YES.
491
492SHOW_FILES = YES
493
494# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
495# Namespaces page.
496# This will remove the Namespaces entry from the Quick Index
497# and from the Folder Tree View (if specified). The default is YES.
498
499SHOW_NAMESPACES = YES
500
501# The FILE_VERSION_FILTER tag can be used to specify a program or script that
502# doxygen should invoke to get the current version for each file (typically from
503# the version control system). Doxygen will invoke the program by executing (via
504# popen()) the command <command> <input-file>, where <command> is the value of
505# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
506# provided by doxygen. Whatever the program writes to standard output
507# is used as the file version. See the manual for examples.
508
Christopher Dunne0d72242007-06-14 17:58:59 +0000509FILE_VERSION_FILTER =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000510
511# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
512# doxygen. The layout file controls the global structure of the generated output files
513# in an output format independent way. The create the layout file that represents
514# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
515# file name after the option, if omitted DoxygenLayout.xml will be used as the name
516# of the layout file.
517
518LAYOUT_FILE =
519
Christopher Dunne0d72242007-06-14 17:58:59 +0000520#---------------------------------------------------------------------------
521# configuration options related to warning and progress messages
522#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000523
524# The QUIET tag can be used to turn on/off the messages that are generated
525# by doxygen. Possible values are YES and NO. If left blank NO is used.
526
Christopher Dunne0d72242007-06-14 17:58:59 +0000527QUIET = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000528
529# The WARNINGS tag can be used to turn on/off the warning messages that are
530# generated by doxygen. Possible values are YES and NO. If left blank
531# NO is used.
532
Christopher Dunne0d72242007-06-14 17:58:59 +0000533WARNINGS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000534
535# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
536# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
537# automatically be disabled.
538
Christopher Dunne0d72242007-06-14 17:58:59 +0000539WARN_IF_UNDOCUMENTED = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000540
541# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
542# potential errors in the documentation, such as not documenting some
543# parameters in a documented function, or documenting parameters that
544# don't exist or using markup commands wrongly.
545
Christopher Dunne0d72242007-06-14 17:58:59 +0000546WARN_IF_DOC_ERROR = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000547
548# This WARN_NO_PARAMDOC option can be abled to get warnings for
549# functions that are documented, but have no documentation for their parameters
550# or return value. If set to NO (the default) doxygen will only warn about
551# wrong or incomplete parameter documentation, but not about the absence of
552# documentation.
553
Christopher Dunne0d72242007-06-14 17:58:59 +0000554WARN_NO_PARAMDOC = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000555
556# The WARN_FORMAT tag determines the format of the warning messages that
557# doxygen can produce. The string should contain the $file, $line, and $text
558# tags, which will be replaced by the file and line number from which the
559# warning originated and the warning text. Optionally the format may contain
560# $version, which will be replaced by the version of the file (if it could
561# be obtained via FILE_VERSION_FILTER)
562
Christopher Dunne0d72242007-06-14 17:58:59 +0000563WARN_FORMAT = "$file:$line: $text"
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000564
565# The WARN_LOGFILE tag can be used to specify a file to which warning
566# and error messages should be written. If left blank the output is written
567# to stderr.
568
569WARN_LOGFILE = %WARNING_LOG_PATH%
570
Christopher Dunne0d72242007-06-14 17:58:59 +0000571#---------------------------------------------------------------------------
572# configuration options related to the input files
573#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000574
575# The INPUT tag can be used to specify the files and/or directories that contain
576# documented source files. You may enter file names like "myfile.cpp" or
577# directories like "/usr/src/myproject". Separate the files or directories
578# with spaces.
579
Christopher Dunne0d72242007-06-14 17:58:59 +0000580INPUT = ../include ../src/lib_json .
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000581
582# This tag can be used to specify the character encoding of the source files
583# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
584# also the default input encoding. Doxygen uses libiconv (or the iconv built
585# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
586# the list of possible encodings.
587
588INPUT_ENCODING = UTF-8
589
590# If the value of the INPUT tag contains directories, you can use the
591# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
592# and *.h) to filter out the source-files in the directories. If left
593# blank the following patterns are tested:
594# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
595# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
596
597FILE_PATTERNS = *.h \
598 *.cpp \
599 *.inl \
600 *.dox
601
602# The RECURSIVE tag can be used to turn specify whether or not subdirectories
603# should be searched for input files as well. Possible values are YES and NO.
604# If left blank NO is used.
605
Christopher Dunne0d72242007-06-14 17:58:59 +0000606RECURSIVE = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000607
608# The EXCLUDE tag can be used to specify files and/or directories that should
609# excluded from the INPUT source files. This way you can easily exclude a
610# subdirectory from a directory tree whose root is specified with the INPUT tag.
611
Christopher Dunne0d72242007-06-14 17:58:59 +0000612EXCLUDE =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000613
614# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
615# directories that are symbolic links (a Unix filesystem feature) are excluded
616# from the input.
617
Christopher Dunne0d72242007-06-14 17:58:59 +0000618EXCLUDE_SYMLINKS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000619
620# If the value of the INPUT tag contains directories, you can use the
621# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
622# certain files from those directories. Note that the wildcards are matched
623# against the file with absolute path, so to exclude all test directories
624# for example use the pattern */test/*
625
Christopher Dunne0d72242007-06-14 17:58:59 +0000626EXCLUDE_PATTERNS =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000627
628# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
629# (namespaces, classes, functions, etc.) that should be excluded from the
630# output. The symbol name can be a fully qualified name, a word, or if the
631# wildcard * is used, a substring. Examples: ANamespace, AClass,
632# AClass::ANamespace, ANamespace::*Test
633
634EXCLUDE_SYMBOLS =
635
636# The EXAMPLE_PATH tag can be used to specify one or more files or
637# directories that contain example code fragments that are included (see
638# the \include command).
639
Christopher Dunne0d72242007-06-14 17:58:59 +0000640EXAMPLE_PATH =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000641
642# If the value of the EXAMPLE_PATH tag contains directories, you can use the
643# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
644# and *.h) to filter out the source-files in the directories. If left
645# blank all files are included.
646
Christopher Dunne0d72242007-06-14 17:58:59 +0000647EXAMPLE_PATTERNS = *
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000648
649# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
650# searched for input files to be used with the \include or \dontinclude
651# commands irrespective of the value of the RECURSIVE tag.
652# Possible values are YES and NO. If left blank NO is used.
653
Christopher Dunne0d72242007-06-14 17:58:59 +0000654EXAMPLE_RECURSIVE = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000655
656# The IMAGE_PATH tag can be used to specify one or more files or
657# directories that contain image that are included in the documentation (see
658# the \image command).
659
Christopher Dunne0d72242007-06-14 17:58:59 +0000660IMAGE_PATH =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000661
662# The INPUT_FILTER tag can be used to specify a program that doxygen should
663# invoke to filter for each input file. Doxygen will invoke the filter program
664# by executing (via popen()) the command <filter> <input-file>, where <filter>
665# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
666# input file. Doxygen will then use the output that the filter program writes
667# to standard output.
668# If FILTER_PATTERNS is specified, this tag will be
669# ignored.
670
Christopher Dunne0d72242007-06-14 17:58:59 +0000671INPUT_FILTER =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000672
673# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
674# basis.
675# Doxygen will compare the file name with each pattern and apply the
676# filter if there is a match.
677# The filters are a list of the form:
678# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
679# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
680# is applied to all files.
681
Christopher Dunne0d72242007-06-14 17:58:59 +0000682FILTER_PATTERNS =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000683
684# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
685# INPUT_FILTER) will be used to filter the input files when producing source
686# files to browse (i.e. when SOURCE_BROWSER is set to YES).
687
Christopher Dunne0d72242007-06-14 17:58:59 +0000688FILTER_SOURCE_FILES = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000689
Christopher Dunne0d72242007-06-14 17:58:59 +0000690#---------------------------------------------------------------------------
691# configuration options related to source browsing
692#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000693
694# If the SOURCE_BROWSER tag is set to YES then a list of source files will
695# be generated. Documented entities will be cross-referenced with these sources.
696# Note: To get rid of all source code in the generated output, make sure also
697# VERBATIM_HEADERS is set to NO.
698
Christopher Dunne0d72242007-06-14 17:58:59 +0000699SOURCE_BROWSER = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000700
701# Setting the INLINE_SOURCES tag to YES will include the body
702# of functions and classes directly in the documentation.
703
Christopher Dunne0d72242007-06-14 17:58:59 +0000704INLINE_SOURCES = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000705
706# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
707# doxygen to hide any special comment blocks from generated source code
708# fragments. Normal C and C++ comments will always remain visible.
709
Christopher Dunne0d72242007-06-14 17:58:59 +0000710STRIP_CODE_COMMENTS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000711
712# If the REFERENCED_BY_RELATION tag is set to YES
713# then for each documented function all documented
714# functions referencing it will be listed.
715
Christopher Dunne0d72242007-06-14 17:58:59 +0000716REFERENCED_BY_RELATION = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000717
718# If the REFERENCES_RELATION tag is set to YES
719# then for each documented function all documented entities
720# called/used by that function will be listed.
721
Christopher Dunne0d72242007-06-14 17:58:59 +0000722REFERENCES_RELATION = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000723
724# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
725# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
726# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
727# link to the source code.
728# Otherwise they will link to the documentation.
729
730REFERENCES_LINK_SOURCE = YES
731
732# If the USE_HTAGS tag is set to YES then the references to source code
733# will point to the HTML generated by the htags(1) tool instead of doxygen
734# built-in source browser. The htags tool is part of GNU's global source
735# tagging system (see http://www.gnu.org/software/global/global.html). You
736# will need version 4.8.6 or higher.
737
Christopher Dunne0d72242007-06-14 17:58:59 +0000738USE_HTAGS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000739
740# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
741# will generate a verbatim copy of the header file for each class for
742# which an include is specified. Set to NO to disable this.
743
Christopher Dunne0d72242007-06-14 17:58:59 +0000744VERBATIM_HEADERS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000745
Christopher Dunne0d72242007-06-14 17:58:59 +0000746#---------------------------------------------------------------------------
747# configuration options related to the alphabetical class index
748#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000749
750# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
751# of all compounds will be generated. Enable this if the project
752# contains a lot of classes, structs, unions or interfaces.
753
Christopher Dunne0d72242007-06-14 17:58:59 +0000754ALPHABETICAL_INDEX = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000755
756# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
757# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
758# in which this list will be split (can be a number in the range [1..20])
759
Christopher Dunne0d72242007-06-14 17:58:59 +0000760COLS_IN_ALPHA_INDEX = 5
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000761
762# In case all classes in a project start with a common prefix, all
763# classes will be put under the same header in the alphabetical index.
764# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
765# should be ignored while generating the index headers.
766
Christopher Dunne0d72242007-06-14 17:58:59 +0000767IGNORE_PREFIX =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000768
Christopher Dunne0d72242007-06-14 17:58:59 +0000769#---------------------------------------------------------------------------
770# configuration options related to the HTML output
771#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000772
773# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
774# generate HTML output.
775
Christopher Dunne0d72242007-06-14 17:58:59 +0000776GENERATE_HTML = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000777
778# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
779# If a relative path is entered the value of OUTPUT_DIRECTORY will be
780# put in front of it. If left blank `html' will be used as the default path.
781
782HTML_OUTPUT = %HTML_OUTPUT%
783
784# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
785# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
786# doxygen will generate files with .html extension.
787
Christopher Dunne0d72242007-06-14 17:58:59 +0000788HTML_FILE_EXTENSION = .html
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000789
790# The HTML_HEADER tag can be used to specify a personal HTML header for
791# each generated HTML page. If it is left blank doxygen will generate a
792# standard header.
793
Christopher Dunne0d72242007-06-14 17:58:59 +0000794HTML_HEADER = header.html
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000795
796# The HTML_FOOTER tag can be used to specify a personal HTML footer for
797# each generated HTML page. If it is left blank doxygen will generate a
798# standard footer.
799
Christopher Dunne0d72242007-06-14 17:58:59 +0000800HTML_FOOTER = footer.html
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000801
802# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
803# style sheet that is used by each HTML page. It can be used to
804# fine-tune the look of the HTML output. If the tag is left blank doxygen
805# will generate a default style sheet. Note that doxygen will try to copy
806# the style sheet file to the HTML output directory, so don't put your own
807# stylesheet in the HTML output directory as well, or it will be erased!
808
Christopher Dunne0d72242007-06-14 17:58:59 +0000809HTML_STYLESHEET =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000810
811# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
812# files or namespaces will be aligned in HTML using tables. If set to
813# NO a bullet list will be used.
814
Christopher Dunne0d72242007-06-14 17:58:59 +0000815HTML_ALIGN_MEMBERS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000816
817# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
818# documentation will contain sections that can be hidden and shown after the
819# page has loaded. For this to work a browser that supports
820# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
821# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
822
823HTML_DYNAMIC_SECTIONS = YES
824
825# If the GENERATE_DOCSET tag is set to YES, additional index files
826# will be generated that can be used as input for Apple's Xcode 3
827# integrated development environment, introduced with OSX 10.5 (Leopard).
828# To create a documentation set, doxygen will generate a Makefile in the
829# HTML output directory. Running make will produce the docset in that
830# directory and running "make install" will install the docset in
831# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
832# it at startup.
833# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
834
835GENERATE_DOCSET = NO
836
837# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
838# feed. A documentation feed provides an umbrella under which multiple
839# documentation sets from a single provider (such as a company or product suite)
840# can be grouped.
841
842DOCSET_FEEDNAME = "Doxygen generated docs"
843
844# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
845# should uniquely identify the documentation set bundle. This should be a
846# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
847# will append .docset to the name.
848
849DOCSET_BUNDLE_ID = org.doxygen.Project
850
851# If the GENERATE_HTMLHELP tag is set to YES, additional index files
852# will be generated that can be used as input for tools like the
853# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
854# of the generated HTML documentation.
855
856GENERATE_HTMLHELP = %HTML_HELP%
857
858# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
859# be used to specify the file name of the resulting .chm file. You
860# can add a path in front of the file if the result should not be
861# written to the html output directory.
862
863CHM_FILE = jsoncpp-%JSONCPP_VERSION%.chm
864
865# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
866# be used to specify the location (absolute path including file name) of
867# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
868# the HTML help compiler on the generated index.hhp.
869
870HHC_LOCATION = "c:\Program Files\HTML Help Workshop\hhc.exe"
871
872# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
873# controls if a separate .chi index file is generated (YES) or that
874# it should be included in the master .chm file (NO).
875
876GENERATE_CHI = YES
877
878# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
879# is used to encode HtmlHelp index (hhk), content (hhc) and project file
880# content.
881
882CHM_INDEX_ENCODING =
883
884# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
885# controls whether a binary table of contents is generated (YES) or a
886# normal table of contents (NO) in the .chm file.
887
888BINARY_TOC = YES
889
890# The TOC_EXPAND flag can be set to YES to add extra items for group members
891# to the contents of the HTML help documentation and to the tree view.
892
893TOC_EXPAND = YES
894
895# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
896# are set, an additional index file will be generated that can be used as input for
897# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
898# HTML documentation.
899
900GENERATE_QHP = NO
901
902# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
903# be used to specify the file name of the resulting .qch file.
904# The path specified is relative to the HTML output folder.
905
906QCH_FILE =
907
908# The QHP_NAMESPACE tag specifies the namespace to use when generating
909# Qt Help Project output. For more information please see
910# http://doc.trolltech.com/qthelpproject.html#namespace
911
912QHP_NAMESPACE =
913
914# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
915# Qt Help Project output. For more information please see
916# http://doc.trolltech.com/qthelpproject.html#virtual-folders
917
918QHP_VIRTUAL_FOLDER = doc
919
920# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
921# For more information please see
922# http://doc.trolltech.com/qthelpproject.html#custom-filters
923
924QHP_CUST_FILTER_NAME =
925
926# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
927# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
928
929QHP_CUST_FILTER_ATTRS =
930
931# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
932# filter section matches.
933# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
934
935QHP_SECT_FILTER_ATTRS =
936
937# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
938# be used to specify the location of Qt's qhelpgenerator.
939# If non-empty doxygen will try to run qhelpgenerator on the generated
940# .qhp file.
941
942QHG_LOCATION =
943
944# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
945# top of each HTML page. The value NO (the default) enables the index and
946# the value YES disables it.
947
Christopher Dunne0d72242007-06-14 17:58:59 +0000948DISABLE_INDEX = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000949
950# This tag can be used to set the number of enum values (range [1..20])
951# that doxygen will group on one line in the generated HTML documentation.
952
Christopher Dunne0d72242007-06-14 17:58:59 +0000953ENUM_VALUES_PER_LINE = 4
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000954
955# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
956# structure should be generated to display hierarchical information.
957# If the tag value is set to FRAME, a side panel will be generated
958# containing a tree-like index structure (just like the one that
959# is generated for HTML Help). For this to work a browser that supports
960# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
961# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
962# probably better off using the HTML help feature. Other possible values
963# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
964# and Class Hierarchy pages using a tree view instead of an ordered list;
965# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
966# disables this behavior completely. For backwards compatibility with previous
967# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
968# respectively.
969
Christopher Dunne0d72242007-06-14 17:58:59 +0000970GENERATE_TREEVIEW = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000971
972# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
973# used to set the initial width (in pixels) of the frame in which the tree
974# is shown.
975
Christopher Dunne0d72242007-06-14 17:58:59 +0000976TREEVIEW_WIDTH = 250
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000977
978# Use this tag to change the font size of Latex formulas included
979# as images in the HTML documentation. The default is 10. Note that
980# when you change the font size after a successful doxygen run you need
981# to manually remove any form_*.png images from the HTML output directory
982# to force them to be regenerated.
983
984FORMULA_FONTSIZE = 10
985
Christopher Dunne0d72242007-06-14 17:58:59 +0000986#---------------------------------------------------------------------------
987# configuration options related to the LaTeX output
988#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000989
990# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
991# generate Latex output.
992
Christopher Dunne0d72242007-06-14 17:58:59 +0000993GENERATE_LATEX = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +0000994
995# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
996# If a relative path is entered the value of OUTPUT_DIRECTORY will be
997# put in front of it. If left blank `latex' will be used as the default path.
998
Christopher Dunne0d72242007-06-14 17:58:59 +0000999LATEX_OUTPUT = latex
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001000
1001# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1002# invoked. If left blank `latex' will be used as the default command name.
1003
Christopher Dunne0d72242007-06-14 17:58:59 +00001004LATEX_CMD_NAME = latex
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001005
1006# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1007# generate index for LaTeX. If left blank `makeindex' will be used as the
1008# default command name.
1009
Christopher Dunne0d72242007-06-14 17:58:59 +00001010MAKEINDEX_CMD_NAME = makeindex
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001011
1012# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1013# LaTeX documents. This may be useful for small projects and may help to
1014# save some trees in general.
1015
Christopher Dunne0d72242007-06-14 17:58:59 +00001016COMPACT_LATEX = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001017
1018# The PAPER_TYPE tag can be used to set the paper type that is used
1019# by the printer. Possible values are: a4, a4wide, letter, legal and
1020# executive. If left blank a4wide will be used.
1021
Christopher Dunne0d72242007-06-14 17:58:59 +00001022PAPER_TYPE = a4wide
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001023
1024# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1025# packages that should be included in the LaTeX output.
1026
Christopher Dunne0d72242007-06-14 17:58:59 +00001027EXTRA_PACKAGES =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001028
1029# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1030# the generated latex document. The header should contain everything until
1031# the first chapter. If it is left blank doxygen will generate a
1032# standard header. Notice: only use this tag if you know what you are doing!
1033
Christopher Dunne0d72242007-06-14 17:58:59 +00001034LATEX_HEADER =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001035
1036# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1037# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1038# contain links (just like the HTML output) instead of page references
1039# This makes the output suitable for online browsing using a pdf viewer.
1040
Christopher Dunne0d72242007-06-14 17:58:59 +00001041PDF_HYPERLINKS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001042
1043# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1044# plain latex in the generated Makefile. Set this option to YES to get a
1045# higher quality PDF documentation.
1046
Christopher Dunne0d72242007-06-14 17:58:59 +00001047USE_PDFLATEX = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001048
1049# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1050# command to the generated LaTeX files. This will instruct LaTeX to keep
1051# running if errors occur, instead of asking the user for help.
1052# This option is also used when generating formulas in HTML.
1053
Christopher Dunne0d72242007-06-14 17:58:59 +00001054LATEX_BATCHMODE = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001055
1056# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1057# include the index chapters (such as File Index, Compound Index, etc.)
1058# in the output.
1059
Christopher Dunne0d72242007-06-14 17:58:59 +00001060LATEX_HIDE_INDICES = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001061
1062# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
1063
1064LATEX_SOURCE_CODE = NO
1065
Christopher Dunne0d72242007-06-14 17:58:59 +00001066#---------------------------------------------------------------------------
1067# configuration options related to the RTF output
1068#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001069
1070# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1071# The RTF output is optimized for Word 97 and may not look very pretty with
1072# other RTF readers or editors.
1073
Christopher Dunne0d72242007-06-14 17:58:59 +00001074GENERATE_RTF = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001075
1076# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1077# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1078# put in front of it. If left blank `rtf' will be used as the default path.
1079
Christopher Dunne0d72242007-06-14 17:58:59 +00001080RTF_OUTPUT = rtf
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001081
1082# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1083# RTF documents. This may be useful for small projects and may help to
1084# save some trees in general.
1085
Christopher Dunne0d72242007-06-14 17:58:59 +00001086COMPACT_RTF = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001087
1088# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1089# will contain hyperlink fields. The RTF file will
1090# contain links (just like the HTML output) instead of page references.
1091# This makes the output suitable for online browsing using WORD or other
1092# programs which support those fields.
1093# Note: wordpad (write) and others do not support links.
1094
Christopher Dunne0d72242007-06-14 17:58:59 +00001095RTF_HYPERLINKS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001096
1097# Load stylesheet definitions from file. Syntax is similar to doxygen's
1098# config file, i.e. a series of assignments. You only have to provide
1099# replacements, missing definitions are set to their default value.
1100
Christopher Dunne0d72242007-06-14 17:58:59 +00001101RTF_STYLESHEET_FILE =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001102
1103# Set optional variables used in the generation of an rtf document.
1104# Syntax is similar to doxygen's config file.
1105
Christopher Dunne0d72242007-06-14 17:58:59 +00001106RTF_EXTENSIONS_FILE =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001107
Christopher Dunne0d72242007-06-14 17:58:59 +00001108#---------------------------------------------------------------------------
1109# configuration options related to the man page output
1110#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001111
1112# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1113# generate man pages
1114
Christopher Dunne0d72242007-06-14 17:58:59 +00001115GENERATE_MAN = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001116
1117# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1118# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1119# put in front of it. If left blank `man' will be used as the default path.
1120
Christopher Dunne0d72242007-06-14 17:58:59 +00001121MAN_OUTPUT = man
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001122
1123# The MAN_EXTENSION tag determines the extension that is added to
1124# the generated man pages (default is the subroutine's section .3)
1125
Christopher Dunne0d72242007-06-14 17:58:59 +00001126MAN_EXTENSION = .3
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001127
1128# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1129# then it will generate one additional man file for each entity
1130# documented in the real man page(s). These additional files
1131# only source the real man page, but without them the man command
1132# would be unable to find the correct page. The default is NO.
1133
Christopher Dunne0d72242007-06-14 17:58:59 +00001134MAN_LINKS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001135
Christopher Dunne0d72242007-06-14 17:58:59 +00001136#---------------------------------------------------------------------------
1137# configuration options related to the XML output
1138#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001139
1140# If the GENERATE_XML tag is set to YES Doxygen will
1141# generate an XML file that captures the structure of
1142# the code including all documentation.
1143
Christopher Dunne0d72242007-06-14 17:58:59 +00001144GENERATE_XML = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001145
1146# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1147# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1148# put in front of it. If left blank `xml' will be used as the default path.
1149
Christopher Dunne0d72242007-06-14 17:58:59 +00001150XML_OUTPUT = xml
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001151
1152# The XML_SCHEMA tag can be used to specify an XML schema,
1153# which can be used by a validating XML parser to check the
1154# syntax of the XML files.
1155
Christopher Dunne0d72242007-06-14 17:58:59 +00001156XML_SCHEMA =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001157
1158# The XML_DTD tag can be used to specify an XML DTD,
1159# which can be used by a validating XML parser to check the
1160# syntax of the XML files.
1161
Christopher Dunne0d72242007-06-14 17:58:59 +00001162XML_DTD =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001163
1164# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1165# dump the program listings (including syntax highlighting
1166# and cross-referencing information) to the XML output. Note that
1167# enabling this will significantly increase the size of the XML output.
1168
Christopher Dunne0d72242007-06-14 17:58:59 +00001169XML_PROGRAMLISTING = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001170
Christopher Dunne0d72242007-06-14 17:58:59 +00001171#---------------------------------------------------------------------------
1172# configuration options for the AutoGen Definitions output
1173#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001174
1175# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1176# generate an AutoGen Definitions (see autogen.sf.net) file
1177# that captures the structure of the code including all
1178# documentation. Note that this feature is still experimental
1179# and incomplete at the moment.
1180
Christopher Dunne0d72242007-06-14 17:58:59 +00001181GENERATE_AUTOGEN_DEF = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001182
Christopher Dunne0d72242007-06-14 17:58:59 +00001183#---------------------------------------------------------------------------
1184# configuration options related to the Perl module output
1185#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001186
1187# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1188# generate a Perl module file that captures the structure of
1189# the code including all documentation. Note that this
1190# feature is still experimental and incomplete at the
1191# moment.
1192
Christopher Dunne0d72242007-06-14 17:58:59 +00001193GENERATE_PERLMOD = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001194
1195# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1196# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1197# to generate PDF and DVI output from the Perl module output.
1198
Christopher Dunne0d72242007-06-14 17:58:59 +00001199PERLMOD_LATEX = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001200
1201# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1202# nicely formatted so it can be parsed by a human reader.
1203# This is useful
1204# if you want to understand what is going on.
1205# On the other hand, if this
1206# tag is set to NO the size of the Perl module output will be much smaller
1207# and Perl will parse it just the same.
1208
Christopher Dunne0d72242007-06-14 17:58:59 +00001209PERLMOD_PRETTY = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001210
1211# The names of the make variables in the generated doxyrules.make file
1212# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1213# This is useful so different doxyrules.make files included by the same
1214# Makefile don't overwrite each other's variables.
1215
Christopher Dunne0d72242007-06-14 17:58:59 +00001216PERLMOD_MAKEVAR_PREFIX =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001217
Christopher Dunne0d72242007-06-14 17:58:59 +00001218#---------------------------------------------------------------------------
1219# Configuration options related to the preprocessor
1220#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001221
1222# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1223# evaluate all C-preprocessor directives found in the sources and include
1224# files.
1225
Christopher Dunne0d72242007-06-14 17:58:59 +00001226ENABLE_PREPROCESSING = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001227
1228# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1229# names in the source code. If set to NO (the default) only conditional
1230# compilation will be performed. Macro expansion can be done in a controlled
1231# way by setting EXPAND_ONLY_PREDEF to YES.
1232
1233MACRO_EXPANSION = YES
1234
1235# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1236# then the macro expansion is limited to the macros specified with the
1237# PREDEFINED and EXPAND_AS_DEFINED tags.
1238
Christopher Dunne0d72242007-06-14 17:58:59 +00001239EXPAND_ONLY_PREDEF = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001240
1241# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1242# in the INCLUDE_PATH (see below) will be search if a #include is found.
1243
Christopher Dunne0d72242007-06-14 17:58:59 +00001244SEARCH_INCLUDES = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001245
1246# The INCLUDE_PATH tag can be used to specify one or more directories that
1247# contain include files that are not input files but should be processed by
1248# the preprocessor.
1249
Christopher Dunne0d72242007-06-14 17:58:59 +00001250INCLUDE_PATH = ../include
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001251
1252# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1253# patterns (like *.h and *.hpp) to filter out the header-files in the
1254# directories. If left blank, the patterns specified with FILE_PATTERNS will
1255# be used.
1256
Christopher Dunne0d72242007-06-14 17:58:59 +00001257INCLUDE_FILE_PATTERNS = *.h
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001258
1259# The PREDEFINED tag can be used to specify one or more macro names that
1260# are defined before the preprocessor is started (similar to the -D option of
1261# gcc). The argument of the tag is a list of macros of the form: name
1262# or name=definition (no spaces). If the definition and the = are
1263# omitted =1 is assumed. To prevent a macro definition from being
1264# undefined via #undef or recursively expanded use the := operator
1265# instead of the = operator.
1266
1267PREDEFINED = "_MSC_VER=1400" \
1268 _CPPRTTI \
1269 _WIN32 \
1270 JSONCPP_DOC_EXCLUDE_IMPLEMENTATION \
1271 JSON_VALUE_USE_INTERNAL_MAP
1272
1273# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1274# this tag can be used to specify a list of macro names that should be expanded.
1275# The macro definition that is found in the sources will be used.
1276# Use the PREDEFINED tag if you want to use a different macro definition.
1277
Christopher Dunne0d72242007-06-14 17:58:59 +00001278EXPAND_AS_DEFINED =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001279
1280# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1281# doxygen's preprocessor will remove all function-like macros that are alone
1282# on a line, have an all uppercase name, and do not end with a semicolon. Such
1283# function macros are typically used for boiler-plate code, and will confuse
1284# the parser if not removed.
1285
Christopher Dunne0d72242007-06-14 17:58:59 +00001286SKIP_FUNCTION_MACROS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001287
Christopher Dunne0d72242007-06-14 17:58:59 +00001288#---------------------------------------------------------------------------
1289# Configuration::additions related to external references
1290#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001291
1292# The TAGFILES option can be used to specify one or more tagfiles.
1293# Optionally an initial location of the external documentation
1294# can be added for each tagfile. The format of a tag file without
1295# this location is as follows:
1296#
1297# TAGFILES = file1 file2 ...
1298# Adding location for the tag files is done as follows:
1299#
1300# TAGFILES = file1=loc1 "file2 = loc2" ...
1301# where "loc1" and "loc2" can be relative or absolute paths or
1302# URLs. If a location is present for each tag, the installdox tool
1303# does not have to be run to correct the links.
1304# Note that each tag file must have a unique name
1305# (where the name does NOT include the path)
1306# If a tag file is not located in the directory in which doxygen
1307# is run, you must also specify the path to the tagfile here.
1308
Christopher Dunne0d72242007-06-14 17:58:59 +00001309TAGFILES =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001310
1311# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1312# a tag file that is based on the input files it reads.
1313
Christopher Dunne0d72242007-06-14 17:58:59 +00001314GENERATE_TAGFILE =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001315
1316# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1317# in the class index. If set to NO only the inherited external classes
1318# will be listed.
1319
Christopher Dunne0d72242007-06-14 17:58:59 +00001320ALLEXTERNALS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001321
1322# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1323# in the modules index. If set to NO, only the current project's groups will
1324# be listed.
1325
Christopher Dunne0d72242007-06-14 17:58:59 +00001326EXTERNAL_GROUPS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001327
1328# The PERL_PATH should be the absolute path and name of the perl script
1329# interpreter (i.e. the result of `which perl').
1330
Christopher Dunne0d72242007-06-14 17:58:59 +00001331PERL_PATH = /usr/bin/perl
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001332
Christopher Dunne0d72242007-06-14 17:58:59 +00001333#---------------------------------------------------------------------------
1334# Configuration options related to the dot tool
1335#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001336
1337# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1338# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1339# or super classes. Setting the tag to NO turns the diagrams off. Note that
1340# this option is superseded by the HAVE_DOT option below. This is only a
1341# fallback. It is recommended to install and use dot, since it yields more
1342# powerful graphs.
1343
Christopher Dunne0d72242007-06-14 17:58:59 +00001344CLASS_DIAGRAMS = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001345
1346# You can define message sequence charts within doxygen comments using the \msc
1347# command. Doxygen will then run the mscgen tool (see
1348# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1349# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1350# the mscgen tool resides. If left empty the tool is assumed to be found in the
1351# default search path.
1352
1353MSCGEN_PATH =
1354
1355# If set to YES, the inheritance and collaboration graphs will hide
1356# inheritance and usage relations if the target is undocumented
1357# or is not a class.
1358
1359HIDE_UNDOC_RELATIONS = NO
1360
1361# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1362# available from the path. This tool is part of Graphviz, a graph visualization
1363# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1364# have no effect if this option is set to NO (the default)
1365
1366HAVE_DOT = %HAVE_DOT%
1367
1368# By default doxygen will write a font called FreeSans.ttf to the output
1369# directory and reference it in all dot files that doxygen generates. This
1370# font does not include all possible unicode characters however, so when you need
1371# these (or just want a differently looking font) you can specify the font name
1372# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1373# which can be done by putting it in a standard location or by setting the
1374# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1375# containing the font.
1376
1377DOT_FONTNAME = FreeSans
1378
1379# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1380# The default size is 10pt.
1381
1382DOT_FONTSIZE = 10
1383
1384# By default doxygen will tell dot to use the output directory to look for the
1385# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1386# different font using DOT_FONTNAME you can set the path where dot
1387# can find it using this tag.
1388
1389DOT_FONTPATH =
1390
1391# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1392# will generate a graph for each documented class showing the direct and
1393# indirect inheritance relations. Setting this tag to YES will force the
1394# the CLASS_DIAGRAMS tag to NO.
1395
Christopher Dunne0d72242007-06-14 17:58:59 +00001396CLASS_GRAPH = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001397
1398# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1399# will generate a graph for each documented class showing the direct and
1400# indirect implementation dependencies (inheritance, containment, and
1401# class references variables) of the class with other documented classes.
1402
Christopher Dunne0d72242007-06-14 17:58:59 +00001403COLLABORATION_GRAPH = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001404
1405# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1406# will generate a graph for groups, showing the direct groups dependencies
1407
Christopher Dunne0d72242007-06-14 17:58:59 +00001408GROUP_GRAPHS = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001409
1410# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1411# collaboration diagrams in a style similar to the OMG's Unified Modeling
1412# Language.
1413
1414UML_LOOK = %UML_LOOK%
1415
1416# If set to YES, the inheritance and collaboration graphs will show the
1417# relations between templates and their instances.
1418
1419TEMPLATE_RELATIONS = YES
1420
1421# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1422# tags are set to YES then doxygen will generate a graph for each documented
1423# file showing the direct and indirect include dependencies of the file with
1424# other documented files.
1425
Christopher Dunne0d72242007-06-14 17:58:59 +00001426INCLUDE_GRAPH = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001427
1428# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1429# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1430# documented header file showing the documented files that directly or
1431# indirectly include this file.
1432
Christopher Dunne0d72242007-06-14 17:58:59 +00001433INCLUDED_BY_GRAPH = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001434
1435# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1436# doxygen will generate a call dependency graph for every global function
1437# or class method. Note that enabling this option will significantly increase
1438# the time of a run. So in most cases it will be better to enable call graphs
1439# for selected functions only using the \callgraph command.
1440
Christopher Dunne0d72242007-06-14 17:58:59 +00001441CALL_GRAPH = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001442
1443# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1444# doxygen will generate a caller dependency graph for every global function
1445# or class method. Note that enabling this option will significantly increase
1446# the time of a run. So in most cases it will be better to enable caller
1447# graphs for selected functions only using the \callergraph command.
1448
1449CALLER_GRAPH = YES
1450
1451# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1452# will graphical hierarchy of all classes instead of a textual one.
1453
Christopher Dunne0d72242007-06-14 17:58:59 +00001454GRAPHICAL_HIERARCHY = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001455
1456# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1457# then doxygen will show the dependencies a directory has on other directories
1458# in a graphical way. The dependency relations are determined by the #include
1459# relations between the files in the directories.
1460
Christopher Dunne0d72242007-06-14 17:58:59 +00001461DIRECTORY_GRAPH = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001462
1463# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1464# generated by dot. Possible values are png, jpg, or gif
1465# If left blank png will be used.
1466
Christopher Dunne0d72242007-06-14 17:58:59 +00001467DOT_IMAGE_FORMAT = png
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001468
1469# The tag DOT_PATH can be used to specify the path where the dot tool can be
1470# found. If left blank, it is assumed the dot tool can be found in the path.
1471
1472DOT_PATH = %DOT_PATH%
1473
1474# The DOTFILE_DIRS tag can be used to specify one or more directories that
1475# contain dot files that are included in the documentation (see the
1476# \dotfile command).
1477
Christopher Dunne0d72242007-06-14 17:58:59 +00001478DOTFILE_DIRS =
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001479
1480# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1481# nodes that will be shown in the graph. If the number of nodes in a graph
1482# becomes larger than this value, doxygen will truncate the graph, which is
1483# visualized by representing a node as a red box. Note that doxygen if the
1484# number of direct children of the root node in a graph is already larger than
1485# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1486# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1487
1488DOT_GRAPH_MAX_NODES = 50
1489
1490# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1491# graphs generated by dot. A depth value of 3 means that only nodes reachable
1492# from the root by following a path via at most 3 edges will be shown. Nodes
1493# that lay further from the root node will be omitted. Note that setting this
1494# option to 1 or 2 may greatly reduce the computation time needed for large
1495# code bases. Also note that the size of a graph can be further restricted by
1496# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1497
Christopher Dunne0d72242007-06-14 17:58:59 +00001498MAX_DOT_GRAPH_DEPTH = 1000
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001499
1500# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1501# background. This is disabled by default, because dot on Windows does not
1502# seem to support this out of the box. Warning: Depending on the platform used,
1503# enabling this option may lead to badly anti-aliased labels on the edges of
1504# a graph (i.e. they become hard to read).
1505
Christopher Dunne0d72242007-06-14 17:58:59 +00001506DOT_TRANSPARENT = NO
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001507
1508# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1509# files in one run (i.e. multiple -o and -T options on the command line). This
1510# makes dot run faster, but since only newer versions of dot (>1.8.10)
1511# support this, this feature is disabled by default.
1512
1513DOT_MULTI_TARGETS = YES
1514
1515# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1516# generate a legend page explaining the meaning of the various boxes and
1517# arrows in the dot generated graphs.
1518
Christopher Dunne0d72242007-06-14 17:58:59 +00001519GENERATE_LEGEND = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001520
1521# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1522# remove the intermediate dot files that are used to generate
1523# the various graphs.
1524
Christopher Dunne0d72242007-06-14 17:58:59 +00001525DOT_CLEANUP = YES
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001526
Christopher Dunne0d72242007-06-14 17:58:59 +00001527#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001528# Options related to the search engine
Christopher Dunne0d72242007-06-14 17:58:59 +00001529#---------------------------------------------------------------------------
Baptiste Lepilleur57ee0e32010-02-22 04:16:10 +00001530
1531# The SEARCHENGINE tag specifies whether or not a search engine should be
1532# used. If set to NO the values of all tags below this one will be ignored.
1533
Christopher Dunne0d72242007-06-14 17:58:59 +00001534SEARCHENGINE = NO