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