blob: 33ce07ee2d0c24de03a4c0446ddc33adbb6195ef [file] [log] [blame]
adamdunkelsbca83322004-03-18 21:06:27 +00001# Doxyfile 1.3.5
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 (" ")
adamdunkels5dd70b52003-08-31 22:15:46 +000012
13#---------------------------------------------------------------------------
adamdunkelsbca83322004-03-18 21:06:27 +000014# Project related configuration options
adamdunkels5dd70b52003-08-31 22:15:46 +000015#---------------------------------------------------------------------------
adamdunkelsbca83322004-03-18 21:06:27 +000016
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18# by quotes) that should identify the project.
19
oliverschmidt22040832005-05-16 21:59:16 +000020PROJECT_NAME = "Contiki 1.2"
adamdunkelsbca83322004-03-18 21:06:27 +000021
22# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23# This could be handy for archiving the generated documentation or
24# if some version control system is used.
25
adamdunkels5dd70b52003-08-31 22:15:46 +000026PROJECT_NUMBER =
adamdunkelsbca83322004-03-18 21:06:27 +000027
28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29# base path where the generated documentation will be put.
30# If a relative path is entered, it will be relative to the location
31# where doxygen was started. If left blank the current directory will be used.
32
adamdunkels5dd70b52003-08-31 22:15:46 +000033OUTPUT_DIRECTORY = .
adamdunkelsbca83322004-03-18 21:06:27 +000034
35# The OUTPUT_LANGUAGE tag is used to specify the language in which all
36# documentation generated by doxygen is written. Doxygen will use this
37# information to generate all constant output in the proper language.
38# The default language is English, other supported languages are:
39# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41# (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
42# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
43
adamdunkels5dd70b52003-08-31 22:15:46 +000044OUTPUT_LANGUAGE = English
adamdunkelsbca83322004-03-18 21:06:27 +000045
46# This tag can be used to specify the encoding used in the generated output.
47# The encoding is not always determined by the language that is chosen,
48# but also whether or not the output is meant for Windows or non-Windows users.
49# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
50# forces the Windows encoding (this is the default for the Windows binary),
51# whereas setting the tag to NO uses a Unix-style encoding (the default for
52# all platforms other than Windows).
53
adamdunkels5dd70b52003-08-31 22:15:46 +000054USE_WINDOWS_ENCODING = NO
adamdunkelsbca83322004-03-18 21:06:27 +000055
56# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57# include brief member descriptions after the members that are listed in
58# the file and class documentation (similar to JavaDoc).
59# Set to NO to disable this.
60
adamdunkels5dd70b52003-08-31 22:15:46 +000061BRIEF_MEMBER_DESC = YES
adamdunkelsbca83322004-03-18 21:06:27 +000062
63# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
64# the brief description of a member or function before the detailed description.
65# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66# brief descriptions will be completely suppressed.
67
adamdunkels5dd70b52003-08-31 22:15:46 +000068REPEAT_BRIEF = YES
adamdunkelsbca83322004-03-18 21:06:27 +000069
70# This tag implements a quasi-intelligent brief description abbreviator
71# that is used to form the text in various listings. Each string
72# in this list, if found as the leading text of the brief description, will be
73# stripped from the text and the result after processing the whole list, is used
74# as the annotated text. Otherwise, the brief description is used as-is. If left
75# blank, the following values are used ("$name" is automatically replaced with the
76# name of the entity): "The $name class" "The $name widget" "The $name file"
77# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
78
79ABBREVIATE_BRIEF =
80
81# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
82# Doxygen will generate a detailed section even if there is only a brief
83# description.
84
adamdunkels5dd70b52003-08-31 22:15:46 +000085ALWAYS_DETAILED_SEC = NO
adamdunkelsbca83322004-03-18 21:06:27 +000086
87# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
88# members of a class in the documentation of that class as if those members were
89# ordinary class members. Constructors, destructors and assignment operators of
90# the base classes will not be shown.
91
adamdunkels5dd70b52003-08-31 22:15:46 +000092INLINE_INHERITED_MEMB = NO
adamdunkelsbca83322004-03-18 21:06:27 +000093
94# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
95# path before files name in the file list and in the header files. If set
96# to NO the shortest path that makes the file name unique will be used.
97
adamdunkels26182b82003-09-01 22:29:28 +000098FULL_PATH_NAMES = YES
adamdunkelsbca83322004-03-18 21:06:27 +000099
100# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
101# can be used to strip a user-defined part of the path. Stripping is
102# only done if one of the specified strings matches the left-hand part of
103# the path. It is allowed to use relative paths in the argument list.
104
adamdunkels1fb843b2003-09-04 20:00:58 +0000105STRIP_FROM_PATH = ../
adamdunkelsbca83322004-03-18 21:06:27 +0000106
107# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
108# (but less readable) file names. This can be useful is your file systems
109# doesn't support long names like on DOS, Mac, or CD-ROM.
110
adamdunkelse937ded2003-10-01 07:53:57 +0000111SHORT_NAMES = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000112
113# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
114# will interpret the first line (until the first dot) of a JavaDoc-style
115# comment as the brief description. If set to NO, the JavaDoc
116# comments will behave just like the Qt-style comments (thus requiring an
117# explicit @brief command for a brief description.
118
adamdunkels5dd70b52003-08-31 22:15:46 +0000119JAVADOC_AUTOBRIEF = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000120
121# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
122# treat a multi-line C++ special comment block (i.e. a block of //! or ///
123# comments) as a brief description. This used to be the default behaviour.
124# The new default is to treat a multi-line C++ comment block as a detailed
125# description. Set this tag to YES if you prefer the old behaviour instead.
126
adamdunkels5dd70b52003-08-31 22:15:46 +0000127MULTILINE_CPP_IS_BRIEF = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000128
129# If the DETAILS_AT_TOP tag is set to YES then Doxygen
130# will output the detailed description near the top, like JavaDoc.
131# If set to NO, the detailed description appears after the member
132# documentation.
133
adamdunkels5dd70b52003-08-31 22:15:46 +0000134DETAILS_AT_TOP = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000135
136# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
137# member inherits the documentation from any documented member that it
138# re-implements.
139
adamdunkels5dd70b52003-08-31 22:15:46 +0000140INHERIT_DOCS = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000141
142# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
143# tag is set to YES, then doxygen will reuse the documentation of the first
144# member in the group (if any) for the other members of the group. By default
145# all members of a group must be documented explicitly.
146
adamdunkels5dd70b52003-08-31 22:15:46 +0000147DISTRIBUTE_GROUP_DOC = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000148
149# The TAB_SIZE tag can be used to set the number of spaces in a tab.
150# Doxygen uses this value to replace tabs by spaces in code fragments.
151
adamdunkels5dd70b52003-08-31 22:15:46 +0000152TAB_SIZE = 8
adamdunkelsbca83322004-03-18 21:06:27 +0000153
154# This tag can be used to specify a number of aliases that acts
155# as commands in the documentation. An alias has the form "name=value".
156# For example adding "sideeffect=\par Side Effects:\n" will allow you to
157# put the command \sideeffect (or @sideeffect) in the documentation, which
158# will result in a user-defined paragraph with heading "Side Effects:".
159# You can put \n's in the value part of an alias to insert newlines.
160
adamdunkels5dd70b52003-08-31 22:15:46 +0000161ALIASES =
adamdunkelsbca83322004-03-18 21:06:27 +0000162
163# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
164# only. Doxygen will then generate output that is more tailored for C.
165# For instance, some of the names that are used will be different. The list
166# of all members will be omitted, etc.
167
adamdunkels5dd70b52003-08-31 22:15:46 +0000168OPTIMIZE_OUTPUT_FOR_C = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000169
170# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
171# only. Doxygen will then generate output that is more tailored for Java.
172# For instance, namespaces will be presented as packages, qualified scopes
173# will look different, etc.
174
adamdunkels5dd70b52003-08-31 22:15:46 +0000175OPTIMIZE_OUTPUT_JAVA = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000176
177# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
178# the same type (for instance a group of public functions) to be put as a
179# subgroup of that type (e.g. under the Public Functions section). Set it to
180# NO to prevent subgrouping. Alternatively, this can be done per class using
181# the \nosubgrouping command.
182
adamdunkels5dd70b52003-08-31 22:15:46 +0000183SUBGROUPING = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000184
185#---------------------------------------------------------------------------
186# Build related configuration options
187#---------------------------------------------------------------------------
188
189# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
190# documentation are documented, even if no documentation was available.
191# Private class members and static file members will be hidden unless
192# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
193
194EXTRACT_ALL = NO
195
196# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
197# will be included in the documentation.
198
199EXTRACT_PRIVATE = NO
200
201# If the EXTRACT_STATIC tag is set to YES all static members of a file
202# will be included in the documentation.
203
204EXTRACT_STATIC = NO
205
206# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
207# defined locally in source files will be included in the documentation.
208# If set to NO only classes defined in header files are included.
209
210EXTRACT_LOCAL_CLASSES = NO
211
212# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
213# undocumented members of documented classes, files or namespaces.
214# If set to NO (the default) these members will be included in the
215# various overviews, but no documentation section is generated.
216# This option has no effect if EXTRACT_ALL is enabled.
217
218HIDE_UNDOC_MEMBERS = YES
219
220# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
221# undocumented classes that are normally visible in the class hierarchy.
222# If set to NO (the default) these classes will be included in the various
223# overviews. This option has no effect if EXTRACT_ALL is enabled.
224
225HIDE_UNDOC_CLASSES = YES
226
227# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
228# friend (class|struct|union) declarations.
229# If set to NO (the default) these declarations will be included in the
230# documentation.
231
232HIDE_FRIEND_COMPOUNDS = NO
233
234# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
235# documentation blocks found inside the body of a function.
236# If set to NO (the default) these blocks will be appended to the
237# function's detailed documentation block.
238
239HIDE_IN_BODY_DOCS = NO
240
241# The INTERNAL_DOCS tag determines if documentation
242# that is typed after a \internal command is included. If the tag is set
243# to NO (the default) then the documentation will be excluded.
244# Set it to YES to include the internal documentation.
245
246INTERNAL_DOCS = NO
247
248# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
249# file names in lower-case letters. If set to YES upper-case letters are also
250# allowed. This is useful if you have classes or files whose names only differ
251# in case and if your file system supports case sensitive file names. Windows
252# users are advised to set this option to NO.
253
254CASE_SENSE_NAMES = YES
255
256# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
257# will show members with their full class and namespace scopes in the
258# documentation. If set to YES the scope will be hidden.
259
260HIDE_SCOPE_NAMES = NO
261
262# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
263# will put a list of the files that are included by a file in the documentation
264# of that file.
265
266SHOW_INCLUDE_FILES = YES
267
268# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
269# is inserted in the documentation for inline members.
270
271INLINE_INFO = YES
272
273# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
274# will sort the (detailed) documentation of file and class members
275# alphabetically by member name. If set to NO the members will appear in
276# declaration order.
277
278SORT_MEMBER_DOCS = YES
279
280# The GENERATE_TODOLIST tag can be used to enable (YES) or
281# disable (NO) the todo list. This list is created by putting \todo
282# commands in the documentation.
283
284GENERATE_TODOLIST = YES
285
286# The GENERATE_TESTLIST tag can be used to enable (YES) or
287# disable (NO) the test list. This list is created by putting \test
288# commands in the documentation.
289
290GENERATE_TESTLIST = YES
291
292# The GENERATE_BUGLIST tag can be used to enable (YES) or
293# disable (NO) the bug list. This list is created by putting \bug
294# commands in the documentation.
295
296GENERATE_BUGLIST = NO
297
298# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
299# disable (NO) the deprecated list. This list is created by putting
300# \deprecated commands in the documentation.
301
302GENERATE_DEPRECATEDLIST= NO
303
304# The ENABLED_SECTIONS tag can be used to enable conditional
305# documentation sections, marked by \if sectionname ... \endif.
306
307ENABLED_SECTIONS =
308
309# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
310# the initial value of a variable or define consists of for it to appear in
311# the documentation. If the initializer consists of more lines than specified
312# here it will be hidden. Use a value of 0 to hide initializers completely.
313# The appearance of the initializer of individual variables and defines in the
314# documentation can be controlled using \showinitializer or \hideinitializer
315# command in the documentation regardless of this setting.
316
317MAX_INITIALIZER_LINES = 30
318
319# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
320# at the bottom of the documentation of classes and structs. If set to YES the
321# list will mention the files that were used to generate the documentation.
322
323SHOW_USED_FILES = NO
324
adamdunkels5dd70b52003-08-31 22:15:46 +0000325#---------------------------------------------------------------------------
326# configuration options related to warning and progress messages
327#---------------------------------------------------------------------------
adamdunkelsbca83322004-03-18 21:06:27 +0000328
329# The QUIET tag can be used to turn on/off the messages that are generated
330# by doxygen. Possible values are YES and NO. If left blank NO is used.
331
adamdunkels5dd70b52003-08-31 22:15:46 +0000332QUIET = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000333
334# The WARNINGS tag can be used to turn on/off the warning messages that are
335# generated by doxygen. Possible values are YES and NO. If left blank
336# NO is used.
337
adamdunkels5dd70b52003-08-31 22:15:46 +0000338WARNINGS = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000339
340# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
341# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
342# automatically be disabled.
343
adamdunkels5dd70b52003-08-31 22:15:46 +0000344WARN_IF_UNDOCUMENTED = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000345
346# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
347# potential errors in the documentation, such as not documenting some
348# parameters in a documented function, or documenting parameters that
349# don't exist or using markup commands wrongly.
350
adamdunkels5dd70b52003-08-31 22:15:46 +0000351WARN_IF_DOC_ERROR = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000352
353# The WARN_FORMAT tag determines the format of the warning messages that
354# doxygen can produce. The string should contain the $file, $line, and $text
355# tags, which will be replaced by the file and line number from which the
356# warning originated and the warning text.
357
adamdunkels5dd70b52003-08-31 22:15:46 +0000358WARN_FORMAT = "$file:$line: $text"
adamdunkelsbca83322004-03-18 21:06:27 +0000359
360# The WARN_LOGFILE tag can be used to specify a file to which warning
361# and error messages should be written. If left blank the output is written
362# to stderr.
363
adamdunkels5dd70b52003-08-31 22:15:46 +0000364WARN_LOGFILE =
adamdunkelsbca83322004-03-18 21:06:27 +0000365
adamdunkels5dd70b52003-08-31 22:15:46 +0000366#---------------------------------------------------------------------------
367# configuration options related to the input files
368#---------------------------------------------------------------------------
adamdunkelsbca83322004-03-18 21:06:27 +0000369
370# The INPUT tag can be used to specify the files and/or directories that contain
371# documented source files. You may enter file names like "myfile.cpp" or
372# directories like "/usr/src/myproject". Separate the files or directories
373# with spaces.
374
adamdunkels89c27a32004-08-15 22:05:01 +0000375INPUT = ../ek/ek.c \
adamdunkelse937ded2003-10-01 07:53:57 +0000376 ../ek/arg.c \
adamdunkels89c27a32004-08-15 22:05:01 +0000377 ../ek/ek.h \
adamdunkels18eebb92005-02-07 07:49:49 +0000378 ../ek/ek-service.h \
adamdunkelse937ded2003-10-01 07:53:57 +0000379 ../ek/dsc.h \
380 ../ek/loader.h \
adamdunkels70316a92005-02-22 22:41:04 +0000381 pt-doc.txt \
adamdunkels89c27a32004-08-15 22:05:01 +0000382 ../ek/pt.h \
adamdunkels70316a92005-02-22 22:41:04 +0000383 ../ek/lc.h \
384 ../ek/lc-switch.h \
385 ../ek/lc-addrlabels.h \
adamdunkels2fcc5192004-08-20 21:26:25 +0000386 ../ek/pt-sem.h \
adamdunkelsbca83322004-03-18 21:06:27 +0000387 ../apps/program-handler.c \
adamdunkels26182b82003-09-01 22:29:28 +0000388 ../ctk/ctk.h \
adamdunkels5dd70b52003-08-31 22:15:46 +0000389 ../ctk/ctk.c \
adamdunkels26182b82003-09-01 22:29:28 +0000390 ../ctk/ctk-draw.h \
adamdunkelse937ded2003-10-01 07:53:57 +0000391 uip-doc.txt \
adamdunkels1e45c6d2003-09-02 21:47:27 +0000392 ../uip/uip.h \
adamdunkelse937ded2003-10-01 07:53:57 +0000393 ../uip/uip.c \
adamdunkels846aabf2003-09-05 21:03:35 +0000394 ../uip/uip_arp.h \
395 ../uip/uip_arp.c \
adamdunkelsaf3e0942004-03-25 09:52:00 +0000396 ../uip/uip-split.h \
397 ../uip/uip-split.c \
adamdunkels18eebb92005-02-07 07:49:49 +0000398 ../uip/uip-fw.h \
399 ../uip/uip-fw.c \
adamdunkelsaf3e0942004-03-25 09:52:00 +0000400 ../uip/uiplib.h \
401 ../uip/uiplib.c \
adamdunkelse937ded2003-10-01 07:53:57 +0000402 ../uip/resolv.h \
adamdunkels1e45c6d2003-09-02 21:47:27 +0000403 ../uip/resolv.c \
adamdunkels70316a92005-02-22 22:41:04 +0000404 ../uip/psock.h \
adamdunkels18eebb92005-02-07 07:49:49 +0000405 ../uip/tcpip.h \
adamdunkelse937ded2003-10-01 07:53:57 +0000406 ../lib/cc.h \
407 ../lib/petsciiconv.h \
adamdunkels1e45c6d2003-09-02 21:47:27 +0000408 ../lib/ctk-textedit.h \
409 ../lib/ctk-textedit.c \
adamdunkelsbca83322004-03-18 21:06:27 +0000410 ../lib/memb.h \
411 ../lib/memb.c \
adamdunkels18eebb92005-02-07 07:49:49 +0000412 ../lib/timer.h \
413 ../lib/timer.c \
414 ../lib/list.h \
415 ../lib/list.c \
416 ../lib/clock.h \
adamdunkels89c27a32004-08-15 22:05:01 +0000417 ../ek/mt.h \
418 ../ek/mt.c \
adamdunkels1e45c6d2003-09-02 21:47:27 +0000419 ../conf/uip-conf.h.example \
adamdunkels1fb843b2003-09-04 20:00:58 +0000420 ../conf/www-conf.h.example \
421 contiki-mainpage.txt
adamdunkelsbca83322004-03-18 21:06:27 +0000422
423# If the value of the INPUT tag contains directories, you can use the
424# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
425# and *.h) to filter out the source-files in the directories. If left
426# blank the following patterns are tested:
427# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
428# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
429
adamdunkels5dd70b52003-08-31 22:15:46 +0000430FILE_PATTERNS =
adamdunkelsbca83322004-03-18 21:06:27 +0000431
432# The RECURSIVE tag can be used to turn specify whether or not subdirectories
433# should be searched for input files as well. Possible values are YES and NO.
434# If left blank NO is used.
435
adamdunkels5dd70b52003-08-31 22:15:46 +0000436RECURSIVE = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000437
438# The EXCLUDE tag can be used to specify files and/or directories that should
439# excluded from the INPUT source files. This way you can easily exclude a
440# subdirectory from a directory tree whose root is specified with the INPUT tag.
441
adamdunkels5dd70b52003-08-31 22:15:46 +0000442EXCLUDE =
adamdunkelsbca83322004-03-18 21:06:27 +0000443
444# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
445# that are symbolic links (a Unix filesystem feature) are excluded from the input.
446
adamdunkels5dd70b52003-08-31 22:15:46 +0000447EXCLUDE_SYMLINKS = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000448
449# If the value of the INPUT tag contains directories, you can use the
450# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
451# certain files from those directories.
452
adamdunkels5dd70b52003-08-31 22:15:46 +0000453EXCLUDE_PATTERNS =
adamdunkelsbca83322004-03-18 21:06:27 +0000454
455# The EXAMPLE_PATH tag can be used to specify one or more files or
456# directories that contain example code fragments that are included (see
457# the \include command).
458
adamdunkels5dd70b52003-08-31 22:15:46 +0000459EXAMPLE_PATH =
adamdunkelsbca83322004-03-18 21:06:27 +0000460
461# If the value of the EXAMPLE_PATH tag contains directories, you can use the
462# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
463# and *.h) to filter out the source-files in the directories. If left
464# blank all files are included.
465
adamdunkels5dd70b52003-08-31 22:15:46 +0000466EXAMPLE_PATTERNS =
adamdunkelsbca83322004-03-18 21:06:27 +0000467
468# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
469# searched for input files to be used with the \include or \dontinclude
470# commands irrespective of the value of the RECURSIVE tag.
471# Possible values are YES and NO. If left blank NO is used.
472
adamdunkels5dd70b52003-08-31 22:15:46 +0000473EXAMPLE_RECURSIVE = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000474
475# The IMAGE_PATH tag can be used to specify one or more files or
476# directories that contain image that are included in the documentation (see
477# the \image command).
478
adamdunkels5dd70b52003-08-31 22:15:46 +0000479IMAGE_PATH =
adamdunkelsbca83322004-03-18 21:06:27 +0000480
481# The INPUT_FILTER tag can be used to specify a program that doxygen should
482# invoke to filter for each input file. Doxygen will invoke the filter program
483# by executing (via popen()) the command <filter> <input-file>, where <filter>
484# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
485# input file. Doxygen will then use the output that the filter program writes
486# to standard output.
487
adamdunkels5dd70b52003-08-31 22:15:46 +0000488INPUT_FILTER =
adamdunkelsbca83322004-03-18 21:06:27 +0000489
490# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
491# INPUT_FILTER) will be used to filter the input files when producing source
492# files to browse (i.e. when SOURCE_BROWSER is set to YES).
493
adamdunkels1fb843b2003-09-04 20:00:58 +0000494FILTER_SOURCE_FILES = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000495
adamdunkels5dd70b52003-08-31 22:15:46 +0000496#---------------------------------------------------------------------------
497# configuration options related to source browsing
498#---------------------------------------------------------------------------
adamdunkelsbca83322004-03-18 21:06:27 +0000499
500# If the SOURCE_BROWSER tag is set to YES then a list of source files will
501# be generated. Documented entities will be cross-referenced with these sources.
502# Note: To get rid of all source code in the generated output, make sure also
503# VERBATIM_HEADERS is set to NO.
504
adamdunkels5dd70b52003-08-31 22:15:46 +0000505SOURCE_BROWSER = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000506
507# Setting the INLINE_SOURCES tag to YES will include the body
508# of functions and classes directly in the documentation.
509
adamdunkels5dd70b52003-08-31 22:15:46 +0000510INLINE_SOURCES = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000511
512# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
513# doxygen to hide any special comment blocks from generated source code
514# fragments. Normal C and C++ comments will always remain visible.
515
adamdunkels5dd70b52003-08-31 22:15:46 +0000516STRIP_CODE_COMMENTS = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000517
518# If the REFERENCED_BY_RELATION tag is set to YES (the default)
519# then for each documented function all documented
520# functions referencing it will be listed.
521
adamdunkels5dd70b52003-08-31 22:15:46 +0000522REFERENCED_BY_RELATION = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000523
524# If the REFERENCES_RELATION tag is set to YES (the default)
525# then for each documented function all documented entities
526# called/used by that function will be listed.
527
adamdunkels5dd70b52003-08-31 22:15:46 +0000528REFERENCES_RELATION = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000529
530# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
531# will generate a verbatim copy of the header file for each class for
532# which an include is specified. Set to NO to disable this.
533
adamdunkels5dd70b52003-08-31 22:15:46 +0000534VERBATIM_HEADERS = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000535
adamdunkels5dd70b52003-08-31 22:15:46 +0000536#---------------------------------------------------------------------------
537# configuration options related to the alphabetical class index
538#---------------------------------------------------------------------------
adamdunkelsbca83322004-03-18 21:06:27 +0000539
540# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
541# of all compounds will be generated. Enable this if the project
542# contains a lot of classes, structs, unions or interfaces.
543
adamdunkelse937ded2003-10-01 07:53:57 +0000544ALPHABETICAL_INDEX = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000545
546# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
547# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
548# in which this list will be split (can be a number in the range [1..20])
549
adamdunkels5dd70b52003-08-31 22:15:46 +0000550COLS_IN_ALPHA_INDEX = 5
adamdunkelsbca83322004-03-18 21:06:27 +0000551
552# In case all classes in a project start with a common prefix, all
553# classes will be put under the same header in the alphabetical index.
554# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
555# should be ignored while generating the index headers.
556
adamdunkels5dd70b52003-08-31 22:15:46 +0000557IGNORE_PREFIX =
adamdunkelsbca83322004-03-18 21:06:27 +0000558
adamdunkels5dd70b52003-08-31 22:15:46 +0000559#---------------------------------------------------------------------------
560# configuration options related to the HTML output
561#---------------------------------------------------------------------------
adamdunkelsbca83322004-03-18 21:06:27 +0000562
563# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
564# generate HTML output.
565
adamdunkels5dd70b52003-08-31 22:15:46 +0000566GENERATE_HTML = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000567
568# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
569# If a relative path is entered the value of OUTPUT_DIRECTORY will be
570# put in front of it. If left blank `html' will be used as the default path.
571
adamdunkels5dd70b52003-08-31 22:15:46 +0000572HTML_OUTPUT = html
adamdunkelsbca83322004-03-18 21:06:27 +0000573
574# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
575# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
576# doxygen will generate files with .html extension.
577
adamdunkels5dd70b52003-08-31 22:15:46 +0000578HTML_FILE_EXTENSION = .html
adamdunkelsbca83322004-03-18 21:06:27 +0000579
580# The HTML_HEADER tag can be used to specify a personal HTML header for
581# each generated HTML page. If it is left blank doxygen will generate a
582# standard header.
583
adamdunkels5dd70b52003-08-31 22:15:46 +0000584HTML_HEADER =
adamdunkelsbca83322004-03-18 21:06:27 +0000585
586# The HTML_FOOTER tag can be used to specify a personal HTML footer for
587# each generated HTML page. If it is left blank doxygen will generate a
588# standard footer.
589
adamdunkels5dd70b52003-08-31 22:15:46 +0000590HTML_FOOTER =
adamdunkelsbca83322004-03-18 21:06:27 +0000591
592# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
593# style sheet that is used by each HTML page. It can be used to
594# fine-tune the look of the HTML output. If the tag is left blank doxygen
595# will generate a default style sheet. Note that doxygen will try to copy
596# the style sheet file to the HTML output directory, so don't put your own
597# stylesheet in the HTML output directory as well, or it will be erased!
598
adamdunkels5dd70b52003-08-31 22:15:46 +0000599HTML_STYLESHEET =
adamdunkelsbca83322004-03-18 21:06:27 +0000600
601# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
602# files or namespaces will be aligned in HTML using tables. If set to
603# NO a bullet list will be used.
604
adamdunkels5dd70b52003-08-31 22:15:46 +0000605HTML_ALIGN_MEMBERS = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000606
607# If the GENERATE_HTMLHELP tag is set to YES, additional index files
608# will be generated that can be used as input for tools like the
609# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
610# of the generated HTML documentation.
611
adamdunkelse937ded2003-10-01 07:53:57 +0000612GENERATE_HTMLHELP = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000613
614# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
615# be used to specify the file name of the resulting .chm file. You
616# can add a path in front of the file if the result should not be
617# written to the html output directory.
618
adamdunkels5dd70b52003-08-31 22:15:46 +0000619CHM_FILE =
adamdunkelsbca83322004-03-18 21:06:27 +0000620
621# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
622# be used to specify the location (absolute path including file name) of
623# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
624# the HTML help compiler on the generated index.hhp.
625
adamdunkels5dd70b52003-08-31 22:15:46 +0000626HHC_LOCATION =
adamdunkelsbca83322004-03-18 21:06:27 +0000627
628# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
629# controls if a separate .chi index file is generated (YES) or that
630# it should be included in the master .chm file (NO).
631
adamdunkels5dd70b52003-08-31 22:15:46 +0000632GENERATE_CHI = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000633
634# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
635# controls whether a binary table of contents is generated (YES) or a
636# normal table of contents (NO) in the .chm file.
637
adamdunkels5dd70b52003-08-31 22:15:46 +0000638BINARY_TOC = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000639
640# The TOC_EXPAND flag can be set to YES to add extra items for group members
641# to the contents of the HTML help documentation and to the tree view.
642
adamdunkels5dd70b52003-08-31 22:15:46 +0000643TOC_EXPAND = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000644
645# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
646# top of each HTML page. The value NO (the default) enables the index and
647# the value YES disables it.
648
adamdunkels5dd70b52003-08-31 22:15:46 +0000649DISABLE_INDEX = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000650
651# This tag can be used to set the number of enum values (range [1..20])
652# that doxygen will group on one line in the generated HTML documentation.
653
adamdunkels5dd70b52003-08-31 22:15:46 +0000654ENUM_VALUES_PER_LINE = 4
adamdunkelsbca83322004-03-18 21:06:27 +0000655
656# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
657# generated containing a tree-like index structure (just like the one that
658# is generated for HTML Help). For this to work a browser that supports
659# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
660# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
661# probably better off using the HTML help feature.
662
663GENERATE_TREEVIEW = YES
664
665# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
666# used to set the initial width (in pixels) of the frame in which the tree
667# is shown.
668
adamdunkels5dd70b52003-08-31 22:15:46 +0000669TREEVIEW_WIDTH = 250
adamdunkelsbca83322004-03-18 21:06:27 +0000670
adamdunkels5dd70b52003-08-31 22:15:46 +0000671#---------------------------------------------------------------------------
672# configuration options related to the LaTeX output
673#---------------------------------------------------------------------------
adamdunkelsbca83322004-03-18 21:06:27 +0000674
675# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
676# generate Latex output.
677
adamdunkels5dd70b52003-08-31 22:15:46 +0000678GENERATE_LATEX = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000679
680# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
681# If a relative path is entered the value of OUTPUT_DIRECTORY will be
682# put in front of it. If left blank `latex' will be used as the default path.
683
adamdunkels5dd70b52003-08-31 22:15:46 +0000684LATEX_OUTPUT = latex
adamdunkelsbca83322004-03-18 21:06:27 +0000685
686# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
687# invoked. If left blank `latex' will be used as the default command name.
688
adamdunkels5dd70b52003-08-31 22:15:46 +0000689LATEX_CMD_NAME = latex
adamdunkelsbca83322004-03-18 21:06:27 +0000690
691# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
692# generate index for LaTeX. If left blank `makeindex' will be used as the
693# default command name.
694
adamdunkels5dd70b52003-08-31 22:15:46 +0000695MAKEINDEX_CMD_NAME = makeindex
adamdunkelsbca83322004-03-18 21:06:27 +0000696
697# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
698# LaTeX documents. This may be useful for small projects and may help to
699# save some trees in general.
700
adamdunkels5dd70b52003-08-31 22:15:46 +0000701COMPACT_LATEX = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000702
703# The PAPER_TYPE tag can be used to set the paper type that is used
704# by the printer. Possible values are: a4, a4wide, letter, legal and
705# executive. If left blank a4wide will be used.
706
adamdunkels5dd70b52003-08-31 22:15:46 +0000707PAPER_TYPE = a4wide
adamdunkelsbca83322004-03-18 21:06:27 +0000708
709# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
710# packages that should be included in the LaTeX output.
711
adamdunkels5dd70b52003-08-31 22:15:46 +0000712EXTRA_PACKAGES =
adamdunkelsbca83322004-03-18 21:06:27 +0000713
714# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
715# the generated latex document. The header should contain everything until
716# the first chapter. If it is left blank doxygen will generate a
717# standard header. Notice: only use this tag if you know what you are doing!
718
adamdunkels5dd70b52003-08-31 22:15:46 +0000719LATEX_HEADER =
adamdunkelsbca83322004-03-18 21:06:27 +0000720
721# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
722# is prepared for conversion to pdf (using ps2pdf). The pdf file will
723# contain links (just like the HTML output) instead of page references
724# This makes the output suitable for online browsing using a pdf viewer.
725
adamdunkels26182b82003-09-01 22:29:28 +0000726PDF_HYPERLINKS = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000727
728# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
729# plain latex in the generated Makefile. Set this option to YES to get a
730# higher quality PDF documentation.
731
adamdunkelse937ded2003-10-01 07:53:57 +0000732USE_PDFLATEX = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000733
734# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
735# command to the generated LaTeX files. This will instruct LaTeX to keep
736# running if errors occur, instead of asking the user for help.
737# This option is also used when generating formulas in HTML.
738
adamdunkels5dd70b52003-08-31 22:15:46 +0000739LATEX_BATCHMODE = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000740
741# If LATEX_HIDE_INDICES is set to YES then doxygen will not
742# include the index chapters (such as File Index, Compound Index, etc.)
743# in the output.
744
adamdunkels5dd70b52003-08-31 22:15:46 +0000745LATEX_HIDE_INDICES = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000746
adamdunkels5dd70b52003-08-31 22:15:46 +0000747#---------------------------------------------------------------------------
748# configuration options related to the RTF output
749#---------------------------------------------------------------------------
adamdunkelsbca83322004-03-18 21:06:27 +0000750
751# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
752# The RTF output is optimized for Word 97 and may not look very pretty with
753# other RTF readers or editors.
754
adamdunkels5dd70b52003-08-31 22:15:46 +0000755GENERATE_RTF = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000756
757# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
758# If a relative path is entered the value of OUTPUT_DIRECTORY will be
759# put in front of it. If left blank `rtf' will be used as the default path.
760
adamdunkels5dd70b52003-08-31 22:15:46 +0000761RTF_OUTPUT = rtf
adamdunkelsbca83322004-03-18 21:06:27 +0000762
763# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
764# RTF documents. This may be useful for small projects and may help to
765# save some trees in general.
766
adamdunkels5dd70b52003-08-31 22:15:46 +0000767COMPACT_RTF = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000768
769# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
770# will contain hyperlink fields. The RTF file will
771# contain links (just like the HTML output) instead of page references.
772# This makes the output suitable for online browsing using WORD or other
773# programs which support those fields.
774# Note: wordpad (write) and others do not support links.
775
adamdunkels5dd70b52003-08-31 22:15:46 +0000776RTF_HYPERLINKS = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000777
778# Load stylesheet definitions from file. Syntax is similar to doxygen's
779# config file, i.e. a series of assignments. You only have to provide
780# replacements, missing definitions are set to their default value.
781
adamdunkels5dd70b52003-08-31 22:15:46 +0000782RTF_STYLESHEET_FILE =
adamdunkelsbca83322004-03-18 21:06:27 +0000783
784# Set optional variables used in the generation of an rtf document.
785# Syntax is similar to doxygen's config file.
786
adamdunkels5dd70b52003-08-31 22:15:46 +0000787RTF_EXTENSIONS_FILE =
adamdunkelsbca83322004-03-18 21:06:27 +0000788
adamdunkels5dd70b52003-08-31 22:15:46 +0000789#---------------------------------------------------------------------------
790# configuration options related to the man page output
791#---------------------------------------------------------------------------
adamdunkelsbca83322004-03-18 21:06:27 +0000792
793# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
794# generate man pages
795
adamdunkelse937ded2003-10-01 07:53:57 +0000796GENERATE_MAN = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000797
798# The MAN_OUTPUT tag is used to specify where the man pages will be put.
799# If a relative path is entered the value of OUTPUT_DIRECTORY will be
800# put in front of it. If left blank `man' will be used as the default path.
801
adamdunkels5dd70b52003-08-31 22:15:46 +0000802MAN_OUTPUT = man
adamdunkelsbca83322004-03-18 21:06:27 +0000803
804# The MAN_EXTENSION tag determines the extension that is added to
805# the generated man pages (default is the subroutine's section .3)
806
adamdunkels5dd70b52003-08-31 22:15:46 +0000807MAN_EXTENSION = .3
adamdunkelsbca83322004-03-18 21:06:27 +0000808
809# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
810# then it will generate one additional man file for each entity
811# documented in the real man page(s). These additional files
812# only source the real man page, but without them the man command
813# would be unable to find the correct page. The default is NO.
814
adamdunkels5dd70b52003-08-31 22:15:46 +0000815MAN_LINKS = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000816
adamdunkels5dd70b52003-08-31 22:15:46 +0000817#---------------------------------------------------------------------------
818# configuration options related to the XML output
819#---------------------------------------------------------------------------
adamdunkelsbca83322004-03-18 21:06:27 +0000820
821# If the GENERATE_XML tag is set to YES Doxygen will
822# generate an XML file that captures the structure of
823# the code including all documentation.
824
adamdunkels5dd70b52003-08-31 22:15:46 +0000825GENERATE_XML = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000826
827# The XML_OUTPUT tag is used to specify where the XML pages will be put.
828# If a relative path is entered the value of OUTPUT_DIRECTORY will be
829# put in front of it. If left blank `xml' will be used as the default path.
830
adamdunkels5dd70b52003-08-31 22:15:46 +0000831XML_OUTPUT = xml
adamdunkelsbca83322004-03-18 21:06:27 +0000832
833# The XML_SCHEMA tag can be used to specify an XML schema,
834# which can be used by a validating XML parser to check the
835# syntax of the XML files.
836
adamdunkels5dd70b52003-08-31 22:15:46 +0000837XML_SCHEMA =
adamdunkelsbca83322004-03-18 21:06:27 +0000838
839# The XML_DTD tag can be used to specify an XML DTD,
840# which can be used by a validating XML parser to check the
841# syntax of the XML files.
842
adamdunkels5dd70b52003-08-31 22:15:46 +0000843XML_DTD =
adamdunkelsbca83322004-03-18 21:06:27 +0000844
845# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
846# dump the program listings (including syntax highlighting
847# and cross-referencing information) to the XML output. Note that
848# enabling this will significantly increase the size of the XML output.
849
850XML_PROGRAMLISTING = YES
851
adamdunkels5dd70b52003-08-31 22:15:46 +0000852#---------------------------------------------------------------------------
853# configuration options for the AutoGen Definitions output
854#---------------------------------------------------------------------------
adamdunkelsbca83322004-03-18 21:06:27 +0000855
856# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
857# generate an AutoGen Definitions (see autogen.sf.net) file
858# that captures the structure of the code including all
859# documentation. Note that this feature is still experimental
860# and incomplete at the moment.
861
adamdunkels5dd70b52003-08-31 22:15:46 +0000862GENERATE_AUTOGEN_DEF = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000863
adamdunkels5dd70b52003-08-31 22:15:46 +0000864#---------------------------------------------------------------------------
865# configuration options related to the Perl module output
866#---------------------------------------------------------------------------
adamdunkelsbca83322004-03-18 21:06:27 +0000867
868# If the GENERATE_PERLMOD tag is set to YES Doxygen will
869# generate a Perl module file that captures the structure of
870# the code including all documentation. Note that this
871# feature is still experimental and incomplete at the
872# moment.
873
adamdunkels5dd70b52003-08-31 22:15:46 +0000874GENERATE_PERLMOD = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000875
876# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
877# the necessary Makefile rules, Perl scripts and LaTeX code to be able
878# to generate PDF and DVI output from the Perl module output.
879
adamdunkels5dd70b52003-08-31 22:15:46 +0000880PERLMOD_LATEX = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000881
882# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
883# nicely formatted so it can be parsed by a human reader. This is useful
884# if you want to understand what is going on. On the other hand, if this
885# tag is set to NO the size of the Perl module output will be much smaller
886# and Perl will parse it just the same.
887
adamdunkels5dd70b52003-08-31 22:15:46 +0000888PERLMOD_PRETTY = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000889
890# The names of the make variables in the generated doxyrules.make file
891# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
892# This is useful so different doxyrules.make files included by the same
893# Makefile don't overwrite each other's variables.
894
adamdunkels5dd70b52003-08-31 22:15:46 +0000895PERLMOD_MAKEVAR_PREFIX =
adamdunkelsbca83322004-03-18 21:06:27 +0000896
adamdunkels5dd70b52003-08-31 22:15:46 +0000897#---------------------------------------------------------------------------
898# Configuration options related to the preprocessor
899#---------------------------------------------------------------------------
adamdunkelsbca83322004-03-18 21:06:27 +0000900
901# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
902# evaluate all C-preprocessor directives found in the sources and include
903# files.
904
adamdunkels5dd70b52003-08-31 22:15:46 +0000905ENABLE_PREPROCESSING = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000906
907# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
908# names in the source code. If set to NO (the default) only conditional
909# compilation will be performed. Macro expansion can be done in a controlled
910# way by setting EXPAND_ONLY_PREDEF to YES.
911
adamdunkels5dd70b52003-08-31 22:15:46 +0000912MACRO_EXPANSION = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000913
914# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
915# then the macro expansion is limited to the macros specified with the
916# PREDEFINED and EXPAND_AS_PREDEFINED tags.
917
adamdunkels5dd70b52003-08-31 22:15:46 +0000918EXPAND_ONLY_PREDEF = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000919
920# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
921# in the INCLUDE_PATH (see below) will be search if a #include is found.
922
adamdunkels5dd70b52003-08-31 22:15:46 +0000923SEARCH_INCLUDES = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000924
925# The INCLUDE_PATH tag can be used to specify one or more directories that
926# contain include files that are not input files but should be processed by
927# the preprocessor.
928
adamdunkels5dd70b52003-08-31 22:15:46 +0000929INCLUDE_PATH =
adamdunkelsbca83322004-03-18 21:06:27 +0000930
931# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
932# patterns (like *.h and *.hpp) to filter out the header-files in the
933# directories. If left blank, the patterns specified with FILE_PATTERNS will
934# be used.
935
adamdunkels5dd70b52003-08-31 22:15:46 +0000936INCLUDE_FILE_PATTERNS =
adamdunkelsbca83322004-03-18 21:06:27 +0000937
938# The PREDEFINED tag can be used to specify one or more macro names that
939# are defined before the preprocessor is started (similar to the -D option of
940# gcc). The argument of the tag is a list of macros of the form: name
941# or name=definition (no spaces). If the definition and the = are
942# omitted =1 is assumed.
943
adamdunkels1e45c6d2003-09-02 21:47:27 +0000944PREDEFINED = CC_FUNCTION_POINTER_ARGS \
945 UIP_UDP \
adamdunkels70316a92005-02-22 22:41:04 +0000946 WITH_LOADER_ARCH \
947 DOXYGEN
adamdunkelsbca83322004-03-18 21:06:27 +0000948
949# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
950# this tag can be used to specify a list of macro names that should be expanded.
951# The macro definition that is found in the sources will be used.
952# Use the PREDEFINED tag if you want to use a different macro definition.
953
adamdunkels5dd70b52003-08-31 22:15:46 +0000954EXPAND_AS_DEFINED =
adamdunkelsbca83322004-03-18 21:06:27 +0000955
956# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
957# doxygen's preprocessor will remove all function-like macros that are alone
958# on a line, have an all uppercase name, and do not end with a semicolon. Such
959# function macros are typically used for boiler-plate code, and will confuse the
960# parser if not removed.
961
adamdunkels5dd70b52003-08-31 22:15:46 +0000962SKIP_FUNCTION_MACROS = YES
adamdunkelsbca83322004-03-18 21:06:27 +0000963
adamdunkels5dd70b52003-08-31 22:15:46 +0000964#---------------------------------------------------------------------------
965# Configuration::addtions related to external references
966#---------------------------------------------------------------------------
adamdunkelsbca83322004-03-18 21:06:27 +0000967
968# The TAGFILES option can be used to specify one or more tagfiles.
969# Optionally an initial location of the external documentation
970# can be added for each tagfile. The format of a tag file without
971# this location is as follows:
972# TAGFILES = file1 file2 ...
973# Adding location for the tag files is done as follows:
974# TAGFILES = file1=loc1 "file2 = loc2" ...
975# where "loc1" and "loc2" can be relative or absolute paths or
976# URLs. If a location is present for each tag, the installdox tool
977# does not have to be run to correct the links.
978# Note that each tag file must have a unique name
979# (where the name does NOT include the path)
980# If a tag file is not located in the directory in which doxygen
981# is run, you must also specify the path to the tagfile here.
982
adamdunkels5dd70b52003-08-31 22:15:46 +0000983TAGFILES =
adamdunkelsbca83322004-03-18 21:06:27 +0000984
985# When a file name is specified after GENERATE_TAGFILE, doxygen will create
986# a tag file that is based on the input files it reads.
987
adamdunkels5dd70b52003-08-31 22:15:46 +0000988GENERATE_TAGFILE =
adamdunkelsbca83322004-03-18 21:06:27 +0000989
990# If the ALLEXTERNALS tag is set to YES all external classes will be listed
991# in the class index. If set to NO only the inherited external classes
992# will be listed.
993
adamdunkels5dd70b52003-08-31 22:15:46 +0000994ALLEXTERNALS = NO
adamdunkelsbca83322004-03-18 21:06:27 +0000995
996# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
997# in the modules index. If set to NO, only the current project's groups will
998# be listed.
999
adamdunkels5dd70b52003-08-31 22:15:46 +00001000EXTERNAL_GROUPS = YES
adamdunkelsbca83322004-03-18 21:06:27 +00001001
1002# The PERL_PATH should be the absolute path and name of the perl script
1003# interpreter (i.e. the result of `which perl').
1004
adamdunkels5dd70b52003-08-31 22:15:46 +00001005PERL_PATH = /usr/bin/perl
adamdunkelsbca83322004-03-18 21:06:27 +00001006
adamdunkels5dd70b52003-08-31 22:15:46 +00001007#---------------------------------------------------------------------------
1008# Configuration options related to the dot tool
1009#---------------------------------------------------------------------------
adamdunkelsbca83322004-03-18 21:06:27 +00001010
1011# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1012# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
1013# super classes. Setting the tag to NO turns the diagrams off. Note that this
1014# option is superseded by the HAVE_DOT option below. This is only a fallback. It is
1015# recommended to install and use dot, since it yields more powerful graphs.
1016
adamdunkels5dd70b52003-08-31 22:15:46 +00001017CLASS_DIAGRAMS = YES
adamdunkelsbca83322004-03-18 21:06:27 +00001018
1019# If set to YES, the inheritance and collaboration graphs will hide
1020# inheritance and usage relations if the target is undocumented
1021# or is not a class.
1022
adamdunkels5dd70b52003-08-31 22:15:46 +00001023HIDE_UNDOC_RELATIONS = YES
adamdunkelsbca83322004-03-18 21:06:27 +00001024
1025# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1026# available from the path. This tool is part of Graphviz, a graph visualization
1027# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1028# have no effect if this option is set to NO (the default)
1029
adamdunkels26182b82003-09-01 22:29:28 +00001030HAVE_DOT = YES
adamdunkelsbca83322004-03-18 21:06:27 +00001031
1032# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1033# will generate a graph for each documented class showing the direct and
1034# indirect inheritance relations. Setting this tag to YES will force the
1035# the CLASS_DIAGRAMS tag to NO.
1036
adamdunkels26182b82003-09-01 22:29:28 +00001037CLASS_GRAPH = NO
adamdunkelsbca83322004-03-18 21:06:27 +00001038
1039# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1040# will generate a graph for each documented class showing the direct and
1041# indirect implementation dependencies (inheritance, containment, and
1042# class references variables) of the class with other documented classes.
1043
adamdunkels5dd70b52003-08-31 22:15:46 +00001044COLLABORATION_GRAPH = YES
adamdunkelsbca83322004-03-18 21:06:27 +00001045
1046# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1047# collaboration diagrams in a style similar to the OMG's Unified Modeling
1048# Language.
1049
adamdunkels5dd70b52003-08-31 22:15:46 +00001050UML_LOOK = NO
adamdunkelsbca83322004-03-18 21:06:27 +00001051
1052# If set to YES, the inheritance and collaboration graphs will show the
1053# relations between templates and their instances.
1054
adamdunkels5dd70b52003-08-31 22:15:46 +00001055TEMPLATE_RELATIONS = NO
adamdunkelsbca83322004-03-18 21:06:27 +00001056
1057# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1058# tags are set to YES then doxygen will generate a graph for each documented
1059# file showing the direct and indirect include dependencies of the file with
1060# other documented files.
1061
adamdunkels26182b82003-09-01 22:29:28 +00001062INCLUDE_GRAPH = NO
adamdunkelsbca83322004-03-18 21:06:27 +00001063
1064# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1065# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1066# documented header file showing the documented files that directly or
1067# indirectly include this file.
1068
adamdunkels5dd70b52003-08-31 22:15:46 +00001069INCLUDED_BY_GRAPH = YES
adamdunkelsbca83322004-03-18 21:06:27 +00001070
1071# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1072# generate a call dependency graph for every global function or class method.
1073# Note that enabling this option will significantly increase the time of a run.
1074# So in most cases it will be better to enable call graphs for selected
1075# functions only using the \callgraph command.
1076
adamdunkelse937ded2003-10-01 07:53:57 +00001077CALL_GRAPH = YES
adamdunkelsbca83322004-03-18 21:06:27 +00001078
1079# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1080# will graphical hierarchy of all classes instead of a textual one.
1081
adamdunkels5dd70b52003-08-31 22:15:46 +00001082GRAPHICAL_HIERARCHY = YES
adamdunkelsbca83322004-03-18 21:06:27 +00001083
1084# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1085# generated by dot. Possible values are png, jpg, or gif
1086# If left blank png will be used.
1087
adamdunkels5dd70b52003-08-31 22:15:46 +00001088DOT_IMAGE_FORMAT = png
adamdunkelsbca83322004-03-18 21:06:27 +00001089
1090# The tag DOT_PATH can be used to specify the path where the dot tool can be
1091# found. If left blank, it is assumed the dot tool can be found on the path.
1092
adamdunkels5dd70b52003-08-31 22:15:46 +00001093DOT_PATH =
adamdunkelsbca83322004-03-18 21:06:27 +00001094
1095# The DOTFILE_DIRS tag can be used to specify one or more directories that
1096# contain dot files that are included in the documentation (see the
1097# \dotfile command).
1098
adamdunkels5dd70b52003-08-31 22:15:46 +00001099DOTFILE_DIRS =
adamdunkelsbca83322004-03-18 21:06:27 +00001100
1101# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1102# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1103# this value, doxygen will try to truncate the graph, so that it fits within
1104# the specified constraint. Beware that most browsers cannot cope with very
1105# large images.
1106
adamdunkels5dd70b52003-08-31 22:15:46 +00001107MAX_DOT_GRAPH_WIDTH = 1024
adamdunkelsbca83322004-03-18 21:06:27 +00001108
1109# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1110# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1111# this value, doxygen will try to truncate the graph, so that it fits within
1112# the specified constraint. Beware that most browsers cannot cope with very
1113# large images.
1114
adamdunkels5dd70b52003-08-31 22:15:46 +00001115MAX_DOT_GRAPH_HEIGHT = 1024
adamdunkelsbca83322004-03-18 21:06:27 +00001116
1117# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1118# graphs generated by dot. A depth value of 3 means that only nodes reachable
1119# from the root by following a path via at most 3 edges will be shown. Nodes that
1120# lay further from the root node will be omitted. Note that setting this option to
1121# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1122# note that a graph may be further truncated if the graph's image dimensions are
1123# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1124# If 0 is used for the depth value (the default), the graph is not depth-constrained.
1125
adamdunkels5dd70b52003-08-31 22:15:46 +00001126MAX_DOT_GRAPH_DEPTH = 0
adamdunkelsbca83322004-03-18 21:06:27 +00001127
1128# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1129# generate a legend page explaining the meaning of the various boxes and
1130# arrows in the dot generated graphs.
1131
adamdunkels5dd70b52003-08-31 22:15:46 +00001132GENERATE_LEGEND = YES
adamdunkelsbca83322004-03-18 21:06:27 +00001133
1134# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1135# remove the intermediate dot files that are used to generate
1136# the various graphs.
1137
adamdunkels5dd70b52003-08-31 22:15:46 +00001138DOT_CLEANUP = YES
adamdunkelsbca83322004-03-18 21:06:27 +00001139
adamdunkels5dd70b52003-08-31 22:15:46 +00001140#---------------------------------------------------------------------------
1141# Configuration::addtions related to the search engine
1142#---------------------------------------------------------------------------
adamdunkelsbca83322004-03-18 21:06:27 +00001143
1144# The SEARCHENGINE tag specifies whether or not a search engine should be
1145# used. If set to NO the values of all tags below this one will be ignored.
1146
adamdunkels5dd70b52003-08-31 22:15:46 +00001147SEARCHENGINE = NO