source: docs/libtrace.doxygen @ e641bdc

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivegetfragoffhelplibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since e641bdc was 80a6589, checked in by Daniel Lawson <dlawson@…>, 16 years ago

moving doxygen stuff round
created docs/Makefile.am
fixed some dag detection crazyness.

  • Property mode set to 100644
File size: 35.2 KB
Line 
1# Doxyfile 1.2.15
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# General 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           = "WAND Trace processing"
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         = 3.0
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       = doxygen
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, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
40# German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
41# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
42
43OUTPUT_LANGUAGE        = English
44
45# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
46# documentation are documented, even if no documentation was available.
47# Private class members and static file members will be hidden unless
48# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
49
50EXTRACT_ALL            = NO
51
52# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
53# will be included in the documentation.
54
55EXTRACT_PRIVATE        = NO
56
57# If the EXTRACT_STATIC tag is set to YES all static members of a file
58# will be included in the documentation.
59
60EXTRACT_STATIC         = NO
61
62# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
63# defined locally in source files will be included in the documentation.
64# If set to NO only classes defined in header files are included.
65
66EXTRACT_LOCAL_CLASSES  = NO
67
68# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
69# undocumented members of documented classes, files or namespaces.
70# If set to NO (the default) these members will be included in the
71# various overviews, but no documentation section is generated.
72# This option has no effect if EXTRACT_ALL is enabled.
73
74HIDE_UNDOC_MEMBERS     = NO
75
76# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
77# undocumented classes that are normally visible in the class hierarchy.
78# If set to NO (the default) these class will be included in the various
79# overviews. This option has no effect if EXTRACT_ALL is enabled.
80
81HIDE_UNDOC_CLASSES     = NO
82
83# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
84# include brief member descriptions after the members that are listed in
85# the file and class documentation (similar to JavaDoc).
86# Set to NO to disable this.
87
88BRIEF_MEMBER_DESC      = YES
89
90# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
91# the brief description of a member or function before the detailed description.
92# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
93# brief descriptions will be completely suppressed.
94
95REPEAT_BRIEF           = YES
96
97# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
98# Doxygen will generate a detailed section even if there is only a brief
99# description.
100
101ALWAYS_DETAILED_SEC    = YES
102
103# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
104# members of a class in the documentation of that class as if those members were
105# ordinary class members. Constructors, destructors and assignment operators of
106# the base classes will not be shown.
107
108INLINE_INHERITED_MEMB  = NO
109
110# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
111# path before files name in the file list and in the header files. If set
112# to NO the shortest path that makes the file name unique will be used.
113
114FULL_PATH_NAMES        = NO
115
116# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
117# can be used to strip a user defined part of the path. Stripping is
118# only done if one of the specified strings matches the left-hand part of
119# the path. It is allowed to use relative paths in the argument list.
120
121STRIP_FROM_PATH        =
122
123# The INTERNAL_DOCS tag determines if documentation
124# that is typed after a \internal command is included. If the tag is set
125# to NO (the default) then the documentation will be excluded.
126# Set it to YES to include the internal documentation.
127
128INTERNAL_DOCS          = NO
129
130# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
131# doxygen to hide any special comment blocks from generated source code
132# fragments. Normal C and C++ comments will always remain visible.
133
134STRIP_CODE_COMMENTS    = YES
135
136# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
137# file names in lower case letters. If set to YES upper case letters are also
138# allowed. This is useful if you have classes or files whose names only differ
139# in case and if your file system supports case sensitive file names. Windows
140# users are adviced to set this option to NO.
141
142CASE_SENSE_NAMES       = YES
143
144# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
145# (but less readable) file names. This can be useful is your file systems
146# doesn't support long names like on DOS, Mac, or CD-ROM.
147
148SHORT_NAMES            = NO
149
150# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
151# will show members with their full class and namespace scopes in the
152# documentation. If set to YES the scope will be hidden.
153
154HIDE_SCOPE_NAMES       = NO
155
156# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
157# will generate a verbatim copy of the header file for each class for
158# which an include is specified. Set to NO to disable this.
159
160VERBATIM_HEADERS       = YES
161
162# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
163# will put list of the files that are included by a file in the documentation
164# of that file.
165
166SHOW_INCLUDE_FILES     = NO
167
168# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
169# will interpret the first line (until the first dot) of a JavaDoc-style
170# comment as the brief description. If set to NO, the JavaDoc
171# comments  will behave just like the Qt-style comments (thus requiring an
172# explict @brief command for a brief description.
173
174JAVADOC_AUTOBRIEF      = YES
175
176# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
177# member inherits the documentation from any documented member that it
178# reimplements.
179
180INHERIT_DOCS           = YES
181
182# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
183# is inserted in the documentation for inline members.
184
185INLINE_INFO            = YES
186
187# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
188# will sort the (detailed) documentation of file and class members
189# alphabetically by member name. If set to NO the members will appear in
190# declaration order.
191
192SORT_MEMBER_DOCS       = YES
193
194# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
195# tag is set to YES, then doxygen will reuse the documentation of the first
196# member in the group (if any) for the other members of the group. By default
197# all members of a group must be documented explicitly.
198
199DISTRIBUTE_GROUP_DOC   = NO
200
201# The TAB_SIZE tag can be used to set the number of spaces in a tab.
202# Doxygen uses this value to replace tabs by spaces in code fragments.
203
204TAB_SIZE               = 8
205
206# The GENERATE_TODOLIST tag can be used to enable (YES) or
207# disable (NO) the todo list. This list is created by putting \todo
208# commands in the documentation.
209
210GENERATE_TODOLIST      = YES
211
212# The GENERATE_TESTLIST tag can be used to enable (YES) or
213# disable (NO) the test list. This list is created by putting \test
214# commands in the documentation.
215
216GENERATE_TESTLIST      = YES
217
218# The GENERATE_BUGLIST tag can be used to enable (YES) or
219# disable (NO) the bug list. This list is created by putting \bug
220# commands in the documentation.
221
222GENERATE_BUGLIST       = YES
223
224# This tag can be used to specify a number of aliases that acts
225# as commands in the documentation. An alias has the form "name=value".
226# For example adding "sideeffect=\par Side Effects:\n" will allow you to
227# put the command \sideeffect (or @sideeffect) in the documentation, which
228# will result in a user defined paragraph with heading "Side Effects:".
229# You can put \n's in the value part of an alias to insert newlines.
230
231ALIASES                =
232
233# The ENABLED_SECTIONS tag can be used to enable conditional
234# documentation sections, marked by \if sectionname ... \endif.
235
236ENABLED_SECTIONS       =
237
238# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
239# the initial value of a variable or define consist of for it to appear in
240# the documentation. If the initializer consists of more lines than specified
241# here it will be hidden. Use a value of 0 to hide initializers completely.
242# The appearance of the initializer of individual variables and defines in the
243# documentation can be controlled using \showinitializer or \hideinitializer
244# command in the documentation regardless of this setting.
245
246MAX_INITIALIZER_LINES  = 30
247
248# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
249# only. Doxygen will then generate output that is more tailored for C.
250# For instance some of the names that are used will be different. The list
251# of all members will be omitted, etc.
252
253OPTIMIZE_OUTPUT_FOR_C  = YES
254
255# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
256# only. Doxygen will then generate output that is more tailored for Java.
257# For instance namespaces will be presented as packages, qualified scopes
258# will look different, etc.
259
260OPTIMIZE_OUTPUT_JAVA   = NO
261
262# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
263# at the bottom of the documentation of classes and structs. If set to YES the
264# list will mention the files that were used to generate the documentation.
265
266SHOW_USED_FILES        = YES
267
268#---------------------------------------------------------------------------
269# configuration options related to warning and progress messages
270#---------------------------------------------------------------------------
271
272# The QUIET tag can be used to turn on/off the messages that are generated
273# by doxygen. Possible values are YES and NO. If left blank NO is used.
274
275QUIET                  = NO
276
277# The WARNINGS tag can be used to turn on/off the warning messages that are
278# generated by doxygen. Possible values are YES and NO. If left blank
279# NO is used.
280
281WARNINGS               = YES
282
283# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
284# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
285# automatically be disabled.
286
287WARN_IF_UNDOCUMENTED   = YES
288
289# The WARN_FORMAT tag determines the format of the warning messages that
290# doxygen can produce. The string should contain the $file, $line, and $text
291# tags, which will be replaced by the file and line number from which the
292# warning originated and the warning text.
293
294WARN_FORMAT            = "$file:$line: $text"
295
296# The WARN_LOGFILE tag can be used to specify a file to which warning
297# and error messages should be written. If left blank the output is written
298# to stderr.
299
300WARN_LOGFILE           =
301
302#---------------------------------------------------------------------------
303# configuration options related to the input files
304#---------------------------------------------------------------------------
305
306# The INPUT tag can be used to specify the files and/or directories that contain
307# documented source files. You may enter file names like "myfile.cpp" or
308# directories like "/usr/src/myproject". Separate the files or directories
309# with spaces.
310
311INPUT                  = ../lib
312
313# If the value of the INPUT tag contains directories, you can use the
314# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
315# and *.h) to filter out the source-files in the directories. If left
316# blank the following patterns are tested:
317# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
318# *.h++ *.idl *.odl
319
320FILE_PATTERNS          =
321
322# The RECURSIVE tag can be used to turn specify whether or not subdirectories
323# should be searched for input files as well. Possible values are YES and NO.
324# If left blank NO is used.
325
326RECURSIVE              = YES
327
328# The EXCLUDE tag can be used to specify files and/or directories that should
329# excluded from the INPUT source files. This way you can easily exclude a
330# subdirectory from a directory tree whose root is specified with the INPUT tag.
331
332EXCLUDE                =
333
334# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
335# that are symbolic links (a Unix filesystem feature) are excluded from the input.
336
337EXCLUDE_SYMLINKS       = NO
338
339# If the value of the INPUT tag contains directories, you can use the
340# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
341# certain files from those directories.
342
343EXCLUDE_PATTERNS       =
344
345# The EXAMPLE_PATH tag can be used to specify one or more files or
346# directories that contain example code fragments that are included (see
347# the \include command).
348
349EXAMPLE_PATH           =
350
351# If the value of the EXAMPLE_PATH tag contains directories, you can use the
352# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
353# and *.h) to filter out the source-files in the directories. If left
354# blank all files are included.
355
356EXAMPLE_PATTERNS       =
357
358# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
359# searched for input files to be used with the \include or \dontinclude
360# commands irrespective of the value of the RECURSIVE tag.
361# Possible values are YES and NO. If left blank NO is used.
362
363EXAMPLE_RECURSIVE      = NO
364
365# The IMAGE_PATH tag can be used to specify one or more files or
366# directories that contain image that are included in the documentation (see
367# the \image command).
368
369IMAGE_PATH             =
370
371# The INPUT_FILTER tag can be used to specify a program that doxygen should
372# invoke to filter for each input file. Doxygen will invoke the filter program
373# by executing (via popen()) the command <filter> <input-file>, where <filter>
374# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
375# input file. Doxygen will then use the output that the filter program writes
376# to standard output.
377
378INPUT_FILTER           =
379
380# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
381# INPUT_FILTER) will be used to filter the input files when producing source
382# files to browse.
383
384FILTER_SOURCE_FILES    = NO
385
386#---------------------------------------------------------------------------
387# configuration options related to source browsing
388#---------------------------------------------------------------------------
389
390# If the SOURCE_BROWSER tag is set to YES then a list of source files will
391# be generated. Documented entities will be cross-referenced with these sources.
392
393SOURCE_BROWSER         = NO
394
395# Setting the INLINE_SOURCES tag to YES will include the body
396# of functions and classes directly in the documentation.
397
398INLINE_SOURCES         = NO
399
400# If the REFERENCED_BY_RELATION tag is set to YES (the default)
401# then for each documented function all documented
402# functions referencing it will be listed.
403
404REFERENCED_BY_RELATION = YES
405
406# If the REFERENCES_RELATION tag is set to YES (the default)
407# then for each documented function all documented entities
408# called/used by that function will be listed.
409
410REFERENCES_RELATION    = YES
411
412#---------------------------------------------------------------------------
413# configuration options related to the alphabetical class index
414#---------------------------------------------------------------------------
415
416# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
417# of all compounds will be generated. Enable this if the project
418# contains a lot of classes, structs, unions or interfaces.
419
420ALPHABETICAL_INDEX     = NO
421
422# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
423# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
424# in which this list will be split (can be a number in the range [1..20])
425
426COLS_IN_ALPHA_INDEX    = 5
427
428# In case all classes in a project start with a common prefix, all
429# classes will be put under the same header in the alphabetical index.
430# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
431# should be ignored while generating the index headers.
432
433IGNORE_PREFIX          =
434
435#---------------------------------------------------------------------------
436# configuration options related to the HTML output
437#---------------------------------------------------------------------------
438
439# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
440# generate HTML output.
441
442GENERATE_HTML          = YES
443
444# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
445# If a relative path is entered the value of OUTPUT_DIRECTORY will be
446# put in front of it. If left blank `html' will be used as the default path.
447
448HTML_OUTPUT            = html
449
450# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
451# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
452# doxygen will generate files with .html extension.
453
454HTML_FILE_EXTENSION    = .html
455
456# The HTML_HEADER tag can be used to specify a personal HTML header for
457# each generated HTML page. If it is left blank doxygen will generate a
458# standard header.
459
460HTML_HEADER            =
461
462# The HTML_FOOTER tag can be used to specify a personal HTML footer for
463# each generated HTML page. If it is left blank doxygen will generate a
464# standard footer.
465
466HTML_FOOTER            =
467
468# The HTML_STYLESHEET tag can be used to specify a user defined cascading
469# style sheet that is used by each HTML page. It can be used to
470# fine-tune the look of the HTML output. If the tag is left blank doxygen
471# will generate a default style sheet
472
473HTML_STYLESHEET        =
474
475# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
476# files or namespaces will be aligned in HTML using tables. If set to
477# NO a bullet list will be used.
478
479HTML_ALIGN_MEMBERS     = YES
480
481# If the GENERATE_HTMLHELP tag is set to YES, additional index files
482# will be generated that can be used as input for tools like the
483# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
484# of the generated HTML documentation.
485
486GENERATE_HTMLHELP      = NO
487
488# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
489# controls if a separate .chi index file is generated (YES) or that
490# it should be included in the master .chm file (NO).
491
492GENERATE_CHI           = NO
493
494# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
495# controls whether a binary table of contents is generated (YES) or a
496# normal table of contents (NO) in the .chm file.
497
498BINARY_TOC             = NO
499
500# The TOC_EXPAND flag can be set to YES to add extra items for group members
501# to the contents of the Html help documentation and to the tree view.
502
503TOC_EXPAND             = NO
504
505# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
506# top of each HTML page. The value NO (the default) enables the index and
507# the value YES disables it.
508
509DISABLE_INDEX          = NO
510
511# This tag can be used to set the number of enum values (range [1..20])
512# that doxygen will group on one line in the generated HTML documentation.
513
514ENUM_VALUES_PER_LINE   = 4
515
516# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
517# generated containing a tree-like index structure (just like the one that
518# is generated for HTML Help). For this to work a browser that supports
519# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
520# or Internet explorer 4.0+). Note that for large projects the tree generation
521# can take a very long time. In such cases it is better to disable this feature.
522# Windows users are probably better off using the HTML help feature.
523
524GENERATE_TREEVIEW      = YES
525
526# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
527# used to set the initial width (in pixels) of the frame in which the tree
528# is shown.
529
530TREEVIEW_WIDTH         = 250
531
532#---------------------------------------------------------------------------
533# configuration options related to the LaTeX output
534#---------------------------------------------------------------------------
535
536# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
537# generate Latex output.
538
539GENERATE_LATEX         = YES
540
541# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
542# If a relative path is entered the value of OUTPUT_DIRECTORY will be
543# put in front of it. If left blank `latex' will be used as the default path.
544
545LATEX_OUTPUT           = latex
546
547# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name.
548
549LATEX_CMD_NAME         = latex
550
551# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
552# generate index for LaTeX. If left blank `makeindex' will be used as the
553# default command name.
554
555MAKEINDEX_CMD_NAME     = makeindex
556
557# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
558# LaTeX documents. This may be useful for small projects and may help to
559# save some trees in general.
560
561COMPACT_LATEX          = NO
562
563# The PAPER_TYPE tag can be used to set the paper type that is used
564# by the printer. Possible values are: a4, a4wide, letter, legal and
565# executive. If left blank a4wide will be used.
566
567PAPER_TYPE             = a4wide
568
569# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
570# packages that should be included in the LaTeX output.
571
572EXTRA_PACKAGES         =
573
574# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
575# the generated latex document. The header should contain everything until
576# the first chapter. If it is left blank doxygen will generate a
577# standard header. Notice: only use this tag if you know what you are doing!
578
579LATEX_HEADER           =
580
581# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
582# is prepared for conversion to pdf (using ps2pdf). The pdf file will
583# contain links (just like the HTML output) instead of page references
584# This makes the output suitable for online browsing using a pdf viewer.
585
586PDF_HYPERLINKS         = YES
587
588# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
589# plain latex in the generated Makefile. Set this option to YES to get a
590# higher quality PDF documentation.
591
592USE_PDFLATEX           = YES
593
594# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
595# command to the generated LaTeX files. This will instruct LaTeX to keep
596# running if errors occur, instead of asking the user for help.
597# This option is also used when generating formulas in HTML.
598
599LATEX_BATCHMODE        = YES
600
601#---------------------------------------------------------------------------
602# configuration options related to the RTF output
603#---------------------------------------------------------------------------
604
605# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
606# The RTF output is optimised for Word 97 and may not look very pretty with
607# other RTF readers or editors.
608
609GENERATE_RTF           = NO
610
611# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
612# If a relative path is entered the value of OUTPUT_DIRECTORY will be
613# put in front of it. If left blank `rtf' will be used as the default path.
614
615RTF_OUTPUT             = rtf
616
617# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
618# RTF documents. This may be useful for small projects and may help to
619# save some trees in general.
620
621COMPACT_RTF            = NO
622
623# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
624# will contain hyperlink fields. The RTF file will
625# contain links (just like the HTML output) instead of page references.
626# This makes the output suitable for online browsing using WORD or other
627# programs which support those fields.
628# Note: wordpad (write) and others do not support links.
629
630RTF_HYPERLINKS         = NO
631
632# Load stylesheet definitions from file. Syntax is similar to doxygen's
633# config file, i.e. a series of assigments. You only have to provide
634# replacements, missing definitions are set to their default value.
635
636RTF_STYLESHEET_FILE    =
637
638# Set optional variables used in the generation of an rtf document.
639# Syntax is similar to doxygen's config file.
640
641RTF_EXTENSIONS_FILE    =
642
643#---------------------------------------------------------------------------
644# configuration options related to the man page output
645#---------------------------------------------------------------------------
646
647# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
648# generate man pages
649
650GENERATE_MAN           = YES
651
652# The MAN_OUTPUT tag is used to specify where the man pages will be put.
653# If a relative path is entered the value of OUTPUT_DIRECTORY will be
654# put in front of it. If left blank `man' will be used as the default path.
655
656MAN_OUTPUT             = man
657
658# The MAN_EXTENSION tag determines the extension that is added to
659# the generated man pages (default is the subroutine's section .3)
660
661MAN_EXTENSION          = .3
662
663# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
664# then it will generate one additional man file for each entity
665# documented in the real man page(s). These additional files
666# only source the real man page, but without them the man command
667# would be unable to find the correct page. The default is NO.
668
669MAN_LINKS              = YES
670
671#---------------------------------------------------------------------------
672# configuration options related to the XML output
673#---------------------------------------------------------------------------
674
675# If the GENERATE_XML tag is set to YES Doxygen will
676# generate an XML file that captures the structure of
677# the code including all documentation. Note that this
678# feature is still experimental and incomplete at the
679# moment.
680
681GENERATE_XML           = NO
682
683#---------------------------------------------------------------------------
684# configuration options for the AutoGen Definitions output
685#---------------------------------------------------------------------------
686
687# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
688# generate an AutoGen Definitions (see autogen.sf.net) file
689# that captures the structure of the code including all
690# documentation. Note that this feature is still experimental
691# and incomplete at the moment.
692
693GENERATE_AUTOGEN_DEF   = NO
694
695#---------------------------------------------------------------------------
696# Configuration options related to the preprocessor   
697#---------------------------------------------------------------------------
698
699# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
700# evaluate all C-preprocessor directives found in the sources and include
701# files.
702
703ENABLE_PREPROCESSING   = YES
704
705# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
706# names in the source code. If set to NO (the default) only conditional
707# compilation will be performed. Macro expansion can be done in a controlled
708# way by setting EXPAND_ONLY_PREDEF to YES.
709
710MACRO_EXPANSION        = NO
711
712# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
713# then the macro expansion is limited to the macros specified with the
714# PREDEFINED and EXPAND_AS_PREDEFINED tags.
715
716EXPAND_ONLY_PREDEF     = NO
717
718# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
719# in the INCLUDE_PATH (see below) will be search if a #include is found.
720
721SEARCH_INCLUDES        = YES
722
723# The INCLUDE_PATH tag can be used to specify one or more directories that
724# contain include files that are not input files but should be processed by
725# the preprocessor.
726
727INCLUDE_PATH           =
728
729# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
730# patterns (like *.h and *.hpp) to filter out the header-files in the
731# directories. If left blank, the patterns specified with FILE_PATTERNS will
732# be used.
733
734INCLUDE_FILE_PATTERNS  =
735
736# The PREDEFINED tag can be used to specify one or more macro names that
737# are defined before the preprocessor is started (similar to the -D option of
738# gcc). The argument of the tag is a list of macros of the form: name
739# or name=definition (no spaces). If the definition and the = are
740# omitted =1 is assumed.
741
742PREDEFINED             =
743
744# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
745# this tag can be used to specify a list of macro names that should be expanded.
746# The macro definition that is found in the sources will be used.
747# Use the PREDEFINED tag if you want to use a different macro definition.
748
749EXPAND_AS_DEFINED      =
750
751# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
752# doxygen's preprocessor will remove all function-like macros that are alone
753# on a line and do not end with a semicolon. Such function macros are typically
754# used for boiler-plate code, and will confuse the parser if not removed.
755
756SKIP_FUNCTION_MACROS   = YES
757
758#---------------------------------------------------------------------------
759# Configuration::addtions related to external references   
760#---------------------------------------------------------------------------
761
762# The TAGFILES tag can be used to specify one or more tagfiles.
763
764TAGFILES               =
765
766# When a file name is specified after GENERATE_TAGFILE, doxygen will create
767# a tag file that is based on the input files it reads.
768
769GENERATE_TAGFILE       =
770
771# If the ALLEXTERNALS tag is set to YES all external classes will be listed
772# in the class index. If set to NO only the inherited external classes
773# will be listed.
774
775ALLEXTERNALS           = NO
776
777# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
778# in the modules index. If set to NO, only the current project's groups will
779# be listed.
780
781EXTERNAL_GROUPS        = YES
782
783# The PERL_PATH should be the absolute path and name of the perl script
784# interpreter (i.e. the result of `which perl').
785
786PERL_PATH              = /usr/bin/perl
787
788#---------------------------------------------------------------------------
789# Configuration options related to the dot tool   
790#---------------------------------------------------------------------------
791
792# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
793# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
794# super classes. Setting the tag to NO turns the diagrams off. Note that this
795# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
796# recommended to install and use dot, since it yield more powerful graphs.
797
798CLASS_DIAGRAMS         = YES
799
800# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
801# available from the path. This tool is part of Graphviz, a graph visualization
802# toolkit from AT&T and Lucent Bell Labs. The other options in this section
803# have no effect if this option is set to NO (the default)
804
805HAVE_DOT               = YES
806
807# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
808# will generate a graph for each documented class showing the direct and
809# indirect inheritance relations. Setting this tag to YES will force the
810# the CLASS_DIAGRAMS tag to NO.
811
812CLASS_GRAPH            = YES
813
814# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
815# will generate a graph for each documented class showing the direct and
816# indirect implementation dependencies (inheritance, containment, and
817# class references variables) of the class with other documented classes.
818
819COLLABORATION_GRAPH    = YES
820
821# If set to YES, the inheritance and collaboration graphs will show the
822# relations between templates and their instances.
823
824TEMPLATE_RELATIONS     = YES
825
826# If set to YES, the inheritance and collaboration graphs will hide
827# inheritance and usage relations if the target is undocumented
828# or is not a class.
829
830HIDE_UNDOC_RELATIONS   = YES
831
832# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
833# tags are set to YES then doxygen will generate a graph for each documented
834# file showing the direct and indirect include dependencies of the file with
835# other documented files.
836
837INCLUDE_GRAPH          = NO
838
839# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
840# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
841# documented header file showing the documented files that directly or
842# indirectly include this file.
843
844INCLUDED_BY_GRAPH      = YES
845
846# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
847# will graphical hierarchy of all classes instead of a textual one.
848
849GRAPHICAL_HIERARCHY    = YES
850
851# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
852# generated by dot. Possible values are png, jpg, or gif
853# If left blank png will be used.
854
855DOT_IMAGE_FORMAT       = png
856
857# The tag DOT_PATH can be used to specify the path where the dot tool can be
858# found. If left blank, it is assumed the dot tool can be found on the path.
859
860DOT_PATH               =
861
862# The DOTFILE_DIRS tag can be used to specify one or more directories that
863# contain dot files that are included in the documentation (see the
864# \dotfile command).
865
866DOTFILE_DIRS           =
867
868# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
869# (in pixels) of the graphs generated by dot. If a graph becomes larger than
870# this value, doxygen will try to truncate the graph, so that it fits within
871# the specified constraint. Beware that most browsers cannot cope with very
872# large images.
873
874MAX_DOT_GRAPH_WIDTH    = 1024
875
876# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
877# (in pixels) of the graphs generated by dot. If a graph becomes larger than
878# this value, doxygen will try to truncate the graph, so that it fits within
879# the specified constraint. Beware that most browsers cannot cope with very
880# large images.
881
882MAX_DOT_GRAPH_HEIGHT   = 1024
883
884# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
885# generate a legend page explaining the meaning of the various boxes and
886# arrows in the dot generated graphs.
887
888GENERATE_LEGEND        = YES
889
890# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
891# remove the intermedate dot files that are used to generate
892# the various graphs.
893
894DOT_CLEANUP            = YES
895
896#---------------------------------------------------------------------------
897# Configuration::addtions related to the search engine   
898#---------------------------------------------------------------------------
899
900# The SEARCHENGINE tag specifies whether or not a search engine should be
901# used. If set to NO the values of all tags below this one will be ignored.
902
903SEARCHENGINE           = NO
904
Note: See TracBrowser for help on using the repository browser.