source: trunk/doc/doxygen.config @ 5

Last change on this file since 5 was 5, checked in by Jari Häkkinen, 19 years ago

* empty log message *

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