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

Subversion Repositories gecko3

[/] [gecko3/] [trunk/] [GECKO3COM/] [gecko3com-fw/] [doc/] [Doxyfile.in] - Blame information for rev 36

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

Line No. Rev Author Line
1 9 nussgipfel
#
2
# Copyright 2001,2004,2005 Free Software Foundation, Inc.
3
#
4
# This file is part of GNU Radio
5
#
6
# GNU Radio is free software; you can redistribute it and/or modify
7
# it under the terms of the GNU General Public License as published by
8
# the Free Software Foundation; either version 3, or (at your option)
9
# any later version.
10
#
11
# GNU Radio is distributed in the hope that it will be useful,
12
# but WITHOUT ANY WARRANTY; without even the implied warranty of
13
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14
# GNU General Public License for more details.
15
#
16
# You should have received a copy of the GNU General Public License
17
# along with GNU Radio; see the file COPYING.  If not, write to
18
# the Free Software Foundation, Inc., 51 Franklin Street,
19
# Boston, MA 02110-1301, USA.
20
#
21
 
22
# Doxyfile 1.3.7
23
 
24
# This file describes the settings to be used by the documentation system
25
# doxygen (www.doxygen.org) for a project
26
#
27
# All text after a hash (#) is considered a comment and will be ignored
28
# The format is:
29
#       TAG = value [value, ...]
30
# For lists items can also be appended using:
31
#       TAG += value [value, ...]
32
# Values that contain spaces should be placed between quotes (" ")
33
 
34
#---------------------------------------------------------------------------
35
# Project related configuration options
36
#---------------------------------------------------------------------------
37
 
38
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
39
# by quotes) that should identify the project.
40
 
41
PROJECT_NAME           = "GECKO3COM"
42
 
43
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
44
# This could be handy for archiving the generated documentation or
45
# if some version control system is used.
46
 
47
PROJECT_NUMBER         =
48
 
49
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
50
# base path where the generated documentation will be put.
51
# If a relative path is entered, it will be relative to the location
52
# where doxygen was started. If left blank the current directory will be used.
53
 
54
OUTPUT_DIRECTORY       =
55
 
56
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
57
# 2 levels of 10 sub-directories under the output directory of each output
58
# format and will distribute the generated files over these directories.
59
# Enabling this option can be useful when feeding doxygen a huge amount of source
60
# files, where putting all generated files in the same directory would otherwise
61
# cause performance problems for the file system.
62
 
63
CREATE_SUBDIRS         = NO
64
 
65
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
66
# documentation generated by doxygen is written. Doxygen will use this
67
# information to generate all constant output in the proper language.
68
# The default language is English, other supported languages are:
69
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
70
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
71
# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese,
72
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
73
 
74
OUTPUT_LANGUAGE        = English
75
 
76
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
77
# include brief member descriptions after the members that are listed in
78
# the file and class documentation (similar to JavaDoc).
79
# Set to NO to disable this.
80
 
81
BRIEF_MEMBER_DESC      = YES
82
 
83
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
84
# the brief description of a member or function before the detailed description.
85
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
86
# brief descriptions will be completely suppressed.
87
 
88
REPEAT_BRIEF           = YES
89
 
90
# This tag implements a quasi-intelligent brief description abbreviator
91
# that is used to form the text in various listings. Each string
92
# in this list, if found as the leading text of the brief description, will be
93
# stripped from the text and the result after processing the whole list, is used
94
# as the annotated text. Otherwise, the brief description is used as-is. If left
95
# blank, the following values are used ("$name" is automatically replaced with the
96
# name of the entity): "The $name class" "The $name widget" "The $name file"
97
# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
98
 
99
ABBREVIATE_BRIEF       =
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 inherited
108
# members of a class in the documentation of that class as if those members were
109
# ordinary class members. Constructors, destructors and assignment operators of
110
# 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        = NO
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
# (but less readable) file names. This can be useful is your file systems
140
# 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 the Qt-style comments (thus requiring an
148
# explicit @brief command for a brief description.
149
 
150
JAVADOC_AUTOBRIEF      = NO
151
 
152
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
153
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
154
# comments) as a brief description. This used to be the default behaviour.
155
# The new default is to treat a multi-line C++ comment block as a detailed
156
# description. Set this tag to YES if you prefer the old behaviour instead.
157
 
158
MULTILINE_CPP_IS_BRIEF = NO
159
 
160
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
161
# member inherits the documentation from any documented member that it
162
# re-implements.
163
 
164
INHERIT_DOCS           = YES
165
 
166
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
167
# tag is set to YES, then doxygen will reuse the documentation of the first
168
# member in the group (if any) for the other members of the group. By default
169
# all members of a group must be documented explicitly.
170
 
171
DISTRIBUTE_GROUP_DOC   = NO
172
 
173
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
174
# Doxygen uses this value to replace tabs by spaces in code fragments.
175
 
176
TAB_SIZE               = 8
177
 
178
# This tag can be used to specify a number of aliases that acts
179
# as commands in the documentation. An alias has the form "name=value".
180
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
181
# put the command \sideeffect (or @sideeffect) in the documentation, which
182
# will result in a user-defined paragraph with heading "Side Effects:".
183
# You can put \n's in the value part of an alias to insert newlines.
184
 
185
ALIASES                =
186
 
187
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
188
# only. Doxygen will then generate output that is more tailored for C.
189
# For instance, some of the names that are used will be different. The list
190
# of all members will be omitted, etc.
191
 
192
OPTIMIZE_OUTPUT_FOR_C  = YES
193
 
194
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
195
# only. Doxygen will then generate output that is more tailored for Java.
196
# For instance, namespaces will be presented as packages, qualified scopes
197
# will look different, etc.
198
 
199
OPTIMIZE_OUTPUT_JAVA   = NO
200
 
201
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
202
# the same type (for instance a group of public functions) to be put as a
203
# subgroup of that type (e.g. under the Public Functions section). Set it to
204
# NO to prevent subgrouping. Alternatively, this can be done per class using
205
# the \nosubgrouping command.
206
 
207
SUBGROUPING            = YES
208
 
209
#---------------------------------------------------------------------------
210
# Build related configuration options
211
#---------------------------------------------------------------------------
212
 
213
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
214
# documentation are documented, even if no documentation was available.
215
# Private class members and static file members will be hidden unless
216
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
217
 
218
EXTRACT_ALL            = NO
219
 
220
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
221
# will be included in the documentation.
222
 
223
EXTRACT_PRIVATE        = NO
224
 
225
# If the EXTRACT_STATIC tag is set to YES all static members of a file
226
# will be included in the documentation.
227
 
228
EXTRACT_STATIC         = NO
229
 
230
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
231
# defined locally in source files will be included in the documentation.
232
# If set to NO only classes defined in header files are included.
233
 
234
EXTRACT_LOCAL_CLASSES  = YES
235
 
236
# This flag is only useful for Objective-C code. When set to YES local
237
# methods, which are defined in the implementation section but not in
238
# the interface are included in the documentation.
239
# If set to NO (the default) only methods in the interface are included.
240
 
241
EXTRACT_LOCAL_METHODS  = NO
242
 
243
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
244
# undocumented members of documented classes, files or namespaces.
245
# If set to NO (the default) these members will be included in the
246
# various overviews, but no documentation section is generated.
247
# This option has no effect if EXTRACT_ALL is enabled.
248
 
249
HIDE_UNDOC_MEMBERS     = NO
250
 
251
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
252
# undocumented classes that are normally visible in the class hierarchy.
253
# If set to NO (the default) these classes will be included in the various
254
# overviews. This option has no effect if EXTRACT_ALL is enabled.
255
 
256
HIDE_UNDOC_CLASSES     = NO
257
 
258
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
259
# friend (class|struct|union) declarations.
260
# If set to NO (the default) these declarations will be included in the
261
# documentation.
262
 
263
HIDE_FRIEND_COMPOUNDS  = NO
264
 
265
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
266
# documentation blocks found inside the body of a function.
267
# If set to NO (the default) these blocks will be appended to the
268
# function's detailed documentation block.
269
 
270
HIDE_IN_BODY_DOCS      = NO
271
 
272
# The INTERNAL_DOCS tag determines if documentation
273
# that is typed after a \internal command is included. If the tag is set
274
# to NO (the default) then the documentation will be excluded.
275
# Set it to YES to include the internal documentation.
276
 
277
INTERNAL_DOCS          = NO
278
 
279
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
280
# file names in lower-case letters. If set to YES upper-case letters are also
281
# allowed. This is useful if you have classes or files whose names only differ
282
# in case and if your file system supports case sensitive file names. Windows
283
# users are advised to set this option to NO.
284
 
285
CASE_SENSE_NAMES       = YES
286
 
287
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
288
# will show members with their full class and namespace scopes in the
289
# documentation. If set to YES the scope will be hidden.
290
 
291
HIDE_SCOPE_NAMES       = NO
292
 
293
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
294
# will put a list of the files that are included by a file in the documentation
295
# of that file.
296
 
297
SHOW_INCLUDE_FILES     = YES
298
 
299
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
300
# is inserted in the documentation for inline members.
301
 
302
INLINE_INFO            = YES
303
 
304
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
305
# will sort the (detailed) documentation of file and class members
306
# alphabetically by member name. If set to NO the members will appear in
307
# declaration order.
308
 
309
SORT_MEMBER_DOCS       = YES
310
 
311
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
312
# brief documentation of file, namespace and class members alphabetically
313
# by member name. If set to NO (the default) the members will appear in
314
# declaration order.
315
 
316
SORT_BRIEF_DOCS        = NO
317
 
318
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
319
# sorted by fully-qualified names, including namespaces. If set to
320
# NO (the default), the class list will be sorted only by class name,
321
# not including the namespace part.
322
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
323
# Note: This option applies only to the class list, not to the
324
# alphabetical list.
325
 
326
SORT_BY_SCOPE_NAME     = NO
327
 
328
# The GENERATE_TODOLIST tag can be used to enable (YES) or
329
# disable (NO) the todo list. This list is created by putting \todo
330
# commands in the documentation.
331
 
332
GENERATE_TODOLIST      = YES
333
 
334
# The GENERATE_TESTLIST tag can be used to enable (YES) or
335
# disable (NO) the test list. This list is created by putting \test
336
# commands in the documentation.
337
 
338
GENERATE_TESTLIST      = NO
339
 
340
# The GENERATE_BUGLIST tag can be used to enable (YES) or
341
# disable (NO) the bug list. This list is created by putting \bug
342
# commands in the documentation.
343
 
344
GENERATE_BUGLIST       = NO
345
 
346
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
347
# disable (NO) the deprecated list. This list is created by putting
348
# \deprecated commands in the documentation.
349
 
350
GENERATE_DEPRECATEDLIST= YES
351
 
352
# The ENABLED_SECTIONS tag can be used to enable conditional
353
# documentation sections, marked by \if sectionname ... \endif.
354
 
355
ENABLED_SECTIONS       =
356
 
357
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
358
# the initial value of a variable or define consists of for it to appear in
359
# the documentation. If the initializer consists of more lines than specified
360
# here it will be hidden. Use a value of 0 to hide initializers completely.
361
# The appearance of the initializer of individual variables and defines in the
362
# documentation can be controlled using \showinitializer or \hideinitializer
363
# command in the documentation regardless of this setting.
364
 
365
MAX_INITIALIZER_LINES  = 0
366
 
367
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
368
# at the bottom of the documentation of classes and structs. If set to YES the
369
# list will mention the files that were used to generate the documentation.
370
 
371
SHOW_USED_FILES        = YES
372
 
373
#---------------------------------------------------------------------------
374
# configuration options related to warning and progress messages
375
#---------------------------------------------------------------------------
376
 
377
# The QUIET tag can be used to turn on/off the messages that are generated
378
# by doxygen. Possible values are YES and NO. If left blank NO is used.
379
 
380
QUIET                  = NO
381
 
382
# The WARNINGS tag can be used to turn on/off the warning messages that are
383
# generated by doxygen. Possible values are YES and NO. If left blank
384
# NO is used.
385
 
386
WARNINGS               = YES
387
 
388
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
389
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
390
# automatically be disabled.
391
 
392
WARN_IF_UNDOCUMENTED   = YES
393
 
394
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
395
# potential errors in the documentation, such as not documenting some
396
# parameters in a documented function, or documenting parameters that
397
# don't exist or using markup commands wrongly.
398
 
399
WARN_IF_DOC_ERROR      = YES
400
 
401
# The WARN_FORMAT tag determines the format of the warning messages that
402
# doxygen can produce. The string should contain the $file, $line, and $text
403
# tags, which will be replaced by the file and line number from which the
404
# warning originated and the warning text.
405
 
406
WARN_FORMAT            = "$file:$line: $text"
407
 
408
# The WARN_LOGFILE tag can be used to specify a file to which warning
409
# and error messages should be written. If left blank the output is written
410
# to stderr.
411
 
412
WARN_LOGFILE           =
413
 
414
#---------------------------------------------------------------------------
415
# configuration options related to the input files
416
#---------------------------------------------------------------------------
417
 
418
# The INPUT tag can be used to specify the files and/or directories that contain
419
# documented source files. You may enter file names like "myfile.cpp" or
420
# directories like "/usr/src/myproject". Separate the files or directories
421
# with spaces.
422
 
423
INPUT                  = ../firmware/include \
424
                         ../firmware/lib \
425
                         ../firmware/src \
426
                         inc
427
 
428
# If the value of the INPUT tag contains directories, you can use the
429
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
430
# and *.h) to filter out the source-files in the directories. If left
431
# blank the following patterns are tested:
432
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
433
# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
434
 
435
FILE_PATTERNS          = *.h  \
436
                         *.c  \
437
                         *.dox
438
 
439
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
440
# should be searched for input files as well. Possible values are YES and NO.
441
# If left blank NO is used.
442
 
443
RECURSIVE              = YES
444
 
445
# The EXCLUDE tag can be used to specify files and/or directories that should
446
# excluded from the INPUT source files. This way you can easily exclude a
447
# subdirectory from a directory tree whose root is specified with the INPUT tag.
448
 
449
EXCLUDE                = CVS .svn
450
 
451
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
452
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
453
 
454
EXCLUDE_SYMLINKS       = NO
455
 
456
# If the value of the INPUT tag contains directories, you can use the
457
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
458
# certain files from those directories.
459
 
460
EXCLUDE_PATTERNS       =
461
 
462
# The EXAMPLE_PATH tag can be used to specify one or more files or
463
# directories that contain example code fragments that are included (see
464
# the \include command).
465
 
466
EXAMPLE_PATH           = ../examples
467
 
468
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
469
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
470
# and *.h) to filter out the source-files in the directories. If left
471
# blank all files are included.
472
 
473
EXAMPLE_PATTERNS       =
474
 
475
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
476
# searched for input files to be used with the \include or \dontinclude
477
# commands irrespective of the value of the RECURSIVE tag.
478
# Possible values are YES and NO. If left blank NO is used.
479
 
480
EXAMPLE_RECURSIVE      = NO
481
 
482
# The IMAGE_PATH tag can be used to specify one or more files or
483
# directories that contain image that are included in the documentation (see
484
# the \image command).
485
 
486
IMAGE_PATH             = inc
487
 
488
# The INPUT_FILTER tag can be used to specify a program that doxygen should
489
# invoke to filter for each input file. Doxygen will invoke the filter program
490
# by executing (via popen()) the command  , where 
491
# is the value of the INPUT_FILTER tag, and  is the name of an
492
# input file. Doxygen will then use the output that the filter program writes
493
# to standard output.
494
 
495
INPUT_FILTER           =
496
 
497
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
498
# INPUT_FILTER) will be used to filter the input files when producing source
499
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
500
 
501
FILTER_SOURCE_FILES    = NO
502
 
503
#---------------------------------------------------------------------------
504
# configuration options related to source browsing
505
#---------------------------------------------------------------------------
506
 
507
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
508
# be generated. Documented entities will be cross-referenced with these sources.
509
# Note: To get rid of all source code in the generated output, make sure also
510
# VERBATIM_HEADERS is set to NO.
511
 
512
SOURCE_BROWSER         = YES
513
 
514
# Setting the INLINE_SOURCES tag to YES will include the body
515
# of functions and classes directly in the documentation.
516
 
517
INLINE_SOURCES         = NO
518
 
519
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
520
# doxygen to hide any special comment blocks from generated source code
521
# fragments. Normal C and C++ comments will always remain visible.
522
 
523
STRIP_CODE_COMMENTS    = YES
524
 
525
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
526
# then for each documented function all documented
527
# functions referencing it will be listed.
528
 
529
REFERENCED_BY_RELATION = YES
530
 
531
# If the REFERENCES_RELATION tag is set to YES (the default)
532
# then for each documented function all documented entities
533
# called/used by that function will be listed.
534
 
535
REFERENCES_RELATION    = YES
536
 
537
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
538
# will generate a verbatim copy of the header file for each class for
539
# which an include is specified. Set to NO to disable this.
540
 
541
VERBATIM_HEADERS       = YES
542
 
543
#---------------------------------------------------------------------------
544
# configuration options related to the alphabetical class index
545
#---------------------------------------------------------------------------
546
 
547
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
548
# of all compounds will be generated. Enable this if the project
549
# contains a lot of classes, structs, unions or interfaces.
550
 
551
ALPHABETICAL_INDEX     = NO
552
 
553
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
554
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
555
# in which this list will be split (can be a number in the range [1..20])
556
 
557
COLS_IN_ALPHA_INDEX    = 5
558
 
559
# In case all classes in a project start with a common prefix, all
560
# classes will be put under the same header in the alphabetical index.
561
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
562
# should be ignored while generating the index headers.
563
 
564
IGNORE_PREFIX          =
565
 
566
#---------------------------------------------------------------------------
567
# configuration options related to the HTML output
568
#---------------------------------------------------------------------------
569
 
570
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
571
# generate HTML output.
572
 
573
GENERATE_HTML          = YES
574
 
575
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
576
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
577
# put in front of it. If left blank `html' will be used as the default path.
578
 
579
HTML_OUTPUT            = html
580
 
581
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
582
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
583
# doxygen will generate files with .html extension.
584
 
585
HTML_FILE_EXTENSION    = .html
586
 
587
# The HTML_HEADER tag can be used to specify a personal HTML header for
588
# each generated HTML page. If it is left blank doxygen will generate a
589
# standard header.
590
 
591
#HTML_HEADER            = inc/doxygen-header.html
592
 
593
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
594
# each generated HTML page. If it is left blank doxygen will generate a
595
# standard footer.
596
 
597
#HTML_FOOTER            = inc/doxygen-footer.html
598
 
599
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
600
# style sheet that is used by each HTML page. It can be used to
601
# fine-tune the look of the HTML output. If the tag is left blank doxygen
602
# will generate a default style sheet. Note that doxygen will try to copy
603
# the style sheet file to the HTML output directory, so don't put your own
604
# stylesheet in the HTML output directory as well, or it will be erased!
605
 
606
HTML_STYLESHEET        = inc/doxygen.css inc/tabs.css
607
 
608
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
609
# files or namespaces will be aligned in HTML using tables. If set to
610
# NO a bullet list will be used.
611
 
612
HTML_ALIGN_MEMBERS     = YES
613
 
614
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
615
# will be generated that can be used as input for tools like the
616
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
617
# of the generated HTML documentation.
618
 
619
GENERATE_HTMLHELP      = NO
620
 
621
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
622
# be used to specify the file name of the resulting .chm file. You
623
# can add a path in front of the file if the result should not be
624
# written to the html output directory.
625
 
626
CHM_FILE               =
627
 
628
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
629
# be used to specify the location (absolute path including file name) of
630
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
631
# the HTML help compiler on the generated index.hhp.
632
 
633
HHC_LOCATION           =
634
 
635
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
636
# controls if a separate .chi index file is generated (YES) or that
637
# it should be included in the master .chm file (NO).
638
 
639
GENERATE_CHI           = NO
640
 
641
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
642
# controls whether a binary table of contents is generated (YES) or a
643
# normal table of contents (NO) in the .chm file.
644
 
645
BINARY_TOC             = NO
646
 
647
# The TOC_EXPAND flag can be set to YES to add extra items for group members
648
# to the contents of the HTML help documentation and to the tree view.
649
 
650
TOC_EXPAND             = NO
651
 
652
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
653
# top of each HTML page. The value NO (the default) enables the index and
654
# the value YES disables it.
655
 
656
DISABLE_INDEX          = NO
657
 
658
# This tag can be used to set the number of enum values (range [1..20])
659
# that doxygen will group on one line in the generated HTML documentation.
660
 
661
ENUM_VALUES_PER_LINE   = 4
662
 
663
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
664
# generated containing a tree-like index structure (just like the one that
665
# is generated for HTML Help). For this to work a browser that supports
666
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
667
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
668
# probably better off using the HTML help feature.
669
 
670
GENERATE_TREEVIEW      = YES
671
 
672
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
673
# used to set the initial width (in pixels) of the frame in which the tree
674
# is shown.
675
 
676
TREEVIEW_WIDTH         = 250
677
 
678
#---------------------------------------------------------------------------
679
# configuration options related to the LaTeX output
680
#---------------------------------------------------------------------------
681
 
682
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
683
# generate Latex output.
684
 
685
GENERATE_LATEX         = NO
686
 
687
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
688
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
689
# put in front of it. If left blank `latex' will be used as the default path.
690
 
691
LATEX_OUTPUT           = latex
692
 
693
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
694
# invoked. If left blank `latex' will be used as the default command name.
695
 
696
LATEX_CMD_NAME         = latex
697
 
698
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
699
# generate index for LaTeX. If left blank `makeindex' will be used as the
700
# default command name.
701
 
702
MAKEINDEX_CMD_NAME     = makeindex
703
 
704
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
705
# LaTeX documents. This may be useful for small projects and may help to
706
# save some trees in general.
707
 
708
COMPACT_LATEX          = NO
709
 
710
# The PAPER_TYPE tag can be used to set the paper type that is used
711
# by the printer. Possible values are: a4, a4wide, letter, legal and
712
# executive. If left blank a4wide will be used.
713
 
714
PAPER_TYPE             = letter
715
 
716
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
717
# packages that should be included in the LaTeX output.
718
 
719
EXTRA_PACKAGES         =
720
 
721
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
722
# the generated latex document. The header should contain everything until
723
# the first chapter. If it is left blank doxygen will generate a
724
# standard header. Notice: only use this tag if you know what you are doing!
725
 
726
LATEX_HEADER           =
727
 
728
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
729
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
730
# contain links (just like the HTML output) instead of page references
731
# This makes the output suitable for online browsing using a pdf viewer.
732
 
733
PDF_HYPERLINKS         = YES
734
 
735
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
736
# plain latex in the generated Makefile. Set this option to YES to get a
737
# higher quality PDF documentation.
738
 
739
USE_PDFLATEX           = NO
740
 
741
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
742
# command to the generated LaTeX files. This will instruct LaTeX to keep
743
# running if errors occur, instead of asking the user for help.
744
# This option is also used when generating formulas in HTML.
745
 
746
LATEX_BATCHMODE        = NO
747
 
748
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
749
# include the index chapters (such as File Index, Compound Index, etc.)
750
# in the output.
751
 
752
LATEX_HIDE_INDICES     = NO
753
 
754
#---------------------------------------------------------------------------
755
# configuration options related to the RTF output
756
#---------------------------------------------------------------------------
757
 
758
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
759
# The RTF output is optimized for Word 97 and may not look very pretty with
760
# other RTF readers or editors.
761
 
762
GENERATE_RTF           = NO
763
 
764
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
765
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
766
# put in front of it. If left blank `rtf' will be used as the default path.
767
 
768
RTF_OUTPUT             = rtf
769
 
770
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
771
# RTF documents. This may be useful for small projects and may help to
772
# save some trees in general.
773
 
774
COMPACT_RTF            = NO
775
 
776
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
777
# will contain hyperlink fields. The RTF file will
778
# contain links (just like the HTML output) instead of page references.
779
# This makes the output suitable for online browsing using WORD or other
780
# programs which support those fields.
781
# Note: wordpad (write) and others do not support links.
782
 
783
RTF_HYPERLINKS         = NO
784
 
785
# Load stylesheet definitions from file. Syntax is similar to doxygen's
786
# config file, i.e. a series of assignments. You only have to provide
787
# replacements, missing definitions are set to their default value.
788
 
789
RTF_STYLESHEET_FILE    =
790
 
791
# Set optional variables used in the generation of an rtf document.
792
# Syntax is similar to doxygen's config file.
793
 
794
RTF_EXTENSIONS_FILE    =
795
 
796
#---------------------------------------------------------------------------
797
# configuration options related to the man page output
798
#---------------------------------------------------------------------------
799
 
800
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
801
# generate man pages
802
 
803
GENERATE_MAN           = NO
804
 
805
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
806
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
807
# put in front of it. If left blank `man' will be used as the default path.
808
 
809
MAN_OUTPUT             = man
810
 
811
# The MAN_EXTENSION tag determines the extension that is added to
812
# the generated man pages (default is the subroutine's section .3)
813
 
814
MAN_EXTENSION          = .3
815
 
816
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
817
# then it will generate one additional man file for each entity
818
# documented in the real man page(s). These additional files
819
# only source the real man page, but without them the man command
820
# would be unable to find the correct page. The default is NO.
821
 
822
MAN_LINKS              = NO
823
 
824
#---------------------------------------------------------------------------
825
# configuration options related to the XML output
826
#---------------------------------------------------------------------------
827
 
828
# If the GENERATE_XML tag is set to YES Doxygen will
829
# generate an XML file that captures the structure of
830
# the code including all documentation.
831
 
832
GENERATE_XML           = NO
833
 
834
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
835
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
836
# put in front of it. If left blank `xml' will be used as the default path.
837
 
838
XML_OUTPUT             = xml
839
 
840
# The XML_SCHEMA tag can be used to specify an XML schema,
841
# which can be used by a validating XML parser to check the
842
# syntax of the XML files.
843
 
844
XML_SCHEMA             =
845
 
846
# The XML_DTD tag can be used to specify an XML DTD,
847
# which can be used by a validating XML parser to check the
848
# syntax of the XML files.
849
 
850
XML_DTD                =
851
 
852
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
853
# dump the program listings (including syntax highlighting
854
# and cross-referencing information) to the XML output. Note that
855
# enabling this will significantly increase the size of the XML output.
856
 
857
XML_PROGRAMLISTING     = YES
858
 
859
#---------------------------------------------------------------------------
860
# configuration options for the AutoGen Definitions output
861
#---------------------------------------------------------------------------
862
 
863
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
864
# generate an AutoGen Definitions (see autogen.sf.net) file
865
# that captures the structure of the code including all
866
# documentation. Note that this feature is still experimental
867
# and incomplete at the moment.
868
 
869
GENERATE_AUTOGEN_DEF   = NO
870
 
871
#---------------------------------------------------------------------------
872
# configuration options related to the Perl module output
873
#---------------------------------------------------------------------------
874
 
875
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
876
# generate a Perl module file that captures the structure of
877
# the code including all documentation. Note that this
878
# feature is still experimental and incomplete at the
879
# moment.
880
 
881
GENERATE_PERLMOD       = NO
882
 
883
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
884
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
885
# to generate PDF and DVI output from the Perl module output.
886
 
887
PERLMOD_LATEX          = NO
888
 
889
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
890
# nicely formatted so it can be parsed by a human reader.  This is useful
891
# if you want to understand what is going on.  On the other hand, if this
892
# tag is set to NO the size of the Perl module output will be much smaller
893
# and Perl will parse it just the same.
894
 
895
PERLMOD_PRETTY         = YES
896
 
897
# The names of the make variables in the generated doxyrules.make file
898
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
899
# This is useful so different doxyrules.make files included by the same
900
# Makefile don't overwrite each other's variables.
901
 
902
PERLMOD_MAKEVAR_PREFIX =
903
 
904
#---------------------------------------------------------------------------
905
# Configuration options related to the preprocessor
906
#---------------------------------------------------------------------------
907
 
908
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
909
# evaluate all C-preprocessor directives found in the sources and include
910
# files.
911
 
912
ENABLE_PREPROCESSING   = YES
913
 
914
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
915
# names in the source code. If set to NO (the default) only conditional
916
# compilation will be performed. Macro expansion can be done in a controlled
917
# way by setting EXPAND_ONLY_PREDEF to YES.
918
 
919
MACRO_EXPANSION        = NO
920
 
921
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
922
# then the macro expansion is limited to the macros specified with the
923
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
924
 
925
EXPAND_ONLY_PREDEF     = NO
926
 
927
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
928
# in the INCLUDE_PATH (see below) will be search if a #include is found.
929
 
930
SEARCH_INCLUDES        = YES
931
 
932
# The INCLUDE_PATH tag can be used to specify one or more directories that
933
# contain include files that are not input files but should be processed by
934
# the preprocessor.
935
 
936
INCLUDE_PATH           =
937
 
938
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
939
# patterns (like *.h and *.hpp) to filter out the header-files in the
940
# directories. If left blank, the patterns specified with FILE_PATTERNS will
941
# be used.
942
 
943
INCLUDE_FILE_PATTERNS  =
944
 
945
# The PREDEFINED tag can be used to specify one or more macro names that
946
# are defined before the preprocessor is started (similar to the -D option of
947
# gcc). The argument of the tag is a list of macros of the form: name
948
# or name=definition (no spaces). If the definition and the = are
949
# omitted =1 is assumed.
950
 
951
PREDEFINED             =
952
 
953
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
954
# this tag can be used to specify a list of macro names that should be expanded.
955
# The macro definition that is found in the sources will be used.
956
# Use the PREDEFINED tag if you want to use a different macro definition.
957
 
958
EXPAND_AS_DEFINED      =
959
 
960
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
961
# doxygen's preprocessor will remove all function-like macros that are alone
962
# on a line, have an all uppercase name, and do not end with a semicolon. Such
963
# function macros are typically used for boiler-plate code, and will confuse the
964
# parser if not removed.
965
 
966
SKIP_FUNCTION_MACROS   = YES
967
 
968
#---------------------------------------------------------------------------
969
# Configuration::additions related to external references
970
#---------------------------------------------------------------------------
971
 
972
# The TAGFILES option can be used to specify one or more tagfiles.
973
# Optionally an initial location of the external documentation
974
# can be added for each tagfile. The format of a tag file without
975
# this location is as follows:
976
#   TAGFILES = file1 file2 ...
977
# Adding location for the tag files is done as follows:
978
#   TAGFILES = file1=loc1 "file2 = loc2" ...
979
# where "loc1" and "loc2" can be relative or absolute paths or
980
# URLs. If a location is present for each tag, the installdox tool
981
# does not have to be run to correct the links.
982
# Note that each tag file must have a unique name
983
# (where the name does NOT include the path)
984
# If a tag file is not located in the directory in which doxygen
985
# is run, you must also specify the path to the tagfile here.
986
 
987
TAGFILES               =
988
 
989
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
990
# a tag file that is based on the input files it reads.
991
 
992
GENERATE_TAGFILE       =
993
 
994
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
995
# in the class index. If set to NO only the inherited external classes
996
# will be listed.
997
 
998
ALLEXTERNALS           = NO
999
 
1000
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1001
# in the modules index. If set to NO, only the current project's groups will
1002
# be listed.
1003
 
1004
EXTERNAL_GROUPS        = YES
1005
 
1006
# The PERL_PATH should be the absolute path and name of the perl script
1007
# interpreter (i.e. the result of `which perl').
1008
 
1009
PERL_PATH              = /usr/bin/perl
1010
 
1011
#---------------------------------------------------------------------------
1012
# Configuration options related to the dot tool
1013
#---------------------------------------------------------------------------
1014
 
1015
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1016
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
1017
# super classes. Setting the tag to NO turns the diagrams off. Note that this
1018
# option is superseded by the HAVE_DOT option below. This is only a fallback. It is
1019
# recommended to install and use dot, since it yields more powerful graphs.
1020
 
1021
CLASS_DIAGRAMS         = YES
1022
 
1023
# If set to YES, the inheritance and collaboration graphs will hide
1024
# inheritance and usage relations if the target is undocumented
1025
# or is not a class.
1026
 
1027
HIDE_UNDOC_RELATIONS   = YES
1028
 
1029
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1030
# available from the path. This tool is part of Graphviz, a graph visualization
1031
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1032
# have no effect if this option is set to NO (the default)
1033
 
1034
HAVE_DOT               = YES
1035
 
1036
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1037
# will generate a graph for each documented class showing the direct and
1038
# indirect inheritance relations. Setting this tag to YES will force the
1039
# the CLASS_DIAGRAMS tag to NO.
1040
 
1041
CLASS_GRAPH            = YES
1042
 
1043
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1044
# will generate a graph for each documented class showing the direct and
1045
# indirect implementation dependencies (inheritance, containment, and
1046
# class references variables) of the class with other documented classes.
1047
 
1048
COLLABORATION_GRAPH    = YES
1049
 
1050
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1051
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1052
# Language.
1053
 
1054
UML_LOOK               = YES
1055
 
1056
# If set to YES, the inheritance and collaboration graphs will show the
1057
# relations between templates and their instances.
1058
 
1059
TEMPLATE_RELATIONS     = NO
1060
 
1061
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1062
# tags are set to YES then doxygen will generate a graph for each documented
1063
# file showing the direct and indirect include dependencies of the file with
1064
# other documented files.
1065
 
1066
INCLUDE_GRAPH          = YES
1067
 
1068
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1069
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1070
# documented header file showing the documented files that directly or
1071
# indirectly include this file.
1072
 
1073
INCLUDED_BY_GRAPH      = YES
1074
 
1075
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1076
# generate a call dependency graph for every global function or class method.
1077
# Note that enabling this option will significantly increase the time of a run.
1078
# So in most cases it will be better to enable call graphs for selected
1079
# functions only using the \callgraph command.
1080
 
1081
CALL_GRAPH             = NO
1082
 
1083
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1084
# will graphical hierarchy of all classes instead of a textual one.
1085
 
1086
GRAPHICAL_HIERARCHY    = YES
1087
 
1088
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1089
# generated by dot. Possible values are png, jpg, or gif
1090
# If left blank png will be used.
1091
 
1092
DOT_IMAGE_FORMAT       = png
1093
 
1094
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1095
# found. If left blank, it is assumed the dot tool can be found on the path.
1096
 
1097
DOT_PATH               =
1098
 
1099
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1100
# contain dot files that are included in the documentation (see the
1101
# \dotfile command).
1102
 
1103
DOTFILE_DIRS           =
1104
 
1105
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1106
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1107
# from the root by following a path via at most 3 edges will be shown. Nodes that
1108
# lay further from the root node will be omitted. Note that setting this option to
1109
# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1110
# note that a graph may be further truncated if the graph's image dimensions are
1111
# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1112
# If 0 is used for the depth value (the default), the graph is not depth-constrained.
1113
 
1114
MAX_DOT_GRAPH_DEPTH    = 0
1115
 
1116
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1117
# generate a legend page explaining the meaning of the various boxes and
1118
# arrows in the dot generated graphs.
1119
 
1120
GENERATE_LEGEND        = YES
1121
 
1122
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1123
# remove the intermediate dot files that are used to generate
1124
# the various graphs.
1125
 
1126
DOT_CLEANUP            = YES
1127
 
1128
#---------------------------------------------------------------------------
1129
# Configuration::additions related to the search engine
1130
#---------------------------------------------------------------------------
1131
 
1132
# The SEARCHENGINE tag specifies whether or not a search engine should be
1133
# used. If set to NO the values of all tags below this one will be ignored.
1134
 
1135
SEARCHENGINE           = NO

powered by: WebSVN 2.1.0

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