annotate Doxyfile @ 22:adc776858a2d

enable some debug logging
author Carl Byington <carl@five-ten-sg.com>
date Tue, 08 Jul 2014 09:29:08 -0700
parents 5564580fe160
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1 # Doxyfile 1.6.1
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
2
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
3 # This file describes the settings to be used by the documentation system
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
4 # doxygen (www.doxygen.org) for a project
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
5 #
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
6 # All text after a hash (#) is considered a comment and will be ignored
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
7 # The format is:
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
8 # TAG = value [value, ...]
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
9 # For lists items can also be appended using:
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
10 # TAG += value [value, ...]
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
11 # Values that contain spaces should be placed between quotes (" ")
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
12
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
13 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
14 # Project related configuration options
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
15 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
16
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
17 # This tag specifies the encoding used for all characters in the config file
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
18 # that follow. The default is UTF-8 which is also the encoding used for all
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
20 # iconv built into libc) for the transcoding. See
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
22
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
23 DOXYFILE_ENCODING = UTF-8
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
24
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
26 # by quotes) that should identify the project.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
27
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
28 PROJECT_NAME = AccuSpeech
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
29
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
31 # This could be handy for archiving the generated documentation or
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
32 # if some version control system is used.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
33
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
34 PROJECT_NUMBER =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
35
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
37 # base path where the generated documentation will be put.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
38 # If a relative path is entered, it will be relative to the location
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
39 # where doxygen was started. If left blank the current directory will be used.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
40
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
41 OUTPUT_DIRECTORY = doc
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
42
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
45 # format and will distribute the generated files over these directories.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
46 # Enabling this option can be useful when feeding doxygen a huge amount of
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
47 # source files, where putting all generated files in the same directory would
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
48 # otherwise cause performance problems for the file system.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
49
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
50 CREATE_SUBDIRS = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
51
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
53 # documentation generated by doxygen is written. Doxygen will use this
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
54 # information to generate all constant output in the proper language.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
55 # The default language is English, other supported languages are:
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
57 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
62
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
63 OUTPUT_LANGUAGE = English
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
64
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
66 # include brief member descriptions after the members that are listed in
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
67 # the file and class documentation (similar to JavaDoc).
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
68 # Set to NO to disable this.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
69
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
70 BRIEF_MEMBER_DESC = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
71
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
73 # the brief description of a member or function before the detailed description.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
75 # brief descriptions will be completely suppressed.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
76
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
77 REPEAT_BRIEF = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
78
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
79 # This tag implements a quasi-intelligent brief description abbreviator
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
80 # that is used to form the text in various listings. Each string
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
81 # in this list, if found as the leading text of the brief description, will be
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
82 # stripped from the text and the result after processing the whole list, is
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
83 # used as the annotated text. Otherwise, the brief description is used as-is.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
84 # If left blank, the following values are used ("$name" is automatically
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
85 # replaced with the name of the entity): "The $name class" "The $name widget"
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
86 # "The $name file" "is" "provides" "specifies" "contains"
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
87 # "represents" "a" "an" "the"
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
88
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
89 ABBREVIATE_BRIEF =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
90
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
92 # Doxygen will generate a detailed section even if there is only a brief
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
93 # description.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
94
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
95 ALWAYS_DETAILED_SEC = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
96
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
98 # inherited members of a class in the documentation of that class as if those
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
99 # members were ordinary class members. Constructors, destructors and assignment
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
100 # operators of the base classes will not be shown.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
101
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
102 INLINE_INHERITED_MEMB = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
103
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
105 # path before files name in the file list and in the header files. If set
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
106 # to NO the shortest path that makes the file name unique will be used.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
107
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
108 FULL_PATH_NAMES = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
109
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
111 # can be used to strip a user-defined part of the path. Stripping is
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
112 # only done if one of the specified strings matches the left-hand part of
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
113 # the path. The tag can be used to show relative paths in the file list.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
114 # If left blank the directory from which doxygen is run is used as the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
115 # path to strip.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
116
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
117 STRIP_FROM_PATH =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
118
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
120 # the path mentioned in the documentation of a class, which tells
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
121 # the reader which header file to include in order to use a class.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
122 # If left blank only the name of the header file containing the class
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
123 # definition is used. Otherwise one should specify the include paths that
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
124 # are normally passed to the compiler using the -I flag.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
125
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
126 STRIP_FROM_INC_PATH =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
127
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
129 # (but less readable) file names. This can be useful is your file systems
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
130 # doesn't support long names like on DOS, Mac, or CD-ROM.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
131
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
132 SHORT_NAMES = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
133
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
135 # will interpret the first line (until the first dot) of a JavaDoc-style
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
136 # comment as the brief description. If set to NO, the JavaDoc
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
137 # comments will behave just like regular Qt-style comments
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
138 # (thus requiring an explicit @brief command for a brief description.)
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
139
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
140 JAVADOC_AUTOBRIEF = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
141
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
143 # interpret the first line (until the first dot) of a Qt-style
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
144 # comment as the brief description. If set to NO, the comments
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
145 # will behave just like regular Qt-style comments (thus requiring
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
146 # an explicit \brief command for a brief description.)
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
147
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
148 QT_AUTOBRIEF = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
149
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
151 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
152 # comments) as a brief description. This used to be the default behaviour.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
153 # The new default is to treat a multi-line C++ comment block as a detailed
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
154 # description. Set this tag to YES if you prefer the old behaviour instead.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
155
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
156 MULTILINE_CPP_IS_BRIEF = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
157
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
159 # member inherits the documentation from any documented member that it
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
160 # re-implements.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
161
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
162 INHERIT_DOCS = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
163
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
164 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
165 # a new page for each member. If set to NO, the documentation of a member will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
166 # be part of the file/class/namespace that contains it.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
167
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
168 SEPARATE_MEMBER_PAGES = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
169
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
170 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
171 # Doxygen uses this value to replace tabs by spaces in code fragments.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
172
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
173 TAB_SIZE = 4
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
174
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
175 # This tag can be used to specify a number of aliases that acts
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
176 # as commands in the documentation. An alias has the form "name=value".
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
177 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
178 # put the command \sideeffect (or @sideeffect) in the documentation, which
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
179 # will result in a user-defined paragraph with heading "Side Effects:".
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
180 # You can put \n's in the value part of an alias to insert newlines.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
181
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
182 ALIASES =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
183
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
185 # sources only. Doxygen will then generate output that is more tailored for C.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
186 # For instance, some of the names that are used will be different. The list
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
187 # of all members will be omitted, etc.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
188
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
189 OPTIMIZE_OUTPUT_FOR_C = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
190
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
192 # sources only. Doxygen will then generate output that is more tailored for
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
193 # Java. For instance, namespaces will be presented as packages, qualified
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
194 # scopes will look different, etc.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
195
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
196 OPTIMIZE_OUTPUT_JAVA = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
197
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
198 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
199 # sources only. Doxygen will then generate output that is more tailored for
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
200 # Fortran.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
201
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
202 OPTIMIZE_FOR_FORTRAN = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
203
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
204 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
205 # sources. Doxygen will then generate output that is tailored for
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
206 # VHDL.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
207
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
208 OPTIMIZE_OUTPUT_VHDL = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
209
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
210 # Doxygen selects the parser to use depending on the extension of the files it parses.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
211 # With this tag you can assign which parser to use for a given extension.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
212 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
213 # The format is ext=language, where ext is a file extension, and language is one of
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
214 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
215 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
216 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
217 # use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
218
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
219 EXTENSION_MAPPING =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
220
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
221 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
222 # to include (a tag file for) the STL sources as input, then you should
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
223 # set this tag to YES in order to let doxygen match functions declarations and
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
224 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
225 # func(std::string) {}). This also make the inheritance and collaboration
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
226 # diagrams that involve STL classes more complete and accurate.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
227
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
228 BUILTIN_STL_SUPPORT = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
229
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
230 # If you use Microsoft's C++/CLI language, you should set this option to YES to
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
231 # enable parsing support.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
232
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
233 CPP_CLI_SUPPORT = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
234
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
235 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
236 # Doxygen will parse them like normal C++ but will assume all classes use public
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
237 # instead of private inheritance when no explicit protection keyword is present.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
238
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
239 SIP_SUPPORT = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
240
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
241 # For Microsoft's IDL there are propget and propput attributes to indicate getter
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
242 # and setter methods for a property. Setting this option to YES (the default)
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
243 # will make doxygen to replace the get and set methods by a property in the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
244 # documentation. This will only work if the methods are indeed getting or
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
245 # setting a simple type. If this is not the case, or you want to show the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
246 # methods anyway, you should set this option to NO.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
247
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
248 IDL_PROPERTY_SUPPORT = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
249
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
250 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
251 # tag is set to YES, then doxygen will reuse the documentation of the first
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
252 # member in the group (if any) for the other members of the group. By default
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
253 # all members of a group must be documented explicitly.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
254
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
255 DISTRIBUTE_GROUP_DOC = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
256
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
257 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
258 # the same type (for instance a group of public functions) to be put as a
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
259 # subgroup of that type (e.g. under the Public Functions section). Set it to
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
260 # NO to prevent subgrouping. Alternatively, this can be done per class using
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
261 # the \nosubgrouping command.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
262
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
263 SUBGROUPING = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
264
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
265 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
266 # is documented as struct, union, or enum with the name of the typedef. So
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
267 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
268 # with name TypeT. When disabled the typedef will appear as a member of a file,
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
269 # namespace, or class. And the struct will be named TypeS. This can typically
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
270 # be useful for C code in case the coding convention dictates that all compound
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
271 # types are typedef'ed and only the typedef is referenced, never the tag name.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
272
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
273 TYPEDEF_HIDES_STRUCT = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
274
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
275 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
276 # determine which symbols to keep in memory and which to flush to disk.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
277 # When the cache is full, less often used symbols will be written to disk.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
278 # For small to medium size projects (<1000 input files) the default value is
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
279 # probably good enough. For larger projects a too small cache size can cause
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
280 # doxygen to be busy swapping symbols to and from disk most of the time
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
281 # causing a significant performance penality.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
282 # If the system has enough physical memory increasing the cache will improve the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
283 # performance by keeping more symbols in memory. Note that the value works on
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
284 # a logarithmic scale so increasing the size by one will rougly double the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
285 # memory usage. The cache size is given by this formula:
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
286 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
287 # corresponding to a cache size of 2^16 = 65536 symbols
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
288
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
289 SYMBOL_CACHE_SIZE = 0
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
290
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
291 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
292 # Build related configuration options
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
293 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
294
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
295 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
296 # documentation are documented, even if no documentation was available.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
297 # Private class members and static file members will be hidden unless
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
298 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
299
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
300 EXTRACT_ALL = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
301
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
302 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
303 # will be included in the documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
304
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
305 EXTRACT_PRIVATE = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
306
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
307 # If the EXTRACT_STATIC tag is set to YES all static members of a file
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
308 # will be included in the documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
309
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
310 EXTRACT_STATIC = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
311
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
312 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
313 # defined locally in source files will be included in the documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
314 # If set to NO only classes defined in header files are included.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
315
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
316 EXTRACT_LOCAL_CLASSES = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
317
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
318 # This flag is only useful for Objective-C code. When set to YES local
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
319 # methods, which are defined in the implementation section but not in
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
320 # the interface are included in the documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
321 # If set to NO (the default) only methods in the interface are included.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
322
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
323 EXTRACT_LOCAL_METHODS = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
324
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
325 # If this flag is set to YES, the members of anonymous namespaces will be
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
326 # extracted and appear in the documentation as a namespace called
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
327 # 'anonymous_namespace{file}', where file will be replaced with the base
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
328 # name of the file that contains the anonymous namespace. By default
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
329 # anonymous namespace are hidden.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
330
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
331 EXTRACT_ANON_NSPACES = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
332
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
333 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
334 # undocumented members of documented classes, files or namespaces.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
335 # If set to NO (the default) these members will be included in the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
336 # various overviews, but no documentation section is generated.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
337 # This option has no effect if EXTRACT_ALL is enabled.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
338
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
339 HIDE_UNDOC_MEMBERS = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
340
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
341 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
342 # undocumented classes that are normally visible in the class hierarchy.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
343 # If set to NO (the default) these classes will be included in the various
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
344 # overviews. This option has no effect if EXTRACT_ALL is enabled.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
345
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
346 HIDE_UNDOC_CLASSES = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
347
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
348 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
349 # friend (class|struct|union) declarations.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
350 # If set to NO (the default) these declarations will be included in the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
351 # documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
352
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
353 HIDE_FRIEND_COMPOUNDS = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
354
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
355 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
356 # documentation blocks found inside the body of a function.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
357 # If set to NO (the default) these blocks will be appended to the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
358 # function's detailed documentation block.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
359
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
360 HIDE_IN_BODY_DOCS = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
361
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
362 # The INTERNAL_DOCS tag determines if documentation
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
363 # that is typed after a \internal command is included. If the tag is set
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
364 # to NO (the default) then the documentation will be excluded.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
365 # Set it to YES to include the internal documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
366
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
367 INTERNAL_DOCS = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
368
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
369 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
370 # file names in lower-case letters. If set to YES upper-case letters are also
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
371 # allowed. This is useful if you have classes or files whose names only differ
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
372 # in case and if your file system supports case sensitive file names. Windows
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
373 # and Mac users are advised to set this option to NO.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
374
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
375 CASE_SENSE_NAMES = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
376
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
377 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
378 # will show members with their full class and namespace scopes in the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
379 # documentation. If set to YES the scope will be hidden.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
380
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
381 HIDE_SCOPE_NAMES = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
382
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
383 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
384 # will put a list of the files that are included by a file in the documentation
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
385 # of that file.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
386
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
387 SHOW_INCLUDE_FILES = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
388
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
389 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
390 # is inserted in the documentation for inline members.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
391
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
392 INLINE_INFO = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
393
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
394 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
395 # will sort the (detailed) documentation of file and class members
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
396 # alphabetically by member name. If set to NO the members will appear in
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
397 # declaration order.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
398
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
399 SORT_MEMBER_DOCS = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
400
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
401 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
402 # brief documentation of file, namespace and class members alphabetically
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
403 # by member name. If set to NO (the default) the members will appear in
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
404 # declaration order.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
405
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
406 SORT_BRIEF_DOCS = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
407
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
408 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
409
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
410 SORT_MEMBERS_CTORS_1ST = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
411
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
412 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
413 # hierarchy of group names into alphabetical order. If set to NO (the default)
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
414 # the group names will appear in their defined order.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
415
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
416 SORT_GROUP_NAMES = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
417
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
418 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
419 # sorted by fully-qualified names, including namespaces. If set to
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
420 # NO (the default), the class list will be sorted only by class name,
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
421 # not including the namespace part.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
422 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
423 # Note: This option applies only to the class list, not to the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
424 # alphabetical list.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
425
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
426 SORT_BY_SCOPE_NAME = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
427
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
428 # The GENERATE_TODOLIST tag can be used to enable (YES) or
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
429 # disable (NO) the todo list. This list is created by putting \todo
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
430 # commands in the documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
431
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
432 GENERATE_TODOLIST = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
433
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
434 # The GENERATE_TESTLIST tag can be used to enable (YES) or
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
435 # disable (NO) the test list. This list is created by putting \test
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
436 # commands in the documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
437
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
438 GENERATE_TESTLIST = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
439
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
440 # The GENERATE_BUGLIST tag can be used to enable (YES) or
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
441 # disable (NO) the bug list. This list is created by putting \bug
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
442 # commands in the documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
443
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
444 GENERATE_BUGLIST = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
445
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
446 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
447 # disable (NO) the deprecated list. This list is created by putting
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
448 # \deprecated commands in the documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
449
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
450 GENERATE_DEPRECATEDLIST= YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
451
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
452 # The ENABLED_SECTIONS tag can be used to enable conditional
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
453 # documentation sections, marked by \if sectionname ... \endif.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
454
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
455 ENABLED_SECTIONS =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
456
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
457 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
458 # the initial value of a variable or define consists of for it to appear in
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
459 # the documentation. If the initializer consists of more lines than specified
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
460 # here it will be hidden. Use a value of 0 to hide initializers completely.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
461 # The appearance of the initializer of individual variables and defines in the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
462 # documentation can be controlled using \showinitializer or \hideinitializer
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
463 # command in the documentation regardless of this setting.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
464
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
465 MAX_INITIALIZER_LINES = 30
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
466
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
467 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
468 # at the bottom of the documentation of classes and structs. If set to YES the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
469 # list will mention the files that were used to generate the documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
470
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
471 SHOW_USED_FILES = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
472
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
473 # If the sources in your project are distributed over multiple directories
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
474 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
475 # in the documentation. The default is NO.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
476
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
477 SHOW_DIRECTORIES = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
478
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
479 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
480 # This will remove the Files entry from the Quick Index and from the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
481 # Folder Tree View (if specified). The default is YES.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
482
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
483 SHOW_FILES = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
484
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
485 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
486 # Namespaces page.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
487 # This will remove the Namespaces entry from the Quick Index
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
488 # and from the Folder Tree View (if specified). The default is YES.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
489
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
490 SHOW_NAMESPACES = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
491
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
492 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
493 # doxygen should invoke to get the current version for each file (typically from
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
494 # the version control system). Doxygen will invoke the program by executing (via
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
495 # popen()) the command <command> <input-file>, where <command> is the value of
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
496 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
497 # provided by doxygen. Whatever the program writes to standard output
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
498 # is used as the file version. See the manual for examples.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
499
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
500 FILE_VERSION_FILTER =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
501
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
502 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
503 # doxygen. The layout file controls the global structure of the generated output files
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
504 # in an output format independent way. The create the layout file that represents
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
505 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
506 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
507 # of the layout file.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
508
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
509 LAYOUT_FILE =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
510
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
511 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
512 # configuration options related to warning and progress messages
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
513 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
514
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
515 # The QUIET tag can be used to turn on/off the messages that are generated
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
516 # by doxygen. Possible values are YES and NO. If left blank NO is used.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
517
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
518 QUIET = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
519
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
520 # The WARNINGS tag can be used to turn on/off the warning messages that are
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
521 # generated by doxygen. Possible values are YES and NO. If left blank
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
522 # NO is used.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
523
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
524 WARNINGS = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
525
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
526 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
527 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
528 # automatically be disabled.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
529
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
530 WARN_IF_UNDOCUMENTED = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
531
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
532 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
533 # potential errors in the documentation, such as not documenting some
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
534 # parameters in a documented function, or documenting parameters that
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
535 # don't exist or using markup commands wrongly.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
536
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
537 WARN_IF_DOC_ERROR = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
538
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
539 # This WARN_NO_PARAMDOC option can be abled to get warnings for
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
540 # functions that are documented, but have no documentation for their parameters
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
541 # or return value. If set to NO (the default) doxygen will only warn about
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
542 # wrong or incomplete parameter documentation, but not about the absence of
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
543 # documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
544
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
545 WARN_NO_PARAMDOC = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
546
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
547 # The WARN_FORMAT tag determines the format of the warning messages that
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
548 # doxygen can produce. The string should contain the $file, $line, and $text
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
549 # tags, which will be replaced by the file and line number from which the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
550 # warning originated and the warning text. Optionally the format may contain
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
551 # $version, which will be replaced by the version of the file (if it could
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
552 # be obtained via FILE_VERSION_FILTER)
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
553
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
554 WARN_FORMAT = "$file:$line: $text"
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
555
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
556 # The WARN_LOGFILE tag can be used to specify a file to which warning
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
557 # and error messages should be written. If left blank the output is written
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
558 # to stderr.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
559
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
560 WARN_LOGFILE =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
561
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
562 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
563 # configuration options related to the input files
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
564 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
565
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
566 # The INPUT tag can be used to specify the files and/or directories that contain
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
567 # documented source files. You may enter file names like "myfile.cpp" or
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
568 # directories like "/usr/src/myproject". Separate the files or directories
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
569 # with spaces.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
570
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
571 INPUT = .
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
572
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
573 # This tag can be used to specify the character encoding of the source files
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
574 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
575 # also the default input encoding. Doxygen uses libiconv (or the iconv built
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
576 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
577 # the list of possible encodings.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
578
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
579 INPUT_ENCODING = UTF-8
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
580
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
581 # If the value of the INPUT tag contains directories, you can use the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
582 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
583 # and *.h) to filter out the source-files in the directories. If left
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
584 # blank the following patterns are tested:
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
585 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
586 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
587
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
588 FILE_PATTERNS =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
589
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
590 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
591 # should be searched for input files as well. Possible values are YES and NO.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
592 # If left blank NO is used.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
593
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
594 RECURSIVE = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
595
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
596 # The EXCLUDE tag can be used to specify files and/or directories that should
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
597 # excluded from the INPUT source files. This way you can easily exclude a
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
598 # subdirectory from a directory tree whose root is specified with the INPUT tag.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
599
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
600 EXCLUDE = doc .hg
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
601
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
602 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
603 # directories that are symbolic links (a Unix filesystem feature) are excluded
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
604 # from the input.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
605
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
606 EXCLUDE_SYMLINKS = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
607
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
608 # If the value of the INPUT tag contains directories, you can use the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
609 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
610 # certain files from those directories. Note that the wildcards are matched
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
611 # against the file with absolute path, so to exclude all test directories
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
612 # for example use the pattern */test/*
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
613
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
614 EXCLUDE_PATTERNS =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
615
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
616 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
617 # (namespaces, classes, functions, etc.) that should be excluded from the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
618 # output. The symbol name can be a fully qualified name, a word, or if the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
619 # wildcard * is used, a substring. Examples: ANamespace, AClass,
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
620 # AClass::ANamespace, ANamespace::*Test
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
621
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
622 EXCLUDE_SYMBOLS =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
623
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
624 # The EXAMPLE_PATH tag can be used to specify one or more files or
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
625 # directories that contain example code fragments that are included (see
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
626 # the \include command).
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
627
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
628 EXAMPLE_PATH =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
629
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
630 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
631 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
632 # and *.h) to filter out the source-files in the directories. If left
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
633 # blank all files are included.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
634
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
635 EXAMPLE_PATTERNS =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
636
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
637 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
638 # searched for input files to be used with the \include or \dontinclude
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
639 # commands irrespective of the value of the RECURSIVE tag.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
640 # Possible values are YES and NO. If left blank NO is used.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
641
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
642 EXAMPLE_RECURSIVE = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
643
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
644 # The IMAGE_PATH tag can be used to specify one or more files or
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
645 # directories that contain image that are included in the documentation (see
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
646 # the \image command).
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
647
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
648 IMAGE_PATH =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
649
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
650 # The INPUT_FILTER tag can be used to specify a program that doxygen should
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
651 # invoke to filter for each input file. Doxygen will invoke the filter program
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
652 # by executing (via popen()) the command <filter> <input-file>, where <filter>
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
653 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
654 # input file. Doxygen will then use the output that the filter program writes
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
655 # to standard output.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
656 # If FILTER_PATTERNS is specified, this tag will be
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
657 # ignored.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
658
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
659 INPUT_FILTER =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
660
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
661 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
662 # basis.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
663 # Doxygen will compare the file name with each pattern and apply the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
664 # filter if there is a match.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
665 # The filters are a list of the form:
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
666 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
667 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
668 # is applied to all files.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
669
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
670 FILTER_PATTERNS =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
671
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
672 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
673 # INPUT_FILTER) will be used to filter the input files when producing source
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
674 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
675
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
676 FILTER_SOURCE_FILES = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
677
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
678 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
679 # configuration options related to source browsing
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
680 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
681
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
682 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
683 # be generated. Documented entities will be cross-referenced with these sources.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
684 # Note: To get rid of all source code in the generated output, make sure also
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
685 # VERBATIM_HEADERS is set to NO.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
686
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
687 SOURCE_BROWSER = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
688
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
689 # Setting the INLINE_SOURCES tag to YES will include the body
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
690 # of functions and classes directly in the documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
691
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
692 INLINE_SOURCES = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
693
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
694 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
695 # doxygen to hide any special comment blocks from generated source code
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
696 # fragments. Normal C and C++ comments will always remain visible.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
697
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
698 STRIP_CODE_COMMENTS = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
699
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
700 # If the REFERENCED_BY_RELATION tag is set to YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
701 # then for each documented function all documented
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
702 # functions referencing it will be listed.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
703
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
704 REFERENCED_BY_RELATION = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
705
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
706 # If the REFERENCES_RELATION tag is set to YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
707 # then for each documented function all documented entities
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
708 # called/used by that function will be listed.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
709
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
710 REFERENCES_RELATION = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
711
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
712 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
713 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
714 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
715 # link to the source code.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
716 # Otherwise they will link to the documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
717
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
718 REFERENCES_LINK_SOURCE = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
719
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
720 # If the USE_HTAGS tag is set to YES then the references to source code
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
721 # will point to the HTML generated by the htags(1) tool instead of doxygen
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
722 # built-in source browser. The htags tool is part of GNU's global source
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
723 # tagging system (see http://www.gnu.org/software/global/global.html). You
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
724 # will need version 4.8.6 or higher.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
725
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
726 USE_HTAGS = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
727
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
728 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
729 # will generate a verbatim copy of the header file for each class for
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
730 # which an include is specified. Set to NO to disable this.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
731
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
732 VERBATIM_HEADERS = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
733
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
734 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
735 # configuration options related to the alphabetical class index
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
736 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
737
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
738 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
739 # of all compounds will be generated. Enable this if the project
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
740 # contains a lot of classes, structs, unions or interfaces.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
741
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
742 ALPHABETICAL_INDEX = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
743
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
744 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
745 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
746 # in which this list will be split (can be a number in the range [1..20])
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
747
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
748 COLS_IN_ALPHA_INDEX = 5
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
749
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
750 # In case all classes in a project start with a common prefix, all
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
751 # classes will be put under the same header in the alphabetical index.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
752 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
753 # should be ignored while generating the index headers.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
754
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
755 IGNORE_PREFIX =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
756
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
757 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
758 # configuration options related to the HTML output
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
759 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
760
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
761 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
762 # generate HTML output.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
763
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
764 GENERATE_HTML = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
765
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
766 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
767 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
768 # put in front of it. If left blank `html' will be used as the default path.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
769
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
770 HTML_OUTPUT = html
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
771
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
772 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
773 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
774 # doxygen will generate files with .html extension.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
775
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
776 HTML_FILE_EXTENSION = .html
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
777
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
778 # The HTML_HEADER tag can be used to specify a personal HTML header for
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
779 # each generated HTML page. If it is left blank doxygen will generate a
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
780 # standard header.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
781
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
782 HTML_HEADER =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
783
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
784 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
785 # each generated HTML page. If it is left blank doxygen will generate a
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
786 # standard footer.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
787
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
788 HTML_FOOTER =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
789
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
790 # If the HTML_TIMESTAMP tag is set to YES then the generated HTML
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
791 # documentation will contain the timesstamp.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
792
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
793 HTML_TIMESTAMP = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
794
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
795 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
796 # style sheet that is used by each HTML page. It can be used to
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
797 # fine-tune the look of the HTML output. If the tag is left blank doxygen
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
798 # will generate a default style sheet. Note that doxygen will try to copy
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
799 # the style sheet file to the HTML output directory, so don't put your own
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
800 # stylesheet in the HTML output directory as well, or it will be erased!
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
801
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
802 HTML_STYLESHEET =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
803
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
804 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
805 # files or namespaces will be aligned in HTML using tables. If set to
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
806 # NO a bullet list will be used.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
807
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
808 HTML_ALIGN_MEMBERS = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
809
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
810 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
811 # documentation will contain sections that can be hidden and shown after the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
812 # page has loaded. For this to work a browser that supports
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
813 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
814 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
815
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
816 HTML_DYNAMIC_SECTIONS = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
817
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
818 # If the GENERATE_DOCSET tag is set to YES, additional index files
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
819 # will be generated that can be used as input for Apple's Xcode 3
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
820 # integrated development environment, introduced with OSX 10.5 (Leopard).
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
821 # To create a documentation set, doxygen will generate a Makefile in the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
822 # HTML output directory. Running make will produce the docset in that
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
823 # directory and running "make install" will install the docset in
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
824 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
825 # it at startup.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
826 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
827
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
828 GENERATE_DOCSET = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
829
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
830 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
831 # feed. A documentation feed provides an umbrella under which multiple
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
832 # documentation sets from a single provider (such as a company or product suite)
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
833 # can be grouped.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
834
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
835 DOCSET_FEEDNAME = "Doxygen generated docs"
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
836
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
837 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
838 # should uniquely identify the documentation set bundle. This should be a
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
839 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
840 # will append .docset to the name.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
841
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
842 DOCSET_BUNDLE_ID = org.doxygen.Project
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
843
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
844 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
845 # will be generated that can be used as input for tools like the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
846 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
847 # of the generated HTML documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
848
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
849 GENERATE_HTMLHELP = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
850
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
851 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
852 # be used to specify the file name of the resulting .chm file. You
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
853 # can add a path in front of the file if the result should not be
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
854 # written to the html output directory.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
855
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
856 CHM_FILE =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
857
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
858 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
859 # be used to specify the location (absolute path including file name) of
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
860 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
861 # the HTML help compiler on the generated index.hhp.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
862
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
863 HHC_LOCATION =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
864
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
865 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
866 # controls if a separate .chi index file is generated (YES) or that
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
867 # it should be included in the master .chm file (NO).
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
868
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
869 GENERATE_CHI = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
870
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
871 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
872 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
873 # content.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
874
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
875 CHM_INDEX_ENCODING =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
876
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
877 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
878 # controls whether a binary table of contents is generated (YES) or a
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
879 # normal table of contents (NO) in the .chm file.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
880
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
881 BINARY_TOC = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
882
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
883 # The TOC_EXPAND flag can be set to YES to add extra items for group members
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
884 # to the contents of the HTML help documentation and to the tree view.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
885
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
886 TOC_EXPAND = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
887
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
888 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
889 # are set, an additional index file will be generated that can be used as input for
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
890 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
891 # HTML documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
892
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
893 GENERATE_QHP = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
894
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
895 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
896 # be used to specify the file name of the resulting .qch file.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
897 # The path specified is relative to the HTML output folder.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
898
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
899 QCH_FILE =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
900
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
901 # The QHP_NAMESPACE tag specifies the namespace to use when generating
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
902 # Qt Help Project output. For more information please see
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
903 # http://doc.trolltech.com/qthelpproject.html#namespace
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
904
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
905 QHP_NAMESPACE =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
906
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
907 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
908 # Qt Help Project output. For more information please see
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
909 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
910
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
911 QHP_VIRTUAL_FOLDER = doc
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
912
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
913 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
914 # For more information please see
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
915 # http://doc.trolltech.com/qthelpproject.html#custom-filters
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
916
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
917 QHP_CUST_FILTER_NAME =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
918
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
919 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
920 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
921
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
922 QHP_CUST_FILTER_ATTRS =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
923
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
924 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
925 # filter section matches.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
926 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
927
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
928 QHP_SECT_FILTER_ATTRS =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
929
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
930 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
931 # be used to specify the location of Qt's qhelpgenerator.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
932 # If non-empty doxygen will try to run qhelpgenerator on the generated
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
933 # .qhp file.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
934
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
935 QHG_LOCATION =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
936
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
937 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
938 # top of each HTML page. The value NO (the default) enables the index and
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
939 # the value YES disables it.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
940
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
941 DISABLE_INDEX = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
942
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
943 # This tag can be used to set the number of enum values (range [1..20])
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
944 # that doxygen will group on one line in the generated HTML documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
945
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
946 ENUM_VALUES_PER_LINE = 4
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
947
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
948 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
949 # structure should be generated to display hierarchical information.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
950 # If the tag value is set to YES, a side panel will be generated
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
951 # containing a tree-like index structure (just like the one that
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
952 # is generated for HTML Help). For this to work a browser that supports
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
953 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
954 # Windows users are probably better off using the HTML help feature.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
955
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
956 GENERATE_TREEVIEW = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
957
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
958 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
959 # and Class Hierarchy pages using a tree view instead of an ordered list.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
960
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
961 USE_INLINE_TREES = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
962
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
963 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
964 # used to set the initial width (in pixels) of the frame in which the tree
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
965 # is shown.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
966
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
967 TREEVIEW_WIDTH = 250
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
968
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
969 # Use this tag to change the font size of Latex formulas included
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
970 # as images in the HTML documentation. The default is 10. Note that
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
971 # when you change the font size after a successful doxygen run you need
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
972 # to manually remove any form_*.png images from the HTML output directory
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
973 # to force them to be regenerated.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
974
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
975 FORMULA_FONTSIZE = 10
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
976
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
977 # When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
978 # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
979 # there is already a search function so this one should typically
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
980 # be disabled.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
981
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
982 SEARCHENGINE = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
983
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
984 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
985 # configuration options related to the LaTeX output
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
986 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
987
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
988 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
989 # generate Latex output.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
990
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
991 GENERATE_LATEX = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
992
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
993 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
994 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
995 # put in front of it. If left blank `latex' will be used as the default path.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
996
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
997 LATEX_OUTPUT = latex
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
998
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
999 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1000 # invoked. If left blank `latex' will be used as the default command name.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1001
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1002 LATEX_CMD_NAME = latex
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1003
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1004 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1005 # generate index for LaTeX. If left blank `makeindex' will be used as the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1006 # default command name.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1007
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1008 MAKEINDEX_CMD_NAME = makeindex
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1009
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1010 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1011 # LaTeX documents. This may be useful for small projects and may help to
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1012 # save some trees in general.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1013
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1014 COMPACT_LATEX = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1015
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1016 # The PAPER_TYPE tag can be used to set the paper type that is used
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1017 # by the printer. Possible values are: a4, a4wide, letter, legal and
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1018 # executive. If left blank a4wide will be used.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1019
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1020 PAPER_TYPE = a4wide
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1021
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1022 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1023 # packages that should be included in the LaTeX output.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1024
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1025 EXTRA_PACKAGES =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1026
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1027 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1028 # the generated latex document. The header should contain everything until
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1029 # the first chapter. If it is left blank doxygen will generate a
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1030 # standard header. Notice: only use this tag if you know what you are doing!
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1031
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1032 LATEX_HEADER =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1033
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1034 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1035 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1036 # contain links (just like the HTML output) instead of page references
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1037 # This makes the output suitable for online browsing using a pdf viewer.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1038
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1039 PDF_HYPERLINKS = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1040
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1041 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1042 # plain latex in the generated Makefile. Set this option to YES to get a
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1043 # higher quality PDF documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1044
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1045 USE_PDFLATEX = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1046
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1047 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1048 # command to the generated LaTeX files. This will instruct LaTeX to keep
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1049 # running if errors occur, instead of asking the user for help.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1050 # This option is also used when generating formulas in HTML.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1051
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1052 LATEX_BATCHMODE = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1053
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1054 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1055 # include the index chapters (such as File Index, Compound Index, etc.)
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1056 # in the output.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1057
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1058 LATEX_HIDE_INDICES = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1059
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1060 # If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1061
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1062 LATEX_SOURCE_CODE = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1063
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1064 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1065 # configuration options related to the RTF output
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1066 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1067
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1068 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1069 # The RTF output is optimized for Word 97 and may not look very pretty with
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1070 # other RTF readers or editors.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1071
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1072 GENERATE_RTF = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1073
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1074 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1075 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1076 # put in front of it. If left blank `rtf' will be used as the default path.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1077
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1078 RTF_OUTPUT = rtf
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1079
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1080 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1081 # RTF documents. This may be useful for small projects and may help to
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1082 # save some trees in general.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1083
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1084 COMPACT_RTF = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1085
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1086 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1087 # will contain hyperlink fields. The RTF file will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1088 # contain links (just like the HTML output) instead of page references.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1089 # This makes the output suitable for online browsing using WORD or other
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1090 # programs which support those fields.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1091 # Note: wordpad (write) and others do not support links.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1092
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1093 RTF_HYPERLINKS = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1094
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1095 # Load stylesheet definitions from file. Syntax is similar to doxygen's
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1096 # config file, i.e. a series of assignments. You only have to provide
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1097 # replacements, missing definitions are set to their default value.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1098
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1099 RTF_STYLESHEET_FILE =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1100
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1101 # Set optional variables used in the generation of an rtf document.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1102 # Syntax is similar to doxygen's config file.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1103
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1104 RTF_EXTENSIONS_FILE =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1105
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1106 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1107 # configuration options related to the man page output
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1108 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1109
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1110 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1111 # generate man pages
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1112
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1113 GENERATE_MAN = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1114
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1115 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1116 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1117 # put in front of it. If left blank `man' will be used as the default path.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1118
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1119 MAN_OUTPUT = man
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1120
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1121 # The MAN_EXTENSION tag determines the extension that is added to
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1122 # the generated man pages (default is the subroutine's section .3)
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1123
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1124 MAN_EXTENSION = .3
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1125
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1126 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1127 # then it will generate one additional man file for each entity
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1128 # documented in the real man page(s). These additional files
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1129 # only source the real man page, but without them the man command
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1130 # would be unable to find the correct page. The default is NO.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1131
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1132 MAN_LINKS = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1133
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1134 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1135 # configuration options related to the XML output
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1136 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1137
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1138 # If the GENERATE_XML tag is set to YES Doxygen will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1139 # generate an XML file that captures the structure of
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1140 # the code including all documentation.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1141
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1142 GENERATE_XML = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1143
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1144 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1145 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1146 # put in front of it. If left blank `xml' will be used as the default path.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1147
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1148 XML_OUTPUT = xml
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1149
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1150 # The XML_SCHEMA tag can be used to specify an XML schema,
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1151 # which can be used by a validating XML parser to check the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1152 # syntax of the XML files.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1153
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1154 XML_SCHEMA =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1155
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1156 # The XML_DTD tag can be used to specify an XML DTD,
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1157 # which can be used by a validating XML parser to check the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1158 # syntax of the XML files.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1159
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1160 XML_DTD =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1161
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1162 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1163 # dump the program listings (including syntax highlighting
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1164 # and cross-referencing information) to the XML output. Note that
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1165 # enabling this will significantly increase the size of the XML output.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1166
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1167 XML_PROGRAMLISTING = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1168
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1169 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1170 # configuration options for the AutoGen Definitions output
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1171 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1172
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1173 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1174 # generate an AutoGen Definitions (see autogen.sf.net) file
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1175 # that captures the structure of the code including all
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1176 # documentation. Note that this feature is still experimental
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1177 # and incomplete at the moment.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1178
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1179 GENERATE_AUTOGEN_DEF = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1180
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1181 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1182 # configuration options related to the Perl module output
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1183 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1184
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1185 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1186 # generate a Perl module file that captures the structure of
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1187 # the code including all documentation. Note that this
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1188 # feature is still experimental and incomplete at the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1189 # moment.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1190
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1191 GENERATE_PERLMOD = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1192
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1193 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1194 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1195 # to generate PDF and DVI output from the Perl module output.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1196
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1197 PERLMOD_LATEX = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1198
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1199 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1200 # nicely formatted so it can be parsed by a human reader.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1201 # This is useful
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1202 # if you want to understand what is going on.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1203 # On the other hand, if this
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1204 # tag is set to NO the size of the Perl module output will be much smaller
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1205 # and Perl will parse it just the same.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1206
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1207 PERLMOD_PRETTY = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1208
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1209 # The names of the make variables in the generated doxyrules.make file
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1210 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1211 # This is useful so different doxyrules.make files included by the same
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1212 # Makefile don't overwrite each other's variables.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1213
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1214 PERLMOD_MAKEVAR_PREFIX =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1215
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1216 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1217 # Configuration options related to the preprocessor
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1218 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1219
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1220 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1221 # evaluate all C-preprocessor directives found in the sources and include
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1222 # files.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1223
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1224 ENABLE_PREPROCESSING = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1225
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1226 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1227 # names in the source code. If set to NO (the default) only conditional
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1228 # compilation will be performed. Macro expansion can be done in a controlled
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1229 # way by setting EXPAND_ONLY_PREDEF to YES.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1230
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1231 MACRO_EXPANSION = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1232
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1233 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1234 # then the macro expansion is limited to the macros specified with the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1235 # PREDEFINED and EXPAND_AS_DEFINED tags.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1236
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1237 EXPAND_ONLY_PREDEF = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1238
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1239 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1240 # in the INCLUDE_PATH (see below) will be search if a #include is found.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1241
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1242 SEARCH_INCLUDES = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1243
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1244 # The INCLUDE_PATH tag can be used to specify one or more directories that
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1245 # contain include files that are not input files but should be processed by
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1246 # the preprocessor.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1247
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1248 INCLUDE_PATH =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1249
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1250 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1251 # patterns (like *.h and *.hpp) to filter out the header-files in the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1252 # directories. If left blank, the patterns specified with FILE_PATTERNS will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1253 # be used.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1254
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1255 INCLUDE_FILE_PATTERNS =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1256
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1257 # The PREDEFINED tag can be used to specify one or more macro names that
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1258 # are defined before the preprocessor is started (similar to the -D option of
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1259 # gcc). The argument of the tag is a list of macros of the form: name
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1260 # or name=definition (no spaces). If the definition and the = are
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1261 # omitted =1 is assumed. To prevent a macro definition from being
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1262 # undefined via #undef or recursively expanded use the := operator
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1263 # instead of the = operator.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1264
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1265 PREDEFINED =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1266
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1267 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1268 # this tag can be used to specify a list of macro names that should be expanded.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1269 # The macro definition that is found in the sources will be used.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1270 # Use the PREDEFINED tag if you want to use a different macro definition.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1271
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1272 EXPAND_AS_DEFINED =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1273
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1274 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1275 # doxygen's preprocessor will remove all function-like macros that are alone
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1276 # on a line, have an all uppercase name, and do not end with a semicolon. Such
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1277 # function macros are typically used for boiler-plate code, and will confuse
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1278 # the parser if not removed.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1279
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1280 SKIP_FUNCTION_MACROS = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1281
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1282 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1283 # Configuration::additions related to external references
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1284 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1285
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1286 # The TAGFILES option can be used to specify one or more tagfiles.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1287 # Optionally an initial location of the external documentation
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1288 # can be added for each tagfile. The format of a tag file without
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1289 # this location is as follows:
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1290 #
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1291 # TAGFILES = file1 file2 ...
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1292 # Adding location for the tag files is done as follows:
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1293 #
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1294 # TAGFILES = file1=loc1 "file2 = loc2" ...
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1295 # where "loc1" and "loc2" can be relative or absolute paths or
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1296 # URLs. If a location is present for each tag, the installdox tool
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1297 # does not have to be run to correct the links.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1298 # Note that each tag file must have a unique name
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1299 # (where the name does NOT include the path)
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1300 # If a tag file is not located in the directory in which doxygen
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1301 # is run, you must also specify the path to the tagfile here.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1302
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1303 TAGFILES =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1304
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1305 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1306 # a tag file that is based on the input files it reads.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1307
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1308 GENERATE_TAGFILE =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1309
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1310 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1311 # in the class index. If set to NO only the inherited external classes
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1312 # will be listed.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1313
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1314 ALLEXTERNALS = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1315
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1316 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1317 # in the modules index. If set to NO, only the current project's groups will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1318 # be listed.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1319
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1320 EXTERNAL_GROUPS = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1321
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1322 # The PERL_PATH should be the absolute path and name of the perl script
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1323 # interpreter (i.e. the result of `which perl').
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1324
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1325 PERL_PATH = /usr/bin/perl
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1326
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1327 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1328 # Configuration options related to the dot tool
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1329 #---------------------------------------------------------------------------
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1330
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1331 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1332 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1333 # or super classes. Setting the tag to NO turns the diagrams off. Note that
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1334 # this option is superseded by the HAVE_DOT option below. This is only a
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1335 # fallback. It is recommended to install and use dot, since it yields more
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1336 # powerful graphs.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1337
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1338 CLASS_DIAGRAMS = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1339
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1340 # You can define message sequence charts within doxygen comments using the \msc
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1341 # command. Doxygen will then run the mscgen tool (see
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1342 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1343 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1344 # the mscgen tool resides. If left empty the tool is assumed to be found in the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1345 # default search path.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1346
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1347 MSCGEN_PATH =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1348
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1349 # If set to YES, the inheritance and collaboration graphs will hide
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1350 # inheritance and usage relations if the target is undocumented
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1351 # or is not a class.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1352
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1353 HIDE_UNDOC_RELATIONS = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1354
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1355 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1356 # available from the path. This tool is part of Graphviz, a graph visualization
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1357 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1358 # have no effect if this option is set to NO (the default)
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1359
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1360 HAVE_DOT = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1361
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1362 # By default doxygen will write a font called FreeSans.ttf to the output
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1363 # directory and reference it in all dot files that doxygen generates. This
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1364 # font does not include all possible unicode characters however, so when you need
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1365 # these (or just want a differently looking font) you can specify the font name
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1366 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1367 # which can be done by putting it in a standard location or by setting the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1368 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1369 # containing the font.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1370
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1371 DOT_FONTNAME = FreeSans
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1372
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1373 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1374 # The default size is 10pt.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1375
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1376 DOT_FONTSIZE = 10
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1377
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1378 # By default doxygen will tell dot to use the output directory to look for the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1379 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1380 # different font using DOT_FONTNAME you can set the path where dot
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1381 # can find it using this tag.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1382
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1383 DOT_FONTPATH =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1384
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1385 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1386 # will generate a graph for each documented class showing the direct and
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1387 # indirect inheritance relations. Setting this tag to YES will force the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1388 # the CLASS_DIAGRAMS tag to NO.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1389
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1390 CLASS_GRAPH = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1391
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1392 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1393 # will generate a graph for each documented class showing the direct and
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1394 # indirect implementation dependencies (inheritance, containment, and
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1395 # class references variables) of the class with other documented classes.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1396
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1397 COLLABORATION_GRAPH = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1398
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1399 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1400 # will generate a graph for groups, showing the direct groups dependencies
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1401
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1402 GROUP_GRAPHS = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1403
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1404 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1405 # collaboration diagrams in a style similar to the OMG's Unified Modeling
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1406 # Language.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1407
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1408 UML_LOOK = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1409
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1410 # If set to YES, the inheritance and collaboration graphs will show the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1411 # relations between templates and their instances.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1412
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1413 TEMPLATE_RELATIONS = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1414
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1415 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1416 # tags are set to YES then doxygen will generate a graph for each documented
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1417 # file showing the direct and indirect include dependencies of the file with
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1418 # other documented files.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1419
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1420 INCLUDE_GRAPH = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1421
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1422 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1423 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1424 # documented header file showing the documented files that directly or
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1425 # indirectly include this file.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1426
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1427 INCLUDED_BY_GRAPH = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1428
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1429 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1430 # doxygen will generate a call dependency graph for every global function
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1431 # or class method. Note that enabling this option will significantly increase
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1432 # the time of a run. So in most cases it will be better to enable call graphs
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1433 # for selected functions only using the \callgraph command.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1434
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1435 CALL_GRAPH = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1436
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1437 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1438 # doxygen will generate a caller dependency graph for every global function
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1439 # or class method. Note that enabling this option will significantly increase
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1440 # the time of a run. So in most cases it will be better to enable caller
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1441 # graphs for selected functions only using the \callergraph command.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1442
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1443 CALLER_GRAPH = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1444
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1445 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1446 # will graphical hierarchy of all classes instead of a textual one.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1447
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1448 GRAPHICAL_HIERARCHY = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1449
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1450 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1451 # then doxygen will show the dependencies a directory has on other directories
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1452 # in a graphical way. The dependency relations are determined by the #include
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1453 # relations between the files in the directories.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1454
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1455 DIRECTORY_GRAPH = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1456
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1457 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1458 # generated by dot. Possible values are png, jpg, or gif
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1459 # If left blank png will be used.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1460
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1461 DOT_IMAGE_FORMAT = png
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1462
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1463 # The tag DOT_PATH can be used to specify the path where the dot tool can be
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1464 # found. If left blank, it is assumed the dot tool can be found in the path.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1465
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1466 DOT_PATH =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1467
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1468 # The DOTFILE_DIRS tag can be used to specify one or more directories that
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1469 # contain dot files that are included in the documentation (see the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1470 # \dotfile command).
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1471
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1472 DOTFILE_DIRS =
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1473
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1474 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1475 # nodes that will be shown in the graph. If the number of nodes in a graph
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1476 # becomes larger than this value, doxygen will truncate the graph, which is
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1477 # visualized by representing a node as a red box. Note that doxygen if the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1478 # number of direct children of the root node in a graph is already larger than
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1479 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1480 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1481
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1482 DOT_GRAPH_MAX_NODES = 50
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1483
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1484 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1485 # graphs generated by dot. A depth value of 3 means that only nodes reachable
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1486 # from the root by following a path via at most 3 edges will be shown. Nodes
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1487 # that lay further from the root node will be omitted. Note that setting this
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1488 # option to 1 or 2 may greatly reduce the computation time needed for large
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1489 # code bases. Also note that the size of a graph can be further restricted by
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1490 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1491
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1492 MAX_DOT_GRAPH_DEPTH = 0
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1493
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1494 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1495 # background. This is disabled by default, because dot on Windows does not
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1496 # seem to support this out of the box. Warning: Depending on the platform used,
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1497 # enabling this option may lead to badly anti-aliased labels on the edges of
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1498 # a graph (i.e. they become hard to read).
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1499
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1500 DOT_TRANSPARENT = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1501
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1502 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1503 # files in one run (i.e. multiple -o and -T options on the command line). This
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1504 # makes dot run faster, but since only newer versions of dot (>1.8.10)
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1505 # support this, this feature is disabled by default.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1506
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1507 DOT_MULTI_TARGETS = NO
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1508
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1509 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1510 # generate a legend page explaining the meaning of the various boxes and
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1511 # arrows in the dot generated graphs.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1512
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1513 GENERATE_LEGEND = YES
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1514
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1515 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1516 # remove the intermediate dot files that are used to generate
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1517 # the various graphs.
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1518
5564580fe160 initial version
Carl Byington <carl@five-ten-sg.com>
parents:
diff changeset
1519 DOT_CLEANUP = YES