source: libcaca/trunk/doc/doxygen.cfg @ 207

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