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