3
# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project
6
# All text after a hash (#) is considered a comment and will be ignored
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 (" ")
13
#---------------------------------------------------------------------------
14
# General configuration options
15
#---------------------------------------------------------------------------
17
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18
# by quotes) that should identify the project.
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.
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.
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.
44
OUTPUT_LANGUAGE = English
46
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
47
# documentation are documented, even if no documentation was available.
48
# Private class members and static file members will be hidden unless
49
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
53
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
54
# will be included in the documentation.
58
# If the EXTRACT_STATIC tag is set to YES all static members of a file
59
# will be included in the documentation.
63
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
64
# defined locally in source files will be included in the documentation.
65
# If set to NO only classes defined in header files are included.
67
EXTRACT_LOCAL_CLASSES = YES
69
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
70
# undocumented members of documented classes, files or namespaces.
71
# If set to NO (the default) these members will be included in the
72
# various overviews, but no documentation section is generated.
73
# This option has no effect if EXTRACT_ALL is enabled.
75
HIDE_UNDOC_MEMBERS = YES
77
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
78
# undocumented classes that are normally visible in the class hierarchy.
79
# If set to NO (the default) these class will be included in the various
80
# overviews. This option has no effect if EXTRACT_ALL is enabled.
82
HIDE_UNDOC_CLASSES = YES
84
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
85
# friend (class|struct|union) declarations.
86
# If set to NO (the default) these declarations will be included in the
89
HIDE_FRIEND_COMPOUNDS = NO
91
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
92
# documentation blocks found inside the body of a function.
93
# If set to NO (the default) these blocks will be appended to the
94
# function's detailed documentation block.
96
HIDE_IN_BODY_DOCS = NO
98
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
99
# include brief member descriptions after the members that are listed in
100
# the file and class documentation (similar to JavaDoc).
101
# Set to NO to disable this.
103
BRIEF_MEMBER_DESC = YES
105
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
106
# the brief description of a member or function before the detailed description.
107
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
108
# brief descriptions will be completely suppressed.
112
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
113
# Doxygen will generate a detailed section even if there is only a brief
116
ALWAYS_DETAILED_SEC = NO
118
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
119
# members of a class in the documentation of that class as if those members were
120
# ordinary class members. Constructors, destructors and assignment operators of
121
# the base classes will not be shown.
123
INLINE_INHERITED_MEMB = NO
125
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
126
# path before files name in the file list and in the header files. If set
127
# to NO the shortest path that makes the file name unique will be used.
131
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
132
# can be used to strip a user defined part of the path. Stripping is
133
# only done if one of the specified strings matches the left-hand part of
134
# the path. It is allowed to use relative paths in the argument list.
138
# The INTERNAL_DOCS tag determines if documentation
139
# that is typed after a \internal command is included. If the tag is set
140
# to NO (the default) then the documentation will be excluded.
141
# Set it to YES to include the internal documentation.
145
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
146
# file names in lower case letters. If set to YES upper case letters are also
147
# allowed. This is useful if you have classes or files whose names only differ
148
# in case and if your file system supports case sensitive file names. Windows
149
# users are adviced to set this option to NO.
151
CASE_SENSE_NAMES = YES
153
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
154
# (but less readable) file names. This can be useful is your file systems
155
# doesn't support long names like on DOS, Mac, or CD-ROM.
159
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
160
# will show members with their full class and namespace scopes in the
161
# documentation. If set to YES the scope will be hidden.
163
HIDE_SCOPE_NAMES = NO
165
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
166
# will generate a verbatim copy of the header file for each class for
167
# which an include is specified. Set to NO to disable this.
169
VERBATIM_HEADERS = YES
171
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
172
# will put list of the files that are included by a file in the documentation
175
SHOW_INCLUDE_FILES = YES
177
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
178
# will interpret the first line (until the first dot) of a JavaDoc-style
179
# comment as the brief description. If set to NO, the JavaDoc
180
# comments will behave just like the Qt-style comments (thus requiring an
181
# explict @brief command for a brief description.
183
JAVADOC_AUTOBRIEF = NO
185
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
186
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
187
# comments) as a brief description. This used to be the default behaviour.
188
# The new default is to treat a multi-line C++ comment block as a detailed
189
# description. Set this tag to YES if you prefer the old behaviour instead.
191
MULTILINE_CPP_IS_BRIEF = NO
193
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
194
# will output the detailed description near the top, like JavaDoc.
195
# If set to NO, the detailed description appears after the member
200
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
201
# member inherits the documentation from any documented member that it
206
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
207
# is inserted in the documentation for inline members.
211
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
212
# will sort the (detailed) documentation of file and class members
213
# alphabetically by member name. If set to NO the members will appear in
216
SORT_MEMBER_DOCS = YES
218
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
219
# tag is set to YES, then doxygen will reuse the documentation of the first
220
# member in the group (if any) for the other members of the group. By default
221
# all members of a group must be documented explicitly.
223
DISTRIBUTE_GROUP_DOC = NO
225
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
226
# Doxygen uses this value to replace tabs by spaces in code fragments.
230
# The GENERATE_TODOLIST tag can be used to enable (YES) or
231
# disable (NO) the todo list. This list is created by putting \todo
232
# commands in the documentation.
234
GENERATE_TODOLIST = YES
236
# The GENERATE_TESTLIST tag can be used to enable (YES) or
237
# disable (NO) the test list. This list is created by putting \test
238
# commands in the documentation.
240
GENERATE_TESTLIST = YES
242
# The GENERATE_BUGLIST tag can be used to enable (YES) or
243
# disable (NO) the bug list. This list is created by putting \bug
244
# commands in the documentation.
246
GENERATE_BUGLIST = YES
248
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
249
# disable (NO) the deprecated list. This list is created by putting
250
# \deprecated commands in the documentation.
252
GENERATE_DEPRECATEDLIST= YES
254
# This tag can be used to specify a number of aliases that acts
255
# as commands in the documentation. An alias has the form "name=value".
256
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
257
# put the command \sideeffect (or @sideeffect) in the documentation, which
258
# will result in a user defined paragraph with heading "Side Effects:".
259
# You can put \n's in the value part of an alias to insert newlines.
263
# The ENABLED_SECTIONS tag can be used to enable conditional
264
# documentation sections, marked by \if sectionname ... \endif.
268
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
269
# the initial value of a variable or define consist of for it to appear in
270
# the documentation. If the initializer consists of more lines than specified
271
# here it will be hidden. Use a value of 0 to hide initializers completely.
272
# The appearance of the initializer of individual variables and defines in the
273
# documentation can be controlled using \showinitializer or \hideinitializer
274
# command in the documentation regardless of this setting.
276
MAX_INITIALIZER_LINES = 30
278
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
279
# only. Doxygen will then generate output that is more tailored for C.
280
# For instance some of the names that are used will be different. The list
281
# of all members will be omitted, etc.
283
OPTIMIZE_OUTPUT_FOR_C = NO
285
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
286
# only. Doxygen will then generate output that is more tailored for Java.
287
# For instance namespaces will be presented as packages, qualified scopes
288
# will look different, etc.
290
OPTIMIZE_OUTPUT_JAVA = NO
292
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
293
# at the bottom of the documentation of classes and structs. If set to YES the
294
# list will mention the files that were used to generate the documentation.
296
SHOW_USED_FILES = YES
298
#---------------------------------------------------------------------------
299
# configuration options related to warning and progress messages
300
#---------------------------------------------------------------------------
302
# The QUIET tag can be used to turn on/off the messages that are generated
303
# by doxygen. Possible values are YES and NO. If left blank NO is used.
307
# The WARNINGS tag can be used to turn on/off the warning messages that are
308
# generated by doxygen. Possible values are YES and NO. If left blank
313
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
314
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
315
# automatically be disabled.
317
WARN_IF_UNDOCUMENTED = YES
319
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
320
# potential errors in the documentation, such as not documenting some
321
# parameters in a documented function, or documenting parameters that
322
# don't exist or using markup commands wrongly.
324
WARN_IF_DOC_ERROR = YES
326
# The WARN_FORMAT tag determines the format of the warning messages that
327
# doxygen can produce. The string should contain the $file, $line, and $text
328
# tags, which will be replaced by the file and line number from which the
329
# warning originated and the warning text.
331
WARN_FORMAT = "$file:$line: $text"
333
# The WARN_LOGFILE tag can be used to specify a file to which warning
334
# and error messages should be written. If left blank the output is written
339
#---------------------------------------------------------------------------
340
# configuration options related to the input files
341
#---------------------------------------------------------------------------
343
# The INPUT tag can be used to specify the files and/or directories that contain
344
# documented source files. You may enter file names like "myfile.cpp" or
345
# directories like "/usr/src/myproject". Separate the files or directories
348
INPUT = ../../Src/DasherCore/DashEdit.h ../../Src/DasherCore/DasherScreen.h ../../Src/DasherCore/SettingsStore.h ../../Src/DasherCore/DasherAppInterface.h ../../Src/DasherCore/DasherWidgetInterface.h ../../Src/DasherCore/DasherSettingsInterface.h ../../Src/DasherCore/DasherInterface.h ../../Src/DasherCore/DasherTypes.h
350
# If the value of the INPUT tag contains directories, you can use the
351
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
352
# and *.h) to filter out the source-files in the directories. If left
353
# blank the following patterns are tested:
354
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
359
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
360
# should be searched for input files as well. Possible values are YES and NO.
361
# If left blank NO is used.
365
# The EXCLUDE tag can be used to specify files and/or directories that should
366
# excluded from the INPUT source files. This way you can easily exclude a
367
# subdirectory from a directory tree whose root is specified with the INPUT tag.
371
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
372
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
374
EXCLUDE_SYMLINKS = NO
376
# If the value of the INPUT tag contains directories, you can use the
377
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
378
# certain files from those directories.
382
# The EXAMPLE_PATH tag can be used to specify one or more files or
383
# directories that contain example code fragments that are included (see
384
# the \include command).
388
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
389
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
390
# and *.h) to filter out the source-files in the directories. If left
391
# blank all files are included.
395
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
396
# searched for input files to be used with the \include or \dontinclude
397
# commands irrespective of the value of the RECURSIVE tag.
398
# Possible values are YES and NO. If left blank NO is used.
400
EXAMPLE_RECURSIVE = NO
402
# The IMAGE_PATH tag can be used to specify one or more files or
403
# directories that contain image that are included in the documentation (see
404
# the \image command).
408
# The INPUT_FILTER tag can be used to specify a program that doxygen should
409
# invoke to filter for each input file. Doxygen will invoke the filter program
410
# by executing (via popen()) the command <filter> <input-file>, where <filter>
411
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
412
# input file. Doxygen will then use the output that the filter program writes
413
# to standard output.
417
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
418
# INPUT_FILTER) will be used to filter the input files when producing source
419
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
421
FILTER_SOURCE_FILES = NO
423
#---------------------------------------------------------------------------
424
# configuration options related to source browsing
425
#---------------------------------------------------------------------------
427
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
428
# be generated. Documented entities will be cross-referenced with these sources.
432
# Setting the INLINE_SOURCES tag to YES will include the body
433
# of functions and classes directly in the documentation.
437
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
438
# doxygen to hide any special comment blocks from generated source code
439
# fragments. Normal C and C++ comments will always remain visible.
441
STRIP_CODE_COMMENTS = YES
443
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
444
# then for each documented function all documented
445
# functions referencing it will be listed.
447
REFERENCED_BY_RELATION = YES
449
# If the REFERENCES_RELATION tag is set to YES (the default)
450
# then for each documented function all documented entities
451
# called/used by that function will be listed.
453
REFERENCES_RELATION = YES
455
#---------------------------------------------------------------------------
456
# configuration options related to the alphabetical class index
457
#---------------------------------------------------------------------------
459
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
460
# of all compounds will be generated. Enable this if the project
461
# contains a lot of classes, structs, unions or interfaces.
463
ALPHABETICAL_INDEX = NO
465
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
466
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
467
# in which this list will be split (can be a number in the range [1..20])
469
COLS_IN_ALPHA_INDEX = 5
471
# In case all classes in a project start with a common prefix, all
472
# classes will be put under the same header in the alphabetical index.
473
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
474
# should be ignored while generating the index headers.
478
#---------------------------------------------------------------------------
479
# configuration options related to the HTML output
480
#---------------------------------------------------------------------------
482
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
483
# generate HTML output.
487
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
488
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
489
# put in front of it. If left blank `html' will be used as the default path.
493
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
494
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
495
# doxygen will generate files with .html extension.
497
HTML_FILE_EXTENSION = .html
499
# The HTML_HEADER tag can be used to specify a personal HTML header for
500
# each generated HTML page. If it is left blank doxygen will generate a
505
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
506
# each generated HTML page. If it is left blank doxygen will generate a
511
# The HTML_STYLESHEET tag can be used to specify a user defined cascading
512
# style sheet that is used by each HTML page. It can be used to
513
# fine-tune the look of the HTML output. If the tag is left blank doxygen
514
# will generate a default style sheet
518
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
519
# files or namespaces will be aligned in HTML using tables. If set to
520
# NO a bullet list will be used.
522
HTML_ALIGN_MEMBERS = YES
524
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
525
# will be generated that can be used as input for tools like the
526
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
527
# of the generated HTML documentation.
529
GENERATE_HTMLHELP = NO
531
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
532
# be used to specify the file name of the resulting .chm file. You
533
# can add a path in front of the file if the result should not be
534
# written to the html output dir.
538
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
539
# be used to specify the location (absolute path including file name) of
540
# the HTML help compiler (hhc.exe). If non empty doxygen will try to run
541
# the html help compiler on the generated index.hhp.
545
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
546
# controls if a separate .chi index file is generated (YES) or that
547
# it should be included in the master .chm file (NO).
551
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
552
# controls whether a binary table of contents is generated (YES) or a
553
# normal table of contents (NO) in the .chm file.
557
# The TOC_EXPAND flag can be set to YES to add extra items for group members
558
# to the contents of the Html help documentation and to the tree view.
562
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
563
# top of each HTML page. The value NO (the default) enables the index and
564
# the value YES disables it.
568
# This tag can be used to set the number of enum values (range [1..20])
569
# that doxygen will group on one line in the generated HTML documentation.
571
ENUM_VALUES_PER_LINE = 4
573
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
574
# generated containing a tree-like index structure (just like the one that
575
# is generated for HTML Help). For this to work a browser that supports
576
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla,
577
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
578
# probably better off using the HTML help feature.
580
GENERATE_TREEVIEW = NO
582
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
583
# used to set the initial width (in pixels) of the frame in which the tree
588
#---------------------------------------------------------------------------
589
# configuration options related to the LaTeX output
590
#---------------------------------------------------------------------------
592
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
593
# generate Latex output.
597
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
598
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
599
# put in front of it. If left blank `latex' will be used as the default path.
603
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
604
# invoked. If left blank `latex' will be used as the default command name.
606
LATEX_CMD_NAME = latex
608
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
609
# generate index for LaTeX. If left blank `makeindex' will be used as the
610
# default command name.
612
MAKEINDEX_CMD_NAME = makeindex
614
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
615
# LaTeX documents. This may be useful for small projects and may help to
616
# save some trees in general.
620
# The PAPER_TYPE tag can be used to set the paper type that is used
621
# by the printer. Possible values are: a4, a4wide, letter, legal and
622
# executive. If left blank a4wide will be used.
626
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
627
# packages that should be included in the LaTeX output.
631
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
632
# the generated latex document. The header should contain everything until
633
# the first chapter. If it is left blank doxygen will generate a
634
# standard header. Notice: only use this tag if you know what you are doing!
638
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
639
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
640
# contain links (just like the HTML output) instead of page references
641
# This makes the output suitable for online browsing using a pdf viewer.
645
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
646
# plain latex in the generated Makefile. Set this option to YES to get a
647
# higher quality PDF documentation.
651
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
652
# command to the generated LaTeX files. This will instruct LaTeX to keep
653
# running if errors occur, instead of asking the user for help.
654
# This option is also used when generating formulas in HTML.
658
#---------------------------------------------------------------------------
659
# configuration options related to the RTF output
660
#---------------------------------------------------------------------------
662
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
663
# The RTF output is optimised for Word 97 and may not look very pretty with
664
# other RTF readers or editors.
668
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
669
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
670
# put in front of it. If left blank `rtf' will be used as the default path.
674
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
675
# RTF documents. This may be useful for small projects and may help to
676
# save some trees in general.
680
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
681
# will contain hyperlink fields. The RTF file will
682
# contain links (just like the HTML output) instead of page references.
683
# This makes the output suitable for online browsing using WORD or other
684
# programs which support those fields.
685
# Note: wordpad (write) and others do not support links.
689
# Load stylesheet definitions from file. Syntax is similar to doxygen's
690
# config file, i.e. a series of assigments. You only have to provide
691
# replacements, missing definitions are set to their default value.
693
RTF_STYLESHEET_FILE =
695
# Set optional variables used in the generation of an rtf document.
696
# Syntax is similar to doxygen's config file.
698
RTF_EXTENSIONS_FILE =
700
#---------------------------------------------------------------------------
701
# configuration options related to the man page output
702
#---------------------------------------------------------------------------
704
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
709
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
710
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
711
# put in front of it. If left blank `man' will be used as the default path.
715
# The MAN_EXTENSION tag determines the extension that is added to
716
# the generated man pages (default is the subroutine's section .3)
720
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
721
# then it will generate one additional man file for each entity
722
# documented in the real man page(s). These additional files
723
# only source the real man page, but without them the man command
724
# would be unable to find the correct page. The default is NO.
728
#---------------------------------------------------------------------------
729
# configuration options related to the XML output
730
#---------------------------------------------------------------------------
732
# If the GENERATE_XML tag is set to YES Doxygen will
733
# generate an XML file that captures the structure of
734
# the code including all documentation. Note that this
735
# feature is still experimental and incomplete at the
740
# The XML_SCHEMA tag can be used to specify an XML schema,
741
# which can be used by a validating XML parser to check the
742
# syntax of the XML files.
746
# The XML_DTD tag can be used to specify an XML DTD,
747
# which can be used by a validating XML parser to check the
748
# syntax of the XML files.
752
#---------------------------------------------------------------------------
753
# configuration options for the AutoGen Definitions output
754
#---------------------------------------------------------------------------
756
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
757
# generate an AutoGen Definitions (see autogen.sf.net) file
758
# that captures the structure of the code including all
759
# documentation. Note that this feature is still experimental
760
# and incomplete at the moment.
762
GENERATE_AUTOGEN_DEF = NO
764
#---------------------------------------------------------------------------
765
# configuration options related to the Perl module output
766
#---------------------------------------------------------------------------
768
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
769
# generate a Perl module file that captures the structure of
770
# the code including all documentation. Note that this
771
# feature is still experimental and incomplete at the
774
GENERATE_PERLMOD = NO
776
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
777
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
778
# to generate PDF and DVI output from the Perl module output.
782
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
783
# nicely formatted so it can be parsed by a human reader. This is useful
784
# if you want to understand what is going on. On the other hand, if this
785
# tag is set to NO the size of the Perl module output will be much smaller
786
# and Perl will parse it just the same.
790
# The names of the make variables in the generated doxyrules.make file
791
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
792
# This is useful so different doxyrules.make files included by the same
793
# Makefile don't overwrite each other's variables.
795
PERLMOD_MAKEVAR_PREFIX =
797
#---------------------------------------------------------------------------
798
# Configuration options related to the preprocessor
799
#---------------------------------------------------------------------------
801
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
802
# evaluate all C-preprocessor directives found in the sources and include
805
ENABLE_PREPROCESSING = YES
807
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
808
# names in the source code. If set to NO (the default) only conditional
809
# compilation will be performed. Macro expansion can be done in a controlled
810
# way by setting EXPAND_ONLY_PREDEF to YES.
814
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
815
# then the macro expansion is limited to the macros specified with the
816
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
818
EXPAND_ONLY_PREDEF = NO
820
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
821
# in the INCLUDE_PATH (see below) will be search if a #include is found.
823
SEARCH_INCLUDES = YES
825
# The INCLUDE_PATH tag can be used to specify one or more directories that
826
# contain include files that are not input files but should be processed by
831
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
832
# patterns (like *.h and *.hpp) to filter out the header-files in the
833
# directories. If left blank, the patterns specified with FILE_PATTERNS will
836
INCLUDE_FILE_PATTERNS =
838
# The PREDEFINED tag can be used to specify one or more macro names that
839
# are defined before the preprocessor is started (similar to the -D option of
840
# gcc). The argument of the tag is a list of macros of the form: name
841
# or name=definition (no spaces). If the definition and the = are
842
# omitted =1 is assumed.
846
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
847
# this tag can be used to specify a list of macro names that should be expanded.
848
# The macro definition that is found in the sources will be used.
849
# Use the PREDEFINED tag if you want to use a different macro definition.
853
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
854
# doxygen's preprocessor will remove all function-like macros that are alone
855
# on a line, have an all uppercase name, and do not end with a semicolon. Such
856
# function macros are typically used for boiler-plate code, and will confuse the
857
# parser if not removed.
859
SKIP_FUNCTION_MACROS = YES
861
#---------------------------------------------------------------------------
862
# Configuration::addtions related to external references
863
#---------------------------------------------------------------------------
865
# The TAGFILES tag can be used to specify one or more tagfiles.
869
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
870
# a tag file that is based on the input files it reads.
874
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
875
# in the class index. If set to NO only the inherited external classes
880
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
881
# in the modules index. If set to NO, only the current project's groups will
884
EXTERNAL_GROUPS = YES
886
# The PERL_PATH should be the absolute path and name of the perl script
887
# interpreter (i.e. the result of `which perl').
889
PERL_PATH = /usr/bin/perl
891
#---------------------------------------------------------------------------
892
# Configuration options related to the dot tool
893
#---------------------------------------------------------------------------
895
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
896
# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
897
# super classes. Setting the tag to NO turns the diagrams off. Note that this
898
# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
899
# recommended to install and use dot, since it yield more powerful graphs.
903
# If set to YES, the inheritance and collaboration graphs will hide
904
# inheritance and usage relations if the target is undocumented
907
HIDE_UNDOC_RELATIONS = YES
909
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
910
# available from the path. This tool is part of Graphviz, a graph visualization
911
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
912
# have no effect if this option is set to NO (the default)
916
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
917
# will generate a graph for each documented class showing the direct and
918
# indirect inheritance relations. Setting this tag to YES will force the
919
# the CLASS_DIAGRAMS tag to NO.
923
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
924
# will generate a graph for each documented class showing the direct and
925
# indirect implementation dependencies (inheritance, containment, and
926
# class references variables) of the class with other documented classes.
928
COLLABORATION_GRAPH = YES
930
# If set to YES, the inheritance and collaboration graphs will show the
931
# relations between templates and their instances.
933
TEMPLATE_RELATIONS = YES
935
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
936
# tags are set to YES then doxygen will generate a graph for each documented
937
# file showing the direct and indirect include dependencies of the file with
938
# other documented files.
942
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
943
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
944
# documented header file showing the documented files that directly or
945
# indirectly include this file.
947
INCLUDED_BY_GRAPH = YES
949
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
950
# will graphical hierarchy of all classes instead of a textual one.
952
GRAPHICAL_HIERARCHY = YES
954
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
955
# generated by dot. Possible values are png, jpg, or gif
956
# If left blank png will be used.
958
DOT_IMAGE_FORMAT = png
960
# The tag DOT_PATH can be used to specify the path where the dot tool can be
961
# found. If left blank, it is assumed the dot tool can be found on the path.
965
# The DOTFILE_DIRS tag can be used to specify one or more directories that
966
# contain dot files that are included in the documentation (see the
971
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
972
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
973
# this value, doxygen will try to truncate the graph, so that it fits within
974
# the specified constraint. Beware that most browsers cannot cope with very
977
MAX_DOT_GRAPH_WIDTH = 1024
979
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
980
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
981
# this value, doxygen will try to truncate the graph, so that it fits within
982
# the specified constraint. Beware that most browsers cannot cope with very
985
MAX_DOT_GRAPH_HEIGHT = 1024
987
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
988
# generate a legend page explaining the meaning of the various boxes and
989
# arrows in the dot generated graphs.
991
GENERATE_LEGEND = YES
993
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
994
# remove the intermedate dot files that are used to generate
995
# the various graphs.
999
#---------------------------------------------------------------------------
1000
# Configuration::addtions related to the search engine
1001
#---------------------------------------------------------------------------
1003
# The SEARCHENGINE tag specifies whether or not a search engine should be
1004
# used. If set to NO the values of all tags below this one will be ignored.
1008
# The CGI_NAME tag should be the name of the CGI script that
1009
# starts the search engine (doxysearch) with the correct parameters.
1010
# A script with this name will be generated by doxygen.
1012
CGI_NAME = search.cgi
1014
# The CGI_URL tag should be the absolute URL to the directory where the
1015
# cgi binaries are located. See the documentation of your http daemon for
1020
# The DOC_URL tag should be the absolute URL to the directory where the
1021
# documentation is located. If left blank the absolute path to the
1022
# documentation, with file:// prepended to it, will be used.
1026
# The DOC_ABSPATH tag should be the absolute path to the directory where the
1027
# documentation is located. If left blank the directory on the local machine
1032
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
1035
BIN_ABSPATH = /usr/local/bin/
1037
# The EXT_DOC_PATHS tag can be used to specify one or more paths to
1038
# documentation generated for other projects. This allows doxysearch to search
1039
# the documentation for these projects as well.