source: trunk/doc/doxygen.config @ 586

Last change on this file since 586 was 577, checked in by Jari Häkkinen, 15 years ago

More lib changed to c++_tools stuff.

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