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

Subversion Repositories openrisc

[/] [openrisc/] [trunk/] [gnu-old/] [gcc-4.2.2/] [contrib/] [tree-ssa.doxy] - Blame information for rev 816

Details | Compare with Previous | View Log

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

powered by: WebSVN 2.1.0

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