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