Mercurial > mplayer.hg
annotate DOCS/tech/Doxyfile @ 33389:2672587086ad
Add MNG output support.
Patch by Stefan Schuermans, stefan blinkenarea dot org.
author | cboesch |
---|---|
date | Sat, 21 May 2011 15:04:50 +0000 |
parents | 2cd61a522248 |
children | e1a74e3ddee7 |
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 | |
251 DISTRIBUTE_GROUP_DOC = NO | |
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 mp3lib \ | |
577 stream/freesdp \ | |
578 stream/librtsp \ | |
579 stream/realrtsp \ | |
580 tremor | |
13097 | 581 |
33273 | 582 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or |
583 # directories that are symbolic links (a Unix filesystem feature) are excluded | |
584 # from the input. | |
13097 | 585 |
586 EXCLUDE_SYMLINKS = NO | |
587 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
588 # 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
|
589 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
33273 | 590 # certain files from those directories. Note that the wildcards are matched |
591 # against the file with absolute path, so to exclude all test directories | |
592 # for example use the pattern */test/* | |
13097 | 593 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
594 EXCLUDE_PATTERNS = |
13097 | 595 |
33273 | 596 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
597 # (namespaces, classes, functions, etc.) that should be excluded from the | |
598 # output. The symbol name can be a fully qualified name, a word, or if the | |
599 # wildcard * is used, a substring. Examples: ANamespace, AClass, | |
600 # AClass::ANamespace, ANamespace::*Test | |
601 | |
602 EXCLUDE_SYMBOLS = | |
603 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
604 # 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
|
605 # directories that contain example code fragments that are included (see |
13097 | 606 # the \include command). |
607 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
608 EXAMPLE_PATH = |
13097 | 609 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
610 # 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
|
611 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
612 # and *.h) to filter out the source-files in the directories. If left |
13097 | 613 # blank all files are included. |
614 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
615 EXAMPLE_PATTERNS = |
13097 | 616 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
617 # 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
|
618 # searched for input files to be used with the \include or \dontinclude |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
619 # commands irrespective of the value of the RECURSIVE tag. |
13097 | 620 # Possible values are YES and NO. If left blank NO is used. |
621 | |
622 EXAMPLE_RECURSIVE = NO | |
623 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
624 # 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
|
625 # directories that contain image that are included in the documentation (see |
13097 | 626 # the \image command). |
627 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
628 IMAGE_PATH = |
13097 | 629 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
630 # 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
|
631 # 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
|
632 # by executing (via popen()) the command <filter> <input-file>, where <filter> |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
633 # 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
|
634 # input file. Doxygen will then use the output that the filter program writes |
33273 | 635 # to standard output. If FILTER_PATTERNS is specified, this tag will be |
636 # ignored. | |
13097 | 637 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
638 INPUT_FILTER = |
13097 | 639 |
33273 | 640 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
641 # basis. Doxygen will compare the file name with each pattern and apply the | |
642 # filter if there is a match. The filters are a list of the form: | |
643 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further | |
644 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER | |
645 # is applied to all files. | |
646 | |
647 FILTER_PATTERNS = | |
648 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
649 # 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
|
650 # INPUT_FILTER) will be used to filter the input files when producing source |
13097 | 651 # files to browse (i.e. when SOURCE_BROWSER is set to YES). |
652 | |
653 FILTER_SOURCE_FILES = NO | |
654 | |
655 #--------------------------------------------------------------------------- | |
656 # configuration options related to source browsing | |
657 #--------------------------------------------------------------------------- | |
658 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
659 # 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
|
660 # be generated. Documented entities will be cross-referenced with these sources. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
661 # Note: To get rid of all source code in the generated output, make sure also |
13097 | 662 # VERBATIM_HEADERS is set to NO. |
663 | |
664 SOURCE_BROWSER = YES | |
665 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
666 # Setting the INLINE_SOURCES tag to YES will include the body |
13097 | 667 # of functions and classes directly in the documentation. |
668 | |
669 INLINE_SOURCES = YES | |
670 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
671 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
672 # doxygen to hide any special comment blocks from generated source code |
13097 | 673 # fragments. Normal C and C++ comments will always remain visible. |
674 | |
675 STRIP_CODE_COMMENTS = YES | |
676 | |
33273 | 677 # If the REFERENCED_BY_RELATION tag is set to YES |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
678 # then for each documented function all documented |
13097 | 679 # functions referencing it will be listed. |
680 | |
681 REFERENCED_BY_RELATION = YES | |
682 | |
33273 | 683 # If the REFERENCES_RELATION tag is set to YES |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
684 # then for each documented function all documented entities |
13097 | 685 # called/used by that function will be listed. |
686 | |
687 REFERENCES_RELATION = YES | |
688 | |
33273 | 689 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) |
690 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from | |
691 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will | |
692 # link to the source code. Otherwise they will link to the documentstion. | |
693 | |
694 REFERENCES_LINK_SOURCE = YES | |
695 | |
696 # If the USE_HTAGS tag is set to YES then the references to source code | |
697 # will point to the HTML generated by the htags(1) tool instead of doxygen | |
698 # built-in source browser. The htags tool is part of GNU's global source | |
699 # tagging system (see http://www.gnu.org/software/global/global.html). You | |
700 # will need version 4.8.6 or higher. | |
701 | |
702 USE_HTAGS = NO | |
703 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
704 # 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
|
705 # will generate a verbatim copy of the header file for each class for |
13097 | 706 # which an include is specified. Set to NO to disable this. |
707 | |
708 VERBATIM_HEADERS = YES | |
709 | |
710 #--------------------------------------------------------------------------- | |
711 # configuration options related to the alphabetical class index | |
712 #--------------------------------------------------------------------------- | |
713 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
714 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
715 # of all compounds will be generated. Enable this if the project |
13097 | 716 # contains a lot of classes, structs, unions or interfaces. |
717 | |
718 ALPHABETICAL_INDEX = YES | |
719 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
720 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
721 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns |
13097 | 722 # in which this list will be split (can be a number in the range [1..20]) |
723 | |
724 COLS_IN_ALPHA_INDEX = 2 | |
725 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
726 # 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
|
727 # classes will be put under the same header in the alphabetical index. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
728 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that |
13097 | 729 # should be ignored while generating the index headers. |
730 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
731 IGNORE_PREFIX = |
13097 | 732 |
733 #--------------------------------------------------------------------------- | |
734 # configuration options related to the HTML output | |
735 #--------------------------------------------------------------------------- | |
736 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
737 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
13097 | 738 # generate HTML output. |
739 | |
740 GENERATE_HTML = YES | |
741 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
742 # 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
|
743 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
13097 | 744 # put in front of it. If left blank `html' will be used as the default path. |
745 | |
746 HTML_OUTPUT = html | |
747 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
748 # 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
|
749 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank |
13097 | 750 # doxygen will generate files with .html extension. |
751 | |
752 HTML_FILE_EXTENSION = .html | |
753 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
754 # 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
|
755 # each generated HTML page. If it is left blank doxygen will generate a |
13097 | 756 # standard header. |
757 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
758 HTML_HEADER = |
13097 | 759 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
760 # 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
|
761 # each generated HTML page. If it is left blank doxygen will generate a |
13097 | 762 # standard footer. |
763 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
764 HTML_FOOTER = |
13097 | 765 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
766 # 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
|
767 # 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
|
768 # 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
|
769 # 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
|
770 # the style sheet file to the HTML output directory, so don't put your own |
13097 | 771 # stylesheet in the HTML output directory as well, or it will be erased! |
772 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
773 HTML_STYLESHEET = |
13097 | 774 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
775 # 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
|
776 # files or namespaces will be aligned in HTML using tables. If set to |
13097 | 777 # NO a bullet list will be used. |
778 | |
779 HTML_ALIGN_MEMBERS = YES | |
780 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
781 # If the GENERATE_HTMLHELP tag is set to YES, additional index files |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
782 # will be generated that can be used as input for tools like the |
33273 | 783 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) |
13097 | 784 # of the generated HTML documentation. |
785 | |
786 GENERATE_HTMLHELP = NO | |
787 | |
33273 | 788 # If the GENERATE_DOCSET tag is set to YES, additional index files |
789 # will be generated that can be used as input for Apple's Xcode 3 | |
790 # integrated development environment, introduced with OSX 10.5 (Leopard). | |
791 # To create a documentation set, doxygen will generate a Makefile in the | |
792 # HTML output directory. Running make will produce the docset in that | |
793 # directory and running "make install" will install the docset in | |
794 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find | |
795 # it at startup. | |
796 | |
797 GENERATE_DOCSET = NO | |
798 | |
799 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the | |
800 # feed. A documentation feed provides an umbrella under which multiple | |
801 # documentation sets from a single provider (such as a company or product suite) | |
802 # can be grouped. | |
803 | |
804 DOCSET_FEEDNAME = "Doxygen generated docs" | |
805 | |
806 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that | |
807 # should uniquely identify the documentation set bundle. This should be a | |
808 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen | |
809 # will append .docset to the name. | |
810 | |
811 DOCSET_BUNDLE_ID = org.doxygen.Project | |
812 | |
813 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML | |
814 # documentation will contain sections that can be hidden and shown after the | |
815 # page has loaded. For this to work a browser that supports | |
816 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox | |
817 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). | |
818 | |
819 HTML_DYNAMIC_SECTIONS = NO | |
820 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
821 # 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
|
822 # 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
|
823 # can add a path in front of the file if the result should not be |
13097 | 824 # written to the html output directory. |
825 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
826 CHM_FILE = |
13097 | 827 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
828 # 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
|
829 # be used to specify the location (absolute path including file name) of |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
830 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run |
13097 | 831 # the HTML help compiler on the generated index.hhp. |
832 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
833 HHC_LOCATION = |
13097 | 834 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
835 # 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
|
836 # controls if a separate .chi index file is generated (YES) or that |
13097 | 837 # it should be included in the master .chm file (NO). |
838 | |
839 GENERATE_CHI = NO | |
840 | |
33273 | 841 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING |
842 # is used to encode HtmlHelp index (hhk), content (hhc) and project file | |
843 # content. | |
844 | |
845 CHM_INDEX_ENCODING = | |
846 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
847 # 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
|
848 # controls whether a binary table of contents is generated (YES) or a |
13097 | 849 # normal table of contents (NO) in the .chm file. |
850 | |
851 BINARY_TOC = NO | |
852 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
853 # The TOC_EXPAND flag can be set to YES to add extra items for group members |
13097 | 854 # to the contents of the HTML help documentation and to the tree view. |
855 | |
856 TOC_EXPAND = NO | |
857 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
858 # 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
|
859 # top of each HTML page. The value NO (the default) enables the index and |
13097 | 860 # the value YES disables it. |
861 | |
862 DISABLE_INDEX = NO | |
863 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
864 # This tag can be used to set the number of enum values (range [1..20]) |
13097 | 865 # that doxygen will group on one line in the generated HTML documentation. |
866 | |
867 ENUM_VALUES_PER_LINE = 4 | |
868 | |
33273 | 869 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
870 # structure should be generated to display hierarchical information. | |
871 # If the tag value is set to FRAME, a side panel will be generated | |
872 # containing a tree-like index structure (just like the one that | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
873 # 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
|
874 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
875 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are |
33273 | 876 # probably better off using the HTML help feature. Other possible values |
877 # for this tag are: HIERARCHIES, which will generate the Groups, Directories, | |
878 # and Class Hiererachy pages using a tree view instead of an ordered list; | |
879 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which | |
880 # disables this behavior completely. For backwards compatibility with previous | |
881 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE | |
882 # respectively. | |
13097 | 883 |
884 GENERATE_TREEVIEW = NO | |
885 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
886 # 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
|
887 # used to set the initial width (in pixels) of the frame in which the tree |
13097 | 888 # is shown. |
889 | |
890 TREEVIEW_WIDTH = 250 | |
891 | |
33273 | 892 # Use this tag to change the font size of Latex formulas included |
893 # as images in the HTML documentation. The default is 10. Note that | |
894 # when you change the font size after a successful doxygen run you need | |
895 # to manually remove any form_*.png images from the HTML output directory | |
896 # to force them to be regenerated. | |
897 | |
898 FORMULA_FONTSIZE = 10 | |
899 | |
13097 | 900 #--------------------------------------------------------------------------- |
901 # configuration options related to the LaTeX output | |
902 #--------------------------------------------------------------------------- | |
903 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
904 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
13097 | 905 # generate Latex output. |
906 | |
907 GENERATE_LATEX = NO | |
908 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
909 # 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
|
910 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
13097 | 911 # put in front of it. If left blank `latex' will be used as the default path. |
912 | |
913 LATEX_OUTPUT = latex | |
914 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
915 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
13097 | 916 # invoked. If left blank `latex' will be used as the default command name. |
917 | |
918 LATEX_CMD_NAME = latex | |
919 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
920 # 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
|
921 # generate index for LaTeX. If left blank `makeindex' will be used as the |
13097 | 922 # default command name. |
923 | |
924 MAKEINDEX_CMD_NAME = makeindex | |
925 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
926 # 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
|
927 # LaTeX documents. This may be useful for small projects and may help to |
13097 | 928 # save some trees in general. |
929 | |
930 COMPACT_LATEX = NO | |
931 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
932 # 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
|
933 # by the printer. Possible values are: a4, a4wide, letter, legal and |
13097 | 934 # executive. If left blank a4wide will be used. |
935 | |
936 PAPER_TYPE = a4wide | |
937 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
938 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
13097 | 939 # packages that should be included in the LaTeX output. |
940 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
941 EXTRA_PACKAGES = |
13097 | 942 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
943 # 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
|
944 # the generated latex document. The header should contain everything until |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
945 # the first chapter. If it is left blank doxygen will generate a |
13097 | 946 # standard header. Notice: only use this tag if you know what you are doing! |
947 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
948 LATEX_HEADER = |
13097 | 949 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
950 # 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
|
951 # is prepared for conversion to pdf (using ps2pdf). The pdf file will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
952 # contain links (just like the HTML output) instead of page references |
13097 | 953 # This makes the output suitable for online browsing using a pdf viewer. |
954 | |
955 PDF_HYPERLINKS = NO | |
956 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
957 # 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
|
958 # plain latex in the generated Makefile. Set this option to YES to get a |
13097 | 959 # higher quality PDF documentation. |
960 | |
961 USE_PDFLATEX = NO | |
962 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
963 # 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
|
964 # command to the generated LaTeX files. This will instruct LaTeX to keep |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
965 # running if errors occur, instead of asking the user for help. |
13097 | 966 # This option is also used when generating formulas in HTML. |
967 | |
968 LATEX_BATCHMODE = NO | |
969 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
970 # If LATEX_HIDE_INDICES is set to YES then doxygen will not |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
971 # include the index chapters (such as File Index, Compound Index, etc.) |
13097 | 972 # in the output. |
973 | |
974 LATEX_HIDE_INDICES = NO | |
975 | |
976 #--------------------------------------------------------------------------- | |
977 # configuration options related to the RTF output | |
978 #--------------------------------------------------------------------------- | |
979 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
980 # 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
|
981 # The RTF output is optimized for Word 97 and may not look very pretty with |
13097 | 982 # other RTF readers or editors. |
983 | |
984 GENERATE_RTF = NO | |
985 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
986 # 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
|
987 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
13097 | 988 # put in front of it. If left blank `rtf' will be used as the default path. |
989 | |
990 RTF_OUTPUT = rtf | |
991 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
992 # 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
|
993 # RTF documents. This may be useful for small projects and may help to |
13097 | 994 # save some trees in general. |
995 | |
996 COMPACT_RTF = NO | |
997 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
998 # 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
|
999 # will contain hyperlink fields. The RTF file will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1000 # contain links (just like the HTML output) instead of page references. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1001 # This makes the output suitable for online browsing using WORD or other |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1002 # programs which support those fields. |
13097 | 1003 # Note: wordpad (write) and others do not support links. |
1004 | |
1005 RTF_HYPERLINKS = NO | |
1006 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1007 # Load stylesheet definitions from file. Syntax is similar to doxygen's |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1008 # config file, i.e. a series of assignments. You only have to provide |
13097 | 1009 # replacements, missing definitions are set to their default value. |
1010 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1011 RTF_STYLESHEET_FILE = |
13097 | 1012 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1013 # Set optional variables used in the generation of an rtf document. |
13097 | 1014 # Syntax is similar to doxygen's config file. |
1015 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1016 RTF_EXTENSIONS_FILE = |
13097 | 1017 |
1018 #--------------------------------------------------------------------------- | |
1019 # configuration options related to the man page output | |
1020 #--------------------------------------------------------------------------- | |
1021 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1022 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
13097 | 1023 # generate man pages |
1024 | |
1025 GENERATE_MAN = NO | |
1026 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1027 # 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
|
1028 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
13097 | 1029 # put in front of it. If left blank `man' will be used as the default path. |
1030 | |
1031 MAN_OUTPUT = man | |
1032 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1033 # The MAN_EXTENSION tag determines the extension that is added to |
13097 | 1034 # the generated man pages (default is the subroutine's section .3) |
1035 | |
1036 MAN_EXTENSION = .3 | |
1037 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1038 # 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
|
1039 # then it will generate one additional man file for each entity |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1040 # documented in the real man page(s). These additional files |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1041 # only source the real man page, but without them the man command |
13097 | 1042 # would be unable to find the correct page. The default is NO. |
1043 | |
1044 MAN_LINKS = NO | |
1045 | |
1046 #--------------------------------------------------------------------------- | |
1047 # configuration options related to the XML output | |
1048 #--------------------------------------------------------------------------- | |
1049 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1050 # If the GENERATE_XML tag is set to YES Doxygen will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1051 # generate an XML file that captures the structure of |
13097 | 1052 # the code including all documentation. |
1053 | |
1054 GENERATE_XML = NO | |
1055 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1056 # 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
|
1057 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
13097 | 1058 # put in front of it. If left blank `xml' will be used as the default path. |
1059 | |
1060 XML_OUTPUT = xml | |
1061 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1062 # The XML_SCHEMA tag can be used to specify an XML schema, |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1063 # which can be used by a validating XML parser to check the |
13097 | 1064 # syntax of the XML files. |
1065 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1066 XML_SCHEMA = |
13097 | 1067 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1068 # The XML_DTD tag can be used to specify an XML DTD, |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1069 # which can be used by a validating XML parser to check the |
13097 | 1070 # syntax of the XML files. |
1071 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1072 XML_DTD = |
13097 | 1073 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1074 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1075 # dump the program listings (including syntax highlighting |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1076 # and cross-referencing information) to the XML output. Note that |
13097 | 1077 # enabling this will significantly increase the size of the XML output. |
1078 | |
1079 XML_PROGRAMLISTING = YES | |
1080 | |
1081 #--------------------------------------------------------------------------- | |
1082 # configuration options for the AutoGen Definitions output | |
1083 #--------------------------------------------------------------------------- | |
1084 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1085 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1086 # generate an AutoGen Definitions (see autogen.sf.net) file |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1087 # that captures the structure of the code including all |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1088 # documentation. Note that this feature is still experimental |
13097 | 1089 # and incomplete at the moment. |
1090 | |
1091 GENERATE_AUTOGEN_DEF = NO | |
1092 | |
1093 #--------------------------------------------------------------------------- | |
1094 # configuration options related to the Perl module output | |
1095 #--------------------------------------------------------------------------- | |
1096 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1097 # If the GENERATE_PERLMOD tag is set to YES Doxygen will |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1098 # generate a Perl module file that captures the structure of |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1099 # the code including all documentation. Note that this |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1100 # feature is still experimental and incomplete at the |
13097 | 1101 # moment. |
1102 | |
1103 GENERATE_PERLMOD = NO | |
1104 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1105 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1106 # the necessary Makefile rules, Perl scripts and LaTeX code to be able |
13097 | 1107 # to generate PDF and DVI output from the Perl module output. |
1108 | |
1109 PERLMOD_LATEX = NO | |
1110 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1111 # 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
|
1112 # 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
|
1113 # 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
|
1114 # tag is set to NO the size of the Perl module output will be much smaller |
13097 | 1115 # and Perl will parse it just the same. |
1116 | |
1117 PERLMOD_PRETTY = YES | |
1118 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1119 # The names of the make variables in the generated doxyrules.make file |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1120 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1121 # This is useful so different doxyrules.make files included by the same |
13097 | 1122 # Makefile don't overwrite each other's variables. |
1123 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1124 PERLMOD_MAKEVAR_PREFIX = |
13097 | 1125 |
1126 #--------------------------------------------------------------------------- | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1127 # Configuration options related to the preprocessor |
13097 | 1128 #--------------------------------------------------------------------------- |
1129 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1130 # 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
|
1131 # evaluate all C-preprocessor directives found in the sources and include |
13097 | 1132 # files. |
1133 | |
1134 ENABLE_PREPROCESSING = YES | |
1135 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1136 # 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
|
1137 # 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
|
1138 # compilation will be performed. Macro expansion can be done in a controlled |
13097 | 1139 # way by setting EXPAND_ONLY_PREDEF to YES. |
1140 | |
1141 MACRO_EXPANSION = NO | |
1142 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1143 # 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
|
1144 # then the macro expansion is limited to the macros specified with the |
33273 | 1145 # PREDEFINED and EXPAND_AS_DEFINED tags. |
13097 | 1146 |
1147 EXPAND_ONLY_PREDEF = NO | |
1148 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1149 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
13097 | 1150 # in the INCLUDE_PATH (see below) will be search if a #include is found. |
1151 | |
1152 SEARCH_INCLUDES = YES | |
1153 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1154 # 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
|
1155 # contain include files that are not input files but should be processed by |
13097 | 1156 # the preprocessor. |
1157 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1158 INCLUDE_PATH = |
13097 | 1159 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1160 # 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
|
1161 # 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
|
1162 # directories. If left blank, the patterns specified with FILE_PATTERNS will |
13097 | 1163 # be used. |
1164 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1165 INCLUDE_FILE_PATTERNS = |
13097 | 1166 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1167 # 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
|
1168 # 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
|
1169 # 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
|
1170 # or name=definition (no spaces). If the definition and the = are |
33273 | 1171 # omitted =1 is assumed. To prevent a macro definition from being |
1172 # undefined via #undef or recursively expanded use the := operator | |
1173 # instead of the = operator. | |
13097 | 1174 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1175 PREDEFINED = |
13097 | 1176 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1177 # 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
|
1178 # 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
|
1179 # The macro definition that is found in the sources will be used. |
13097 | 1180 # Use the PREDEFINED tag if you want to use a different macro definition. |
1181 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1182 EXPAND_AS_DEFINED = |
13097 | 1183 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1184 # 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
|
1185 # doxygen's preprocessor will remove all function-like macros that are alone |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1186 # on a line, have an all uppercase name, and do not end with a semicolon. Such |
33273 | 1187 # function macros are typically used for boiler-plate code, and will confuse |
1188 # the parser if not removed. | |
13097 | 1189 |
1190 SKIP_FUNCTION_MACROS = YES | |
1191 | |
1192 #--------------------------------------------------------------------------- | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1193 # Configuration::additions related to external references |
13097 | 1194 #--------------------------------------------------------------------------- |
1195 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1196 # The TAGFILES option can be used to specify one or more tagfiles. |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1197 # Optionally an initial location of the external documentation |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1198 # 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
|
1199 # this location is as follows: |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1200 # TAGFILES = file1 file2 ... |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1201 # Adding location for the tag files is done as follows: |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1202 # TAGFILES = file1=loc1 "file2 = loc2" ... |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1203 # where "loc1" and "loc2" can be relative or absolute paths or |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1204 # URLs. If a location is present for each tag, the installdox tool |
13097 | 1205 # does not have to be run to correct the links. |
1206 # Note that each tag file must have a unique name | |
1207 # (where the name does NOT include the path) | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1208 # If a tag file is not located in the directory in which doxygen |
13097 | 1209 # is run, you must also specify the path to the tagfile here. |
1210 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1211 TAGFILES = |
13097 | 1212 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1213 # When a file name is specified after GENERATE_TAGFILE, doxygen will create |
13097 | 1214 # a tag file that is based on the input files it reads. |
1215 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1216 GENERATE_TAGFILE = |
13097 | 1217 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1218 # 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
|
1219 # in the class index. If set to NO only the inherited external classes |
13097 | 1220 # will be listed. |
1221 | |
1222 ALLEXTERNALS = NO | |
1223 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1224 # 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
|
1225 # in the modules index. If set to NO, only the current project's groups will |
13097 | 1226 # be listed. |
1227 | |
1228 EXTERNAL_GROUPS = YES | |
1229 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1230 # The PERL_PATH should be the absolute path and name of the perl script |
13097 | 1231 # interpreter (i.e. the result of `which perl'). |
1232 | |
1233 PERL_PATH = /usr/bin/perl | |
1234 | |
1235 #--------------------------------------------------------------------------- | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1236 # Configuration options related to the dot tool |
13097 | 1237 #--------------------------------------------------------------------------- |
1238 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1239 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
33273 | 1240 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base |
1241 # or super classes. Setting the tag to NO turns the diagrams off. Note that | |
1242 # this option is superseded by the HAVE_DOT option below. This is only a | |
1243 # fallback. It is recommended to install and use dot, since it yields more | |
1244 # powerful graphs. | |
13097 | 1245 |
1246 CLASS_DIAGRAMS = NO | |
1247 | |
33273 | 1248 # You can define message sequence charts within doxygen comments using the \msc |
1249 # command. Doxygen will then run the mscgen tool (see | |
1250 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the | |
1251 # documentation. The MSCGEN_PATH tag allows you to specify the directory where | |
1252 # the mscgen tool resides. If left empty the tool is assumed to be found in the | |
1253 # default search path. | |
1254 | |
1255 MSCGEN_PATH = | |
1256 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1257 # If set to YES, the inheritance and collaboration graphs will hide |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1258 # inheritance and usage relations if the target is undocumented |
13097 | 1259 # or is not a class. |
1260 | |
1261 HIDE_UNDOC_RELATIONS = YES | |
1262 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1263 # 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
|
1264 # 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
|
1265 # toolkit from AT&T and Lucent Bell Labs. The other options in this section |
13097 | 1266 # have no effect if this option is set to NO (the default) |
1267 | |
1268 HAVE_DOT = NO | |
1269 | |
33273 | 1270 # By default doxygen will write a font called FreeSans.ttf to the output |
1271 # directory and reference it in all dot files that doxygen generates. This | |
1272 # font does not include all possible unicode characters however, so when you need | |
1273 # these (or just want a differently looking font) you can specify the font name | |
1274 # using DOT_FONTNAME. You need need to make sure dot is able to find the font, | |
1275 # which can be done by putting it in a standard location or by setting the | |
1276 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory | |
1277 # containing the font. | |
1278 | |
1279 DOT_FONTNAME = FreeSans | |
1280 | |
1281 # By default doxygen will tell dot to use the output directory to look for the | |
1282 # FreeSans.ttf font (which doxygen will put there itself). If you specify a | |
1283 # different font using DOT_FONTNAME you can set the path where dot | |
1284 # can find it using this tag. | |
1285 | |
1286 DOT_FONTPATH = | |
1287 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1288 # 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
|
1289 # will generate a graph for each documented class showing the direct and |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1290 # indirect inheritance relations. Setting this tag to YES will force the |
13097 | 1291 # the CLASS_DIAGRAMS tag to NO. |
1292 | |
1293 CLASS_GRAPH = YES | |
1294 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1295 # 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
|
1296 # will generate a graph for each documented class showing the direct and |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1297 # indirect implementation dependencies (inheritance, containment, and |
13097 | 1298 # class references variables) of the class with other documented classes. |
1299 | |
1300 COLLABORATION_GRAPH = YES | |
1301 | |
33273 | 1302 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen |
1303 # will generate a graph for groups, showing the direct groups dependencies | |
1304 | |
1305 GROUP_GRAPHS = YES | |
1306 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1307 # 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
|
1308 # collaboration diagrams in a style similar to the OMG's Unified Modeling |
13097 | 1309 # Language. |
1310 | |
1311 UML_LOOK = NO | |
1312 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1313 # If set to YES, the inheritance and collaboration graphs will show the |
13097 | 1314 # relations between templates and their instances. |
1315 | |
1316 TEMPLATE_RELATIONS = NO | |
1317 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1318 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1319 # 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
|
1320 # file showing the direct and indirect include dependencies of the file with |
13097 | 1321 # other documented files. |
1322 | |
1323 INCLUDE_GRAPH = YES | |
1324 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1325 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and |
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1326 # 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
|
1327 # documented header file showing the documented files that directly or |
13097 | 1328 # indirectly include this file. |
1329 | |
1330 INCLUDED_BY_GRAPH = YES | |
1331 | |
33273 | 1332 # If the CALL_GRAPH and HAVE_DOT options are set to YES then |
1333 # doxygen will generate a call dependency graph for every global function | |
1334 # or class method. Note that enabling this option will significantly increase | |
1335 # the time of a run. So in most cases it will be better to enable call graphs | |
1336 # for selected functions only using the \callgraph command. | |
13097 | 1337 |
1338 CALL_GRAPH = NO | |
1339 | |
33273 | 1340 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then |
1341 # doxygen will generate a caller dependency graph for every global function | |
1342 # or class method. Note that enabling this option will significantly increase | |
1343 # the time of a run. So in most cases it will be better to enable caller | |
1344 # graphs for selected functions only using the \callergraph command. | |
1345 | |
1346 CALLER_GRAPH = NO | |
1347 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1348 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
13097 | 1349 # will graphical hierarchy of all classes instead of a textual one. |
1350 | |
1351 GRAPHICAL_HIERARCHY = YES | |
1352 | |
33273 | 1353 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES |
1354 # then doxygen will show the dependencies a directory has on other directories | |
1355 # in a graphical way. The dependency relations are determined by the #include | |
1356 # relations between the files in the directories. | |
1357 | |
1358 DIRECTORY_GRAPH = YES | |
1359 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1360 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
13097 | 1361 # generated by dot. Possible values are png, jpg, or gif |
1362 # If left blank png will be used. | |
1363 | |
1364 DOT_IMAGE_FORMAT = png | |
1365 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1366 # The tag DOT_PATH can be used to specify the path where the dot tool can be |
33273 | 1367 # found. If left blank, it is assumed the dot tool can be found in the path. |
13097 | 1368 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1369 DOT_PATH = |
13097 | 1370 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1371 # 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
|
1372 # contain dot files that are included in the documentation (see the |
13097 | 1373 # \dotfile command). |
1374 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1375 DOTFILE_DIRS = |
13097 | 1376 |
33273 | 1377 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of |
1378 # nodes that will be shown in the graph. If the number of nodes in a graph | |
1379 # becomes larger than this value, doxygen will truncate the graph, which is | |
1380 # visualized by representing a node as a red box. Note that doxygen if the | |
1381 # number of direct children of the root node in a graph is already larger than | |
1382 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note | |
1383 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. | |
13097 | 1384 |
33273 | 1385 DOT_GRAPH_MAX_NODES = 50 |
13097 | 1386 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1387 # 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
|
1388 # graphs generated by dot. A depth value of 3 means that only nodes reachable |
33273 | 1389 # from the root by following a path via at most 3 edges will be shown. Nodes |
1390 # that lay further from the root node will be omitted. Note that setting this | |
1391 # option to 1 or 2 may greatly reduce the computation time needed for large | |
1392 # code bases. Also note that the size of a graph can be further restricted by | |
1393 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. | |
13097 | 1394 |
1395 MAX_DOT_GRAPH_DEPTH = 0 | |
1396 | |
33273 | 1397 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
1398 # background. This is enabled by default, which results in a transparent | |
1399 # background. Warning: Depending on the platform used, enabling this option | |
1400 # may lead to badly anti-aliased labels on the edges of a graph (i.e. they | |
1401 # become hard to read). | |
1402 | |
1403 DOT_TRANSPARENT = YES | |
1404 | |
1405 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output | |
1406 # files in one run (i.e. multiple -o and -T options on the command line). This | |
1407 # makes dot run faster, but since only newer versions of dot (>1.8.10) | |
1408 # support this, this feature is disabled by default. | |
1409 | |
1410 DOT_MULTI_TARGETS = NO | |
1411 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1412 # 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
|
1413 # generate a legend page explaining the meaning of the various boxes and |
13097 | 1414 # arrows in the dot generated graphs. |
1415 | |
1416 GENERATE_LEGEND = YES | |
1417 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1418 # 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
|
1419 # remove the intermediate dot files that are used to generate |
13097 | 1420 # the various graphs. |
1421 | |
1422 DOT_CLEANUP = YES | |
1423 | |
1424 #--------------------------------------------------------------------------- | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1425 # Configuration::additions related to the search engine |
13097 | 1426 #--------------------------------------------------------------------------- |
1427 | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
13097
diff
changeset
|
1428 # The SEARCHENGINE tag specifies whether or not a search engine should be |
13097 | 1429 # used. If set to NO the values of all tags below this one will be ignored. |
1430 | |
1431 SEARCHENGINE = NO |