blob: b8d1823bccec3d824da80006be66eb488c86b28c [file] [log] [blame]
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001# Doxyfile 1.8.7
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002
3# This file describes the settings to be used by the documentation system
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08004# doxygen (www.doxygen.org) for a project.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07005#
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08006# All text after a double hash (##) is considered a comment and is placed in
7# front of the TAG it is preceding.
8#
9# All text after a single hash (#) is considered a comment and will be ignored.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -070010# The format is:
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -080011# TAG = value [value, ...]
12# For lists, items can also be appended using:
13# TAG += value [value, ...]
14# Values that contain spaces should be placed between quotes (\" \").
Alexander Afanasyev6315ef72012-06-01 20:56:31 -070015
16#---------------------------------------------------------------------------
17# Project related configuration options
18#---------------------------------------------------------------------------
19
20# This tag specifies the encoding used for all characters in the config file
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -080021# that follow. The default is UTF-8 which is also the encoding used for all text
22# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24# for the list of possible encodings.
25# The default value is: UTF-8.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -070026
27DOXYFILE_ENCODING = UTF-8
28
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -080029# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30# double-quotes, unless you are using Doxywizard) that should identify the
31# project for which the documentation is generated. This name is used in the
32# title of most generated pages and in a few other places.
33# The default value is: My Project.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -070034
Alexander Afanasyev508269a2012-07-28 13:59:54 -070035PROJECT_NAME = "ndnSIM"
Alexander Afanasyev6315ef72012-06-01 20:56:31 -070036
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -080037# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38# could be handy for archiving the generated documentation or if some version
39# control system is used.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -070040
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -080041PROJECT_NUMBER = 2.0
42
43# Using the PROJECT_BRIEF tag one can provide an optional one line description
44# for a project that appears at the top of each page and should give viewer a
45# quick idea about the purpose of the project. Keep the description short.
46
47PROJECT_BRIEF =
48
49# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
50# the documentation. The maximum height of the logo should not exceed 55 pixels
51# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
52# to the output directory.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -070053
Alexander Afanasyev508269a2012-07-28 13:59:54 -070054PROJECT_LOGO = ./doc/ns3_html_theme/static/ndn-logo.png
55
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -080056# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57# into which the generated documentation will be written. If a relative path is
58# entered, it will be relative to the location where doxygen was started. If
59# left blank the current directory will be used.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -070060
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -080061OUTPUT_DIRECTORY =
Alexander Afanasyev6315ef72012-06-01 20:56:31 -070062
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -080063# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
64# directories (in 2 levels) under the output directory of each output format and
65# will distribute the generated files over these directories. Enabling this
66# option can be useful when feeding doxygen a huge amount of source files, where
67# putting all generated files in the same directory would otherwise causes
68# performance problems for the file system.
69# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -070070
71CREATE_SUBDIRS = NO
72
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -080073# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74# characters to appear in the names of generated files. If set to NO, non-ASCII
75# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76# U+3044.
77# The default value is: NO.
78
79ALLOW_UNICODE_NAMES = NO
80
Alexander Afanasyev6315ef72012-06-01 20:56:31 -070081# The OUTPUT_LANGUAGE tag is used to specify the language in which all
82# documentation generated by doxygen is written. Doxygen will use this
83# information to generate all constant output in the proper language.
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -080084# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91# Ukrainian and Vietnamese.
92# The default value is: English.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -070093
94OUTPUT_LANGUAGE = English
95
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -080096# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
97# descriptions after the members that are listed in the file and class
98# documentation (similar to Javadoc). Set to NO to disable this.
99# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700100
101BRIEF_MEMBER_DESC = YES
102
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800103# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
104# description of a member or function before the detailed description
105#
106# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700107# brief descriptions will be completely suppressed.
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800108# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700109
110REPEAT_BRIEF = YES
111
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800112# This tag implements a quasi-intelligent brief description abbreviator that is
113# used to form the text in various listings. Each string in this list, if found
114# as the leading text of the brief description, will be stripped from the text
115# and the result, after processing the whole list, is used as the annotated
116# text. Otherwise, the brief description is used as-is. If left blank, the
117# following values are used ($name is automatically replaced with the name of
118# the entity):The $name class, The $name widget, The $name file, is, provides,
119# specifies, contains, represents, a, an and the.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700120
121ABBREVIATE_BRIEF =
122
123# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800124# doxygen will generate a detailed section even if there is only a brief
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700125# description.
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800126# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700127
128ALWAYS_DETAILED_SEC = NO
129
130# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131# inherited members of a class in the documentation of that class as if those
132# members were ordinary class members. Constructors, destructors and assignment
133# operators of the base classes will not be shown.
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800134# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700135
136INLINE_INHERITED_MEMB = NO
137
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800138# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
139# before files name in the file list and in the header files. If set to NO the
140# shortest path that makes the file name unique will be used
141# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700142
143FULL_PATH_NAMES = YES
144
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800145# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146# Stripping is only done if one of the specified strings matches the left-hand
147# part of the path. The tag can be used to show relative paths in the file list.
148# If left blank the directory from which doxygen is run is used as the path to
149# strip.
150#
151# Note that you can specify absolute paths here, but also relative paths, which
152# will be relative from the directory where doxygen is started.
153# This tag requires that the tag FULL_PATH_NAMES is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700154
Alexander Afanasyev508269a2012-07-28 13:59:54 -0700155STRIP_FROM_PATH = ../..
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700156
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800157# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158# path mentioned in the documentation of a class, which tells the reader which
159# header file to include in order to use a class. If left blank only the name of
160# the header file containing the class definition is used. Otherwise one should
161# specify the list of include paths that are normally passed to the compiler
162# using the -I flag.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700163
164STRIP_FROM_INC_PATH =
165
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800166# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
167# less readable) file names. This can be useful is your file systems doesn't
168# support long names like on DOS, Mac, or CD-ROM.
169# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700170
171SHORT_NAMES = NO
172
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800173# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
174# first line (until the first dot) of a Javadoc-style comment as the brief
175# description. If set to NO, the Javadoc-style will behave just like regular Qt-
176# style comments (thus requiring an explicit @brief command for a brief
177# description.)
178# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700179
180JAVADOC_AUTOBRIEF = YES
181
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800182# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
183# line (until the first dot) of a Qt-style comment as the brief description. If
184# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
185# requiring an explicit \brief command for a brief description.)
186# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700187
188QT_AUTOBRIEF = NO
189
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800190# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
191# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
192# a brief description. This used to be the default behavior. The new default is
193# to treat a multi-line C++ comment block as a detailed description. Set this
194# tag to YES if you prefer the old behavior instead.
195#
196# Note that setting this tag to YES also means that rational rose comments are
197# not recognized any more.
198# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700199
200MULTILINE_CPP_IS_BRIEF = NO
201
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800202# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
203# documentation from any documented member that it re-implements.
204# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700205
206INHERIT_DOCS = YES
207
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800208# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
209# new page for each member. If set to NO, the documentation of a member will be
210# part of the file/class/namespace that contains it.
211# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700212
213SEPARATE_MEMBER_PAGES = NO
214
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800215# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
216# uses this value to replace tabs by spaces in code fragments.
217# Minimum value: 1, maximum value: 16, default value: 4.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700218
219TAB_SIZE = 4
220
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800221# This tag can be used to specify a number of aliases that act as commands in
222# the documentation. An alias has the form:
223# name=value
224# For example adding
225# "sideeffect=@par Side Effects:\n"
226# will allow you to put the command \sideeffect (or @sideeffect) in the
227# documentation, which will result in a user-defined paragraph with heading
228# "Side Effects:". You can put \n's in the value part of an alias to insert
229# newlines.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700230
Alexander Afanasyev5dee3612015-08-25 16:09:04 -0700231ALIASES = "detail=@details"
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700232
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800233# This tag can be used to specify a number of word-keyword mappings (TCL only).
234# A mapping has the form "name=value". For example adding "class=itcl::class"
235# will allow you to use the command class in the itcl::class meaning.
236
237TCL_SUBST =
238
239# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
240# only. Doxygen will then generate output that is more tailored for C. For
241# instance, some of the names that are used will be different. The list of all
242# members will be omitted, etc.
243# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700244
245OPTIMIZE_OUTPUT_FOR_C = NO
246
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800247# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
248# Python sources only. Doxygen will then generate output that is more tailored
249# for that language. For instance, namespaces will be presented as packages,
250# qualified scopes will look different, etc.
251# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700252
253OPTIMIZE_OUTPUT_JAVA = NO
254
255# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800256# sources. Doxygen will then generate output that is tailored for Fortran.
257# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700258
259OPTIMIZE_FOR_FORTRAN = NO
260
261# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800262# sources. Doxygen will then generate output that is tailored for VHDL.
263# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700264
265OPTIMIZE_OUTPUT_VHDL = NO
266
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800267# Doxygen selects the parser to use depending on the extension of the files it
268# parses. With this tag you can assign which parser to use for a given
269# extension. Doxygen has a built-in mapping, but you can override or extend it
270# using this tag. The format is ext=language, where ext is a file extension, and
271# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
272# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
273# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
274# Fortran. In the later case the parser tries to guess whether the code is fixed
275# or free formatted code, this is the default for Fortran type files), VHDL. For
276# instance to make doxygen treat .inc files as Fortran files (default is PHP),
277# and .f files as C (default is Fortran), use: inc=Fortran f=C.
278#
279# Note For files without extension you can use no_extension as a placeholder.
280#
281# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
282# the files are not read by doxygen.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700283
284EXTENSION_MAPPING =
285
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800286# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
287# according to the Markdown format, which allows for more readable
288# documentation. See http://daringfireball.net/projects/markdown/ for details.
289# The output of markdown processing is further processed by doxygen, so you can
290# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
291# case of backward compatibilities issues.
292# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700293
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800294MARKDOWN_SUPPORT = YES
295
296# When enabled doxygen tries to link words that correspond to documented
297# classes, or namespaces to their corresponding documentation. Such a link can
298# be prevented in individual cases by by putting a % sign in front of the word
299# or globally by setting AUTOLINK_SUPPORT to NO.
300# The default value is: YES.
301
302AUTOLINK_SUPPORT = YES
303
304# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
305# to include (a tag file for) the STL sources as input, then you should set this
306# tag to YES in order to let doxygen match functions declarations and
307# definitions whose arguments contain STL classes (e.g. func(std::string);
308# versus func(std::string) {}). This also make the inheritance and collaboration
309# diagrams that involve STL classes more complete and accurate.
310# The default value is: NO.
311
312BUILTIN_STL_SUPPORT = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700313
314# If you use Microsoft's C++/CLI language, you should set this option to YES to
315# enable parsing support.
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800316# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700317
318CPP_CLI_SUPPORT = NO
319
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800320# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
321# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
322# will parse them like normal C++ but will assume all classes use public instead
323# of private inheritance when no explicit protection keyword is present.
324# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700325
326SIP_SUPPORT = NO
327
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800328# For Microsoft's IDL there are propget and propput attributes to indicate
329# getter and setter methods for a property. Setting this option to YES will make
330# doxygen to replace the get and set methods by a property in the documentation.
331# This will only work if the methods are indeed getting or setting a simple
332# type. If this is not the case, or you want to show the methods anyway, you
333# should set this option to NO.
334# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700335
336IDL_PROPERTY_SUPPORT = YES
337
338# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
339# tag is set to YES, then doxygen will reuse the documentation of the first
340# member in the group (if any) for the other members of the group. By default
341# all members of a group must be documented explicitly.
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800342# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700343
344DISTRIBUTE_GROUP_DOC = NO
345
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800346# Set the SUBGROUPING tag to YES to allow class member groups of the same type
347# (for instance a group of public functions) to be put as a subgroup of that
348# type (e.g. under the Public Functions section). Set it to NO to prevent
349# subgrouping. Alternatively, this can be done per class using the
350# \nosubgrouping command.
351# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700352
353SUBGROUPING = YES
354
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800355# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
356# are shown inside the group in which they are included (e.g. using \ingroup)
357# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
358# and RTF).
359#
360# Note that this feature does not work in combination with
361# SEPARATE_MEMBER_PAGES.
362# The default value is: NO.
363
364INLINE_GROUPED_CLASSES = NO
365
366# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
367# with only public data fields or simple typedef fields will be shown inline in
368# the documentation of the scope in which they are defined (i.e. file,
369# namespace, or group documentation), provided this scope is documented. If set
370# to NO, structs, classes, and unions are shown on a separate page (for HTML and
371# Man pages) or section (for LaTeX and RTF).
372# The default value is: NO.
373
374INLINE_SIMPLE_STRUCTS = NO
375
376# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
377# enum is documented as struct, union, or enum with the name of the typedef. So
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700378# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
379# with name TypeT. When disabled the typedef will appear as a member of a file,
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800380# namespace, or class. And the struct will be named TypeS. This can typically be
381# useful for C code in case the coding convention dictates that all compound
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700382# types are typedef'ed and only the typedef is referenced, never the tag name.
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800383# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700384
385TYPEDEF_HIDES_STRUCT = NO
386
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800387# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
388# cache is used to resolve symbols given their name and scope. Since this can be
389# an expensive process and often the same symbol appears multiple times in the
390# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
391# doxygen will become slower. If the cache is too large, memory is wasted. The
392# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
393# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
394# symbols. At the end of a run doxygen will report the cache usage and suggest
395# the optimal cache size from a speed point of view.
396# Minimum value: 0, maximum value: 9, default value: 0.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700397
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800398LOOKUP_CACHE_SIZE = 0
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700399
400#---------------------------------------------------------------------------
401# Build related configuration options
402#---------------------------------------------------------------------------
403
404# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800405# documentation are documented, even if no documentation was available. Private
406# class members and static file members will be hidden unless the
407# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
408# Note: This will also disable the warnings about undocumented members that are
409# normally produced when WARNINGS is set to YES.
410# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700411
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800412EXTRACT_ALL = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700413
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800414# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
415# be included in the documentation.
416# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700417
418EXTRACT_PRIVATE = NO
419
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800420# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
421# scope will be included in the documentation.
422# The default value is: NO.
423
424EXTRACT_PACKAGE = NO
425
426# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
427# included in the documentation.
428# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700429
Alexander Afanasyev042b4a72012-11-09 17:47:48 -0800430EXTRACT_STATIC = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700431
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800432# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
433# locally in source files will be included in the documentation. If set to NO
434# only classes defined in header files are included. Does not have any effect
435# for Java sources.
436# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700437
Alexander Afanasyev042b4a72012-11-09 17:47:48 -0800438EXTRACT_LOCAL_CLASSES = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700439
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800440# This flag is only useful for Objective-C code. When set to YES local methods,
441# which are defined in the implementation section but not in the interface are
442# included in the documentation. If set to NO only methods in the interface are
443# included.
444# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700445
446EXTRACT_LOCAL_METHODS = NO
447
448# If this flag is set to YES, the members of anonymous namespaces will be
449# extracted and appear in the documentation as a namespace called
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800450# 'anonymous_namespace{file}', where file will be replaced with the base name of
451# the file that contains the anonymous namespace. By default anonymous namespace
452# are hidden.
453# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700454
455EXTRACT_ANON_NSPACES = NO
456
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800457# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
458# undocumented members inside documented classes or files. If set to NO these
459# members will be included in the various overviews, but no documentation
460# section is generated. This option has no effect if EXTRACT_ALL is enabled.
461# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700462
463HIDE_UNDOC_MEMBERS = NO
464
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800465# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
466# undocumented classes that are normally visible in the class hierarchy. If set
467# to NO these classes will be included in the various overviews. This option has
468# no effect if EXTRACT_ALL is enabled.
469# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700470
471HIDE_UNDOC_CLASSES = NO
472
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800473# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
474# (class|struct|union) declarations. If set to NO these declarations will be
475# included in the documentation.
476# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700477
478HIDE_FRIEND_COMPOUNDS = NO
479
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800480# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
481# documentation blocks found inside the body of a function. If set to NO these
482# blocks will be appended to the function's detailed documentation block.
483# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700484
Alexander Afanasyev5dee3612015-08-25 16:09:04 -0700485HIDE_IN_BODY_DOCS = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700486
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800487# The INTERNAL_DOCS tag determines if documentation that is typed after a
488# \internal command is included. If the tag is set to NO then the documentation
489# will be excluded. Set it to YES to include the internal documentation.
490# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700491
492INTERNAL_DOCS = NO
493
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800494# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
495# names in lower-case letters. If set to YES upper-case letters are also
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700496# allowed. This is useful if you have classes or files whose names only differ
497# in case and if your file system supports case sensitive file names. Windows
498# and Mac users are advised to set this option to NO.
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800499# The default value is: system dependent.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700500
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800501CASE_SENSE_NAMES = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700502
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800503# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
504# their full class and namespace scopes in the documentation. If set to YES the
505# scope will be hidden.
506# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700507
508HIDE_SCOPE_NAMES = NO
509
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800510# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
511# the files that are included by a file in the documentation of that file.
512# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700513
514SHOW_INCLUDE_FILES = YES
515
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800516# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
517# grouped member an include statement to the documentation, telling the reader
518# which file to include in order to use the member.
519# The default value is: NO.
520
521SHOW_GROUPED_MEMB_INC = NO
522
523# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
524# files with double quotes in the documentation rather than with sharp brackets.
525# The default value is: NO.
526
527FORCE_LOCAL_INCLUDES = NO
528
529# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
530# documentation for inline members.
531# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700532
533INLINE_INFO = YES
534
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800535# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
536# (detailed) documentation of file and class members alphabetically by member
537# name. If set to NO the members will appear in declaration order.
538# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700539
Alexander Afanasyev465f6412015-08-13 18:45:51 -0700540SORT_MEMBER_DOCS = NO
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700541
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800542# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
543# descriptions of file, namespace and class members alphabetically by member
544# name. If set to NO the members will appear in declaration order. Note that
545# this will also influence the order of the classes in the class list.
546# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700547
548SORT_BRIEF_DOCS = NO
549
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800550# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
551# (brief and detailed) documentation of class members so that constructors and
552# destructors are listed first. If set to NO the constructors will appear in the
553# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
554# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
555# member documentation.
556# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
557# detailed member documentation.
558# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700559
560SORT_MEMBERS_CTORS_1ST = NO
561
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800562# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
563# of group names into alphabetical order. If set to NO the group names will
564# appear in their defined order.
565# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700566
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800567SORT_GROUP_NAMES = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700568
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800569# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
570# fully-qualified names, including namespaces. If set to NO, the class list will
571# be sorted only by class name, not including the namespace part.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700572# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800573# Note: This option applies only to the class list, not to the alphabetical
574# list.
575# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700576
577SORT_BY_SCOPE_NAME = YES
578
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800579# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
580# type resolution of all parameters of a function it will reject a match between
581# the prototype and the implementation of a member function even if there is
582# only one candidate or it is obvious which candidate to choose by doing a
583# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
584# accept a match between prototype and implementation in such cases.
585# The default value is: NO.
586
587STRICT_PROTO_MATCHING = NO
588
589# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
590# todo list. This list is created by putting \todo commands in the
591# documentation.
592# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700593
594GENERATE_TODOLIST = YES
595
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800596# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
597# test list. This list is created by putting \test commands in the
598# documentation.
599# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700600
601GENERATE_TESTLIST = YES
602
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800603# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
604# list. This list is created by putting \bug commands in the documentation.
605# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700606
607GENERATE_BUGLIST = YES
608
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800609# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
610# the deprecated list. This list is created by putting \deprecated commands in
611# the documentation.
612# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700613
614GENERATE_DEPRECATEDLIST= YES
615
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800616# The ENABLED_SECTIONS tag can be used to enable conditional documentation
617# sections, marked by \if <section_label> ... \endif and \cond <section_label>
618# ... \endcond blocks.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700619
620ENABLED_SECTIONS =
621
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800622# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
623# initial value of a variable or macro / define can have for it to appear in the
624# documentation. If the initializer consists of more lines than specified here
625# it will be hidden. Use a value of 0 to hide initializers completely. The
626# appearance of the value of individual variables and macros / defines can be
627# controlled using \showinitializer or \hideinitializer command in the
628# documentation regardless of this setting.
629# Minimum value: 0, maximum value: 10000, default value: 30.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700630
631MAX_INITIALIZER_LINES = 30
632
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800633# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
634# the bottom of the documentation of classes and structs. If set to YES the list
635# will mention the files that were used to generate the documentation.
636# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700637
638SHOW_USED_FILES = YES
639
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800640# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
641# will remove the Files entry from the Quick Index and from the Folder Tree View
642# (if specified).
643# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700644
645SHOW_FILES = YES
646
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800647# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
648# page. This will remove the Namespaces entry from the Quick Index and from the
649# Folder Tree View (if specified).
650# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700651
652SHOW_NAMESPACES = YES
653
654# The FILE_VERSION_FILTER tag can be used to specify a program or script that
655# doxygen should invoke to get the current version for each file (typically from
656# the version control system). Doxygen will invoke the program by executing (via
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800657# popen()) the command command input-file, where command is the value of the
658# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
659# by doxygen. Whatever the program writes to standard output is used as the file
660# version. For an example see the documentation.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700661
662FILE_VERSION_FILTER =
663
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800664# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
665# by doxygen. The layout file controls the global structure of the generated
666# output files in an output format independent way. To create the layout file
667# that represents doxygen's defaults, run doxygen with the -l option. You can
668# optionally specify a file name after the option, if omitted DoxygenLayout.xml
669# will be used as the name of the layout file.
670#
671# Note that if you run doxygen from a directory containing a file called
672# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
673# tag is left empty.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700674
675LAYOUT_FILE =
676
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800677# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
678# the reference definitions. This must be a list of .bib files. The .bib
679# extension is automatically appended if omitted. This requires the bibtex tool
680# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
681# For LaTeX the style of the bibliography can be controlled using
682# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
683# search path. Do not use file names with spaces, bibtex cannot handle them. See
684# also \cite for info how to create references.
685
686CITE_BIB_FILES =
687
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700688#---------------------------------------------------------------------------
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800689# Configuration options related to warning and progress messages
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700690#---------------------------------------------------------------------------
691
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800692# The QUIET tag can be used to turn on/off the messages that are generated to
693# standard output by doxygen. If QUIET is set to YES this implies that the
694# messages are off.
695# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700696
Alexander Afanasyev465f6412015-08-13 18:45:51 -0700697QUIET = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700698
699# The WARNINGS tag can be used to turn on/off the warning messages that are
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800700# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
701# this implies that the warnings are on.
702#
703# Tip: Turn warnings on while writing the documentation.
704# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700705
706WARNINGS = YES
707
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800708# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
709# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
710# will automatically be disabled.
711# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700712
713WARN_IF_UNDOCUMENTED = YES
714
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800715# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
716# potential errors in the documentation, such as not documenting some parameters
717# in a documented function, or documenting parameters that don't exist or using
718# markup commands wrongly.
719# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700720
Alexander Afanasyev042b4a72012-11-09 17:47:48 -0800721WARN_IF_DOC_ERROR = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700722
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800723# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
724# are documented, but have no documentation for their parameters or return
725# value. If set to NO doxygen will only warn about wrong or incomplete parameter
726# documentation, but not about the absence of documentation.
727# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700728
Alexander Afanasyev4a4ea602012-06-06 11:12:45 -0700729WARN_NO_PARAMDOC = NO
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700730
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800731# The WARN_FORMAT tag determines the format of the warning messages that doxygen
732# can produce. The string should contain the $file, $line, and $text tags, which
733# will be replaced by the file and line number from which the warning originated
734# and the warning text. Optionally the format may contain $version, which will
735# be replaced by the version of the file (if it could be obtained via
736# FILE_VERSION_FILTER)
737# The default value is: $file:$line: $text.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700738
739WARN_FORMAT = "$file:$line: $text "
740
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800741# The WARN_LOGFILE tag can be used to specify a file to which warning and error
742# messages should be written. If left blank the output is written to standard
743# error (stderr).
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700744
Alexander Afanasyev508269a2012-07-28 13:59:54 -0700745WARN_LOGFILE = doxygen.warnings.log
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700746
747#---------------------------------------------------------------------------
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800748# Configuration options related to the input files
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700749#---------------------------------------------------------------------------
750
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800751# The INPUT tag is used to specify the files and/or directories that contain
752# documented source files. You may enter file names like myfile.cpp or
753# directories like /usr/src/myproject. Separate the files or directories with
754# spaces.
755# Note: If this tag is empty the current directory is searched.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700756
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800757INPUT = ../model \
758 ../helper \
759 ../utils \
760 ../apps \
761 ../NFD \
Alexander Afanasyev5dee3612015-08-25 16:09:04 -0700762 ../ndn-cxx \
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800763 introspected-doxygen.hpp \
764 doxygen.hpp
Alexander Afanasyev5dee3612015-08-25 16:09:04 -0700765
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700766# For example:
Spyridon Mastorakis95be5092015-08-26 15:07:37 -0700767# ../../../build/utils/ns3-dev-print-introspected-doxygen-debug --group=Ndn > introspected-doxygen.hpp
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700768
769# This tag can be used to specify the character encoding of the source files
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800770# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
771# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
772# documentation (see: http://www.gnu.org/software/libiconv) for the list of
773# possible encodings.
774# The default value is: UTF-8.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700775
776INPUT_ENCODING = UTF-8
777
778# If the value of the INPUT tag contains directories, you can use the
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800779# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
780# *.h) to filter out the source-files in the directories. If left blank the
781# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
782# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
783# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
784# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
785# *.qsf, *.as and *.js.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700786
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800787FILE_PATTERNS = *.hpp \
788 *.cpp
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700789
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800790# The RECURSIVE tag can be used to specify whether or not subdirectories should
791# be searched for input files as well.
792# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700793
794RECURSIVE = YES
795
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800796# The EXCLUDE tag can be used to specify files and/or directories that should be
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700797# excluded from the INPUT source files. This way you can easily exclude a
798# subdirectory from a directory tree whose root is specified with the INPUT tag.
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800799#
800# Note that relative paths are relative to the directory from which doxygen is
801# run.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700802
Alexander Afanasyev5dee3612015-08-25 16:09:04 -0700803EXCLUDE = ../NFD/tools \
804 ../NFD/tests \
805 ../ndn-cxx/util \
806 ../ndn-cxx/tools \
807 ../ndn-cxx/examples
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700808
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800809# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
810# directories that are symbolic links (a Unix file system feature) are excluded
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700811# from the input.
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800812# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700813
814EXCLUDE_SYMLINKS = NO
815
816# If the value of the INPUT tag contains directories, you can use the
817# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800818# certain files from those directories.
819#
820# Note that the wildcards are matched against the file with absolute path, so to
821# exclude all test directories for example use the pattern */test/*
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700822
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800823EXCLUDE_PATTERNS = */tests/*
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700824
825# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
826# (namespaces, classes, functions, etc.) that should be excluded from the
827# output. The symbol name can be a fully qualified name, a word, or if the
828# wildcard * is used, a substring. Examples: ANamespace, AClass,
829# AClass::ANamespace, ANamespace::*Test
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800830#
831# Note that the wildcards are matched against the file with absolute path, so to
832# exclude all test directories use the pattern */test/*
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700833
834EXCLUDE_SYMBOLS =
835
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800836# The EXAMPLE_PATH tag can be used to specify one or more files or directories
837# that contain example code fragments that are included (see the \include
838# command).
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700839
840EXAMPLE_PATH = ../examples
841
842# If the value of the EXAMPLE_PATH tag contains directories, you can use the
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800843# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
844# *.h) to filter out the source-files in the directories. If left blank all
845# files are included.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700846
847EXAMPLE_PATTERNS =
848
849# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800850# searched for input files to be used with the \include or \dontinclude commands
851# irrespective of the value of the RECURSIVE tag.
852# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700853
854EXAMPLE_RECURSIVE = NO
855
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800856# The IMAGE_PATH tag can be used to specify one or more files or directories
857# that contain images that are to be included in the documentation (see the
858# \image command).
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700859
Alexander Afanasyev508269a2012-07-28 13:59:54 -0700860IMAGE_PATH = ns3_html_theme/static
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700861
862# The INPUT_FILTER tag can be used to specify a program that doxygen should
863# invoke to filter for each input file. Doxygen will invoke the filter program
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800864# by executing (via popen()) the command:
865#
866# <filter> <input-file>
867#
868# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
869# name of an input file. Doxygen will then use the output that the filter
870# program writes to standard output. If FILTER_PATTERNS is specified, this tag
871# will be ignored.
872#
873# Note that the filter must not add or remove lines; it is applied before the
874# code is scanned, but not when the output code is generated. If lines are added
875# or removed, the anchors will not be placed correctly.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700876
877INPUT_FILTER =
878
879# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800880# basis. Doxygen will compare the file name with each pattern and apply the
881# filter if there is a match. The filters are a list of the form: pattern=filter
882# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
883# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
884# patterns match the file name, INPUT_FILTER is applied.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700885
886FILTER_PATTERNS =
887
888# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800889# INPUT_FILTER ) will also be used to filter the input files that are used for
890# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
891# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700892
893FILTER_SOURCE_FILES = NO
894
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800895# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
896# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
897# it is also possible to disable source filtering for a specific pattern using
898# *.ext= (so without naming a filter).
899# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
900
901FILTER_SOURCE_PATTERNS =
902
903# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
904# is part of the input, its contents will be placed on the main page
905# (index.html). This can be useful if you have a project on for instance GitHub
906# and want to reuse the introduction page also for the doxygen output.
907
908USE_MDFILE_AS_MAINPAGE =
909
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700910#---------------------------------------------------------------------------
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800911# Configuration options related to source browsing
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700912#---------------------------------------------------------------------------
913
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800914# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
915# generated. Documented entities will be cross-referenced with these sources.
916#
917# Note: To get rid of all source code in the generated output, make sure that
918# also VERBATIM_HEADERS is set to NO.
919# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700920
921SOURCE_BROWSER = YES
922
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800923# Setting the INLINE_SOURCES tag to YES will include the body of functions,
924# classes and enums directly into the documentation.
925# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700926
927INLINE_SOURCES = NO
928
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800929# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
930# special comment blocks from generated source code fragments. Normal C, C++ and
931# Fortran comments will always remain visible.
932# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700933
934STRIP_CODE_COMMENTS = YES
935
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800936# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
937# function all documented functions referencing it will be listed.
938# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700939
940REFERENCED_BY_RELATION = YES
941
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800942# If the REFERENCES_RELATION tag is set to YES then for each documented function
943# all documented entities called/used by that function will be listed.
944# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700945
946REFERENCES_RELATION = YES
947
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800948# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
949# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
950# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
951# link to the documentation.
952# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700953
954REFERENCES_LINK_SOURCE = YES
955
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800956# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
957# source code will show a tooltip with additional information such as prototype,
958# brief description and links to the definition and documentation. Since this
959# will make the HTML file larger and loading of large files a bit slower, you
960# can opt to disable this feature.
961# The default value is: YES.
962# This tag requires that the tag SOURCE_BROWSER is set to YES.
963
964SOURCE_TOOLTIPS = YES
965
966# If the USE_HTAGS tag is set to YES then the references to source code will
967# point to the HTML generated by the htags(1) tool instead of doxygen built-in
968# source browser. The htags tool is part of GNU's global source tagging system
969# (see http://www.gnu.org/software/global/global.html). You will need version
970# 4.8.6 or higher.
971#
972# To use it do the following:
973# - Install the latest version of global
974# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
975# - Make sure the INPUT points to the root of the source tree
976# - Run doxygen as normal
977#
978# Doxygen will invoke htags (and that will in turn invoke gtags), so these
979# tools must be available from the command line (i.e. in the search path).
980#
981# The result: instead of the source browser generated by doxygen, the links to
982# source code will now point to the output of htags.
983# The default value is: NO.
984# This tag requires that the tag SOURCE_BROWSER is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700985
986USE_HTAGS = NO
987
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800988# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
989# verbatim copy of the header file for each class for which an include is
990# specified. Set to NO to disable this.
991# See also: Section \class.
992# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700993
994VERBATIM_HEADERS = NO
995
996#---------------------------------------------------------------------------
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -0800997# Configuration options related to the alphabetical class index
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700998#---------------------------------------------------------------------------
999
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001000# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1001# compounds will be generated. Enable this if the project contains a lot of
1002# classes, structs, unions or interfaces.
1003# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001004
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001005ALPHABETICAL_INDEX = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001006
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001007# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1008# which the alphabetical index list will be split.
1009# Minimum value: 1, maximum value: 20, default value: 5.
1010# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001011
1012COLS_IN_ALPHA_INDEX = 5
1013
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001014# In case all classes in a project start with a common prefix, all classes will
1015# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1016# can be used to specify a prefix (or a list of prefixes) that should be ignored
1017# while generating the index headers.
1018# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001019
1020IGNORE_PREFIX =
1021
1022#---------------------------------------------------------------------------
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001023# Configuration options related to the HTML output
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001024#---------------------------------------------------------------------------
1025
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001026# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1027# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001028
1029GENERATE_HTML = YES
1030
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001031# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1032# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1033# it.
1034# The default directory is: html.
1035# This tag requires that the tag GENERATE_HTML is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001036
Alexander Afanasyev97fb44d2012-06-04 18:50:47 -07001037HTML_OUTPUT = build/html/doxygen
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001038
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001039# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1040# generated HTML page (for example: .htm, .php, .asp).
1041# The default value is: .html.
1042# This tag requires that the tag GENERATE_HTML is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001043
1044HTML_FILE_EXTENSION = .html
1045
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001046# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1047# each generated HTML page. If the tag is left blank doxygen will generate a
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001048# standard header.
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001049#
1050# To get valid HTML the header file that includes any scripts and style sheets
1051# that doxygen needs, which is dependent on the configuration options used (e.g.
1052# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1053# default header using
1054# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1055# YourConfigFile
1056# and then modify the file new_header.html. See also section "Doxygen usage"
1057# for information on how to generate the default header that doxygen normally
1058# uses.
1059# Note: The header is subject to change so you typically have to regenerate the
1060# default header when upgrading to a newer version of doxygen. For a description
1061# of the possible markers and block names see the documentation.
1062# This tag requires that the tag GENERATE_HTML is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001063
Alexander Afanasyev508269a2012-07-28 13:59:54 -07001064HTML_HEADER = ns3_html_theme/ns3_doxy_header.html
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001065
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001066# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1067# generated HTML page. If the tag is left blank doxygen will generate a standard
1068# footer. See HTML_HEADER for more information on how to generate a default
1069# footer and what special commands can be used inside the footer. See also
1070# section "Doxygen usage" for information on how to generate the default footer
1071# that doxygen normally uses.
1072# This tag requires that the tag GENERATE_HTML is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001073
Alexander Afanasyev508269a2012-07-28 13:59:54 -07001074HTML_FOOTER = ns3_html_theme/ns3_doxy_footer.html
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001075
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001076# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1077# sheet that is used by each HTML page. It can be used to fine-tune the look of
1078# the HTML output. If left blank doxygen will generate a default style sheet.
1079# See also section "Doxygen usage" for information on how to generate the style
1080# sheet that doxygen normally uses.
1081# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1082# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1083# obsolete.
1084# This tag requires that the tag GENERATE_HTML is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001085
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001086# HTML_STYLESHEET = ns3_html_theme/static/ns3_stylesheet.css
1087
1088# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1089# defined cascading style sheet that is included after the standard style sheets
1090# created by doxygen. Using this option one can overrule certain style aspects.
1091# This is preferred over using HTML_STYLESHEET since it does not replace the
1092# standard style sheet and is therefor more robust against future updates.
1093# Doxygen will copy the style sheet file to the output directory. For an example
1094# see the documentation.
1095# This tag requires that the tag GENERATE_HTML is set to YES.
1096
1097HTML_EXTRA_STYLESHEET =
1098
1099# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1100# other source files which should be copied to the HTML output directory. Note
1101# that these files will be copied to the base HTML output directory. Use the
1102# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1103# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1104# files will be copied as-is; there are no commands or markers available.
1105# This tag requires that the tag GENERATE_HTML is set to YES.
Alexander Afanasyev508269a2012-07-28 13:59:54 -07001106
1107HTML_EXTRA_FILES = ns3_html_theme/static/doxygen.css \
1108 ns3_html_theme/static/bar-top.png \
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001109 ns3_html_theme/static/favicon.ico \
1110 ns3_html_theme/static/ns3_stylesheet.css
1111
1112# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1113# will adjust the colors in the stylesheet and background images according to
1114# this color. Hue is specified as an angle on a colorwheel, see
1115# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1116# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1117# purple, and 360 is red again.
1118# Minimum value: 0, maximum value: 359, default value: 220.
1119# This tag requires that the tag GENERATE_HTML is set to YES.
Alexander Afanasyev508269a2012-07-28 13:59:54 -07001120
1121HTML_COLORSTYLE_HUE = 0
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001122
1123# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1124# in the HTML output. For a value of 0 the output will use grayscales only. A
1125# value of 255 will produce the most vivid colors.
1126# Minimum value: 0, maximum value: 255, default value: 100.
1127# This tag requires that the tag GENERATE_HTML is set to YES.
1128
Alexander Afanasyev508269a2012-07-28 13:59:54 -07001129HTML_COLORSTYLE_SAT = 0
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001130
1131# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1132# luminance component of the colors in the HTML output. Values below 100
1133# gradually make the output lighter, whereas values above 100 make the output
1134# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1135# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1136# change the gamma.
1137# Minimum value: 40, maximum value: 240, default value: 80.
1138# This tag requires that the tag GENERATE_HTML is set to YES.
1139
Alexander Afanasyev508269a2012-07-28 13:59:54 -07001140HTML_COLORSTYLE_GAMMA = 91
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001141
1142# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1143# page will contain the date and time when the page was generated. Setting this
1144# to NO can help when comparing the output of multiple runs.
1145# The default value is: YES.
1146# This tag requires that the tag GENERATE_HTML is set to YES.
1147
Alexander Afanasyev508269a2012-07-28 13:59:54 -07001148HTML_TIMESTAMP = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001149
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001150# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1151# documentation will contain sections that can be hidden and shown after the
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001152# page has loaded.
1153# The default value is: NO.
1154# This tag requires that the tag GENERATE_HTML is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001155
1156HTML_DYNAMIC_SECTIONS = NO
1157
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001158# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1159# shown in the various tree structured indices initially; the user can expand
1160# and collapse entries dynamically later on. Doxygen will expand the tree to
1161# such a level that at most the specified number of entries are visible (unless
1162# a fully collapsed tree already exceeds this amount). So setting the number of
1163# entries 1 will produce a full collapsed tree by default. 0 is a special value
1164# representing an infinite number of entries and will result in a full expanded
1165# tree by default.
1166# Minimum value: 0, maximum value: 9999, default value: 100.
1167# This tag requires that the tag GENERATE_HTML is set to YES.
1168
1169HTML_INDEX_NUM_ENTRIES = 100
1170
1171# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1172# generated that can be used as input for Apple's Xcode 3 integrated development
1173# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1174# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1175# Makefile in the HTML output directory. Running make will produce the docset in
1176# that directory and running make install will install the docset in
1177# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1178# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1179# for more information.
1180# The default value is: NO.
1181# This tag requires that the tag GENERATE_HTML is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001182
1183GENERATE_DOCSET = NO
1184
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001185# This tag determines the name of the docset feed. A documentation feed provides
1186# an umbrella under which multiple documentation sets from a single provider
1187# (such as a company or product suite) can be grouped.
1188# The default value is: Doxygen generated docs.
1189# This tag requires that the tag GENERATE_DOCSET is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001190
1191DOCSET_FEEDNAME = "Doxygen generated docs"
1192
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001193# This tag specifies a string that should uniquely identify the documentation
1194# set bundle. This should be a reverse domain-name style string, e.g.
1195# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1196# The default value is: org.doxygen.Project.
1197# This tag requires that the tag GENERATE_DOCSET is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001198
1199DOCSET_BUNDLE_ID = org.doxygen.Project
1200
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001201# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1202# the documentation publisher. This should be a reverse domain-name style
1203# string, e.g. com.mycompany.MyDocSet.documentation.
1204# The default value is: org.doxygen.Publisher.
1205# This tag requires that the tag GENERATE_DOCSET is set to YES.
1206
1207DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1208
1209# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1210# The default value is: Publisher.
1211# This tag requires that the tag GENERATE_DOCSET is set to YES.
1212
1213DOCSET_PUBLISHER_NAME = Publisher
1214
1215# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1216# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1217# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1218# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1219# Windows.
1220#
1221# The HTML Help Workshop contains a compiler that can convert all HTML output
1222# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1223# files are now used as the Windows 98 help format, and will replace the old
1224# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1225# HTML files also contain an index, a table of contents, and you can search for
1226# words in the documentation. The HTML workshop also contains a viewer for
1227# compressed HTML files.
1228# The default value is: NO.
1229# This tag requires that the tag GENERATE_HTML is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001230
1231GENERATE_HTMLHELP = NO
1232
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001233# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1234# file. You can add a path in front of the file if the result should not be
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001235# written to the html output directory.
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001236# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001237
1238CHM_FILE =
1239
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001240# The HHC_LOCATION tag can be used to specify the location (absolute path
1241# including file name) of the HTML help compiler ( hhc.exe). If non-empty
1242# doxygen will try to run the HTML help compiler on the generated index.hhp.
1243# The file has to be specified with full path.
1244# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001245
1246HHC_LOCATION =
1247
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001248# The GENERATE_CHI flag controls if a separate .chi index file is generated (
1249# YES) or that it should be included in the master .chm file ( NO).
1250# The default value is: NO.
1251# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001252
1253GENERATE_CHI = NO
1254
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001255# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1256# and project file content.
1257# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001258
1259CHM_INDEX_ENCODING =
1260
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001261# The BINARY_TOC flag controls whether a binary table of contents is generated (
1262# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
1263# enables the Previous and Next buttons.
1264# The default value is: NO.
1265# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001266
1267BINARY_TOC = NO
1268
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001269# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1270# the table of contents of the HTML help documentation and to the tree view.
1271# The default value is: NO.
1272# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001273
1274TOC_EXPAND = NO
1275
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001276# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1277# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1278# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1279# (.qch) of the generated HTML documentation.
1280# The default value is: NO.
1281# This tag requires that the tag GENERATE_HTML is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001282
1283GENERATE_QHP = NO
1284
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001285# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1286# the file name of the resulting .qch file. The path specified is relative to
1287# the HTML output folder.
1288# This tag requires that the tag GENERATE_QHP is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001289
1290QCH_FILE =
1291
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001292# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1293# Project output. For more information please see Qt Help Project / Namespace
1294# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1295# The default value is: org.doxygen.Project.
1296# This tag requires that the tag GENERATE_QHP is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001297
1298QHP_NAMESPACE =
1299
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001300# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1301# Help Project output. For more information please see Qt Help Project / Virtual
1302# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1303# folders).
1304# The default value is: doc.
1305# This tag requires that the tag GENERATE_QHP is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001306
1307QHP_VIRTUAL_FOLDER = doc
1308
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001309# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1310# filter to add. For more information please see Qt Help Project / Custom
1311# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1312# filters).
1313# This tag requires that the tag GENERATE_QHP is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001314
1315QHP_CUST_FILTER_NAME =
1316
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001317# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1318# custom filter to add. For more information please see Qt Help Project / Custom
1319# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1320# filters).
1321# This tag requires that the tag GENERATE_QHP is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001322
1323QHP_CUST_FILTER_ATTRS =
1324
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001325# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1326# project's filter section matches. Qt Help Project / Filter Attributes (see:
1327# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1328# This tag requires that the tag GENERATE_QHP is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001329
1330QHP_SECT_FILTER_ATTRS =
1331
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001332# The QHG_LOCATION tag can be used to specify the location of Qt's
1333# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1334# generated .qhp file.
1335# This tag requires that the tag GENERATE_QHP is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001336
1337QHG_LOCATION =
1338
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001339# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1340# generated, together with the HTML files, they form an Eclipse help plugin. To
1341# install this plugin and make it available under the help contents menu in
1342# Eclipse, the contents of the directory containing the HTML and XML files needs
1343# to be copied into the plugins directory of eclipse. The name of the directory
1344# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1345# After copying Eclipse needs to be restarted before the help appears.
1346# The default value is: NO.
1347# This tag requires that the tag GENERATE_HTML is set to YES.
1348
1349GENERATE_ECLIPSEHELP = NO
1350
1351# A unique identifier for the Eclipse help plugin. When installing the plugin
1352# the directory name containing the HTML and XML files should also have this
1353# name. Each documentation set should have its own identifier.
1354# The default value is: org.doxygen.Project.
1355# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1356
1357ECLIPSE_DOC_ID = org.doxygen.Project
1358
1359# If you want full control over the layout of the generated HTML pages it might
1360# be necessary to disable the index and replace it with your own. The
1361# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1362# of each HTML page. A value of NO enables the index and the value YES disables
1363# it. Since the tabs in the index contain the same information as the navigation
1364# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1365# The default value is: NO.
1366# This tag requires that the tag GENERATE_HTML is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001367
1368DISABLE_INDEX = NO
1369
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001370# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001371# structure should be generated to display hierarchical information. If the tag
1372# value is set to YES, a side panel will be generated containing a tree-like
1373# index structure (just like the one that is generated for HTML Help). For this
1374# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1375# (i.e. any modern browser). Windows users are probably better off using the
1376# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1377# further fine-tune the look of the index. As an example, the default style
1378# sheet generated by doxygen has an example that shows how to put an image at
1379# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1380# the same information as the tab index, you could consider setting
1381# DISABLE_INDEX to YES when enabling this option.
1382# The default value is: NO.
1383# This tag requires that the tag GENERATE_HTML is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001384
1385GENERATE_TREEVIEW = YES
1386
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001387# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1388# doxygen will group on one line in the generated HTML documentation.
1389#
1390# Note that a value of 0 will completely suppress the enum values from appearing
1391# in the overview section.
1392# Minimum value: 0, maximum value: 20, default value: 4.
1393# This tag requires that the tag GENERATE_HTML is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001394
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001395ENUM_VALUES_PER_LINE = 4
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001396
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001397# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1398# to set the initial width (in pixels) of the frame in which the tree is shown.
1399# Minimum value: 0, maximum value: 1500, default value: 250.
1400# This tag requires that the tag GENERATE_HTML is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001401
Alexander Afanasyev97fb44d2012-06-04 18:50:47 -07001402TREEVIEW_WIDTH = 300
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001403
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001404# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1405# external symbols imported via tag files in a separate window.
1406# The default value is: NO.
1407# This tag requires that the tag GENERATE_HTML is set to YES.
1408
1409EXT_LINKS_IN_WINDOW = NO
1410
1411# Use this tag to change the font size of LaTeX formulas included as images in
1412# the HTML documentation. When you change the font size after a successful
1413# doxygen run you need to manually remove any form_*.png images from the HTML
1414# output directory to force them to be regenerated.
1415# Minimum value: 8, maximum value: 50, default value: 10.
1416# This tag requires that the tag GENERATE_HTML is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001417
1418FORMULA_FONTSIZE = 10
1419
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001420# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1421# generated for formulas are transparent PNGs. Transparent PNGs are not
1422# supported properly for IE 6.0, but are supported on all modern browsers.
1423#
1424# Note that when changing this option you need to delete any form_*.png files in
1425# the HTML output directory before the changes have effect.
1426# The default value is: YES.
1427# This tag requires that the tag GENERATE_HTML is set to YES.
1428
1429FORMULA_TRANSPARENT = YES
1430
1431# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1432# http://www.mathjax.org) which uses client side Javascript for the rendering
1433# instead of using prerendered bitmaps. Use this if you do not have LaTeX
1434# installed or if you want to formulas look prettier in the HTML output. When
1435# enabled you may also need to install MathJax separately and configure the path
1436# to it using the MATHJAX_RELPATH option.
1437# The default value is: NO.
1438# This tag requires that the tag GENERATE_HTML is set to YES.
1439
1440USE_MATHJAX = NO
1441
1442# When MathJax is enabled you can set the default output format to be used for
1443# the MathJax output. See the MathJax site (see:
1444# http://docs.mathjax.org/en/latest/output.html) for more details.
1445# Possible values are: HTML-CSS (which is slower, but has the best
1446# compatibility), NativeMML (i.e. MathML) and SVG.
1447# The default value is: HTML-CSS.
1448# This tag requires that the tag USE_MATHJAX is set to YES.
1449
1450MATHJAX_FORMAT = HTML-CSS
1451
1452# When MathJax is enabled you need to specify the location relative to the HTML
1453# output directory using the MATHJAX_RELPATH option. The destination directory
1454# should contain the MathJax.js script. For instance, if the mathjax directory
1455# is located at the same level as the HTML output directory, then
1456# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1457# Content Delivery Network so you can quickly see the result without installing
1458# MathJax. However, it is strongly recommended to install a local copy of
1459# MathJax from http://www.mathjax.org before deployment.
1460# The default value is: http://cdn.mathjax.org/mathjax/latest.
1461# This tag requires that the tag USE_MATHJAX is set to YES.
1462
1463MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1464
1465# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1466# extension names that should be enabled during MathJax rendering. For example
1467# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1468# This tag requires that the tag USE_MATHJAX is set to YES.
1469
1470MATHJAX_EXTENSIONS =
1471
1472# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1473# of code that will be used on startup of the MathJax code. See the MathJax site
1474# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1475# example see the documentation.
1476# This tag requires that the tag USE_MATHJAX is set to YES.
1477
1478MATHJAX_CODEFILE =
1479
1480# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1481# the HTML output. The underlying search engine uses javascript and DHTML and
1482# should work on any modern browser. Note that when using HTML help
1483# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1484# there is already a search function so this one should typically be disabled.
1485# For large projects the javascript based search engine can be slow, then
1486# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1487# search using the keyboard; to jump to the search box use <access key> + S
1488# (what the <access key> is depends on the OS and browser, but it is typically
1489# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1490# key> to jump into the search results window, the results can be navigated
1491# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1492# the search. The filter options can be selected when the cursor is inside the
1493# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1494# to select a filter and <Enter> or <escape> to activate or cancel the filter
1495# option.
1496# The default value is: YES.
1497# This tag requires that the tag GENERATE_HTML is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001498
Alexander Afanasyev97fb44d2012-06-04 18:50:47 -07001499SEARCHENGINE = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001500
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001501# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1502# implemented using a web server instead of a web client using Javascript. There
1503# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1504# setting. When disabled, doxygen will generate a PHP script for searching and
1505# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1506# and searching needs to be provided by external tools. See the section
1507# "External Indexing and Searching" for details.
1508# The default value is: NO.
1509# This tag requires that the tag SEARCHENGINE is set to YES.
1510
1511SERVER_BASED_SEARCH = NO
1512
1513# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1514# script for searching. Instead the search results are written to an XML file
1515# which needs to be processed by an external indexer. Doxygen will invoke an
1516# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1517# search results.
1518#
1519# Doxygen ships with an example indexer ( doxyindexer) and search engine
1520# (doxysearch.cgi) which are based on the open source search engine library
1521# Xapian (see: http://xapian.org/).
1522#
1523# See the section "External Indexing and Searching" for details.
1524# The default value is: NO.
1525# This tag requires that the tag SEARCHENGINE is set to YES.
1526
1527EXTERNAL_SEARCH = NO
1528
1529# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1530# which will return the search results when EXTERNAL_SEARCH is enabled.
1531#
1532# Doxygen ships with an example indexer ( doxyindexer) and search engine
1533# (doxysearch.cgi) which are based on the open source search engine library
1534# Xapian (see: http://xapian.org/). See the section "External Indexing and
1535# Searching" for details.
1536# This tag requires that the tag SEARCHENGINE is set to YES.
1537
1538SEARCHENGINE_URL =
1539
1540# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1541# search data is written to a file for indexing by an external tool. With the
1542# SEARCHDATA_FILE tag the name of this file can be specified.
1543# The default file is: searchdata.xml.
1544# This tag requires that the tag SEARCHENGINE is set to YES.
1545
1546SEARCHDATA_FILE = searchdata.xml
1547
1548# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1549# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1550# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1551# projects and redirect the results back to the right project.
1552# This tag requires that the tag SEARCHENGINE is set to YES.
1553
1554EXTERNAL_SEARCH_ID =
1555
1556# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1557# projects other than the one defined by this configuration file, but that are
1558# all added to the same external search index. Each project needs to have a
1559# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1560# to a relative location where the documentation can be found. The format is:
1561# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1562# This tag requires that the tag SEARCHENGINE is set to YES.
1563
1564EXTRA_SEARCH_MAPPINGS =
1565
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001566#---------------------------------------------------------------------------
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001567# Configuration options related to the LaTeX output
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001568#---------------------------------------------------------------------------
1569
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001570# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1571# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001572
1573GENERATE_LATEX = NO
1574
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001575# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1576# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1577# it.
1578# The default directory is: latex.
1579# This tag requires that the tag GENERATE_LATEX is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001580
1581LATEX_OUTPUT = latex
1582
1583# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001584# invoked.
1585#
1586# Note that when enabling USE_PDFLATEX this option is only used for generating
1587# bitmaps for formulas in the HTML output, but not in the Makefile that is
1588# written to the output directory.
1589# The default file is: latex.
1590# This tag requires that the tag GENERATE_LATEX is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001591
1592LATEX_CMD_NAME = latex
1593
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001594# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1595# index for LaTeX.
1596# The default file is: makeindex.
1597# This tag requires that the tag GENERATE_LATEX is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001598
1599MAKEINDEX_CMD_NAME = makeindex
1600
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001601# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1602# documents. This may be useful for small projects and may help to save some
1603# trees in general.
1604# The default value is: NO.
1605# This tag requires that the tag GENERATE_LATEX is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001606
1607COMPACT_LATEX = YES
1608
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001609# The PAPER_TYPE tag can be used to set the paper type that is used by the
1610# printer.
1611# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1612# 14 inches) and executive (7.25 x 10.5 inches).
1613# The default value is: a4.
1614# This tag requires that the tag GENERATE_LATEX is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001615
1616PAPER_TYPE = a4wide
1617
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001618# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1619# that should be included in the LaTeX output. To get the times font for
1620# instance you can specify
1621# EXTRA_PACKAGES=times
1622# If left blank no extra packages will be included.
1623# This tag requires that the tag GENERATE_LATEX is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001624
1625EXTRA_PACKAGES = amsmath
1626
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001627# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1628# generated LaTeX document. The header should contain everything until the first
1629# chapter. If it is left blank doxygen will generate a standard header. See
1630# section "Doxygen usage" for information on how to let doxygen write the
1631# default header to a separate file.
1632#
1633# Note: Only use a user-defined header if you know what you are doing! The
1634# following commands have a special meaning inside the header: $title,
1635# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1636# replace them by respectively the title of the page, the current date and time,
1637# only the current date, the version number of doxygen, the project name (see
1638# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1639# This tag requires that the tag GENERATE_LATEX is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001640
1641LATEX_HEADER =
1642
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001643# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1644# generated LaTeX document. The footer should contain everything after the last
1645# chapter. If it is left blank doxygen will generate a standard footer.
1646#
1647# Note: Only use a user-defined footer if you know what you are doing!
1648# This tag requires that the tag GENERATE_LATEX is set to YES.
1649
1650LATEX_FOOTER =
1651
1652# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1653# other source files which should be copied to the LATEX_OUTPUT output
1654# directory. Note that the files will be copied as-is; there are no commands or
1655# markers available.
1656# This tag requires that the tag GENERATE_LATEX is set to YES.
1657
1658LATEX_EXTRA_FILES =
1659
1660# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1661# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1662# contain links (just like the HTML output) instead of page references. This
1663# makes the output suitable for online browsing using a PDF viewer.
1664# The default value is: YES.
1665# This tag requires that the tag GENERATE_LATEX is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001666
1667PDF_HYPERLINKS = YES
1668
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001669# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1670# the PDF file directly from the LaTeX files. Set this option to YES to get a
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001671# higher quality PDF documentation.
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001672# The default value is: YES.
1673# This tag requires that the tag GENERATE_LATEX is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001674
1675USE_PDFLATEX = YES
1676
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001677# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1678# command to the generated LaTeX files. This will instruct LaTeX to keep running
1679# if errors occur, instead of asking the user for help. This option is also used
1680# when generating formulas in HTML.
1681# The default value is: NO.
1682# This tag requires that the tag GENERATE_LATEX is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001683
1684LATEX_BATCHMODE = NO
1685
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001686# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1687# index chapters (such as File Index, Compound Index, etc.) in the output.
1688# The default value is: NO.
1689# This tag requires that the tag GENERATE_LATEX is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001690
1691LATEX_HIDE_INDICES = YES
1692
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001693# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1694# code with syntax highlighting in the LaTeX output.
1695#
1696# Note that which sources are shown also depends on other settings such as
1697# SOURCE_BROWSER.
1698# The default value is: NO.
1699# This tag requires that the tag GENERATE_LATEX is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001700
1701LATEX_SOURCE_CODE = NO
1702
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001703# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1704# bibliography, e.g. plainnat, or ieeetr. See
1705# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1706# The default value is: plain.
1707# This tag requires that the tag GENERATE_LATEX is set to YES.
1708
1709LATEX_BIB_STYLE = plain
1710
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001711#---------------------------------------------------------------------------
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001712# Configuration options related to the RTF output
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001713#---------------------------------------------------------------------------
1714
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001715# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1716# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1717# readers/editors.
1718# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001719
1720GENERATE_RTF = NO
1721
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001722# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1723# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1724# it.
1725# The default directory is: rtf.
1726# This tag requires that the tag GENERATE_RTF is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001727
1728RTF_OUTPUT = rtf
1729
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001730# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1731# documents. This may be useful for small projects and may help to save some
1732# trees in general.
1733# The default value is: NO.
1734# This tag requires that the tag GENERATE_RTF is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001735
1736COMPACT_RTF = NO
1737
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001738# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1739# contain hyperlink fields. The RTF file will contain links (just like the HTML
1740# output) instead of page references. This makes the output suitable for online
1741# browsing using Word or some other Word compatible readers that support those
1742# fields.
1743#
1744# Note: WordPad (write) and others do not support links.
1745# The default value is: NO.
1746# This tag requires that the tag GENERATE_RTF is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001747
1748RTF_HYPERLINKS = NO
1749
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001750# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1751# file, i.e. a series of assignments. You only have to provide replacements,
1752# missing definitions are set to their default value.
1753#
1754# See also section "Doxygen usage" for information on how to generate the
1755# default style sheet that doxygen normally uses.
1756# This tag requires that the tag GENERATE_RTF is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001757
1758RTF_STYLESHEET_FILE =
1759
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001760# Set optional variables used in the generation of an RTF document. Syntax is
1761# similar to doxygen's config file. A template extensions file can be generated
1762# using doxygen -e rtf extensionFile.
1763# This tag requires that the tag GENERATE_RTF is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001764
1765RTF_EXTENSIONS_FILE =
1766
1767#---------------------------------------------------------------------------
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001768# Configuration options related to the man page output
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001769#---------------------------------------------------------------------------
1770
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001771# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1772# classes and files.
1773# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001774
1775GENERATE_MAN = NO
1776
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001777# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1778# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1779# it. A directory man3 will be created inside the directory specified by
1780# MAN_OUTPUT.
1781# The default directory is: man.
1782# This tag requires that the tag GENERATE_MAN is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001783
1784MAN_OUTPUT = man
1785
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001786# The MAN_EXTENSION tag determines the extension that is added to the generated
1787# man pages. In case the manual section does not start with a number, the number
1788# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1789# optional.
1790# The default value is: .3.
1791# This tag requires that the tag GENERATE_MAN is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001792
1793MAN_EXTENSION = .3
1794
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001795# The MAN_SUBDIR tag determines the name of the directory created within
1796# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1797# MAN_EXTENSION with the initial . removed.
1798# This tag requires that the tag GENERATE_MAN is set to YES.
1799
1800MAN_SUBDIR =
1801
1802# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1803# will generate one additional man file for each entity documented in the real
1804# man page(s). These additional files only source the real man page, but without
1805# them the man command would be unable to find the correct page.
1806# The default value is: NO.
1807# This tag requires that the tag GENERATE_MAN is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001808
1809MAN_LINKS = NO
1810
1811#---------------------------------------------------------------------------
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001812# Configuration options related to the XML output
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001813#---------------------------------------------------------------------------
1814
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001815# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1816# captures the structure of the code including all documentation.
1817# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001818
1819GENERATE_XML = NO
1820
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001821# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1822# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1823# it.
1824# The default directory is: xml.
1825# This tag requires that the tag GENERATE_XML is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001826
1827XML_OUTPUT = xml
1828
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001829# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1830# listings (including syntax highlighting and cross-referencing information) to
1831# the XML output. Note that enabling this will significantly increase the size
1832# of the XML output.
1833# The default value is: YES.
1834# This tag requires that the tag GENERATE_XML is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001835
1836XML_PROGRAMLISTING = YES
1837
1838#---------------------------------------------------------------------------
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001839# Configuration options related to the DOCBOOK output
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001840#---------------------------------------------------------------------------
1841
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001842# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1843# that can be used to generate PDF.
1844# The default value is: NO.
1845
1846GENERATE_DOCBOOK = NO
1847
1848# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1849# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1850# front of it.
1851# The default directory is: docbook.
1852# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1853
1854DOCBOOK_OUTPUT = docbook
1855
1856#---------------------------------------------------------------------------
1857# Configuration options for the AutoGen Definitions output
1858#---------------------------------------------------------------------------
1859
1860# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1861# Definitions (see http://autogen.sf.net) file that captures the structure of
1862# the code including all documentation. Note that this feature is still
1863# experimental and incomplete at the moment.
1864# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001865
1866GENERATE_AUTOGEN_DEF = NO
1867
1868#---------------------------------------------------------------------------
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001869# Configuration options related to the Perl module output
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001870#---------------------------------------------------------------------------
1871
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001872# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1873# file that captures the structure of the code including all documentation.
1874#
1875# Note that this feature is still experimental and incomplete at the moment.
1876# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001877
1878GENERATE_PERLMOD = NO
1879
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001880# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1881# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1882# output from the Perl module output.
1883# The default value is: NO.
1884# This tag requires that the tag GENERATE_PERLMOD is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001885
1886PERLMOD_LATEX = NO
1887
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001888# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1889# formatted so it can be parsed by a human reader. This is useful if you want to
1890# understand what is going on. On the other hand, if this tag is set to NO the
1891# size of the Perl module output will be much smaller and Perl will parse it
1892# just the same.
1893# The default value is: YES.
1894# This tag requires that the tag GENERATE_PERLMOD is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001895
1896PERLMOD_PRETTY = YES
1897
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001898# The names of the make variables in the generated doxyrules.make file are
1899# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1900# so different doxyrules.make files included by the same Makefile don't
1901# overwrite each other's variables.
1902# This tag requires that the tag GENERATE_PERLMOD is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001903
1904PERLMOD_MAKEVAR_PREFIX =
1905
1906#---------------------------------------------------------------------------
1907# Configuration options related to the preprocessor
1908#---------------------------------------------------------------------------
1909
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001910# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1911# C-preprocessor directives found in the sources and include files.
1912# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001913
1914ENABLE_PREPROCESSING = YES
1915
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001916# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1917# in the source code. If set to NO only conditional compilation will be
1918# performed. Macro expansion can be done in a controlled way by setting
1919# EXPAND_ONLY_PREDEF to YES.
1920# The default value is: NO.
1921# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001922
1923MACRO_EXPANSION = YES
1924
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001925# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1926# the macro expansion is limited to the macros specified with the PREDEFINED and
1927# EXPAND_AS_DEFINED tags.
1928# The default value is: NO.
1929# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001930
1931EXPAND_ONLY_PREDEF = YES
1932
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001933# If the SEARCH_INCLUDES tag is set to YES the includes files in the
1934# INCLUDE_PATH will be searched if a #include is found.
1935# The default value is: YES.
1936# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001937
1938SEARCH_INCLUDES = YES
1939
1940# The INCLUDE_PATH tag can be used to specify one or more directories that
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001941# contain include files that are not input files but should be processed by the
1942# preprocessor.
1943# This tag requires that the tag SEARCH_INCLUDES is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001944
Alexander Afanasyev79206512013-07-27 16:49:12 -07001945INCLUDE_PATH = ../../../build
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001946
1947# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1948# patterns (like *.h and *.hpp) to filter out the header-files in the
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001949# directories. If left blank, the patterns specified with FILE_PATTERNS will be
1950# used.
1951# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001952
1953INCLUDE_FILE_PATTERNS =
1954
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001955# The PREDEFINED tag can be used to specify one or more macro names that are
1956# defined before the preprocessor is started (similar to the -D option of e.g.
1957# gcc). The argument of the tag is a list of macros of the form: name or
1958# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1959# is assumed. To prevent a macro definition from being undefined via #undef or
1960# recursively expanded use the := operator instead of the = operator.
1961# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001962
1963PREDEFINED = NS3_ASSERT_ENABLE \
Alexander Afanasyev15b71142012-10-29 10:14:30 -07001964 NS3_LOG_ENABLE \
Alexander Afanasyev79206512013-07-27 16:49:12 -07001965 DOXYGEN \
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001966 NS_LOG_COMPONENT_DEFINE \
1967 NFD_LOG_INIT \
1968 BOOST_CONCEPT_ASSERT \
1969 PUBLIC_WITH_TESTS_ELSE_PROTECTED=protected \
1970 PUBLIC_WITH_TESTS_ELSE_PRIVATE=private \
1971 PROTECTED_WITH_TESTS_ELSE_PRIVATE=private \
1972 VIRTUAL_WITH_TESTS \
1973 DECL_OVERRIDE \
Alexander Afanasyev11381c22015-01-19 16:07:46 -08001974 ATTRIBUTE_HELPER_CPP \
1975 NDN_CXX_KEYCHAIN_REGISTER_PIB \
1976 NDN_CXX_KEYCHAIN_REGISTER_TPM
Alexander Afanasyev79206512013-07-27 16:49:12 -07001977
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001978
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001979# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1980# tag can be used to specify a list of macro names that should be expanded. The
1981# macro definition that is found in the sources will be used. Use the PREDEFINED
1982# tag if you want to use a different macro definition that overrules the
1983# definition found in the source code.
1984# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001985
1986EXPAND_AS_DEFINED = ATTRIBUTE_VALUE_DEFINE \
1987 ATTRIBUTE_VALUE_DEFINE_WITH_NAME \
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001988 ATTRIBUTE_HELPER_HEADER_2 \
1989 ATTRIBUTE_HELPER_HEADER
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001990
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08001991# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1992# remove all references to function-like macros that are alone on a line, have
1993# an all uppercase name, and do not end with a semicolon. Such function macros
1994# are typically used for boiler-plate code, and will confuse the parser if not
1995# removed.
1996# The default value is: YES.
1997# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001998
1999SKIP_FUNCTION_MACROS = YES
2000
2001#---------------------------------------------------------------------------
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002002# Configuration options related to external references
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002003#---------------------------------------------------------------------------
2004
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002005# The TAGFILES tag can be used to specify one or more tag files. For each tag
2006# file the location of the external documentation should be added. The format of
2007# a tag file without this location is as follows:
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002008# TAGFILES = file1 file2 ...
2009# Adding location for the tag files is done as follows:
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002010# TAGFILES = file1=loc1 "file2 = loc2" ...
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002011# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2012# section "Linking to external documentation" for more information about the use
2013# of tag files.
2014# Note: Each tag file must have a unique name (where the name does NOT include
2015# the path). If a tag file is not located in the directory in which doxygen is
2016# run, you must also specify the path to the tagfile here.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002017
2018TAGFILES =
2019
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002020# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2021# tag file that is based on the input files it reads. See section "Linking to
2022# external documentation" for more information about the usage of tag files.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002023
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002024GENERATE_TAGFILE = ndnSIM.tag
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002025
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002026# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2027# class index. If set to NO only the inherited external classes will be listed.
2028# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002029
2030ALLEXTERNALS = NO
2031
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002032# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2033# the modules index. If set to NO, only the current project's groups will be
2034# listed.
2035# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002036
2037EXTERNAL_GROUPS = YES
2038
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002039# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2040# the related pages index. If set to NO, only the current project's pages will
2041# be listed.
2042# The default value is: YES.
2043
2044EXTERNAL_PAGES = YES
2045
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002046# The PERL_PATH should be the absolute path and name of the perl script
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002047# interpreter (i.e. the result of 'which perl').
2048# The default file (with absolute path) is: /usr/bin/perl.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002049
2050PERL_PATH = /usr/bin/perl
2051
2052#---------------------------------------------------------------------------
2053# Configuration options related to the dot tool
2054#---------------------------------------------------------------------------
2055
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002056# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2057# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2058# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2059# disabled, but it is recommended to install and use dot, since it yields more
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002060# powerful graphs.
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002061# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002062
2063CLASS_DIAGRAMS = YES
2064
2065# You can define message sequence charts within doxygen comments using the \msc
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002066# command. Doxygen will then run the mscgen tool (see:
2067# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002068# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2069# the mscgen tool resides. If left empty the tool is assumed to be found in the
2070# default search path.
2071
2072MSCGEN_PATH =
2073
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002074# You can include diagrams made with dia in doxygen documentation. Doxygen will
2075# then run dia to produce the diagram and insert it in the documentation. The
2076# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2077# If left empty dia is assumed to be found in the default search path.
2078
2079DIA_PATH =
2080
2081# If set to YES, the inheritance and collaboration graphs will hide inheritance
2082# and usage relations if the target is undocumented or is not a class.
2083# The default value is: YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002084
2085HIDE_UNDOC_RELATIONS = YES
2086
2087# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002088# available from the path. This tool is part of Graphviz (see:
2089# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2090# Bell Labs. The other options in this section have no effect if this option is
2091# set to NO
2092# The default value is: NO.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002093
2094HAVE_DOT = YES
2095
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002096# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2097# to run in parallel. When set to 0 doxygen will base this on the number of
2098# processors available in the system. You can set it explicitly to a value
2099# larger than 0 to get control over the balance between CPU load and processing
2100# speed.
2101# Minimum value: 0, maximum value: 32, default value: 0.
2102# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002103
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002104DOT_NUM_THREADS = 0
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002105
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002106# When you want a differently looking font n the dot files that doxygen
2107# generates you can specify the font name using DOT_FONTNAME. You need to make
2108# sure dot is able to find the font, which can be done by putting it in a
2109# standard location or by setting the DOTFONTPATH environment variable or by
2110# setting DOT_FONTPATH to the directory containing the font.
2111# The default value is: Helvetica.
2112# This tag requires that the tag HAVE_DOT is set to YES.
2113
2114DOT_FONTNAME =
2115
2116# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2117# dot graphs.
2118# Minimum value: 4, maximum value: 24, default value: 10.
2119# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002120
2121DOT_FONTSIZE = 10
2122
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002123# By default doxygen will tell dot to use the default font as specified with
2124# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2125# the path where dot can find it using this tag.
2126# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002127
2128DOT_FONTPATH =
2129
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002130# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2131# each documented class showing the direct and indirect inheritance relations.
2132# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2133# The default value is: YES.
2134# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002135
2136CLASS_GRAPH = YES
2137
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002138# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2139# graph for each documented class showing the direct and indirect implementation
2140# dependencies (inheritance, containment, and class references variables) of the
2141# class with other documented classes.
2142# The default value is: YES.
2143# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002144
2145COLLABORATION_GRAPH = YES
2146
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002147# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2148# groups, showing the direct groups dependencies.
2149# The default value is: YES.
2150# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002151
2152GROUP_GRAPHS = YES
2153
2154# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2155# collaboration diagrams in a style similar to the OMG's Unified Modeling
2156# Language.
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002157# The default value is: NO.
2158# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002159
2160UML_LOOK = NO
2161
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002162# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2163# class node. If there are many fields or methods and many nodes the graph may
2164# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2165# number of items for each type to make the size more manageable. Set this to 0
2166# for no limit. Note that the threshold may be exceeded by 50% before the limit
2167# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2168# but if the number exceeds 15, the total amount of fields shown is limited to
2169# 10.
2170# Minimum value: 0, maximum value: 100, default value: 10.
2171# This tag requires that the tag HAVE_DOT is set to YES.
2172
2173UML_LIMIT_NUM_FIELDS = 10
2174
2175# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2176# collaboration graphs will show the relations between templates and their
2177# instances.
2178# The default value is: NO.
2179# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002180
Alexander Afanasyev1cd79ae2012-10-05 22:42:12 -07002181TEMPLATE_RELATIONS = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002182
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002183# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2184# YES then doxygen will generate a graph for each documented file showing the
2185# direct and indirect include dependencies of the file with other documented
2186# files.
2187# The default value is: YES.
2188# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002189
2190INCLUDE_GRAPH = YES
2191
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002192# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2193# set to YES then doxygen will generate a graph for each documented file showing
2194# the direct and indirect include dependencies of the file with other documented
2195# files.
2196# The default value is: YES.
2197# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002198
2199INCLUDED_BY_GRAPH = YES
2200
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002201# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2202# dependency graph for every global function or class method.
2203#
2204# Note that enabling this option will significantly increase the time of a run.
2205# So in most cases it will be better to enable call graphs for selected
2206# functions only using the \callgraph command.
2207# The default value is: NO.
2208# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002209
2210CALL_GRAPH = NO
2211
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002212# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2213# dependency graph for every global function or class method.
2214#
2215# Note that enabling this option will significantly increase the time of a run.
2216# So in most cases it will be better to enable caller graphs for selected
2217# functions only using the \callergraph command.
2218# The default value is: NO.
2219# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002220
2221CALLER_GRAPH = NO
2222
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002223# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2224# hierarchy of all classes instead of a textual one.
2225# The default value is: YES.
2226# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002227
2228GRAPHICAL_HIERARCHY = YES
2229
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002230# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2231# dependencies a directory has on other directories in a graphical way. The
2232# dependency relations are determined by the #include relations between the
2233# files in the directories.
2234# The default value is: YES.
2235# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002236
2237DIRECTORY_GRAPH = YES
2238
2239# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002240# generated by dot.
2241# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2242# to make the SVG files visible in IE 9+ (other browsers do not have this
2243# requirement).
2244# Possible values are: png, jpg, gif and svg.
2245# The default value is: png.
2246# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002247
2248DOT_IMAGE_FORMAT = png
2249
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002250# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2251# enable generation of interactive SVG images that allow zooming and panning.
2252#
2253# Note that this requires a modern browser other than Internet Explorer. Tested
2254# and working are Firefox, Chrome, Safari, and Opera.
2255# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2256# the SVG files visible. Older versions of IE do not have SVG support.
2257# The default value is: NO.
2258# This tag requires that the tag HAVE_DOT is set to YES.
2259
2260INTERACTIVE_SVG = NO
2261
2262# The DOT_PATH tag can be used to specify the path where the dot tool can be
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002263# found. If left blank, it is assumed the dot tool can be found in the path.
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002264# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002265
2266DOT_PATH =
2267
2268# The DOTFILE_DIRS tag can be used to specify one or more directories that
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002269# contain dot files that are included in the documentation (see the \dotfile
2270# command).
2271# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002272
2273DOTFILE_DIRS =
2274
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002275# The MSCFILE_DIRS tag can be used to specify one or more directories that
2276# contain msc files that are included in the documentation (see the \mscfile
2277# command).
2278
2279MSCFILE_DIRS =
2280
2281# The DIAFILE_DIRS tag can be used to specify one or more directories that
2282# contain dia files that are included in the documentation (see the \diafile
2283# command).
2284
2285DIAFILE_DIRS =
2286
2287# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2288# that will be shown in the graph. If the number of nodes in a graph becomes
2289# larger than this value, doxygen will truncate the graph, which is visualized
2290# by representing a node as a red box. Note that doxygen if the number of direct
2291# children of the root node in a graph is already larger than
2292# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2293# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2294# Minimum value: 0, maximum value: 10000, default value: 50.
2295# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002296
2297DOT_GRAPH_MAX_NODES = 50
2298
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002299# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2300# generated by dot. A depth value of 3 means that only nodes reachable from the
2301# root by following a path via at most 3 edges will be shown. Nodes that lay
2302# further from the root node will be omitted. Note that setting this option to 1
2303# or 2 may greatly reduce the computation time needed for large code bases. Also
2304# note that the size of a graph can be further restricted by
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002305# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002306# Minimum value: 0, maximum value: 1000, default value: 0.
2307# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002308
2309MAX_DOT_GRAPH_DEPTH = 0
2310
2311# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002312# background. This is disabled by default, because dot on Windows does not seem
2313# to support this out of the box.
2314#
2315# Warning: Depending on the platform used, enabling this option may lead to
2316# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2317# read).
2318# The default value is: NO.
2319# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002320
2321DOT_TRANSPARENT = NO
2322
2323# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2324# files in one run (i.e. multiple -o and -T options on the command line). This
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002325# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2326# this, this feature is disabled by default.
2327# The default value is: NO.
2328# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002329
2330DOT_MULTI_TARGETS = NO
2331
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002332# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2333# explaining the meaning of the various boxes and arrows in the dot generated
2334# graphs.
2335# The default value is: YES.
2336# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002337
2338GENERATE_LEGEND = YES
2339
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -08002340# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2341# files that are used to generate the various graphs.
2342# The default value is: YES.
2343# This tag requires that the tag HAVE_DOT is set to YES.
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07002344
2345DOT_CLEANUP = YES