source: rtems/cpukit/Doxyfile.in @ 4670d91

4.104.11
Last change on this file since 4670d91 was 4670d91, checked in by Joel Sherrill <joel.sherrill@…>, on May 15, 2009 at 12:52:12 PM

2009-05-15 Sebastian Huber <sebastian.huber@…>

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