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