Revision 31015ef5

View differences:

Makefile
9 9
P8IGN = E251,E201,E302,E202
10 10
BINDIR = /usr/bin
11 11
MANDIR = /usr/share/man/man1
12
DOCDIRS = doc/html doc/latex
13
PDF = doc/latex/refman.pdf
12 14

  
13 15
all: codecheck test
14 16

  
15 17
clean:
16
	rm -rf build dist *.egg-info *.pyc $(MNEXEC) $(MANPAGES)
18
	rm -rf build dist *.egg-info *.pyc $(MNEXEC) $(MANPAGES) $(DOCDIRS)
17 19

  
18 20
codecheck: $(PYSRC)
19 21
	-echo "Running code check"
......
31 33
	-echo "Running tests"
32 34
	mininet/test/test_nets.py
33 35

  
36
mnexec: mnexec.c $(MN) mininet/net.py
37
	cc $(CFLAGS) $(LDFLAGS) -DVERSION=\"`PYTHONPATH=. $(MN) --version`\" $< -o $@
38

  
34 39
install: $(MNEXEC) $(MANPAGES)
35 40
	install $(MNEXEC) $(BINDIR)
36 41
	install $(MANPAGES) $(MANDIR)
......
48 53
	PYTHONPATH=. help2man -N -n "create a Mininet network." \
49 54
	--no-discard-stderr $< -o $@
50 55

  
51
mnexec: mnexec.c $(MN) mininet/net.py
52
	cc $(CFLAGS) $(LDFLAGS) -DVERSION=\"`PYTHONPATH=. $(MN) --version`\" $< -o $@
53

  
54 56
mnexec.1: mnexec
55 57
	help2man -N -n "execution utility for Mininet." \
56 58
	-h "-h" -v "-v" --no-discard-stderr ./$< -o $@ 
57 59

  
58
doc: man
59
	doxygen doxygen.cfg
60
.PHONY: doc
60 61

  
62
doc: man
63
	doxygen doc/doxygen.cfg
64
	make -C doc/latex
doc/doxygen.cfg
1
# Doxyfile 1.5.6
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

  
23
DOXYFILE_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

  
28
PROJECT_NAME           = "Mininet Python API Reference Manual"
29

  
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

  
34
PROJECT_NUMBER         = 
35

  
36
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
37
# base path where the generated documentation will be put. 
38
# If a relative path is entered, it will be relative to the location 
39
# where doxygen was started. If left blank the current directory will be used.
40

  
41
OUTPUT_DIRECTORY       = doc
42

  
43
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
44
# 4096 sub-directories (in 2 levels) under the output directory of each output 
45
# format and will distribute the generated files over these directories. 
46
# Enabling this option can be useful when feeding doxygen a huge amount of 
47
# source files, where putting all generated files in the same directory would 
48
# otherwise cause performance problems for the file system.
49

  
50
CREATE_SUBDIRS         = NO
51

  
52
# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
53
# documentation generated by doxygen is written. Doxygen will use this 
54
# information to generate all constant output in the proper language. 
55
# The default language is English, other supported languages are: 
56
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
57
# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, 
58
# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), 
59
# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 
60
# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, 
61
# and Ukrainian.
62

  
63
OUTPUT_LANGUAGE        = English
64

  
65
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
66
# include brief member descriptions after the members that are listed in 
67
# the file and class documentation (similar to JavaDoc). 
68
# Set to NO to disable this.
69

  
70
BRIEF_MEMBER_DESC      = YES
71

  
72
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
73
# the brief description of a member or function before the detailed description. 
74
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
75
# brief descriptions will be completely suppressed.
76

  
77
REPEAT_BRIEF           = YES
78

  
79
# This tag implements a quasi-intelligent brief description abbreviator 
80
# that is used to form the text in various listings. Each string 
81
# in this list, if found as the leading text of the brief description, will be 
82
# stripped from the text and the result after processing the whole list, is 
83
# used as the annotated text. Otherwise, the brief description is used as-is. 
84
# If left blank, the following values are used ("$name" is automatically 
85
# replaced with the name of the entity): "The $name class" "The $name widget" 
86
# "The $name file" "is" "provides" "specifies" "contains" 
87
# "represents" "a" "an" "the"
88

  
89
ABBREVIATE_BRIEF       = 
90

  
91
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
92
# Doxygen will generate a detailed section even if there is only a brief 
93
# description.
94

  
95
ALWAYS_DETAILED_SEC    = NO
96

  
97
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
98
# inherited members of a class in the documentation of that class as if those 
99
# members were ordinary class members. Constructors, destructors and assignment 
100
# operators of the base classes will not be shown.
101

  
102
INLINE_INHERITED_MEMB  = NO
103

  
104
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
105
# path before files name in the file list and in the header files. If set 
106
# to NO the shortest path that makes the file name unique will be used.
107

  
108
FULL_PATH_NAMES        = YES
109

  
110
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
111
# can be used to strip a user-defined part of the path. Stripping is 
112
# only done if one of the specified strings matches the left-hand part of 
113
# the path. The tag can be used to show relative paths in the file list. 
114
# If left blank the directory from which doxygen is run is used as the 
115
# path to strip.
116

  
117
STRIP_FROM_PATH        = 
118

  
119
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
120
# the path mentioned in the documentation of a class, which tells 
121
# the reader which header file to include in order to use a class. 
122
# If left blank only the name of the header file containing the class 
123
# definition is used. Otherwise one should specify the include paths that 
124
# are normally passed to the compiler using the -I flag.
125

  
126
STRIP_FROM_INC_PATH    = 
127

  
128
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
129
# (but less readable) file names. This can be useful is your file systems 
130
# doesn't support long names like on DOS, Mac, or CD-ROM.
131

  
132
SHORT_NAMES            = NO
133

  
134
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
135
# will interpret the first line (until the first dot) of a JavaDoc-style 
136
# comment as the brief description. If set to NO, the JavaDoc 
137
# comments will behave just like regular Qt-style comments 
138
# (thus requiring an explicit @brief command for a brief description.)
139

  
140
JAVADOC_AUTOBRIEF      = NO
141

  
142
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
143
# interpret the first line (until the first dot) of a Qt-style 
144
# comment as the brief description. If set to NO, the comments 
145
# will behave just like regular Qt-style comments (thus requiring 
146
# an explicit \brief command for a brief description.)
147

  
148
QT_AUTOBRIEF           = NO
149

  
150
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
151
# treat a multi-line C++ special comment block (i.e. a block of //! or /// 
152
# comments) as a brief description. This used to be the default behaviour. 
153
# The new default is to treat a multi-line C++ comment block as a detailed 
154
# description. Set this tag to YES if you prefer the old behaviour instead.
155

  
156
MULTILINE_CPP_IS_BRIEF = NO
157

  
158
# If the DETAILS_AT_TOP tag is set to YES then Doxygen 
159
# will output the detailed description near the top, like JavaDoc.
160
# If set to NO, the detailed description appears after the member 
161
# documentation.
162

  
163
DETAILS_AT_TOP         = NO
164

  
165
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
166
# member inherits the documentation from any documented member that it 
167
# re-implements.
168

  
169
INHERIT_DOCS           = YES
170

  
171
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
172
# a new page for each member. If set to NO, the documentation of a member will 
173
# be part of the file/class/namespace that contains it.
174

  
175
SEPARATE_MEMBER_PAGES  = NO
176

  
177
# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
178
# Doxygen uses this value to replace tabs by spaces in code fragments.
179

  
180
TAB_SIZE               = 8
181

  
182
# This tag can be used to specify a number of aliases that acts 
183
# as commands in the documentation. An alias has the form "name=value". 
184
# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
185
# put the command \sideeffect (or @sideeffect) in the documentation, which 
186
# will result in a user-defined paragraph with heading "Side Effects:". 
187
# You can put \n's in the value part of an alias to insert newlines.
188

  
189
ALIASES                = 
190

  
191
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
192
# sources only. Doxygen will then generate output that is more tailored for C. 
193
# For instance, some of the names that are used will be different. The list 
194
# of all members will be omitted, etc.
195

  
196
OPTIMIZE_OUTPUT_FOR_C  = NO
197

  
198
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
199
# sources only. Doxygen will then generate output that is more tailored for 
200
# Java. For instance, namespaces will be presented as packages, qualified 
201
# scopes will look different, etc.
202

  
203
OPTIMIZE_OUTPUT_JAVA   = NO
204

  
205
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
206
# sources only. Doxygen will then generate output that is more tailored for 
207
# Fortran.
208

  
209
OPTIMIZE_FOR_FORTRAN   = NO
210

  
211
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
212
# sources. Doxygen will then generate output that is tailored for 
213
# VHDL.
214

  
215
OPTIMIZE_OUTPUT_VHDL   = NO
216

  
217
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 
218
# to include (a tag file for) the STL sources as input, then you should 
219
# set this tag to YES in order to let doxygen match functions declarations and 
220
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
221
# func(std::string) {}). This also make the inheritance and collaboration 
222
# diagrams that involve STL classes more complete and accurate.
223

  
224
BUILTIN_STL_SUPPORT    = NO
225

  
226
# If you use Microsoft's C++/CLI language, you should set this option to YES to
227
# enable parsing support.
228

  
229
CPP_CLI_SUPPORT        = NO
230

  
231
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
232
# Doxygen will parse them like normal C++ but will assume all classes use public 
233
# instead of private inheritance when no explicit protection keyword is present.
234

  
235
SIP_SUPPORT            = NO
236

  
237
# For Microsoft's IDL there are propget and propput attributes to indicate getter 
238
# and setter methods for a property. Setting this option to YES (the default) 
239
# will make doxygen to replace the get and set methods by a property in the 
240
# documentation. This will only work if the methods are indeed getting or 
241
# setting a simple type. If this is not the case, or you want to show the 
242
# methods anyway, you should set this option to NO.
243

  
244
IDL_PROPERTY_SUPPORT   = YES
245

  
246
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
247
# tag is set to YES, then doxygen will reuse the documentation of the first 
248
# member in the group (if any) for the other members of the group. By default 
249
# all members of a group must be documented explicitly.
250

  
251
DISTRIBUTE_GROUP_DOC   = NO
252

  
253
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
254
# the same type (for instance a group of public functions) to be put as a 
255
# subgroup of that type (e.g. under the Public Functions section). Set it to 
256
# NO to prevent subgrouping. Alternatively, this can be done per class using 
257
# the \nosubgrouping command.
258

  
259
SUBGROUPING            = YES
260

  
261
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 
262
# is documented as struct, union, or enum with the name of the typedef. So 
263
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 
264
# with name TypeT. When disabled the typedef will appear as a member of a file, 
265
# namespace, or class. And the struct will be named TypeS. This can typically 
266
# be useful for C code in case the coding convention dictates that all compound 
267
# types are typedef'ed and only the typedef is referenced, never the tag name.
268

  
269
TYPEDEF_HIDES_STRUCT   = NO
270

  
271
#---------------------------------------------------------------------------
272
# Build related configuration options
273
#---------------------------------------------------------------------------
274

  
275
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
276
# documentation are documented, even if no documentation was available. 
277
# Private class members and static file members will be hidden unless 
278
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
279

  
280
EXTRACT_ALL            = NO
281

  
282
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
283
# will be included in the documentation.
284

  
285
EXTRACT_PRIVATE        = NO
286

  
287
# If the EXTRACT_STATIC tag is set to YES all static members of a file 
288
# will be included in the documentation.
289

  
290
EXTRACT_STATIC         = NO
291

  
292
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
293
# defined locally in source files will be included in the documentation. 
294
# If set to NO only classes defined in header files are included.
295

  
296
EXTRACT_LOCAL_CLASSES  = YES
297

  
298
# This flag is only useful for Objective-C code. When set to YES local 
299
# methods, which are defined in the implementation section but not in 
300
# the interface are included in the documentation. 
301
# If set to NO (the default) only methods in the interface are included.
302

  
303
EXTRACT_LOCAL_METHODS  = NO
304

  
305
# If this flag is set to YES, the members of anonymous namespaces will be 
306
# extracted and appear in the documentation as a namespace called 
307
# 'anonymous_namespace{file}', where file will be replaced with the base 
308
# name of the file that contains the anonymous namespace. By default 
309
# anonymous namespace are hidden.
310

  
311
EXTRACT_ANON_NSPACES   = NO
312

  
313
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
314
# undocumented members of documented classes, files or namespaces. 
315
# If set to NO (the default) these members will be included in the 
316
# various overviews, but no documentation section is generated. 
317
# This option has no effect if EXTRACT_ALL is enabled.
318

  
319
HIDE_UNDOC_MEMBERS     = NO
320

  
321
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
322
# undocumented classes that are normally visible in the class hierarchy. 
323
# If set to NO (the default) these classes will be included in the various 
324
# overviews. This option has no effect if EXTRACT_ALL is enabled.
325

  
326
HIDE_UNDOC_CLASSES     = NO
327

  
328
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
329
# friend (class|struct|union) declarations. 
330
# If set to NO (the default) these declarations will be included in the 
331
# documentation.
332

  
333
HIDE_FRIEND_COMPOUNDS  = NO
334

  
335
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
336
# documentation blocks found inside the body of a function. 
337
# If set to NO (the default) these blocks will be appended to the 
338
# function's detailed documentation block.
339

  
340
HIDE_IN_BODY_DOCS      = NO
341

  
342
# The INTERNAL_DOCS tag determines if documentation 
343
# that is typed after a \internal command is included. If the tag is set 
344
# to NO (the default) then the documentation will be excluded. 
345
# Set it to YES to include the internal documentation.
346

  
347
INTERNAL_DOCS          = NO
348

  
349
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
350
# file names in lower-case letters. If set to YES upper-case letters are also 
351
# allowed. This is useful if you have classes or files whose names only differ 
352
# in case and if your file system supports case sensitive file names. Windows 
353
# and Mac users are advised to set this option to NO.
354

  
355
CASE_SENSE_NAMES       = YES
356

  
357
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
358
# will show members with their full class and namespace scopes in the 
359
# documentation. If set to YES the scope will be hidden.
360

  
361
HIDE_SCOPE_NAMES       = NO
362

  
363
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
364
# will put a list of the files that are included by a file in the documentation 
365
# of that file.
366

  
367
SHOW_INCLUDE_FILES     = YES
368

  
369
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
370
# is inserted in the documentation for inline members.
371

  
372
INLINE_INFO            = YES
373

  
374
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
375
# will sort the (detailed) documentation of file and class members 
376
# alphabetically by member name. If set to NO the members will appear in 
377
# declaration order.
378

  
379
SORT_MEMBER_DOCS       = YES
380

  
381
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
382
# brief documentation of file, namespace and class members alphabetically 
383
# by member name. If set to NO (the default) the members will appear in 
384
# declaration order.
385

  
386
SORT_BRIEF_DOCS        = NO
387

  
388
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
389
# hierarchy of group names into alphabetical order. If set to NO (the default) 
390
# the group names will appear in their defined order.
391

  
392
SORT_GROUP_NAMES       = NO
393

  
394
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
395
# sorted by fully-qualified names, including namespaces. If set to 
396
# NO (the default), the class list will be sorted only by class name, 
397
# not including the namespace part. 
398
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
399
# Note: This option applies only to the class list, not to the 
400
# alphabetical list.
401

  
402
SORT_BY_SCOPE_NAME     = NO
403

  
404
# The GENERATE_TODOLIST tag can be used to enable (YES) or 
405
# disable (NO) the todo list. This list is created by putting \todo 
406
# commands in the documentation.
407

  
408
GENERATE_TODOLIST      = YES
409

  
410
# The GENERATE_TESTLIST tag can be used to enable (YES) or 
411
# disable (NO) the test list. This list is created by putting \test 
412
# commands in the documentation.
413

  
414
GENERATE_TESTLIST      = YES
415

  
416
# The GENERATE_BUGLIST tag can be used to enable (YES) or 
417
# disable (NO) the bug list. This list is created by putting \bug 
418
# commands in the documentation.
419

  
420
GENERATE_BUGLIST       = YES
421

  
422
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
423
# disable (NO) the deprecated list. This list is created by putting 
424
# \deprecated commands in the documentation.
425

  
426
GENERATE_DEPRECATEDLIST= YES
427

  
428
# The ENABLED_SECTIONS tag can be used to enable conditional 
429
# documentation sections, marked by \if sectionname ... \endif.
430

  
431
ENABLED_SECTIONS       = 
432

  
433
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
434
# the initial value of a variable or define consists of for it to appear in 
435
# the documentation. If the initializer consists of more lines than specified 
436
# here it will be hidden. Use a value of 0 to hide initializers completely. 
437
# The appearance of the initializer of individual variables and defines in the 
438
# documentation can be controlled using \showinitializer or \hideinitializer 
439
# command in the documentation regardless of this setting.
440

  
441
MAX_INITIALIZER_LINES  = 30
442

  
443
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
444
# at the bottom of the documentation of classes and structs. If set to YES the 
445
# list will mention the files that were used to generate the documentation.
446

  
447
SHOW_USED_FILES        = YES
448

  
449
# If the sources in your project are distributed over multiple directories 
450
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
451
# in the documentation. The default is NO.
452

  
453
SHOW_DIRECTORIES       = NO
454

  
455
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
456
# This will remove the Files entry from the Quick Index and from the 
457
# Folder Tree View (if specified). The default is YES.
458

  
459
SHOW_FILES             = YES
460

  
461
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 
462
# Namespaces page.  This will remove the Namespaces entry from the Quick Index
463
# and from the Folder Tree View (if specified). The default is YES.
464

  
465
SHOW_NAMESPACES        = YES
466

  
467
# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
468
# doxygen should invoke to get the current version for each file (typically from 
469
# the version control system). Doxygen will invoke the program by executing (via 
470
# popen()) the command <command> <input-file>, where <command> is the value of 
471
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
472
# provided by doxygen. Whatever the program writes to standard output 
473
# is used as the file version. See the manual for examples.
474

  
475
FILE_VERSION_FILTER    = 
476

  
477
#---------------------------------------------------------------------------
478
# configuration options related to warning and progress messages
479
#---------------------------------------------------------------------------
480

  
481
# The QUIET tag can be used to turn on/off the messages that are generated 
482
# by doxygen. Possible values are YES and NO. If left blank NO is used.
483

  
484
QUIET                  = NO
485

  
486
# The WARNINGS tag can be used to turn on/off the warning messages that are 
487
# generated by doxygen. Possible values are YES and NO. If left blank 
488
# NO is used.
489

  
490
WARNINGS               = YES
491

  
492
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
493
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
494
# automatically be disabled.
495

  
496
WARN_IF_UNDOCUMENTED   = YES
497

  
498
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
499
# potential errors in the documentation, such as not documenting some 
500
# parameters in a documented function, or documenting parameters that 
501
# don't exist or using markup commands wrongly.
502

  
503
WARN_IF_DOC_ERROR      = YES
504

  
505
# This WARN_NO_PARAMDOC option can be abled to get warnings for 
506
# functions that are documented, but have no documentation for their parameters 
507
# or return value. If set to NO (the default) doxygen will only warn about 
508
# wrong or incomplete parameter documentation, but not about the absence of 
509
# documentation.
510

  
511
WARN_NO_PARAMDOC       = NO
512

  
513
# The WARN_FORMAT tag determines the format of the warning messages that 
514
# doxygen can produce. The string should contain the $file, $line, and $text 
515
# tags, which will be replaced by the file and line number from which the 
516
# warning originated and the warning text. Optionally the format may contain 
517
# $version, which will be replaced by the version of the file (if it could 
518
# be obtained via FILE_VERSION_FILTER)
519

  
520
WARN_FORMAT            = "$file:$line: $text"
521

  
522
# The WARN_LOGFILE tag can be used to specify a file to which warning 
523
# and error messages should be written. If left blank the output is written 
524
# to stderr.
525

  
526
WARN_LOGFILE           = 
527

  
528
#---------------------------------------------------------------------------
529
# configuration options related to the input files
530
#---------------------------------------------------------------------------
531

  
532
# The INPUT tag can be used to specify the files and/or directories that contain 
533
# documented source files. You may enter file names like "myfile.cpp" or 
534
# directories like "/usr/src/myproject". Separate the files or directories 
535
# with spaces.
536

  
537
INPUT                  = mininet
538

  
539
# This tag can be used to specify the character encoding of the source files 
540
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
541
# also the default input encoding. Doxygen uses libiconv (or the iconv built 
542
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
543
# the list of possible encodings.
544

  
545
INPUT_ENCODING         = UTF-8
546

  
547
# If the value of the INPUT tag contains directories, you can use the 
548
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
549
# and *.h) to filter out the source-files in the directories. If left 
550
# blank the following patterns are tested: 
551
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
552
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
553

  
554
FILE_PATTERNS          = *.py
555

  
556
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
557
# should be searched for input files as well. Possible values are YES and NO. 
558
# If left blank NO is used.
559

  
560
RECURSIVE              = NO
561

  
562
# The EXCLUDE tag can be used to specify files and/or directories that should 
563
# excluded from the INPUT source files. This way you can easily exclude a 
564
# subdirectory from a directory tree whose root is specified with the INPUT tag.
565

  
566
EXCLUDE                = 
567

  
568
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
569
# directories that are symbolic links (a Unix filesystem feature) are excluded 
570
# from the input.
571

  
572
EXCLUDE_SYMLINKS       = NO
573

  
574
# If the value of the INPUT tag contains directories, you can use the 
575
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
576
# certain files from those directories. Note that the wildcards are matched 
577
# against the file with absolute path, so to exclude all test directories 
578
# for example use the pattern */test/*
579

  
580
EXCLUDE_PATTERNS       = 
581

  
582
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
583
# (namespaces, classes, functions, etc.) that should be excluded from the 
584
# output. The symbol name can be a fully qualified name, a word, or if the 
585
# wildcard * is used, a substring. Examples: ANamespace, AClass, 
586
# AClass::ANamespace, ANamespace::*Test
587

  
588
EXCLUDE_SYMBOLS        = 
589

  
590
# The EXAMPLE_PATH tag can be used to specify one or more files or 
591
# directories that contain example code fragments that are included (see 
592
# the \include command).
593

  
594
EXAMPLE_PATH           = 
595

  
596
# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
597
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
598
# and *.h) to filter out the source-files in the directories. If left 
599
# blank all files are included.
600

  
601
EXAMPLE_PATTERNS       = 
602

  
603
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
604
# searched for input files to be used with the \include or \dontinclude 
605
# commands irrespective of the value of the RECURSIVE tag. 
606
# Possible values are YES and NO. If left blank NO is used.
607

  
608
EXAMPLE_RECURSIVE      = NO
609

  
610
# The IMAGE_PATH tag can be used to specify one or more files or 
611
# directories that contain image that are included in the documentation (see 
612
# the \image command).
613

  
614
IMAGE_PATH             = 
615

  
616
# The INPUT_FILTER tag can be used to specify a program that doxygen should 
617
# invoke to filter for each input file. Doxygen will invoke the filter program 
618
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
619
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
620
# input file. Doxygen will then use the output that the filter program writes 
621
# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
622
# ignored.
623

  
624
INPUT_FILTER           = util/doxify.py
625

  
626
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
627
# basis.  Doxygen will compare the file name with each pattern and apply the 
628
# filter if there is a match.  The filters are a list of the form: 
629
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
630
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
631
# is applied to all files.
632

  
633
FILTER_PATTERNS        = 
634

  
635
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
636
# INPUT_FILTER) will be used to filter the input files when producing source 
637
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
638

  
639
FILTER_SOURCE_FILES    = YES
640

  
641
#---------------------------------------------------------------------------
642
# configuration options related to source browsing
643
#---------------------------------------------------------------------------
644

  
645
# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
646
# be generated. Documented entities will be cross-referenced with these sources. 
647
# Note: To get rid of all source code in the generated output, make sure also 
648
# VERBATIM_HEADERS is set to NO.
649

  
650
SOURCE_BROWSER         = NO
651

  
652
# Setting the INLINE_SOURCES tag to YES will include the body 
653
# of functions and classes directly in the documentation.
654

  
655
INLINE_SOURCES         = NO
656

  
657
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
658
# doxygen to hide any special comment blocks from generated source code 
659
# fragments. Normal C and C++ comments will always remain visible.
660

  
661
STRIP_CODE_COMMENTS    = YES
662

  
663
# If the REFERENCED_BY_RELATION tag is set to YES 
664
# then for each documented function all documented 
665
# functions referencing it will be listed.
666

  
667
REFERENCED_BY_RELATION = NO
668

  
669
# If the REFERENCES_RELATION tag is set to YES 
670
# then for each documented function all documented entities 
671
# called/used by that function will be listed.
672

  
673
REFERENCES_RELATION    = NO
674

  
675
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
676
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
677
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
678
# link to the source code.  Otherwise they will link to the documentstion.
679

  
680
REFERENCES_LINK_SOURCE = YES
681

  
682
# If the USE_HTAGS tag is set to YES then the references to source code 
683
# will point to the HTML generated by the htags(1) tool instead of doxygen 
684
# built-in source browser. The htags tool is part of GNU's global source 
685
# tagging system (see http://www.gnu.org/software/global/global.html). You 
686
# will need version 4.8.6 or higher.
687

  
688
USE_HTAGS              = NO
689

  
690
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
691
# will generate a verbatim copy of the header file for each class for 
692
# which an include is specified. Set to NO to disable this.
693

  
694
VERBATIM_HEADERS       = YES
695

  
696
#---------------------------------------------------------------------------
697
# configuration options related to the alphabetical class index
698
#---------------------------------------------------------------------------
699

  
700
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
701
# of all compounds will be generated. Enable this if the project 
702
# contains a lot of classes, structs, unions or interfaces.
703

  
704
ALPHABETICAL_INDEX     = NO
705

  
706
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
707
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
708
# in which this list will be split (can be a number in the range [1..20])
709

  
710
COLS_IN_ALPHA_INDEX    = 5
711

  
712
# In case all classes in a project start with a common prefix, all 
713
# classes will be put under the same header in the alphabetical index. 
714
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
715
# should be ignored while generating the index headers.
716

  
717
IGNORE_PREFIX          = 
718

  
719
#---------------------------------------------------------------------------
720
# configuration options related to the HTML output
721
#---------------------------------------------------------------------------
722

  
723
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
724
# generate HTML output.
725

  
726
GENERATE_HTML          = YES
727

  
728
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
729
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
730
# put in front of it. If left blank `html' will be used as the default path.
731

  
732
HTML_OUTPUT            = html
733

  
734
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
735
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
736
# doxygen will generate files with .html extension.
737

  
738
HTML_FILE_EXTENSION    = .html
739

  
740
# The HTML_HEADER tag can be used to specify a personal HTML header for 
741
# each generated HTML page. If it is left blank doxygen will generate a 
742
# standard header.
743

  
744
HTML_HEADER            = 
745

  
746
# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
747
# each generated HTML page. If it is left blank doxygen will generate a 
748
# standard footer.
749

  
750
HTML_FOOTER            = 
751

  
752
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
753
# style sheet that is used by each HTML page. It can be used to 
754
# fine-tune the look of the HTML output. If the tag is left blank doxygen 
755
# will generate a default style sheet. Note that doxygen will try to copy 
756
# the style sheet file to the HTML output directory, so don't put your own 
757
# stylesheet in the HTML output directory as well, or it will be erased!
758

  
759
HTML_STYLESHEET        = 
760

  
761
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
762
# files or namespaces will be aligned in HTML using tables. If set to 
763
# NO a bullet list will be used.
764

  
765
HTML_ALIGN_MEMBERS     = YES
766

  
767
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
768
# will be generated that can be used as input for tools like the 
769
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
770
# of the generated HTML documentation.
771

  
772
GENERATE_HTMLHELP      = NO
773

  
774
# If the GENERATE_DOCSET tag is set to YES, additional index files 
775
# will be generated that can be used as input for Apple's Xcode 3 
776
# integrated development environment, introduced with OSX 10.5 (Leopard). 
777
# To create a documentation set, doxygen will generate a Makefile in the 
778
# HTML output directory. Running make will produce the docset in that 
779
# directory and running "make install" will install the docset in 
780
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
781
# it at startup.
782

  
783
GENERATE_DOCSET        = NO
784

  
785
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
786
# feed. A documentation feed provides an umbrella under which multiple 
787
# documentation sets from a single provider (such as a company or product suite) 
788
# can be grouped.
789

  
790
DOCSET_FEEDNAME        = "Doxygen generated docs"
791

  
792
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
793
# should uniquely identify the documentation set bundle. This should be a 
794
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
795
# will append .docset to the name.
796

  
797
DOCSET_BUNDLE_ID       = org.doxygen.Project
798

  
799
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
800
# documentation will contain sections that can be hidden and shown after the 
801
# page has loaded. For this to work a browser that supports 
802
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
803
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
804

  
805
HTML_DYNAMIC_SECTIONS  = NO
806

  
807
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
808
# be used to specify the file name of the resulting .chm file. You 
809
# can add a path in front of the file if the result should not be 
810
# written to the html output directory.
811

  
812
CHM_FILE               = 
813

  
814
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
815
# be used to specify the location (absolute path including file name) of 
816
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
817
# the HTML help compiler on the generated index.hhp.
818

  
819
HHC_LOCATION           = 
820

  
821
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
822
# controls if a separate .chi index file is generated (YES) or that 
823
# it should be included in the master .chm file (NO).
824

  
825
GENERATE_CHI           = NO
826

  
827
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
828
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
829
# content.
830

  
831
CHM_INDEX_ENCODING     = 
832

  
833
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
834
# controls whether a binary table of contents is generated (YES) or a 
835
# normal table of contents (NO) in the .chm file.
836

  
837
BINARY_TOC             = NO
838

  
839
# The TOC_EXPAND flag can be set to YES to add extra items for group members 
840
# to the contents of the HTML help documentation and to the tree view.
841

  
842
TOC_EXPAND             = NO
843

  
844
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
845
# top of each HTML page. The value NO (the default) enables the index and 
846
# the value YES disables it.
847

  
848
DISABLE_INDEX          = NO
849

  
850
# This tag can be used to set the number of enum values (range [1..20]) 
851
# that doxygen will group on one line in the generated HTML documentation.
852

  
853
ENUM_VALUES_PER_LINE   = 4
854

  
855
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
856
# structure should be generated to display hierarchical information.
857
# If the tag value is set to FRAME, a side panel will be generated
858
# containing a tree-like index structure (just like the one that 
859
# is generated for HTML Help). For this to work a browser that supports 
860
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
861
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
862
# probably better off using the HTML help feature. Other possible values 
863
# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
864
# and Class Hiererachy pages using a tree view instead of an ordered list;
865
# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
866
# disables this behavior completely. For backwards compatibility with previous
867
# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
868
# respectively.
869

  
870
GENERATE_TREEVIEW      = NONE
871

  
872
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
873
# used to set the initial width (in pixels) of the frame in which the tree 
874
# is shown.
875

  
876
TREEVIEW_WIDTH         = 250
877

  
878
# Use this tag to change the font size of Latex formulas included 
879
# as images in the HTML documentation. The default is 10. Note that 
880
# when you change the font size after a successful doxygen run you need 
881
# to manually remove any form_*.png images from the HTML output directory 
882
# to force them to be regenerated.
883

  
884
FORMULA_FONTSIZE       = 10
885

  
886
#---------------------------------------------------------------------------
887
# configuration options related to the LaTeX output
888
#---------------------------------------------------------------------------
889

  
890
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
891
# generate Latex output.
892

  
893
GENERATE_LATEX         = YES
894

  
895
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
896
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
897
# put in front of it. If left blank `latex' will be used as the default path.
898

  
899
LATEX_OUTPUT           = latex
900

  
901
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
902
# invoked. If left blank `latex' will be used as the default command name.
903

  
904
LATEX_CMD_NAME         = latex
905

  
906
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
907
# generate index for LaTeX. If left blank `makeindex' will be used as the 
908
# default command name.
909

  
910
MAKEINDEX_CMD_NAME     = makeindex
911

  
912
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
913
# LaTeX documents. This may be useful for small projects and may help to 
914
# save some trees in general.
915

  
916
COMPACT_LATEX          = NO
917

  
918
# The PAPER_TYPE tag can be used to set the paper type that is used 
919
# by the printer. Possible values are: a4, a4wide, letter, legal and 
920
# executive. If left blank a4wide will be used.
921

  
922
PAPER_TYPE             = letter
923

  
924
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
925
# packages that should be included in the LaTeX output.
926

  
927
EXTRA_PACKAGES         = 
928

  
929
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
930
# the generated latex document. The header should contain everything until 
931
# the first chapter. If it is left blank doxygen will generate a 
932
# standard header. Notice: only use this tag if you know what you are doing!
933

  
934
LATEX_HEADER           = 
935

  
936
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
937
# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
938
# contain links (just like the HTML output) instead of page references 
939
# This makes the output suitable for online browsing using a pdf viewer.
940

  
941
PDF_HYPERLINKS         = YES
942

  
943
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
944
# plain latex in the generated Makefile. Set this option to YES to get a 
945
# higher quality PDF documentation.
946

  
947
USE_PDFLATEX           = YES
948

  
949
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
950
# command to the generated LaTeX files. This will instruct LaTeX to keep 
951
# running if errors occur, instead of asking the user for help. 
952
# This option is also used when generating formulas in HTML.
953

  
954
LATEX_BATCHMODE        = NO
955

  
956
# If LATEX_HIDE_INDICES is set to YES then doxygen will not 
957
# include the index chapters (such as File Index, Compound Index, etc.) 
958
# in the output.
959

  
960
LATEX_HIDE_INDICES     = NO
961

  
962
#---------------------------------------------------------------------------
963
# configuration options related to the RTF output
964
#---------------------------------------------------------------------------
965

  
966
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
967
# The RTF output is optimized for Word 97 and may not look very pretty with 
968
# other RTF readers or editors.
969

  
970
GENERATE_RTF           = NO
971

  
972
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
973
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
974
# put in front of it. If left blank `rtf' will be used as the default path.
975

  
976
RTF_OUTPUT             = rtf
977

  
978
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
979
# RTF documents. This may be useful for small projects and may help to 
980
# save some trees in general.
981

  
982
COMPACT_RTF            = NO
983

  
984
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
985
# will contain hyperlink fields. The RTF file will 
986
# contain links (just like the HTML output) instead of page references. 
987
# This makes the output suitable for online browsing using WORD or other 
988
# programs which support those fields. 
989
# Note: wordpad (write) and others do not support links.
990

  
991
RTF_HYPERLINKS         = NO
992

  
993
# Load stylesheet definitions from file. Syntax is similar to doxygen's 
994
# config file, i.e. a series of assignments. You only have to provide 
995
# replacements, missing definitions are set to their default value.
996

  
997
RTF_STYLESHEET_FILE    = 
998

  
999
# Set optional variables used in the generation of an rtf document. 
1000
# Syntax is similar to doxygen's config file.
1001

  
1002
RTF_EXTENSIONS_FILE    = 
1003

  
1004
#---------------------------------------------------------------------------
1005
# configuration options related to the man page output
1006
#---------------------------------------------------------------------------
1007

  
1008
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
1009
# generate man pages
1010

  
1011
GENERATE_MAN           = NO
1012

  
1013
# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
1014
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1015
# put in front of it. If left blank `man' will be used as the default path.
1016

  
1017
MAN_OUTPUT             = man
1018

  
1019
# The MAN_EXTENSION tag determines the extension that is added to 
1020
# the generated man pages (default is the subroutine's section .3)
1021

  
1022
MAN_EXTENSION          = .3
1023

  
1024
# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
1025
# then it will generate one additional man file for each entity 
1026
# documented in the real man page(s). These additional files 
1027
# only source the real man page, but without them the man command 
1028
# would be unable to find the correct page. The default is NO.
1029

  
1030
MAN_LINKS              = NO
1031

  
1032
#---------------------------------------------------------------------------
1033
# configuration options related to the XML output
1034
#---------------------------------------------------------------------------
1035

  
1036
# If the GENERATE_XML tag is set to YES Doxygen will 
1037
# generate an XML file that captures the structure of 
1038
# the code including all documentation.
1039

  
1040
GENERATE_XML           = NO
1041

  
1042
# The XML_OUTPUT tag is used to specify where the XML pages will be put. 
1043
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1044
# put in front of it. If left blank `xml' will be used as the default path.
1045

  
1046
XML_OUTPUT             = xml
1047

  
1048
# The XML_SCHEMA tag can be used to specify an XML schema, 
1049
# which can be used by a validating XML parser to check the 
1050
# syntax of the XML files.
1051

  
1052
XML_SCHEMA             = 
1053

  
1054
# The XML_DTD tag can be used to specify an XML DTD, 
1055
# which can be used by a validating XML parser to check the 
1056
# syntax of the XML files.
1057

  
1058
XML_DTD                = 
1059

  
1060
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
1061
# dump the program listings (including syntax highlighting 
1062
# and cross-referencing information) to the XML output. Note that 
1063
# enabling this will significantly increase the size of the XML output.
1064

  
1065
XML_PROGRAMLISTING     = YES
1066

  
1067
#---------------------------------------------------------------------------
1068
# configuration options for the AutoGen Definitions output
1069
#---------------------------------------------------------------------------
1070

  
1071
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
1072
# generate an AutoGen Definitions (see autogen.sf.net) file 
1073
# that captures the structure of the code including all 
1074
# documentation. Note that this feature is still experimental 
1075
# and incomplete at the moment.
1076

  
1077
GENERATE_AUTOGEN_DEF   = NO
1078

  
1079
#---------------------------------------------------------------------------
1080
# configuration options related to the Perl module output
1081
#---------------------------------------------------------------------------
1082

  
1083
# If the GENERATE_PERLMOD tag is set to YES Doxygen will 
1084
# generate a Perl module file that captures the structure of 
1085
# the code including all documentation. Note that this 
1086
# feature is still experimental and incomplete at the 
1087
# moment.
1088

  
1089
GENERATE_PERLMOD       = NO
1090

  
1091
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
1092
# the necessary Makefile rules, Perl scripts and LaTeX code to be able 
1093
# to generate PDF and DVI output from the Perl module output.
1094

  
1095
PERLMOD_LATEX          = NO
1096

  
1097
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
1098
# nicely formatted so it can be parsed by a human reader.  This is useful 
1099
# if you want to understand what is going on.  On the other hand, if this 
1100
# tag is set to NO the size of the Perl module output will be much smaller 
1101
# and Perl will parse it just the same.
1102

  
1103
PERLMOD_PRETTY         = YES
1104

  
1105
# The names of the make variables in the generated doxyrules.make file 
1106
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
1107
# This is useful so different doxyrules.make files included by the same 
1108
# Makefile don't overwrite each other's variables.
1109

  
1110
PERLMOD_MAKEVAR_PREFIX = 
1111

  
1112
#---------------------------------------------------------------------------
1113
# Configuration options related to the preprocessor   
1114
#---------------------------------------------------------------------------
1115

  
1116
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
1117
# evaluate all C-preprocessor directives found in the sources and include 
1118
# files.
1119

  
1120
ENABLE_PREPROCESSING   = YES
1121

  
1122
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
1123
# names in the source code. If set to NO (the default) only conditional 
1124
# compilation will be performed. Macro expansion can be done in a controlled 
1125
# way by setting EXPAND_ONLY_PREDEF to YES.
1126

  
1127
MACRO_EXPANSION        = NO
1128

  
1129
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
1130
# then the macro expansion is limited to the macros specified with the 
1131
# PREDEFINED and EXPAND_AS_DEFINED tags.
1132

  
1133
EXPAND_ONLY_PREDEF     = NO
1134

  
1135
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
1136
# in the INCLUDE_PATH (see below) will be search if a #include is found.
1137

  
1138
SEARCH_INCLUDES        = YES
1139

  
1140
# The INCLUDE_PATH tag can be used to specify one or more directories that 
1141
# contain include files that are not input files but should be processed by 
1142
# the preprocessor.
1143

  
1144
INCLUDE_PATH           = 
1145

  
1146
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
1147
# patterns (like *.h and *.hpp) to filter out the header-files in the 
1148
# directories. If left blank, the patterns specified with FILE_PATTERNS will 
1149
# be used.
1150

  
1151
INCLUDE_FILE_PATTERNS  = 
1152

  
1153
# The PREDEFINED tag can be used to specify one or more macro names that 
1154
# are defined before the preprocessor is started (similar to the -D option of 
1155
# gcc). The argument of the tag is a list of macros of the form: name 
1156
# or name=definition (no spaces). If the definition and the = are 
1157
# omitted =1 is assumed. To prevent a macro definition from being 
1158
# undefined via #undef or recursively expanded use the := operator 
1159
# instead of the = operator.
1160

  
1161
PREDEFINED             = 
1162

  
1163
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
1164
# this tag can be used to specify a list of macro names that should be expanded. 
1165
# The macro definition that is found in the sources will be used. 
1166
# Use the PREDEFINED tag if you want to use a different macro definition.
1167

  
1168
EXPAND_AS_DEFINED      = 
1169

  
1170
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
1171
# doxygen's preprocessor will remove all function-like macros that are alone 
1172
# on a line, have an all uppercase name, and do not end with a semicolon. Such 
1173
# function macros are typically used for boiler-plate code, and will confuse 
1174
# the parser if not removed.
1175

  
1176
SKIP_FUNCTION_MACROS   = YES
1177

  
1178
#---------------------------------------------------------------------------
1179
# Configuration::additions related to external references   
1180
#---------------------------------------------------------------------------
1181

  
1182
# The TAGFILES option can be used to specify one or more tagfiles. 
1183
# Optionally an initial location of the external documentation 
1184
# can be added for each tagfile. The format of a tag file without 
1185
# this location is as follows: 
1186
#   TAGFILES = file1 file2 ... 
1187
# Adding location for the tag files is done as follows: 
1188
#   TAGFILES = file1=loc1 "file2 = loc2" ... 
1189
# where "loc1" and "loc2" can be relative or absolute paths or 
1190
# URLs. If a location is present for each tag, the installdox tool 
1191
# does not have to be run to correct the links.
1192
# Note that each tag file must have a unique name
1193
# (where the name does NOT include the path)
1194
# If a tag file is not located in the directory in which doxygen 
1195
# is run, you must also specify the path to the tagfile here.
1196

  
1197
TAGFILES               = 
1198

  
1199
# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
1200
# a tag file that is based on the input files it reads.
1201

  
1202
GENERATE_TAGFILE       = 
1203

  
1204
# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
1205
# in the class index. If set to NO only the inherited external classes 
1206
# will be listed.
1207

  
1208
ALLEXTERNALS           = NO
1209

  
1210
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
1211
# in the modules index. If set to NO, only the current project's groups will 
1212
# be listed.
1213

  
1214
EXTERNAL_GROUPS        = YES
1215

  
1216
# The PERL_PATH should be the absolute path and name of the perl script 
1217
# interpreter (i.e. the result of `which perl').
1218

  
1219
PERL_PATH              = /usr/bin/perl
1220

  
1221
#---------------------------------------------------------------------------
1222
# Configuration options related to the dot tool   
1223
#---------------------------------------------------------------------------
1224

  
1225
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
1226
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
1227
# or super classes. Setting the tag to NO turns the diagrams off. Note that 
1228
# this option is superseded by the HAVE_DOT option below. This is only a 
1229
# fallback. It is recommended to install and use dot, since it yields more 
1230
# powerful graphs.
1231

  
1232
CLASS_DIAGRAMS         = YES
1233

  
1234
# You can define message sequence charts within doxygen comments using the \msc 
1235
# command. Doxygen will then run the mscgen tool (see 
1236
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 
1237
# documentation. The MSCGEN_PATH tag allows you to specify the directory where 
1238
# the mscgen tool resides. If left empty the tool is assumed to be found in the 
1239
# default search path.
1240

  
1241
MSCGEN_PATH            = 
1242

  
1243
# If set to YES, the inheritance and collaboration graphs will hide 
1244
# inheritance and usage relations if the target is undocumented 
1245
# or is not a class.
1246

  
1247
HIDE_UNDOC_RELATIONS   = YES
1248

  
1249
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
1250
# available from the path. This tool is part of Graphviz, a graph visualization 
1251
# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
1252
# have no effect if this option is set to NO (the default)
1253

  
1254
HAVE_DOT               = NO
1255

  
1256
# By default doxygen will write a font called FreeSans.ttf to the output 
1257
# directory and reference it in all dot files that doxygen generates. This 
1258
# font does not include all possible unicode characters however, so when you need 
1259
# these (or just want a differently looking font) you can specify the font name 
1260
# using DOT_FONTNAME. You need need to make sure dot is able to find the font, 
1261
# which can be done by putting it in a standard location or by setting the 
1262
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 
1263
# containing the font.
1264

  
1265
DOT_FONTNAME           = FreeSans
1266

  
1267
# By default doxygen will tell dot to use the output directory to look for the 
1268
# FreeSans.ttf font (which doxygen will put there itself). If you specify a 
1269
# different font using DOT_FONTNAME you can set the path where dot 
1270
# can find it using this tag.
1271

  
1272
DOT_FONTPATH           = 
1273

  
1274
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1275
# will generate a graph for each documented class showing the direct and 
1276
# indirect inheritance relations. Setting this tag to YES will force the 
1277
# the CLASS_DIAGRAMS tag to NO.
1278

  
1279
CLASS_GRAPH            = YES
1280

  
1281
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1282
# will generate a graph for each documented class showing the direct and 
1283
# indirect implementation dependencies (inheritance, containment, and 
1284
# class references variables) of the class with other documented classes.
1285

  
1286
COLLABORATION_GRAPH    = YES
1287

  
1288
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
1289
# will generate a graph for groups, showing the direct groups dependencies
1290

  
1291
GROUP_GRAPHS           = YES
1292

  
1293
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
1294
# collaboration diagrams in a style similar to the OMG's Unified Modeling 
1295
# Language.
1296

  
1297
UML_LOOK               = NO
1298

  
1299
# If set to YES, the inheritance and collaboration graphs will show the 
1300
# relations between templates and their instances.
1301

  
1302
TEMPLATE_RELATIONS     = NO
1303

  
1304
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
1305
# tags are set to YES then doxygen will generate a graph for each documented 
1306
# file showing the direct and indirect include dependencies of the file with 
1307
# other documented files.
1308

  
1309
INCLUDE_GRAPH          = YES
1310

  
1311
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
1312
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
1313
# documented header file showing the documented files that directly or 
1314
# indirectly include this file.
1315

  
1316
INCLUDED_BY_GRAPH      = YES
1317

  
1318
# If the CALL_GRAPH and HAVE_DOT options are set to YES then 
1319
# doxygen will generate a call dependency graph for every global function 
1320
# or class method. Note that enabling this option will significantly increase 
1321
# the time of a run. So in most cases it will be better to enable call graphs 
1322
# for selected functions only using the \callgraph command.
1323

  
1324
CALL_GRAPH             = NO
1325

  
1326
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 
1327
# doxygen will generate a caller dependency graph for every global function 
1328
# or class method. Note that enabling this option will significantly increase 
1329
# the time of a run. So in most cases it will be better to enable caller 
1330
# graphs for selected functions only using the \callergraph command.
1331

  
1332
CALLER_GRAPH           = NO
1333

  
1334
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
1335
# will graphical hierarchy of all classes instead of a textual one.
1336

  
1337
GRAPHICAL_HIERARCHY    = YES
1338

  
1339
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
1340
# then doxygen will show the dependencies a directory has on other directories 
1341
# in a graphical way. The dependency relations are determined by the #include
1342
# relations between the files in the directories.
1343

  
1344
DIRECTORY_GRAPH        = YES
1345

  
1346
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1347
# generated by dot. Possible values are png, jpg, or gif
1348
# If left blank png will be used.
1349

  
1350
DOT_IMAGE_FORMAT       = png
1351

  
1352
# The tag DOT_PATH can be used to specify the path where the dot tool can be 
1353
# found. If left blank, it is assumed the dot tool can be found in the path.
1354

  
1355
DOT_PATH               = 
1356

  
1357
# The DOTFILE_DIRS tag can be used to specify one or more directories that 
1358
# contain dot files that are included in the documentation (see the 
1359
# \dotfile command).
1360

  
1361
DOTFILE_DIRS           = 
1362

  
1363
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
1364
# nodes that will be shown in the graph. If the number of nodes in a graph 
1365
# becomes larger than this value, doxygen will truncate the graph, which is 
1366
# visualized by representing a node as a red box. Note that doxygen if the 
1367
# number of direct children of the root node in a graph is already larger than 
1368
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 
1369
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1370

  
1371
DOT_GRAPH_MAX_NODES    = 50
1372

  
1373
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
1374
# graphs generated by dot. A depth value of 3 means that only nodes reachable 
1375
# from the root by following a path via at most 3 edges will be shown. Nodes 
1376
# that lay further from the root node will be omitted. Note that setting this 
1377
# option to 1 or 2 may greatly reduce the computation time needed for large 
1378
# code bases. Also note that the size of a graph can be further restricted by 
1379
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1380

  
1381
MAX_DOT_GRAPH_DEPTH    = 0
1382

  
1383
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
1384
# background. This is enabled by default, which results in a transparent 
1385
# background. Warning: Depending on the platform used, enabling this option 
1386
# may lead to badly anti-aliased labels on the edges of a graph (i.e. they 
1387
# become hard to read).
1388

  
1389
DOT_TRANSPARENT        = YES
1390

  
1391
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
1392
# files in one run (i.e. multiple -o and -T options on the command line). This 
1393
# makes dot run faster, but since only newer versions of dot (>1.8.10) 
1394
# support this, this feature is disabled by default.
1395

  
1396
DOT_MULTI_TARGETS      = NO
1397

  
1398
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
1399
# generate a legend page explaining the meaning of the various boxes and 
1400
# arrows in the dot generated graphs.
1401

  
1402
GENERATE_LEGEND        = YES
1403

  
1404
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
1405
# remove the intermediate dot files that are used to generate 
1406
# the various graphs.
1407

  
1408
DOT_CLEANUP            = YES
1409

  
1410
#---------------------------------------------------------------------------
1411
# Configuration::additions related to the search engine   
1412
#---------------------------------------------------------------------------
1413

  
1414
# The SEARCHENGINE tag specifies whether or not a search engine should be 
1415
# used. If set to NO the values of all tags below this one will be ignored.
1416

  
1417
SEARCHENGINE           = NO
doxygen.cfg
1
# Doxyfile 1.5.6
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 
... This diff was truncated because it exceeds the maximum size that can be displayed.

Also available in: Unified diff