source: trunk/doc/doxygen.config @ 652

Last change on this file since 652 was 652, checked in by Peter, 16 years ago

added tag in config file so namespaces are included in sorting class list, rather than sorting only by class name

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