blob: ebe4bb061165dee7c69b230801cdcd9e1f0e77c1 [file] [log] [blame]
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001# Doxyfile 1.6.1
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project
5#
6# All text after a hash (#) is considered a comment and will be ignored
7# The format is:
8# TAG = value [value, ...]
9# For lists items can also be appended using:
10# TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ")
12
13#---------------------------------------------------------------------------
14# Project related configuration options
15#---------------------------------------------------------------------------
16
17# This tag specifies the encoding used for all characters in the config file
18# that follow. The default is UTF-8 which is also the encoding used for all
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20# iconv built into libc) for the transcoding. See
21# http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23DOXYFILE_ENCODING = UTF-8
24
25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26# by quotes) that should identify the project.
27
Alexander Afanasyev508269a2012-07-28 13:59:54 -070028PROJECT_NAME = "ndnSIM"
Alexander Afanasyev6315ef72012-06-01 20:56:31 -070029
30# The PROJECT_NUMBER tag can be used to enter a project or revision number.
31# This could be handy for archiving the generated documentation or
32# if some version control system is used.
33
34PROJECT_NUMBER =
35
Alexander Afanasyev508269a2012-07-28 13:59:54 -070036PROJECT_LOGO = ./doc/ns3_html_theme/static/ndn-logo.png
37
Alexander Afanasyev6315ef72012-06-01 20:56:31 -070038# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
39# base path where the generated documentation will be put.
40# If a relative path is entered, it will be relative to the location
41# where doxygen was started. If left blank the current directory will be used.
42
Alexander Afanasyev97fb44d2012-06-04 18:50:47 -070043OUTPUT_DIRECTORY =
Alexander Afanasyev6315ef72012-06-01 20:56:31 -070044
45# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
46# 4096 sub-directories (in 2 levels) under the output directory of each output
47# format and will distribute the generated files over these directories.
48# Enabling this option can be useful when feeding doxygen a huge amount of
49# source files, where putting all generated files in the same directory would
50# otherwise cause performance problems for the file system.
51
52CREATE_SUBDIRS = NO
53
54# The OUTPUT_LANGUAGE tag is used to specify the language in which all
55# documentation generated by doxygen is written. Doxygen will use this
56# information to generate all constant output in the proper language.
57# The default language is English, other supported languages are:
58# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
59# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
60# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
61# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
62# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
63# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
64
65OUTPUT_LANGUAGE = English
66
67# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
68# include brief member descriptions after the members that are listed in
69# the file and class documentation (similar to JavaDoc).
70# Set to NO to disable this.
71
72BRIEF_MEMBER_DESC = YES
73
74# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
75# the brief description of a member or function before the detailed description.
76# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
77# brief descriptions will be completely suppressed.
78
79REPEAT_BRIEF = YES
80
81# This tag implements a quasi-intelligent brief description abbreviator
82# that is used to form the text in various listings. Each string
83# in this list, if found as the leading text of the brief description, will be
84# stripped from the text and the result after processing the whole list, is
85# used as the annotated text. Otherwise, the brief description is used as-is.
86# If left blank, the following values are used ("$name" is automatically
87# replaced with the name of the entity): "The $name class" "The $name widget"
88# "The $name file" "is" "provides" "specifies" "contains"
89# "represents" "a" "an" "the"
90
91ABBREVIATE_BRIEF =
92
93# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
94# Doxygen will generate a detailed section even if there is only a brief
95# description.
96
97ALWAYS_DETAILED_SEC = NO
98
99# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
100# inherited members of a class in the documentation of that class as if those
101# members were ordinary class members. Constructors, destructors and assignment
102# operators of the base classes will not be shown.
103
104INLINE_INHERITED_MEMB = NO
105
106# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
107# path before files name in the file list and in the header files. If set
108# to NO the shortest path that makes the file name unique will be used.
109
110FULL_PATH_NAMES = YES
111
112# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
113# can be used to strip a user-defined part of the path. Stripping is
114# only done if one of the specified strings matches the left-hand part of
115# the path. The tag can be used to show relative paths in the file list.
116# If left blank the directory from which doxygen is run is used as the
117# path to strip.
118
Alexander Afanasyev508269a2012-07-28 13:59:54 -0700119STRIP_FROM_PATH = ../..
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700120
121# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
122# the path mentioned in the documentation of a class, which tells
123# the reader which header file to include in order to use a class.
124# If left blank only the name of the header file containing the class
125# definition is used. Otherwise one should specify the include paths that
126# are normally passed to the compiler using the -I flag.
127
128STRIP_FROM_INC_PATH =
129
130# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
131# (but less readable) file names. This can be useful is your file systems
132# doesn't support long names like on DOS, Mac, or CD-ROM.
133
134SHORT_NAMES = NO
135
136# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
137# will interpret the first line (until the first dot) of a JavaDoc-style
138# comment as the brief description. If set to NO, the JavaDoc
139# comments will behave just like regular Qt-style comments
140# (thus requiring an explicit @brief command for a brief description.)
141
142JAVADOC_AUTOBRIEF = YES
143
144# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
145# interpret the first line (until the first dot) of a Qt-style
146# comment as the brief description. If set to NO, the comments
147# will behave just like regular Qt-style comments (thus requiring
148# an explicit \brief command for a brief description.)
149
150QT_AUTOBRIEF = NO
151
152# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
153# treat a multi-line C++ special comment block (i.e. a block of //! or ///
154# comments) as a brief description. This used to be the default behaviour.
155# The new default is to treat a multi-line C++ comment block as a detailed
156# description. Set this tag to YES if you prefer the old behaviour instead.
157
158MULTILINE_CPP_IS_BRIEF = NO
159
160# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
161# member inherits the documentation from any documented member that it
162# re-implements.
163
164INHERIT_DOCS = YES
165
166# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
167# a new page for each member. If set to NO, the documentation of a member will
168# be part of the file/class/namespace that contains it.
169
170SEPARATE_MEMBER_PAGES = NO
171
172# The TAB_SIZE tag can be used to set the number of spaces in a tab.
173# Doxygen uses this value to replace tabs by spaces in code fragments.
174
175TAB_SIZE = 4
176
177# This tag can be used to specify a number of aliases that acts
178# as commands in the documentation. An alias has the form "name=value".
179# For example adding "sideeffect=\par Side Effects:\n" will allow you to
180# put the command \sideeffect (or @sideeffect) in the documentation, which
181# will result in a user-defined paragraph with heading "Side Effects:".
182# You can put \n's in the value part of an alias to insert newlines.
183
184ALIASES =
185
186# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
187# sources only. Doxygen will then generate output that is more tailored for C.
188# For instance, some of the names that are used will be different. The list
189# of all members will be omitted, etc.
190
191OPTIMIZE_OUTPUT_FOR_C = NO
192
193# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
194# sources only. Doxygen will then generate output that is more tailored for
195# Java. For instance, namespaces will be presented as packages, qualified
196# scopes will look different, etc.
197
198OPTIMIZE_OUTPUT_JAVA = NO
199
200# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
201# sources only. Doxygen will then generate output that is more tailored for
202# Fortran.
203
204OPTIMIZE_FOR_FORTRAN = NO
205
206# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
207# sources. Doxygen will then generate output that is tailored for
208# VHDL.
209
210OPTIMIZE_OUTPUT_VHDL = NO
211
212# Doxygen selects the parser to use depending on the extension of the files it parses.
213# With this tag you can assign which parser to use for a given extension.
214# Doxygen has a built-in mapping, but you can override or extend it using this tag.
215# The format is ext=language, where ext is a file extension, and language is one of
216# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
217# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
218# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
219# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
220
221EXTENSION_MAPPING =
222
223# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
224# to include (a tag file for) the STL sources as input, then you should
225# set this tag to YES in order to let doxygen match functions declarations and
226# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
227# func(std::string) {}). This also make the inheritance and collaboration
228# diagrams that involve STL classes more complete and accurate.
229
230BUILTIN_STL_SUPPORT = NO
231
232# If you use Microsoft's C++/CLI language, you should set this option to YES to
233# enable parsing support.
234
235CPP_CLI_SUPPORT = NO
236
237# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
238# Doxygen will parse them like normal C++ but will assume all classes use public
239# instead of private inheritance when no explicit protection keyword is present.
240
241SIP_SUPPORT = NO
242
243# For Microsoft's IDL there are propget and propput attributes to indicate getter
244# and setter methods for a property. Setting this option to YES (the default)
245# will make doxygen to replace the get and set methods by a property in the
246# documentation. This will only work if the methods are indeed getting or
247# setting a simple type. If this is not the case, or you want to show the
248# methods anyway, you should set this option to NO.
249
250IDL_PROPERTY_SUPPORT = YES
251
252# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
253# tag is set to YES, then doxygen will reuse the documentation of the first
254# member in the group (if any) for the other members of the group. By default
255# all members of a group must be documented explicitly.
256
257DISTRIBUTE_GROUP_DOC = NO
258
259# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
260# the same type (for instance a group of public functions) to be put as a
261# subgroup of that type (e.g. under the Public Functions section). Set it to
262# NO to prevent subgrouping. Alternatively, this can be done per class using
263# the \nosubgrouping command.
264
265SUBGROUPING = YES
266
267# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
268# is documented as struct, union, or enum with the name of the typedef. So
269# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
270# with name TypeT. When disabled the typedef will appear as a member of a file,
271# namespace, or class. And the struct will be named TypeS. This can typically
272# be useful for C code in case the coding convention dictates that all compound
273# types are typedef'ed and only the typedef is referenced, never the tag name.
274
275TYPEDEF_HIDES_STRUCT = NO
276
277# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
278# determine which symbols to keep in memory and which to flush to disk.
279# When the cache is full, less often used symbols will be written to disk.
280# For small to medium size projects (<1000 input files) the default value is
281# probably good enough. For larger projects a too small cache size can cause
282# doxygen to be busy swapping symbols to and from disk most of the time
283# causing a significant performance penality.
284# If the system has enough physical memory increasing the cache will improve the
285# performance by keeping more symbols in memory. Note that the value works on
286# a logarithmic scale so increasing the size by one will rougly double the
287# memory usage. The cache size is given by this formula:
288# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
289# corresponding to a cache size of 2^16 = 65536 symbols
290
291SYMBOL_CACHE_SIZE = 0
292
293#---------------------------------------------------------------------------
294# Build related configuration options
295#---------------------------------------------------------------------------
296
297# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
298# documentation are documented, even if no documentation was available.
299# Private class members and static file members will be hidden unless
300# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
301
302EXTRACT_ALL = NO
303
304# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
305# will be included in the documentation.
306
307EXTRACT_PRIVATE = NO
308
309# If the EXTRACT_STATIC tag is set to YES all static members of a file
310# will be included in the documentation.
311
Alexander Afanasyev042b4a72012-11-09 17:47:48 -0800312EXTRACT_STATIC = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700313
314# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
315# defined locally in source files will be included in the documentation.
316# If set to NO only classes defined in header files are included.
317
Alexander Afanasyev042b4a72012-11-09 17:47:48 -0800318EXTRACT_LOCAL_CLASSES = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700319
320# This flag is only useful for Objective-C code. When set to YES local
321# methods, which are defined in the implementation section but not in
322# the interface are included in the documentation.
323# If set to NO (the default) only methods in the interface are included.
324
325EXTRACT_LOCAL_METHODS = NO
326
327# If this flag is set to YES, the members of anonymous namespaces will be
328# extracted and appear in the documentation as a namespace called
329# 'anonymous_namespace{file}', where file will be replaced with the base
330# name of the file that contains the anonymous namespace. By default
331# anonymous namespace are hidden.
332
333EXTRACT_ANON_NSPACES = NO
334
335# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
336# undocumented members of documented classes, files or namespaces.
337# If set to NO (the default) these members will be included in the
338# various overviews, but no documentation section is generated.
339# This option has no effect if EXTRACT_ALL is enabled.
340
341HIDE_UNDOC_MEMBERS = NO
342
343# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
344# undocumented classes that are normally visible in the class hierarchy.
345# If set to NO (the default) these classes will be included in the various
346# overviews. This option has no effect if EXTRACT_ALL is enabled.
347
348HIDE_UNDOC_CLASSES = NO
349
350# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
351# friend (class|struct|union) declarations.
352# If set to NO (the default) these declarations will be included in the
353# documentation.
354
355HIDE_FRIEND_COMPOUNDS = NO
356
357# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
358# documentation blocks found inside the body of a function.
359# If set to NO (the default) these blocks will be appended to the
360# function's detailed documentation block.
361
362HIDE_IN_BODY_DOCS = NO
363
364# The INTERNAL_DOCS tag determines if documentation
365# that is typed after a \internal command is included. If the tag is set
366# to NO (the default) then the documentation will be excluded.
367# Set it to YES to include the internal documentation.
368
369INTERNAL_DOCS = NO
370
371# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
372# file names in lower-case letters. If set to YES upper-case letters are also
373# allowed. This is useful if you have classes or files whose names only differ
374# in case and if your file system supports case sensitive file names. Windows
375# and Mac users are advised to set this option to NO.
376
377CASE_SENSE_NAMES = NO
378
379# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
380# will show members with their full class and namespace scopes in the
381# documentation. If set to YES the scope will be hidden.
382
383HIDE_SCOPE_NAMES = NO
384
385# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
386# will put a list of the files that are included by a file in the documentation
387# of that file.
388
389SHOW_INCLUDE_FILES = YES
390
391# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
392# is inserted in the documentation for inline members.
393
394INLINE_INFO = YES
395
396# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
397# will sort the (detailed) documentation of file and class members
398# alphabetically by member name. If set to NO the members will appear in
399# declaration order.
400
401SORT_MEMBER_DOCS = YES
402
403# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
404# brief documentation of file, namespace and class members alphabetically
405# by member name. If set to NO (the default) the members will appear in
406# declaration order.
407
408SORT_BRIEF_DOCS = NO
409
410# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
411
412SORT_MEMBERS_CTORS_1ST = NO
413
414# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
415# hierarchy of group names into alphabetical order. If set to NO (the default)
416# the group names will appear in their defined order.
417
418SORT_GROUP_NAMES = NO
419
420# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
421# sorted by fully-qualified names, including namespaces. If set to
422# NO (the default), the class list will be sorted only by class name,
423# not including the namespace part.
424# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
425# Note: This option applies only to the class list, not to the
426# alphabetical list.
427
428SORT_BY_SCOPE_NAME = YES
429
430# The GENERATE_TODOLIST tag can be used to enable (YES) or
431# disable (NO) the todo list. This list is created by putting \todo
432# commands in the documentation.
433
434GENERATE_TODOLIST = YES
435
436# The GENERATE_TESTLIST tag can be used to enable (YES) or
437# disable (NO) the test list. This list is created by putting \test
438# commands in the documentation.
439
440GENERATE_TESTLIST = YES
441
442# The GENERATE_BUGLIST tag can be used to enable (YES) or
443# disable (NO) the bug list. This list is created by putting \bug
444# commands in the documentation.
445
446GENERATE_BUGLIST = YES
447
448# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
449# disable (NO) the deprecated list. This list is created by putting
450# \deprecated commands in the documentation.
451
452GENERATE_DEPRECATEDLIST= YES
453
454# The ENABLED_SECTIONS tag can be used to enable conditional
455# documentation sections, marked by \if sectionname ... \endif.
456
457ENABLED_SECTIONS =
458
459# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
460# the initial value of a variable or define consists of for it to appear in
461# the documentation. If the initializer consists of more lines than specified
462# here it will be hidden. Use a value of 0 to hide initializers completely.
463# The appearance of the initializer of individual variables and defines in the
464# documentation can be controlled using \showinitializer or \hideinitializer
465# command in the documentation regardless of this setting.
466
467MAX_INITIALIZER_LINES = 30
468
469# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
470# at the bottom of the documentation of classes and structs. If set to YES the
471# list will mention the files that were used to generate the documentation.
472
473SHOW_USED_FILES = YES
474
475# If the sources in your project are distributed over multiple directories
476# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
477# in the documentation. The default is NO.
478
479SHOW_DIRECTORIES = NO
480
481# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
482# This will remove the Files entry from the Quick Index and from the
483# Folder Tree View (if specified). The default is YES.
484
485SHOW_FILES = YES
486
487# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
488# Namespaces page.
489# This will remove the Namespaces entry from the Quick Index
490# and from the Folder Tree View (if specified). The default is YES.
491
492SHOW_NAMESPACES = YES
493
494# The FILE_VERSION_FILTER tag can be used to specify a program or script that
495# doxygen should invoke to get the current version for each file (typically from
496# the version control system). Doxygen will invoke the program by executing (via
497# popen()) the command <command> <input-file>, where <command> is the value of
498# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
499# provided by doxygen. Whatever the program writes to standard output
500# is used as the file version. See the manual for examples.
501
502FILE_VERSION_FILTER =
503
504# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
505# doxygen. The layout file controls the global structure of the generated output files
506# in an output format independent way. The create the layout file that represents
507# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
508# file name after the option, if omitted DoxygenLayout.xml will be used as the name
509# of the layout file.
510
511LAYOUT_FILE =
512
513#---------------------------------------------------------------------------
514# configuration options related to warning and progress messages
515#---------------------------------------------------------------------------
516
517# The QUIET tag can be used to turn on/off the messages that are generated
518# by doxygen. Possible values are YES and NO. If left blank NO is used.
519
Alexander Afanasyev042b4a72012-11-09 17:47:48 -0800520QUIET = NO
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700521
522# The WARNINGS tag can be used to turn on/off the warning messages that are
523# generated by doxygen. Possible values are YES and NO. If left blank
524# NO is used.
525
526WARNINGS = YES
527
528# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
529# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
530# automatically be disabled.
531
532WARN_IF_UNDOCUMENTED = YES
533
534# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
535# potential errors in the documentation, such as not documenting some
536# parameters in a documented function, or documenting parameters that
537# don't exist or using markup commands wrongly.
538
Alexander Afanasyev042b4a72012-11-09 17:47:48 -0800539WARN_IF_DOC_ERROR = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700540
541# This WARN_NO_PARAMDOC option can be abled to get warnings for
542# functions that are documented, but have no documentation for their parameters
543# or return value. If set to NO (the default) doxygen will only warn about
544# wrong or incomplete parameter documentation, but not about the absence of
545# documentation.
546
Alexander Afanasyev4a4ea602012-06-06 11:12:45 -0700547WARN_NO_PARAMDOC = NO
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700548
549# The WARN_FORMAT tag determines the format of the warning messages that
550# doxygen can produce. The string should contain the $file, $line, and $text
551# tags, which will be replaced by the file and line number from which the
552# warning originated and the warning text. Optionally the format may contain
553# $version, which will be replaced by the version of the file (if it could
554# be obtained via FILE_VERSION_FILTER)
555
556WARN_FORMAT = "$file:$line: $text "
557
558# The WARN_LOGFILE tag can be used to specify a file to which warning
559# and error messages should be written. If left blank the output is written
560# to stderr.
561
Alexander Afanasyev508269a2012-07-28 13:59:54 -0700562WARN_LOGFILE = doxygen.warnings.log
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700563
564#---------------------------------------------------------------------------
565# configuration options related to the input files
566#---------------------------------------------------------------------------
567
568# The INPUT tag can be used to specify the files and/or directories that contain
569# documented source files. You may enter file names like "myfile.cpp" or
570# directories like "/usr/src/myproject". Separate the files or directories
571# with spaces.
572
Alexander Afanasyev79206512013-07-27 16:49:12 -0700573INPUT = ../model ../ndn.cxx ../helper ../utils ../apps \
574 ../plugins/topology ../plugins/ip-faces \
575 introspected-doxygen.h doxygen.h
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700576
577# introspected-doxygen.h should be manually created:
578# For example:
Alexander Afanasyev1cd79ae2012-10-05 22:42:12 -0700579# ../../../build/utils/ns3-dev-print-introspected-doxygen-debug --group Ndn > introspected-doxygen.h
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700580
581# This tag can be used to specify the character encoding of the source files
582# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
583# also the default input encoding. Doxygen uses libiconv (or the iconv built
584# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
585# the list of possible encodings.
586
587INPUT_ENCODING = UTF-8
588
589# If the value of the INPUT tag contains directories, you can use the
590# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
591# and *.h) to filter out the source-files in the directories. If left
592# blank the following patterns are tested:
593# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
594# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
595
596FILE_PATTERNS = *.h \
597 *.cc
598
599# The RECURSIVE tag can be used to turn specify whether or not subdirectories
600# should be searched for input files as well. Possible values are YES and NO.
601# If left blank NO is used.
602
603RECURSIVE = YES
604
605# The EXCLUDE tag can be used to specify files and/or directories that should
606# excluded from the INPUT source files. This way you can easily exclude a
607# subdirectory from a directory tree whose root is specified with the INPUT tag.
608
609EXCLUDE =
610
611# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
612# directories that are symbolic links (a Unix filesystem feature) are excluded
613# from the input.
614
615EXCLUDE_SYMLINKS = NO
616
617# If the value of the INPUT tag contains directories, you can use the
618# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
619# certain files from those directories. Note that the wildcards are matched
620# against the file with absolute path, so to exclude all test directories
621# for example use the pattern */test/*
622
623EXCLUDE_PATTERNS = */test/*
624
625# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
626# (namespaces, classes, functions, etc.) that should be excluded from the
627# output. The symbol name can be a fully qualified name, a word, or if the
628# wildcard * is used, a substring. Examples: ANamespace, AClass,
629# AClass::ANamespace, ANamespace::*Test
630
631EXCLUDE_SYMBOLS =
632
633# The EXAMPLE_PATH tag can be used to specify one or more files or
634# directories that contain example code fragments that are included (see
635# the \include command).
636
637EXAMPLE_PATH = ../examples
638
639# If the value of the EXAMPLE_PATH tag contains directories, you can use the
640# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
641# and *.h) to filter out the source-files in the directories. If left
642# blank all files are included.
643
644EXAMPLE_PATTERNS =
645
646# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
647# searched for input files to be used with the \include or \dontinclude
648# commands irrespective of the value of the RECURSIVE tag.
649# Possible values are YES and NO. If left blank NO is used.
650
651EXAMPLE_RECURSIVE = NO
652
653# The IMAGE_PATH tag can be used to specify one or more files or
654# directories that contain image that are included in the documentation (see
655# the \image command).
656
Alexander Afanasyev508269a2012-07-28 13:59:54 -0700657IMAGE_PATH = ns3_html_theme/static
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700658
659# The INPUT_FILTER tag can be used to specify a program that doxygen should
660# invoke to filter for each input file. Doxygen will invoke the filter program
661# by executing (via popen()) the command <filter> <input-file>, where <filter>
662# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
663# input file. Doxygen will then use the output that the filter program writes
664# to standard output.
665# If FILTER_PATTERNS is specified, this tag will be
666# ignored.
667
668INPUT_FILTER =
669
670# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
671# basis.
672# Doxygen will compare the file name with each pattern and apply the
673# filter if there is a match.
674# The filters are a list of the form:
675# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
676# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
677# is applied to all files.
678
679FILTER_PATTERNS =
680
681# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
682# INPUT_FILTER) will be used to filter the input files when producing source
683# files to browse (i.e. when SOURCE_BROWSER is set to YES).
684
685FILTER_SOURCE_FILES = NO
686
687#---------------------------------------------------------------------------
688# configuration options related to source browsing
689#---------------------------------------------------------------------------
690
691# If the SOURCE_BROWSER tag is set to YES then a list of source files will
692# be generated. Documented entities will be cross-referenced with these sources.
693# Note: To get rid of all source code in the generated output, make sure also
694# VERBATIM_HEADERS is set to NO.
695
696SOURCE_BROWSER = YES
697
698# Setting the INLINE_SOURCES tag to YES will include the body
699# of functions and classes directly in the documentation.
700
701INLINE_SOURCES = NO
702
703# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
704# doxygen to hide any special comment blocks from generated source code
705# fragments. Normal C and C++ comments will always remain visible.
706
707STRIP_CODE_COMMENTS = YES
708
709# If the REFERENCED_BY_RELATION tag is set to YES
710# then for each documented function all documented
711# functions referencing it will be listed.
712
713REFERENCED_BY_RELATION = YES
714
715# If the REFERENCES_RELATION tag is set to YES
716# then for each documented function all documented entities
717# called/used by that function will be listed.
718
719REFERENCES_RELATION = YES
720
721# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
722# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
723# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
724# link to the source code.
725# Otherwise they will link to the documentation.
726
727REFERENCES_LINK_SOURCE = YES
728
729# If the USE_HTAGS tag is set to YES then the references to source code
730# will point to the HTML generated by the htags(1) tool instead of doxygen
731# built-in source browser. The htags tool is part of GNU's global source
732# tagging system (see http://www.gnu.org/software/global/global.html). You
733# will need version 4.8.6 or higher.
734
735USE_HTAGS = NO
736
737# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
738# will generate a verbatim copy of the header file for each class for
739# which an include is specified. Set to NO to disable this.
740
741VERBATIM_HEADERS = NO
742
743#---------------------------------------------------------------------------
744# configuration options related to the alphabetical class index
745#---------------------------------------------------------------------------
746
747# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
748# of all compounds will be generated. Enable this if the project
749# contains a lot of classes, structs, unions or interfaces.
750
751ALPHABETICAL_INDEX = NO
752
753# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
754# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
755# in which this list will be split (can be a number in the range [1..20])
756
757COLS_IN_ALPHA_INDEX = 5
758
759# In case all classes in a project start with a common prefix, all
760# classes will be put under the same header in the alphabetical index.
761# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
762# should be ignored while generating the index headers.
763
764IGNORE_PREFIX =
765
766#---------------------------------------------------------------------------
767# configuration options related to the HTML output
768#---------------------------------------------------------------------------
769
770# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
771# generate HTML output.
772
773GENERATE_HTML = YES
774
775# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
776# If a relative path is entered the value of OUTPUT_DIRECTORY will be
777# put in front of it. If left blank `html' will be used as the default path.
778
Alexander Afanasyev97fb44d2012-06-04 18:50:47 -0700779HTML_OUTPUT = build/html/doxygen
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700780
781# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
782# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
783# doxygen will generate files with .html extension.
784
785HTML_FILE_EXTENSION = .html
786
787# The HTML_HEADER tag can be used to specify a personal HTML header for
788# each generated HTML page. If it is left blank doxygen will generate a
789# standard header.
790
Alexander Afanasyev508269a2012-07-28 13:59:54 -0700791HTML_HEADER = ns3_html_theme/ns3_doxy_header.html
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700792
793# The HTML_FOOTER tag can be used to specify a personal HTML footer for
794# each generated HTML page. If it is left blank doxygen will generate a
795# standard footer.
796
Alexander Afanasyev508269a2012-07-28 13:59:54 -0700797HTML_FOOTER = ns3_html_theme/ns3_doxy_footer.html
798#HTML_FOOTER = analytics.html
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700799
800# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
801# style sheet that is used by each HTML page. It can be used to
802# fine-tune the look of the HTML output. If the tag is left blank doxygen
803# will generate a default style sheet. Note that doxygen will try to copy
804# the style sheet file to the HTML output directory, so don't put your own
805# stylesheet in the HTML output directory as well, or it will be erased!
806
Alexander Afanasyev508269a2012-07-28 13:59:54 -0700807HTML_STYLESHEET = ns3_html_theme/static/ns3_stylesheet.css
808
809HTML_EXTRA_FILES = ns3_html_theme/static/doxygen.css \
810 ns3_html_theme/static/bar-top.png \
811 ns3_html_theme/static/favicon.ico
812
813HTML_COLORSTYLE_HUE = 0
814HTML_COLORSTYLE_SAT = 0
815HTML_COLORSTYLE_GAMMA = 91
816HTML_TIMESTAMP = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700817
818# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
819# files or namespaces will be aligned in HTML using tables. If set to
820# NO a bullet list will be used.
821
822HTML_ALIGN_MEMBERS = YES
823
824# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
825# documentation will contain sections that can be hidden and shown after the
826# page has loaded. For this to work a browser that supports
827# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
828# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
829
830HTML_DYNAMIC_SECTIONS = NO
831
832# If the GENERATE_DOCSET tag is set to YES, additional index files
833# will be generated that can be used as input for Apple's Xcode 3
834# integrated development environment, introduced with OSX 10.5 (Leopard).
835# To create a documentation set, doxygen will generate a Makefile in the
836# HTML output directory. Running make will produce the docset in that
837# directory and running "make install" will install the docset in
838# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
839# it at startup.
840# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
841
842GENERATE_DOCSET = NO
843
844# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
845# feed. A documentation feed provides an umbrella under which multiple
846# documentation sets from a single provider (such as a company or product suite)
847# can be grouped.
848
849DOCSET_FEEDNAME = "Doxygen generated docs"
850
851# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
852# should uniquely identify the documentation set bundle. This should be a
853# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
854# will append .docset to the name.
855
856DOCSET_BUNDLE_ID = org.doxygen.Project
857
858# If the GENERATE_HTMLHELP tag is set to YES, additional index files
859# will be generated that can be used as input for tools like the
860# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
861# of the generated HTML documentation.
862
863GENERATE_HTMLHELP = NO
864
865# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
866# be used to specify the file name of the resulting .chm file. You
867# can add a path in front of the file if the result should not be
868# written to the html output directory.
869
870CHM_FILE =
871
872# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
873# be used to specify the location (absolute path including file name) of
874# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
875# the HTML help compiler on the generated index.hhp.
876
877HHC_LOCATION =
878
879# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
880# controls if a separate .chi index file is generated (YES) or that
881# it should be included in the master .chm file (NO).
882
883GENERATE_CHI = NO
884
885# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
886# is used to encode HtmlHelp index (hhk), content (hhc) and project file
887# content.
888
889CHM_INDEX_ENCODING =
890
891# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
892# controls whether a binary table of contents is generated (YES) or a
893# normal table of contents (NO) in the .chm file.
894
895BINARY_TOC = NO
896
897# The TOC_EXPAND flag can be set to YES to add extra items for group members
898# to the contents of the HTML help documentation and to the tree view.
899
900TOC_EXPAND = NO
901
902# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
903# are set, an additional index file will be generated that can be used as input for
904# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
905# HTML documentation.
906
907GENERATE_QHP = NO
908
909# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
910# be used to specify the file name of the resulting .qch file.
911# The path specified is relative to the HTML output folder.
912
913QCH_FILE =
914
915# The QHP_NAMESPACE tag specifies the namespace to use when generating
916# Qt Help Project output. For more information please see
917# http://doc.trolltech.com/qthelpproject.html#namespace
918
919QHP_NAMESPACE =
920
921# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
922# Qt Help Project output. For more information please see
923# http://doc.trolltech.com/qthelpproject.html#virtual-folders
924
925QHP_VIRTUAL_FOLDER = doc
926
927# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
928# For more information please see
929# http://doc.trolltech.com/qthelpproject.html#custom-filters
930
931QHP_CUST_FILTER_NAME =
932
933# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
934# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
935
936QHP_CUST_FILTER_ATTRS =
937
938# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
939# filter section matches.
940# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
941
942QHP_SECT_FILTER_ATTRS =
943
944# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
945# be used to specify the location of Qt's qhelpgenerator.
946# If non-empty doxygen will try to run qhelpgenerator on the generated
947# .qhp file.
948
949QHG_LOCATION =
950
951# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
952# top of each HTML page. The value NO (the default) enables the index and
953# the value YES disables it.
954
955DISABLE_INDEX = NO
956
957# This tag can be used to set the number of enum values (range [1..20])
958# that doxygen will group on one line in the generated HTML documentation.
959
960ENUM_VALUES_PER_LINE = 4
961
962# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
963# structure should be generated to display hierarchical information.
964# If the tag value is set to YES, a side panel will be generated
965# containing a tree-like index structure (just like the one that
966# is generated for HTML Help). For this to work a browser that supports
967# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
968# Windows users are probably better off using the HTML help feature.
969
970GENERATE_TREEVIEW = YES
971
972# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
973# and Class Hierarchy pages using a tree view instead of an ordered list.
974
975USE_INLINE_TREES = NO
976
977# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
978# used to set the initial width (in pixels) of the frame in which the tree
979# is shown.
980
Alexander Afanasyev97fb44d2012-06-04 18:50:47 -0700981TREEVIEW_WIDTH = 300
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700982
983# Use this tag to change the font size of Latex formulas included
984# as images in the HTML documentation. The default is 10. Note that
985# when you change the font size after a successful doxygen run you need
986# to manually remove any form_*.png images from the HTML output directory
987# to force them to be regenerated.
988
989FORMULA_FONTSIZE = 10
990
991# When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
992# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
993# there is already a search function so this one should typically
994# be disabled.
995
Alexander Afanasyev97fb44d2012-06-04 18:50:47 -0700996SEARCHENGINE = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700997
998#---------------------------------------------------------------------------
999# configuration options related to the LaTeX output
1000#---------------------------------------------------------------------------
1001
1002# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1003# generate Latex output.
1004
1005GENERATE_LATEX = NO
1006
1007# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1008# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1009# put in front of it. If left blank `latex' will be used as the default path.
1010
1011LATEX_OUTPUT = latex
1012
1013# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1014# invoked. If left blank `latex' will be used as the default command name.
1015
1016LATEX_CMD_NAME = latex
1017
1018# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1019# generate index for LaTeX. If left blank `makeindex' will be used as the
1020# default command name.
1021
1022MAKEINDEX_CMD_NAME = makeindex
1023
1024# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1025# LaTeX documents. This may be useful for small projects and may help to
1026# save some trees in general.
1027
1028COMPACT_LATEX = YES
1029
1030# The PAPER_TYPE tag can be used to set the paper type that is used
1031# by the printer. Possible values are: a4, a4wide, letter, legal and
1032# executive. If left blank a4wide will be used.
1033
1034PAPER_TYPE = a4wide
1035
1036# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1037# packages that should be included in the LaTeX output.
1038
1039EXTRA_PACKAGES = amsmath
1040
1041# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1042# the generated latex document. The header should contain everything until
1043# the first chapter. If it is left blank doxygen will generate a
1044# standard header. Notice: only use this tag if you know what you are doing!
1045
1046LATEX_HEADER =
1047
1048# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1049# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1050# contain links (just like the HTML output) instead of page references
1051# This makes the output suitable for online browsing using a pdf viewer.
1052
1053PDF_HYPERLINKS = YES
1054
1055# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1056# plain latex in the generated Makefile. Set this option to YES to get a
1057# higher quality PDF documentation.
1058
1059USE_PDFLATEX = YES
1060
1061# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1062# command to the generated LaTeX files. This will instruct LaTeX to keep
1063# running if errors occur, instead of asking the user for help.
1064# This option is also used when generating formulas in HTML.
1065
1066LATEX_BATCHMODE = NO
1067
1068# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1069# include the index chapters (such as File Index, Compound Index, etc.)
1070# in the output.
1071
1072LATEX_HIDE_INDICES = YES
1073
1074# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
1075
1076LATEX_SOURCE_CODE = NO
1077
1078#---------------------------------------------------------------------------
1079# configuration options related to the RTF output
1080#---------------------------------------------------------------------------
1081
1082# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1083# The RTF output is optimized for Word 97 and may not look very pretty with
1084# other RTF readers or editors.
1085
1086GENERATE_RTF = NO
1087
1088# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1089# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1090# put in front of it. If left blank `rtf' will be used as the default path.
1091
1092RTF_OUTPUT = rtf
1093
1094# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1095# RTF documents. This may be useful for small projects and may help to
1096# save some trees in general.
1097
1098COMPACT_RTF = NO
1099
1100# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1101# will contain hyperlink fields. The RTF file will
1102# contain links (just like the HTML output) instead of page references.
1103# This makes the output suitable for online browsing using WORD or other
1104# programs which support those fields.
1105# Note: wordpad (write) and others do not support links.
1106
1107RTF_HYPERLINKS = NO
1108
1109# Load stylesheet definitions from file. Syntax is similar to doxygen's
1110# config file, i.e. a series of assignments. You only have to provide
1111# replacements, missing definitions are set to their default value.
1112
1113RTF_STYLESHEET_FILE =
1114
1115# Set optional variables used in the generation of an rtf document.
1116# Syntax is similar to doxygen's config file.
1117
1118RTF_EXTENSIONS_FILE =
1119
1120#---------------------------------------------------------------------------
1121# configuration options related to the man page output
1122#---------------------------------------------------------------------------
1123
1124# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1125# generate man pages
1126
1127GENERATE_MAN = NO
1128
1129# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1130# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1131# put in front of it. If left blank `man' will be used as the default path.
1132
1133MAN_OUTPUT = man
1134
1135# The MAN_EXTENSION tag determines the extension that is added to
1136# the generated man pages (default is the subroutine's section .3)
1137
1138MAN_EXTENSION = .3
1139
1140# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1141# then it will generate one additional man file for each entity
1142# documented in the real man page(s). These additional files
1143# only source the real man page, but without them the man command
1144# would be unable to find the correct page. The default is NO.
1145
1146MAN_LINKS = NO
1147
1148#---------------------------------------------------------------------------
1149# configuration options related to the XML output
1150#---------------------------------------------------------------------------
1151
1152# If the GENERATE_XML tag is set to YES Doxygen will
1153# generate an XML file that captures the structure of
1154# the code including all documentation.
1155
1156GENERATE_XML = NO
1157
1158# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1159# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1160# put in front of it. If left blank `xml' will be used as the default path.
1161
1162XML_OUTPUT = xml
1163
1164# The XML_SCHEMA tag can be used to specify an XML schema,
1165# which can be used by a validating XML parser to check the
1166# syntax of the XML files.
1167
1168XML_SCHEMA =
1169
1170# The XML_DTD tag can be used to specify an XML DTD,
1171# which can be used by a validating XML parser to check the
1172# syntax of the XML files.
1173
1174XML_DTD =
1175
1176# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1177# dump the program listings (including syntax highlighting
1178# and cross-referencing information) to the XML output. Note that
1179# enabling this will significantly increase the size of the XML output.
1180
1181XML_PROGRAMLISTING = YES
1182
1183#---------------------------------------------------------------------------
1184# configuration options for the AutoGen Definitions output
1185#---------------------------------------------------------------------------
1186
1187# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1188# generate an AutoGen Definitions (see autogen.sf.net) file
1189# that captures the structure of the code including all
1190# documentation. Note that this feature is still experimental
1191# and incomplete at the moment.
1192
1193GENERATE_AUTOGEN_DEF = NO
1194
1195#---------------------------------------------------------------------------
1196# configuration options related to the Perl module output
1197#---------------------------------------------------------------------------
1198
1199# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1200# generate a Perl module file that captures the structure of
1201# the code including all documentation. Note that this
1202# feature is still experimental and incomplete at the
1203# moment.
1204
1205GENERATE_PERLMOD = NO
1206
1207# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1208# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1209# to generate PDF and DVI output from the Perl module output.
1210
1211PERLMOD_LATEX = NO
1212
1213# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1214# nicely formatted so it can be parsed by a human reader.
1215# This is useful
1216# if you want to understand what is going on.
1217# On the other hand, if this
1218# tag is set to NO the size of the Perl module output will be much smaller
1219# and Perl will parse it just the same.
1220
1221PERLMOD_PRETTY = YES
1222
1223# The names of the make variables in the generated doxyrules.make file
1224# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1225# This is useful so different doxyrules.make files included by the same
1226# Makefile don't overwrite each other's variables.
1227
1228PERLMOD_MAKEVAR_PREFIX =
1229
1230#---------------------------------------------------------------------------
1231# Configuration options related to the preprocessor
1232#---------------------------------------------------------------------------
1233
1234# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1235# evaluate all C-preprocessor directives found in the sources and include
1236# files.
1237
1238ENABLE_PREPROCESSING = YES
1239
1240# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1241# names in the source code. If set to NO (the default) only conditional
1242# compilation will be performed. Macro expansion can be done in a controlled
1243# way by setting EXPAND_ONLY_PREDEF to YES.
1244
1245MACRO_EXPANSION = YES
1246
1247# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1248# then the macro expansion is limited to the macros specified with the
1249# PREDEFINED and EXPAND_AS_DEFINED tags.
1250
1251EXPAND_ONLY_PREDEF = YES
1252
1253# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1254# in the INCLUDE_PATH (see below) will be search if a #include is found.
1255
1256SEARCH_INCLUDES = YES
1257
1258# The INCLUDE_PATH tag can be used to specify one or more directories that
1259# contain include files that are not input files but should be processed by
1260# the preprocessor.
1261
Alexander Afanasyev79206512013-07-27 16:49:12 -07001262INCLUDE_PATH = ../../../build
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001263
1264# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1265# patterns (like *.h and *.hpp) to filter out the header-files in the
1266# directories. If left blank, the patterns specified with FILE_PATTERNS will
1267# be used.
1268
1269INCLUDE_FILE_PATTERNS =
1270
1271# The PREDEFINED tag can be used to specify one or more macro names that
1272# are defined before the preprocessor is started (similar to the -D option of
1273# gcc). The argument of the tag is a list of macros of the form: name
1274# or name=definition (no spaces). If the definition and the = are
1275# omitted =1 is assumed. To prevent a macro definition from being
1276# undefined via #undef or recursively expanded use the := operator
1277# instead of the = operator.
1278
1279PREDEFINED = NS3_ASSERT_ENABLE \
Alexander Afanasyev15b71142012-10-29 10:14:30 -07001280 NS3_LOG_ENABLE \
Alexander Afanasyev79206512013-07-27 16:49:12 -07001281 DOXYGEN \
1282 "NDN_NAMESPACE_BEGIN=namespace ns3 { namespace ndn {" \
1283 "NDN_NAMESPACE_END="}}"
1284
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001285
1286# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1287# this tag can be used to specify a list of macro names that should be expanded.
1288# The macro definition that is found in the sources will be used.
1289# Use the PREDEFINED tag if you want to use a different macro definition.
1290
1291EXPAND_AS_DEFINED = ATTRIBUTE_VALUE_DEFINE \
1292 ATTRIBUTE_VALUE_DEFINE_WITH_NAME \
1293 ATTRIBUTE_HELPER_HEADER_2
1294
1295# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1296# doxygen's preprocessor will remove all function-like macros that are alone
1297# on a line, have an all uppercase name, and do not end with a semicolon. Such
1298# function macros are typically used for boiler-plate code, and will confuse
1299# the parser if not removed.
1300
1301SKIP_FUNCTION_MACROS = YES
1302
1303#---------------------------------------------------------------------------
1304# Configuration::additions related to external references
1305#---------------------------------------------------------------------------
1306
1307# The TAGFILES option can be used to specify one or more tagfiles.
1308# Optionally an initial location of the external documentation
1309# can be added for each tagfile. The format of a tag file without
1310# this location is as follows:
1311#
1312# TAGFILES = file1 file2 ...
1313# Adding location for the tag files is done as follows:
1314#
1315# TAGFILES = file1=loc1 "file2 = loc2" ...
1316# where "loc1" and "loc2" can be relative or absolute paths or
1317# URLs. If a location is present for each tag, the installdox tool
1318# does not have to be run to correct the links.
1319# Note that each tag file must have a unique name
1320# (where the name does NOT include the path)
1321# If a tag file is not located in the directory in which doxygen
1322# is run, you must also specify the path to the tagfile here.
1323
1324TAGFILES =
1325
1326# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1327# a tag file that is based on the input files it reads.
1328
1329GENERATE_TAGFILE = ndnSIM.tag
1330
1331# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1332# in the class index. If set to NO only the inherited external classes
1333# will be listed.
1334
1335ALLEXTERNALS = NO
1336
1337# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1338# in the modules index. If set to NO, only the current project's groups will
1339# be listed.
1340
1341EXTERNAL_GROUPS = YES
1342
1343# The PERL_PATH should be the absolute path and name of the perl script
1344# interpreter (i.e. the result of `which perl').
1345
1346PERL_PATH = /usr/bin/perl
1347
1348#---------------------------------------------------------------------------
1349# Configuration options related to the dot tool
1350#---------------------------------------------------------------------------
1351
1352# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1353# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1354# or super classes. Setting the tag to NO turns the diagrams off. Note that
1355# this option is superseded by the HAVE_DOT option below. This is only a
1356# fallback. It is recommended to install and use dot, since it yields more
1357# powerful graphs.
1358
1359CLASS_DIAGRAMS = YES
1360
1361# You can define message sequence charts within doxygen comments using the \msc
1362# command. Doxygen will then run the mscgen tool (see
1363# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1364# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1365# the mscgen tool resides. If left empty the tool is assumed to be found in the
1366# default search path.
1367
1368MSCGEN_PATH =
1369
1370# If set to YES, the inheritance and collaboration graphs will hide
1371# inheritance and usage relations if the target is undocumented
1372# or is not a class.
1373
1374HIDE_UNDOC_RELATIONS = YES
1375
1376# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1377# available from the path. This tool is part of Graphviz, a graph visualization
1378# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1379# have no effect if this option is set to NO (the default)
1380
1381HAVE_DOT = YES
1382
1383# By default doxygen will write a font called FreeSans.ttf to the output
1384# directory and reference it in all dot files that doxygen generates. This
1385# font does not include all possible unicode characters however, so when you need
1386# these (or just want a differently looking font) you can specify the font name
1387# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1388# which can be done by putting it in a standard location or by setting the
1389# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1390# containing the font.
1391
1392DOT_FONTNAME = FreeSans
1393
1394# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1395# The default size is 10pt.
1396
1397DOT_FONTSIZE = 10
1398
1399# By default doxygen will tell dot to use the output directory to look for the
1400# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1401# different font using DOT_FONTNAME you can set the path where dot
1402# can find it using this tag.
1403
1404DOT_FONTPATH =
1405
1406# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1407# will generate a graph for each documented class showing the direct and
1408# indirect inheritance relations. Setting this tag to YES will force the
1409# the CLASS_DIAGRAMS tag to NO.
1410
1411CLASS_GRAPH = YES
1412
1413# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1414# will generate a graph for each documented class showing the direct and
1415# indirect implementation dependencies (inheritance, containment, and
1416# class references variables) of the class with other documented classes.
1417
1418COLLABORATION_GRAPH = YES
1419
1420# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1421# will generate a graph for groups, showing the direct groups dependencies
1422
1423GROUP_GRAPHS = YES
1424
1425# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1426# collaboration diagrams in a style similar to the OMG's Unified Modeling
1427# Language.
1428
1429UML_LOOK = NO
1430
1431# If set to YES, the inheritance and collaboration graphs will show the
1432# relations between templates and their instances.
1433
Alexander Afanasyev1cd79ae2012-10-05 22:42:12 -07001434TEMPLATE_RELATIONS = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001435
1436# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1437# tags are set to YES then doxygen will generate a graph for each documented
1438# file showing the direct and indirect include dependencies of the file with
1439# other documented files.
1440
1441INCLUDE_GRAPH = YES
1442
1443# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1444# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1445# documented header file showing the documented files that directly or
1446# indirectly include this file.
1447
1448INCLUDED_BY_GRAPH = YES
1449
1450# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1451# doxygen will generate a call dependency graph for every global function
1452# or class method. Note that enabling this option will significantly increase
1453# the time of a run. So in most cases it will be better to enable call graphs
1454# for selected functions only using the \callgraph command.
1455
1456CALL_GRAPH = NO
1457
1458# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1459# doxygen will generate a caller dependency graph for every global function
1460# or class method. Note that enabling this option will significantly increase
1461# the time of a run. So in most cases it will be better to enable caller
1462# graphs for selected functions only using the \callergraph command.
1463
1464CALLER_GRAPH = NO
1465
1466# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1467# will graphical hierarchy of all classes instead of a textual one.
1468
1469GRAPHICAL_HIERARCHY = YES
1470
1471# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1472# then doxygen will show the dependencies a directory has on other directories
1473# in a graphical way. The dependency relations are determined by the #include
1474# relations between the files in the directories.
1475
1476DIRECTORY_GRAPH = YES
1477
1478# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1479# generated by dot. Possible values are png, jpg, or gif
1480# If left blank png will be used.
1481
1482DOT_IMAGE_FORMAT = png
1483
1484# The tag DOT_PATH can be used to specify the path where the dot tool can be
1485# found. If left blank, it is assumed the dot tool can be found in the path.
1486
1487DOT_PATH =
1488
1489# The DOTFILE_DIRS tag can be used to specify one or more directories that
1490# contain dot files that are included in the documentation (see the
1491# \dotfile command).
1492
1493DOTFILE_DIRS =
1494
1495# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1496# nodes that will be shown in the graph. If the number of nodes in a graph
1497# becomes larger than this value, doxygen will truncate the graph, which is
1498# visualized by representing a node as a red box. Note that doxygen if the
1499# number of direct children of the root node in a graph is already larger than
1500# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1501# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1502
1503DOT_GRAPH_MAX_NODES = 50
1504
1505# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1506# graphs generated by dot. A depth value of 3 means that only nodes reachable
1507# from the root by following a path via at most 3 edges will be shown. Nodes
1508# that lay further from the root node will be omitted. Note that setting this
1509# option to 1 or 2 may greatly reduce the computation time needed for large
1510# code bases. Also note that the size of a graph can be further restricted by
1511# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1512
1513MAX_DOT_GRAPH_DEPTH = 0
1514
1515# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1516# background. This is disabled by default, because dot on Windows does not
1517# seem to support this out of the box. Warning: Depending on the platform used,
1518# enabling this option may lead to badly anti-aliased labels on the edges of
1519# a graph (i.e. they become hard to read).
1520
1521DOT_TRANSPARENT = NO
1522
1523# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1524# files in one run (i.e. multiple -o and -T options on the command line). This
1525# makes dot run faster, but since only newer versions of dot (>1.8.10)
1526# support this, this feature is disabled by default.
1527
1528DOT_MULTI_TARGETS = NO
1529
1530# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1531# generate a legend page explaining the meaning of the various boxes and
1532# arrows in the dot generated graphs.
1533
1534GENERATE_LEGEND = YES
1535
1536# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1537# remove the intermediate dot files that are used to generate
1538# the various graphs.
1539
1540DOT_CLEANUP = YES