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