Doxyfile.in

Mon, 17 Sep 2007 15:05:36 +0000

author
Will Thompson <resiak@pidgin.im>
date
Mon, 17 Sep 2007 15:05:36 +0000
branch
cpw.resiak.disconnectreason
changeset 20429
0e840b026c82
parent 19119
eafe97fbf745
child 19732
f08436883bb1
child 20979
c12847fe6c76
permissions
-rw-r--r--

Remove non-error PurpleDisconnectReasons, and add PURPLE_REASON_OTHER_ERROR
for cases when the exact error is unknown or not in the enum.

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

mercurial