blob: ec68f0486b3dadbf1c32939864156e043ed1c61a [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
312EXTRACT_STATIC = NO
313
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
318EXTRACT_LOCAL_CLASSES = NO
319
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
520QUIET = YES
521
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 Afanasyev4a4ea602012-06-06 11:12:45 -0700539WARN_IF_DOC_ERROR = NO
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
573INPUT = ../model ../helper ../utils ../apps \
Alexander Afanasyev97fb44d2012-06-04 18:50:47 -0700574 introspected-doxygen.h doxygen.h
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700575
576# introspected-doxygen.h should be manually created:
577# For example:
Alexander Afanasyev1cd79ae2012-10-05 22:42:12 -0700578# ../../../build/utils/ns3-dev-print-introspected-doxygen-debug --group Ndn > introspected-doxygen.h
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700579
580# This tag can be used to specify the character encoding of the source files
581# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
582# also the default input encoding. Doxygen uses libiconv (or the iconv built
583# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
584# the list of possible encodings.
585
586INPUT_ENCODING = UTF-8
587
588# If the value of the INPUT tag contains directories, you can use the
589# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
590# and *.h) to filter out the source-files in the directories. If left
591# blank the following patterns are tested:
592# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
593# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
594
595FILE_PATTERNS = *.h \
596 *.cc
597
598# The RECURSIVE tag can be used to turn specify whether or not subdirectories
599# should be searched for input files as well. Possible values are YES and NO.
600# If left blank NO is used.
601
602RECURSIVE = YES
603
604# The EXCLUDE tag can be used to specify files and/or directories that should
605# excluded from the INPUT source files. This way you can easily exclude a
606# subdirectory from a directory tree whose root is specified with the INPUT tag.
607
608EXCLUDE =
609
610# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
611# directories that are symbolic links (a Unix filesystem feature) are excluded
612# from the input.
613
614EXCLUDE_SYMLINKS = NO
615
616# If the value of the INPUT tag contains directories, you can use the
617# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
618# certain files from those directories. Note that the wildcards are matched
619# against the file with absolute path, so to exclude all test directories
620# for example use the pattern */test/*
621
622EXCLUDE_PATTERNS = */test/*
623
624# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
625# (namespaces, classes, functions, etc.) that should be excluded from the
626# output. The symbol name can be a fully qualified name, a word, or if the
627# wildcard * is used, a substring. Examples: ANamespace, AClass,
628# AClass::ANamespace, ANamespace::*Test
629
630EXCLUDE_SYMBOLS =
631
632# The EXAMPLE_PATH tag can be used to specify one or more files or
633# directories that contain example code fragments that are included (see
634# the \include command).
635
636EXAMPLE_PATH = ../examples
637
638# If the value of the EXAMPLE_PATH tag contains directories, you can use the
639# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
640# and *.h) to filter out the source-files in the directories. If left
641# blank all files are included.
642
643EXAMPLE_PATTERNS =
644
645# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
646# searched for input files to be used with the \include or \dontinclude
647# commands irrespective of the value of the RECURSIVE tag.
648# Possible values are YES and NO. If left blank NO is used.
649
650EXAMPLE_RECURSIVE = NO
651
652# The IMAGE_PATH tag can be used to specify one or more files or
653# directories that contain image that are included in the documentation (see
654# the \image command).
655
Alexander Afanasyev508269a2012-07-28 13:59:54 -0700656IMAGE_PATH = ns3_html_theme/static
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700657
658# The INPUT_FILTER tag can be used to specify a program that doxygen should
659# invoke to filter for each input file. Doxygen will invoke the filter program
660# by executing (via popen()) the command <filter> <input-file>, where <filter>
661# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
662# input file. Doxygen will then use the output that the filter program writes
663# to standard output.
664# If FILTER_PATTERNS is specified, this tag will be
665# ignored.
666
667INPUT_FILTER =
668
669# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
670# basis.
671# Doxygen will compare the file name with each pattern and apply the
672# filter if there is a match.
673# The filters are a list of the form:
674# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
675# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
676# is applied to all files.
677
678FILTER_PATTERNS =
679
680# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
681# INPUT_FILTER) will be used to filter the input files when producing source
682# files to browse (i.e. when SOURCE_BROWSER is set to YES).
683
684FILTER_SOURCE_FILES = NO
685
686#---------------------------------------------------------------------------
687# configuration options related to source browsing
688#---------------------------------------------------------------------------
689
690# If the SOURCE_BROWSER tag is set to YES then a list of source files will
691# be generated. Documented entities will be cross-referenced with these sources.
692# Note: To get rid of all source code in the generated output, make sure also
693# VERBATIM_HEADERS is set to NO.
694
695SOURCE_BROWSER = YES
696
697# Setting the INLINE_SOURCES tag to YES will include the body
698# of functions and classes directly in the documentation.
699
700INLINE_SOURCES = NO
701
702# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
703# doxygen to hide any special comment blocks from generated source code
704# fragments. Normal C and C++ comments will always remain visible.
705
706STRIP_CODE_COMMENTS = YES
707
708# If the REFERENCED_BY_RELATION tag is set to YES
709# then for each documented function all documented
710# functions referencing it will be listed.
711
712REFERENCED_BY_RELATION = YES
713
714# If the REFERENCES_RELATION tag is set to YES
715# then for each documented function all documented entities
716# called/used by that function will be listed.
717
718REFERENCES_RELATION = YES
719
720# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
721# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
722# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
723# link to the source code.
724# Otherwise they will link to the documentation.
725
726REFERENCES_LINK_SOURCE = YES
727
728# If the USE_HTAGS tag is set to YES then the references to source code
729# will point to the HTML generated by the htags(1) tool instead of doxygen
730# built-in source browser. The htags tool is part of GNU's global source
731# tagging system (see http://www.gnu.org/software/global/global.html). You
732# will need version 4.8.6 or higher.
733
734USE_HTAGS = NO
735
736# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
737# will generate a verbatim copy of the header file for each class for
738# which an include is specified. Set to NO to disable this.
739
740VERBATIM_HEADERS = NO
741
742#---------------------------------------------------------------------------
743# configuration options related to the alphabetical class index
744#---------------------------------------------------------------------------
745
746# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
747# of all compounds will be generated. Enable this if the project
748# contains a lot of classes, structs, unions or interfaces.
749
750ALPHABETICAL_INDEX = NO
751
752# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
753# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
754# in which this list will be split (can be a number in the range [1..20])
755
756COLS_IN_ALPHA_INDEX = 5
757
758# In case all classes in a project start with a common prefix, all
759# classes will be put under the same header in the alphabetical index.
760# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
761# should be ignored while generating the index headers.
762
763IGNORE_PREFIX =
764
765#---------------------------------------------------------------------------
766# configuration options related to the HTML output
767#---------------------------------------------------------------------------
768
769# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
770# generate HTML output.
771
772GENERATE_HTML = YES
773
774# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
775# If a relative path is entered the value of OUTPUT_DIRECTORY will be
776# put in front of it. If left blank `html' will be used as the default path.
777
Alexander Afanasyev97fb44d2012-06-04 18:50:47 -0700778HTML_OUTPUT = build/html/doxygen
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700779
780# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
781# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
782# doxygen will generate files with .html extension.
783
784HTML_FILE_EXTENSION = .html
785
786# The HTML_HEADER tag can be used to specify a personal HTML header for
787# each generated HTML page. If it is left blank doxygen will generate a
788# standard header.
789
Alexander Afanasyev508269a2012-07-28 13:59:54 -0700790HTML_HEADER = ns3_html_theme/ns3_doxy_header.html
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700791
792# The HTML_FOOTER tag can be used to specify a personal HTML footer for
793# each generated HTML page. If it is left blank doxygen will generate a
794# standard footer.
795
Alexander Afanasyev508269a2012-07-28 13:59:54 -0700796HTML_FOOTER = ns3_html_theme/ns3_doxy_footer.html
797#HTML_FOOTER = analytics.html
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700798
799# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
800# style sheet that is used by each HTML page. It can be used to
801# fine-tune the look of the HTML output. If the tag is left blank doxygen
802# will generate a default style sheet. Note that doxygen will try to copy
803# the style sheet file to the HTML output directory, so don't put your own
804# stylesheet in the HTML output directory as well, or it will be erased!
805
Alexander Afanasyev508269a2012-07-28 13:59:54 -0700806HTML_STYLESHEET = ns3_html_theme/static/ns3_stylesheet.css
807
808HTML_EXTRA_FILES = ns3_html_theme/static/doxygen.css \
809 ns3_html_theme/static/bar-top.png \
810 ns3_html_theme/static/favicon.ico
811
812HTML_COLORSTYLE_HUE = 0
813HTML_COLORSTYLE_SAT = 0
814HTML_COLORSTYLE_GAMMA = 91
815HTML_TIMESTAMP = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700816
817# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
818# files or namespaces will be aligned in HTML using tables. If set to
819# NO a bullet list will be used.
820
821HTML_ALIGN_MEMBERS = YES
822
823# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
824# documentation will contain sections that can be hidden and shown after the
825# page has loaded. For this to work a browser that supports
826# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
827# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
828
829HTML_DYNAMIC_SECTIONS = NO
830
831# If the GENERATE_DOCSET tag is set to YES, additional index files
832# will be generated that can be used as input for Apple's Xcode 3
833# integrated development environment, introduced with OSX 10.5 (Leopard).
834# To create a documentation set, doxygen will generate a Makefile in the
835# HTML output directory. Running make will produce the docset in that
836# directory and running "make install" will install the docset in
837# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
838# it at startup.
839# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
840
841GENERATE_DOCSET = NO
842
843# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
844# feed. A documentation feed provides an umbrella under which multiple
845# documentation sets from a single provider (such as a company or product suite)
846# can be grouped.
847
848DOCSET_FEEDNAME = "Doxygen generated docs"
849
850# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
851# should uniquely identify the documentation set bundle. This should be a
852# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
853# will append .docset to the name.
854
855DOCSET_BUNDLE_ID = org.doxygen.Project
856
857# If the GENERATE_HTMLHELP tag is set to YES, additional index files
858# will be generated that can be used as input for tools like the
859# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
860# of the generated HTML documentation.
861
862GENERATE_HTMLHELP = NO
863
864# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
865# be used to specify the file name of the resulting .chm file. You
866# can add a path in front of the file if the result should not be
867# written to the html output directory.
868
869CHM_FILE =
870
871# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
872# be used to specify the location (absolute path including file name) of
873# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
874# the HTML help compiler on the generated index.hhp.
875
876HHC_LOCATION =
877
878# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
879# controls if a separate .chi index file is generated (YES) or that
880# it should be included in the master .chm file (NO).
881
882GENERATE_CHI = NO
883
884# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
885# is used to encode HtmlHelp index (hhk), content (hhc) and project file
886# content.
887
888CHM_INDEX_ENCODING =
889
890# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
891# controls whether a binary table of contents is generated (YES) or a
892# normal table of contents (NO) in the .chm file.
893
894BINARY_TOC = NO
895
896# The TOC_EXPAND flag can be set to YES to add extra items for group members
897# to the contents of the HTML help documentation and to the tree view.
898
899TOC_EXPAND = NO
900
901# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
902# are set, an additional index file will be generated that can be used as input for
903# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
904# HTML documentation.
905
906GENERATE_QHP = NO
907
908# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
909# be used to specify the file name of the resulting .qch file.
910# The path specified is relative to the HTML output folder.
911
912QCH_FILE =
913
914# The QHP_NAMESPACE tag specifies the namespace to use when generating
915# Qt Help Project output. For more information please see
916# http://doc.trolltech.com/qthelpproject.html#namespace
917
918QHP_NAMESPACE =
919
920# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
921# Qt Help Project output. For more information please see
922# http://doc.trolltech.com/qthelpproject.html#virtual-folders
923
924QHP_VIRTUAL_FOLDER = doc
925
926# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
927# For more information please see
928# http://doc.trolltech.com/qthelpproject.html#custom-filters
929
930QHP_CUST_FILTER_NAME =
931
932# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
933# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
934
935QHP_CUST_FILTER_ATTRS =
936
937# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
938# filter section matches.
939# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
940
941QHP_SECT_FILTER_ATTRS =
942
943# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
944# be used to specify the location of Qt's qhelpgenerator.
945# If non-empty doxygen will try to run qhelpgenerator on the generated
946# .qhp file.
947
948QHG_LOCATION =
949
950# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
951# top of each HTML page. The value NO (the default) enables the index and
952# the value YES disables it.
953
954DISABLE_INDEX = NO
955
956# This tag can be used to set the number of enum values (range [1..20])
957# that doxygen will group on one line in the generated HTML documentation.
958
959ENUM_VALUES_PER_LINE = 4
960
961# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
962# structure should be generated to display hierarchical information.
963# If the tag value is set to YES, a side panel will be generated
964# containing a tree-like index structure (just like the one that
965# is generated for HTML Help). For this to work a browser that supports
966# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
967# Windows users are probably better off using the HTML help feature.
968
969GENERATE_TREEVIEW = YES
970
971# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
972# and Class Hierarchy pages using a tree view instead of an ordered list.
973
974USE_INLINE_TREES = NO
975
976# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
977# used to set the initial width (in pixels) of the frame in which the tree
978# is shown.
979
Alexander Afanasyev97fb44d2012-06-04 18:50:47 -0700980TREEVIEW_WIDTH = 300
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700981
982# Use this tag to change the font size of Latex formulas included
983# as images in the HTML documentation. The default is 10. Note that
984# when you change the font size after a successful doxygen run you need
985# to manually remove any form_*.png images from the HTML output directory
986# to force them to be regenerated.
987
988FORMULA_FONTSIZE = 10
989
990# When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
991# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
992# there is already a search function so this one should typically
993# be disabled.
994
Alexander Afanasyev97fb44d2012-06-04 18:50:47 -0700995SEARCHENGINE = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700996
997#---------------------------------------------------------------------------
998# configuration options related to the LaTeX output
999#---------------------------------------------------------------------------
1000
1001# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1002# generate Latex output.
1003
1004GENERATE_LATEX = NO
1005
1006# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1007# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1008# put in front of it. If left blank `latex' will be used as the default path.
1009
1010LATEX_OUTPUT = latex
1011
1012# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1013# invoked. If left blank `latex' will be used as the default command name.
1014
1015LATEX_CMD_NAME = latex
1016
1017# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1018# generate index for LaTeX. If left blank `makeindex' will be used as the
1019# default command name.
1020
1021MAKEINDEX_CMD_NAME = makeindex
1022
1023# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1024# LaTeX documents. This may be useful for small projects and may help to
1025# save some trees in general.
1026
1027COMPACT_LATEX = YES
1028
1029# The PAPER_TYPE tag can be used to set the paper type that is used
1030# by the printer. Possible values are: a4, a4wide, letter, legal and
1031# executive. If left blank a4wide will be used.
1032
1033PAPER_TYPE = a4wide
1034
1035# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1036# packages that should be included in the LaTeX output.
1037
1038EXTRA_PACKAGES = amsmath
1039
1040# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1041# the generated latex document. The header should contain everything until
1042# the first chapter. If it is left blank doxygen will generate a
1043# standard header. Notice: only use this tag if you know what you are doing!
1044
1045LATEX_HEADER =
1046
1047# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1048# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1049# contain links (just like the HTML output) instead of page references
1050# This makes the output suitable for online browsing using a pdf viewer.
1051
1052PDF_HYPERLINKS = YES
1053
1054# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1055# plain latex in the generated Makefile. Set this option to YES to get a
1056# higher quality PDF documentation.
1057
1058USE_PDFLATEX = YES
1059
1060# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1061# command to the generated LaTeX files. This will instruct LaTeX to keep
1062# running if errors occur, instead of asking the user for help.
1063# This option is also used when generating formulas in HTML.
1064
1065LATEX_BATCHMODE = NO
1066
1067# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1068# include the index chapters (such as File Index, Compound Index, etc.)
1069# in the output.
1070
1071LATEX_HIDE_INDICES = YES
1072
1073# 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.
1074
1075LATEX_SOURCE_CODE = NO
1076
1077#---------------------------------------------------------------------------
1078# configuration options related to the RTF output
1079#---------------------------------------------------------------------------
1080
1081# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1082# The RTF output is optimized for Word 97 and may not look very pretty with
1083# other RTF readers or editors.
1084
1085GENERATE_RTF = NO
1086
1087# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1088# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1089# put in front of it. If left blank `rtf' will be used as the default path.
1090
1091RTF_OUTPUT = rtf
1092
1093# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1094# RTF documents. This may be useful for small projects and may help to
1095# save some trees in general.
1096
1097COMPACT_RTF = NO
1098
1099# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1100# will contain hyperlink fields. The RTF file will
1101# contain links (just like the HTML output) instead of page references.
1102# This makes the output suitable for online browsing using WORD or other
1103# programs which support those fields.
1104# Note: wordpad (write) and others do not support links.
1105
1106RTF_HYPERLINKS = NO
1107
1108# Load stylesheet definitions from file. Syntax is similar to doxygen's
1109# config file, i.e. a series of assignments. You only have to provide
1110# replacements, missing definitions are set to their default value.
1111
1112RTF_STYLESHEET_FILE =
1113
1114# Set optional variables used in the generation of an rtf document.
1115# Syntax is similar to doxygen's config file.
1116
1117RTF_EXTENSIONS_FILE =
1118
1119#---------------------------------------------------------------------------
1120# configuration options related to the man page output
1121#---------------------------------------------------------------------------
1122
1123# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1124# generate man pages
1125
1126GENERATE_MAN = NO
1127
1128# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1129# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1130# put in front of it. If left blank `man' will be used as the default path.
1131
1132MAN_OUTPUT = man
1133
1134# The MAN_EXTENSION tag determines the extension that is added to
1135# the generated man pages (default is the subroutine's section .3)
1136
1137MAN_EXTENSION = .3
1138
1139# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1140# then it will generate one additional man file for each entity
1141# documented in the real man page(s). These additional files
1142# only source the real man page, but without them the man command
1143# would be unable to find the correct page. The default is NO.
1144
1145MAN_LINKS = NO
1146
1147#---------------------------------------------------------------------------
1148# configuration options related to the XML output
1149#---------------------------------------------------------------------------
1150
1151# If the GENERATE_XML tag is set to YES Doxygen will
1152# generate an XML file that captures the structure of
1153# the code including all documentation.
1154
1155GENERATE_XML = NO
1156
1157# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1158# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1159# put in front of it. If left blank `xml' will be used as the default path.
1160
1161XML_OUTPUT = xml
1162
1163# The XML_SCHEMA tag can be used to specify an XML schema,
1164# which can be used by a validating XML parser to check the
1165# syntax of the XML files.
1166
1167XML_SCHEMA =
1168
1169# The XML_DTD tag can be used to specify an XML DTD,
1170# which can be used by a validating XML parser to check the
1171# syntax of the XML files.
1172
1173XML_DTD =
1174
1175# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1176# dump the program listings (including syntax highlighting
1177# and cross-referencing information) to the XML output. Note that
1178# enabling this will significantly increase the size of the XML output.
1179
1180XML_PROGRAMLISTING = YES
1181
1182#---------------------------------------------------------------------------
1183# configuration options for the AutoGen Definitions output
1184#---------------------------------------------------------------------------
1185
1186# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1187# generate an AutoGen Definitions (see autogen.sf.net) file
1188# that captures the structure of the code including all
1189# documentation. Note that this feature is still experimental
1190# and incomplete at the moment.
1191
1192GENERATE_AUTOGEN_DEF = NO
1193
1194#---------------------------------------------------------------------------
1195# configuration options related to the Perl module output
1196#---------------------------------------------------------------------------
1197
1198# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1199# generate a Perl module file that captures the structure of
1200# the code including all documentation. Note that this
1201# feature is still experimental and incomplete at the
1202# moment.
1203
1204GENERATE_PERLMOD = NO
1205
1206# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1207# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1208# to generate PDF and DVI output from the Perl module output.
1209
1210PERLMOD_LATEX = NO
1211
1212# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1213# nicely formatted so it can be parsed by a human reader.
1214# This is useful
1215# if you want to understand what is going on.
1216# On the other hand, if this
1217# tag is set to NO the size of the Perl module output will be much smaller
1218# and Perl will parse it just the same.
1219
1220PERLMOD_PRETTY = YES
1221
1222# The names of the make variables in the generated doxyrules.make file
1223# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1224# This is useful so different doxyrules.make files included by the same
1225# Makefile don't overwrite each other's variables.
1226
1227PERLMOD_MAKEVAR_PREFIX =
1228
1229#---------------------------------------------------------------------------
1230# Configuration options related to the preprocessor
1231#---------------------------------------------------------------------------
1232
1233# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1234# evaluate all C-preprocessor directives found in the sources and include
1235# files.
1236
1237ENABLE_PREPROCESSING = YES
1238
1239# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1240# names in the source code. If set to NO (the default) only conditional
1241# compilation will be performed. Macro expansion can be done in a controlled
1242# way by setting EXPAND_ONLY_PREDEF to YES.
1243
1244MACRO_EXPANSION = YES
1245
1246# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1247# then the macro expansion is limited to the macros specified with the
1248# PREDEFINED and EXPAND_AS_DEFINED tags.
1249
1250EXPAND_ONLY_PREDEF = YES
1251
1252# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1253# in the INCLUDE_PATH (see below) will be search if a #include is found.
1254
1255SEARCH_INCLUDES = YES
1256
1257# The INCLUDE_PATH tag can be used to specify one or more directories that
1258# contain include files that are not input files but should be processed by
1259# the preprocessor.
1260
1261INCLUDE_PATH =
1262
1263# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1264# patterns (like *.h and *.hpp) to filter out the header-files in the
1265# directories. If left blank, the patterns specified with FILE_PATTERNS will
1266# be used.
1267
1268INCLUDE_FILE_PATTERNS =
1269
1270# The PREDEFINED tag can be used to specify one or more macro names that
1271# are defined before the preprocessor is started (similar to the -D option of
1272# gcc). The argument of the tag is a list of macros of the form: name
1273# or name=definition (no spaces). If the definition and the = are
1274# omitted =1 is assumed. To prevent a macro definition from being
1275# undefined via #undef or recursively expanded use the := operator
1276# instead of the = operator.
1277
1278PREDEFINED = NS3_ASSERT_ENABLE \
1279 NS3_LOG_ENABLE
1280
1281# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1282# this tag can be used to specify a list of macro names that should be expanded.
1283# The macro definition that is found in the sources will be used.
1284# Use the PREDEFINED tag if you want to use a different macro definition.
1285
1286EXPAND_AS_DEFINED = ATTRIBUTE_VALUE_DEFINE \
1287 ATTRIBUTE_VALUE_DEFINE_WITH_NAME \
1288 ATTRIBUTE_HELPER_HEADER_2
1289
1290# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1291# doxygen's preprocessor will remove all function-like macros that are alone
1292# on a line, have an all uppercase name, and do not end with a semicolon. Such
1293# function macros are typically used for boiler-plate code, and will confuse
1294# the parser if not removed.
1295
1296SKIP_FUNCTION_MACROS = YES
1297
1298#---------------------------------------------------------------------------
1299# Configuration::additions related to external references
1300#---------------------------------------------------------------------------
1301
1302# The TAGFILES option can be used to specify one or more tagfiles.
1303# Optionally an initial location of the external documentation
1304# can be added for each tagfile. The format of a tag file without
1305# this location is as follows:
1306#
1307# TAGFILES = file1 file2 ...
1308# Adding location for the tag files is done as follows:
1309#
1310# TAGFILES = file1=loc1 "file2 = loc2" ...
1311# where "loc1" and "loc2" can be relative or absolute paths or
1312# URLs. If a location is present for each tag, the installdox tool
1313# does not have to be run to correct the links.
1314# Note that each tag file must have a unique name
1315# (where the name does NOT include the path)
1316# If a tag file is not located in the directory in which doxygen
1317# is run, you must also specify the path to the tagfile here.
1318
1319TAGFILES =
1320
1321# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1322# a tag file that is based on the input files it reads.
1323
1324GENERATE_TAGFILE = ndnSIM.tag
1325
1326# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1327# in the class index. If set to NO only the inherited external classes
1328# will be listed.
1329
1330ALLEXTERNALS = NO
1331
1332# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1333# in the modules index. If set to NO, only the current project's groups will
1334# be listed.
1335
1336EXTERNAL_GROUPS = YES
1337
1338# The PERL_PATH should be the absolute path and name of the perl script
1339# interpreter (i.e. the result of `which perl').
1340
1341PERL_PATH = /usr/bin/perl
1342
1343#---------------------------------------------------------------------------
1344# Configuration options related to the dot tool
1345#---------------------------------------------------------------------------
1346
1347# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1348# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1349# or super classes. Setting the tag to NO turns the diagrams off. Note that
1350# this option is superseded by the HAVE_DOT option below. This is only a
1351# fallback. It is recommended to install and use dot, since it yields more
1352# powerful graphs.
1353
1354CLASS_DIAGRAMS = YES
1355
1356# You can define message sequence charts within doxygen comments using the \msc
1357# command. Doxygen will then run the mscgen tool (see
1358# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1359# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1360# the mscgen tool resides. If left empty the tool is assumed to be found in the
1361# default search path.
1362
1363MSCGEN_PATH =
1364
1365# If set to YES, the inheritance and collaboration graphs will hide
1366# inheritance and usage relations if the target is undocumented
1367# or is not a class.
1368
1369HIDE_UNDOC_RELATIONS = YES
1370
1371# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1372# available from the path. This tool is part of Graphviz, a graph visualization
1373# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1374# have no effect if this option is set to NO (the default)
1375
1376HAVE_DOT = YES
1377
1378# By default doxygen will write a font called FreeSans.ttf to the output
1379# directory and reference it in all dot files that doxygen generates. This
1380# font does not include all possible unicode characters however, so when you need
1381# these (or just want a differently looking font) you can specify the font name
1382# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1383# which can be done by putting it in a standard location or by setting the
1384# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1385# containing the font.
1386
1387DOT_FONTNAME = FreeSans
1388
1389# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1390# The default size is 10pt.
1391
1392DOT_FONTSIZE = 10
1393
1394# By default doxygen will tell dot to use the output directory to look for the
1395# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1396# different font using DOT_FONTNAME you can set the path where dot
1397# can find it using this tag.
1398
1399DOT_FONTPATH =
1400
1401# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1402# will generate a graph for each documented class showing the direct and
1403# indirect inheritance relations. Setting this tag to YES will force the
1404# the CLASS_DIAGRAMS tag to NO.
1405
1406CLASS_GRAPH = YES
1407
1408# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1409# will generate a graph for each documented class showing the direct and
1410# indirect implementation dependencies (inheritance, containment, and
1411# class references variables) of the class with other documented classes.
1412
1413COLLABORATION_GRAPH = YES
1414
1415# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1416# will generate a graph for groups, showing the direct groups dependencies
1417
1418GROUP_GRAPHS = YES
1419
1420# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1421# collaboration diagrams in a style similar to the OMG's Unified Modeling
1422# Language.
1423
1424UML_LOOK = NO
1425
1426# If set to YES, the inheritance and collaboration graphs will show the
1427# relations between templates and their instances.
1428
Alexander Afanasyev1cd79ae2012-10-05 22:42:12 -07001429TEMPLATE_RELATIONS = YES
Alexander Afanasyev6315ef72012-06-01 20:56:31 -07001430
1431# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1432# tags are set to YES then doxygen will generate a graph for each documented
1433# file showing the direct and indirect include dependencies of the file with
1434# other documented files.
1435
1436INCLUDE_GRAPH = YES
1437
1438# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1439# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1440# documented header file showing the documented files that directly or
1441# indirectly include this file.
1442
1443INCLUDED_BY_GRAPH = YES
1444
1445# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1446# doxygen will generate a call dependency graph for every global function
1447# or class method. Note that enabling this option will significantly increase
1448# the time of a run. So in most cases it will be better to enable call graphs
1449# for selected functions only using the \callgraph command.
1450
1451CALL_GRAPH = NO
1452
1453# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1454# doxygen will generate a caller dependency graph for every global function
1455# or class method. Note that enabling this option will significantly increase
1456# the time of a run. So in most cases it will be better to enable caller
1457# graphs for selected functions only using the \callergraph command.
1458
1459CALLER_GRAPH = NO
1460
1461# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1462# will graphical hierarchy of all classes instead of a textual one.
1463
1464GRAPHICAL_HIERARCHY = YES
1465
1466# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1467# then doxygen will show the dependencies a directory has on other directories
1468# in a graphical way. The dependency relations are determined by the #include
1469# relations between the files in the directories.
1470
1471DIRECTORY_GRAPH = YES
1472
1473# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1474# generated by dot. Possible values are png, jpg, or gif
1475# If left blank png will be used.
1476
1477DOT_IMAGE_FORMAT = png
1478
1479# The tag DOT_PATH can be used to specify the path where the dot tool can be
1480# found. If left blank, it is assumed the dot tool can be found in the path.
1481
1482DOT_PATH =
1483
1484# The DOTFILE_DIRS tag can be used to specify one or more directories that
1485# contain dot files that are included in the documentation (see the
1486# \dotfile command).
1487
1488DOTFILE_DIRS =
1489
1490# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1491# nodes that will be shown in the graph. If the number of nodes in a graph
1492# becomes larger than this value, doxygen will truncate the graph, which is
1493# visualized by representing a node as a red box. Note that doxygen if the
1494# number of direct children of the root node in a graph is already larger than
1495# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1496# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1497
1498DOT_GRAPH_MAX_NODES = 50
1499
1500# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1501# graphs generated by dot. A depth value of 3 means that only nodes reachable
1502# from the root by following a path via at most 3 edges will be shown. Nodes
1503# that lay further from the root node will be omitted. Note that setting this
1504# option to 1 or 2 may greatly reduce the computation time needed for large
1505# code bases. Also note that the size of a graph can be further restricted by
1506# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1507
1508MAX_DOT_GRAPH_DEPTH = 0
1509
1510# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1511# background. This is disabled by default, because dot on Windows does not
1512# seem to support this out of the box. Warning: Depending on the platform used,
1513# enabling this option may lead to badly anti-aliased labels on the edges of
1514# a graph (i.e. they become hard to read).
1515
1516DOT_TRANSPARENT = NO
1517
1518# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1519# files in one run (i.e. multiple -o and -T options on the command line). This
1520# makes dot run faster, but since only newer versions of dot (>1.8.10)
1521# support this, this feature is disabled by default.
1522
1523DOT_MULTI_TARGETS = NO
1524
1525# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1526# generate a legend page explaining the meaning of the various boxes and
1527# arrows in the dot generated graphs.
1528
1529GENERATE_LEGEND = YES
1530
1531# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1532# remove the intermediate dot files that are used to generate
1533# the various graphs.
1534
1535DOT_CLEANUP = YES