annotate Doxyfile.in @ 21130:4ea59c6e57cd

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