OpenCores
URL https://opencores.org/ocsvn/opencpu32/opencpu32/trunk

Subversion Repositories opencpu32

[/] [opencpu32/] [trunk/] [docs/] [confDoxygen.cnf] - Blame information for rev 29

Go to most recent revision | Details | Compare with Previous | View Log

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

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.