Mercurial > pidgin
annotate Doxyfile.in @ 32796:5ae7e1f36b43
Fix a possible XMPP remote crash
A series of specially crafted file transfer requests can cause clients
to reference invalid memory. The user must have accepted one of the
file transfer requests.
The fix is to correctly cancel and free a SOCKS5 connection attempt so
that it does not trigger an attempt to access invalid memory later.
This was reported to us by Jos«± Valent«żn Guti«±rrez and this patch is
written by Paul Aurich.
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Mon, 07 May 2012 03:16:31 +0000 |
parents | 15c5a40ef7be |
children |
rev | line source |
---|---|
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1 # Doxyfile 1.7.1 |
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 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
17 # This tag specifies the encoding used for all characters in the config file |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
18 # that follow. The default is UTF-8 which is also the encoding used for all |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
20 # iconv built into libc) for the transcoding. See |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
21 # http://www.gnu.org/software/libiconv for the list of possible encodings. |
21445
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 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
4554 | 26 # by quotes) that should identify the project. |
27 | |
28 PROJECT_NAME = @PACKAGE@ | |
29 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
31 # This could be handy for archiving the generated documentation or |
4554 | 32 # if some version control system is used. |
33 | |
34 PROJECT_NUMBER = @VERSION@ | |
35 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
37 # base path where the generated documentation will be put. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
38 # If a relative path is entered, it will be relative to the location |
4554 | 39 # where doxygen was started. If left blank the current directory will be used. |
40 | |
41 OUTPUT_DIRECTORY = doc | |
42 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
44 # 4096 sub-directories (in 2 levels) under the output directory of each output |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
45 # format and will distribute the generated files over these directories. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
46 # Enabling this option can be useful when feeding doxygen a huge amount of |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
47 # source files, where putting all generated files in the same directory would |
12800 | 48 # otherwise cause performance problems for the file system. |
49 | |
50 CREATE_SUBDIRS = NO | |
51 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
53 # documentation generated by doxygen is written. Doxygen will use this |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
54 # information to generate all constant output in the proper language. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
55 # The default language is English, other supported languages are: |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
57 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. |
4554 | 62 |
63 OUTPUT_LANGUAGE = English | |
64 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
66 # include brief member descriptions after the members that are listed in |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
67 # the file and class documentation (similar to JavaDoc). |
7806 | 68 # Set to NO to disable this. |
69 | |
70 BRIEF_MEMBER_DESC = YES | |
71 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
73 # the brief description of a member or function before the detailed description. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
7806 | 75 # brief descriptions will be completely suppressed. |
76 | |
77 REPEAT_BRIEF = YES | |
78 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
79 # This tag implements a quasi-intelligent brief description abbreviator |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
80 # that is used to form the text in various listings. Each string |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
81 # in this list, if found as the leading text of the brief description, will be |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
82 # stripped from the text and the result after processing the whole list, is |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
83 # used as the annotated text. Otherwise, the brief description is used as-is. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
84 # If left blank, the following values are used ("$name" is automatically |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
85 # replaced with the name of the entity): "The $name class" "The $name widget" |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
86 # "The $name file" "is" "provides" "specifies" "contains" |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
87 # "represents" "a" "an" "the" |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
88 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
89 ABBREVIATE_BRIEF = |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
90 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
92 # Doxygen will generate a detailed section even if there is only a brief |
7806 | 93 # description. |
94 | |
95 ALWAYS_DETAILED_SEC = NO | |
96 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
98 # inherited members of a class in the documentation of that class as if those |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
99 # members were ordinary class members. Constructors, destructors and assignment |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
100 # operators of the base classes will not be shown. |
7806 | 101 |
102 INLINE_INHERITED_MEMB = NO | |
103 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
105 # path before files name in the file list and in the header files. If set |
7806 | 106 # to NO the shortest path that makes the file name unique will be used. |
107 | |
108 FULL_PATH_NAMES = NO | |
109 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
111 # can be used to strip a user-defined part of the path. Stripping is |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
112 # only done if one of the specified strings matches the left-hand part of |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
113 # the path. The tag can be used to show relative paths in the file list. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
114 # If left blank the directory from which doxygen is run is used as the |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
115 # path to strip. |
7806 | 116 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
117 STRIP_FROM_PATH = |
7806 | 118 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
120 # the path mentioned in the documentation of a class, which tells |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
121 # the reader which header file to include in order to use a class. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
122 # If left blank only the name of the header file containing the class |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
123 # definition is used. Otherwise one should specify the include paths that |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
124 # 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
|
125 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
126 STRIP_FROM_INC_PATH = |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
127 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
129 # (but less readable) file names. This can be useful is your file systems |
7806 | 130 # doesn't support long names like on DOS, Mac, or CD-ROM. |
131 | |
132 SHORT_NAMES = NO | |
133 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
135 # will interpret the first line (until the first dot) of a JavaDoc-style |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
136 # comment as the brief description. If set to NO, the JavaDoc |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
137 # comments will behave just like regular Qt-style comments |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
138 # (thus requiring an explicit @brief command for a brief description.) |
7806 | 139 |
140 JAVADOC_AUTOBRIEF = YES | |
141 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
143 # interpret the first line (until the first dot) of a Qt-style |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
144 # comment as the brief description. If set to NO, the comments |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
145 # will behave just like regular Qt-style comments (thus requiring |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
146 # 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
|
147 |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
148 QT_AUTOBRIEF = NO |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
149 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
151 # treat a multi-line C++ special comment block (i.e. a block of //! or /// |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
152 # comments) as a brief description. This used to be the default behaviour. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
153 # The new default is to treat a multi-line C++ comment block as a detailed |
7806 | 154 # description. Set this tag to YES if you prefer the old behaviour instead. |
155 | |
156 MULTILINE_CPP_IS_BRIEF = NO | |
157 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
159 # 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
|
160 # re-implements. |
7806 | 161 |
162 INHERIT_DOCS = YES | |
163 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
164 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
165 # a new page for each member. If set to NO, the documentation of a member will |
12800 | 166 # be part of the file/class/namespace that contains it. |
167 | |
168 SEPARATE_MEMBER_PAGES = NO | |
169 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
170 # The TAB_SIZE tag can be used to set the number of spaces in a tab. |
7806 | 171 # Doxygen uses this value to replace tabs by spaces in code fragments. |
172 | |
173 TAB_SIZE = 4 | |
174 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
175 # This tag can be used to specify a number of aliases that acts |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
176 # as commands in the documentation. An alias has the form "name=value". |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
177 # For example adding "sideeffect=\par Side Effects:\n" will allow you to |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
178 # put the command \sideeffect (or @sideeffect) in the documentation, which |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
179 # will result in a user-defined paragraph with heading "Side Effects:". |
7806 | 180 # You can put \n's in the value part of an alias to insert newlines. |
181 | |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
182 ALIASES = "signal=- @ref " \ |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
183 "signaldef=@section " \ |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
184 "endsignaldef= " \ |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
185 "signalproto=@code " \ |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
186 "endsignalproto=@endcode " \ |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
187 "signaldesc=@par Description: " \ |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
188 "signals=@b Signals: " \ |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
189 "endsignals= " \ |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
190 "constreturn=@note The return value of this function must not be modified or freed. @return " |
7806 | 191 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
192 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
193 # sources only. Doxygen will then generate output that is more tailored for C. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
194 # For instance, some of the names that are used will be different. The list |
7806 | 195 # of all members will be omitted, etc. |
196 | |
197 OPTIMIZE_OUTPUT_FOR_C = YES | |
198 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
199 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
200 # sources only. Doxygen will then generate output that is more tailored for |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
201 # Java. For instance, namespaces will be presented as packages, qualified |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
202 # scopes will look different, etc. |
7806 | 203 |
204 OPTIMIZE_OUTPUT_JAVA = NO | |
205 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
206 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
207 # sources only. Doxygen will then generate output that is more tailored for |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
208 # Fortran. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
209 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
210 OPTIMIZE_FOR_FORTRAN = NO |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
211 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
212 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
213 # sources. Doxygen will then generate output that is tailored for |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
214 # VHDL. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
215 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
216 OPTIMIZE_OUTPUT_VHDL = NO |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
217 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
218 # Doxygen selects the parser to use depending on the extension of the files it |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
219 # parses. With this tag you can assign which parser to use for a given extension. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
220 # Doxygen has a built-in mapping, but you can override or extend it using this |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
221 # tag. The format is ext=language, where ext is a file extension, and language |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
222 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
223 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
224 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
225 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
226 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
227 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
228 EXTENSION_MAPPING = |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
229 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
230 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
231 # to include (a tag file for) the STL sources as input, then you should |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
232 # set this tag to YES in order to let doxygen match functions declarations and |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
233 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
234 # func(std::string) {}). This also make the inheritance and collaboration |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
235 # 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
|
236 |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
237 BUILTIN_STL_SUPPORT = NO |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
238 |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
239 # 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
|
240 # enable parsing support. |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
241 |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
242 CPP_CLI_SUPPORT = NO |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
243 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
244 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
245 # Doxygen will parse them like normal C++ but will assume all classes use public |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
246 # instead of private inheritance when no explicit protection keyword is present. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
247 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
248 SIP_SUPPORT = NO |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
249 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
250 # For Microsoft's IDL there are propget and propput attributes to indicate getter |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
251 # and setter methods for a property. Setting this option to YES (the default) |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
252 # will make doxygen to replace the get and set methods by a property in the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
253 # documentation. This will only work if the methods are indeed getting or |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
254 # setting a simple type. If this is not the case, or you want to show the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
255 # methods anyway, you should set this option to NO. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
256 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
257 IDL_PROPERTY_SUPPORT = YES |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
258 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
259 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
260 # tag is set to YES, then doxygen will reuse the documentation of the first |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
261 # member in the group (if any) for the other members of the group. By default |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
262 # 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
|
263 |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
264 DISTRIBUTE_GROUP_DOC = NO |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
265 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
266 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
267 # the same type (for instance a group of public functions) to be put as a |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
268 # subgroup of that type (e.g. under the Public Functions section). Set it to |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
269 # NO to prevent subgrouping. Alternatively, this can be done per class using |
7806 | 270 # the \nosubgrouping command. |
271 | |
272 SUBGROUPING = YES | |
273 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
274 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
275 # is documented as struct, union, or enum with the name of the typedef. So |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
276 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
277 # with name TypeT. When disabled the typedef will appear as a member of a file, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
278 # namespace, or class. And the struct will be named TypeS. This can typically |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
279 # be useful for C code in case the coding convention dictates that all compound |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
280 # types are typedef'ed and only the typedef is referenced, never the tag name. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
281 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
282 TYPEDEF_HIDES_STRUCT = NO |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
283 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
284 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
285 # determine which symbols to keep in memory and which to flush to disk. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
286 # When the cache is full, less often used symbols will be written to disk. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
287 # For small to medium size projects (<1000 input files) the default value is |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
288 # probably good enough. For larger projects a too small cache size can cause |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
289 # doxygen to be busy swapping symbols to and from disk most of the time |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
290 # causing a significant performance penality. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
291 # If the system has enough physical memory increasing the cache will improve the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
292 # performance by keeping more symbols in memory. Note that the value works on |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
293 # a logarithmic scale so increasing the size by one will rougly double the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
294 # memory usage. The cache size is given by this formula: |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
295 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
296 # corresponding to a cache size of 2^16 = 65536 symbols |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
297 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
298 SYMBOL_CACHE_SIZE = 0 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
299 |
7806 | 300 #--------------------------------------------------------------------------- |
301 # Build related configuration options | |
302 #--------------------------------------------------------------------------- | |
303 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
304 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
305 # documentation are documented, even if no documentation was available. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
306 # Private class members and static file members will be hidden unless |
4554 | 307 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
308 | |
309 EXTRACT_ALL = NO | |
310 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
311 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
4554 | 312 # will be included in the documentation. |
313 | |
314 EXTRACT_PRIVATE = NO | |
315 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
316 # If the EXTRACT_STATIC tag is set to YES all static members of a file |
4554 | 317 # will be included in the documentation. |
318 | |
319 EXTRACT_STATIC = NO | |
320 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
321 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
322 # defined locally in source files will be included in the documentation. |
4554 | 323 # If set to NO only classes defined in header files are included. |
324 | |
325 EXTRACT_LOCAL_CLASSES = YES | |
326 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
327 # This flag is only useful for Objective-C code. When set to YES local |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
328 # methods, which are defined in the implementation section but not in |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
329 # the interface are included in the documentation. |
12800 | 330 # If set to NO (the default) only methods in the interface are included. |
331 | |
332 EXTRACT_LOCAL_METHODS = YES | |
333 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
334 # If this flag is set to YES, the members of anonymous namespaces will be |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
335 # extracted and appear in the documentation as a namespace called |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
336 # 'anonymous_namespace{file}', where file will be replaced with the base |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
337 # name of the file that contains the anonymous namespace. By default |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
338 # anonymous namespace are hidden. |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
339 |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
340 EXTRACT_ANON_NSPACES = NO |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
341 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
342 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
343 # undocumented members of documented classes, files or namespaces. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
344 # If set to NO (the default) these members will be included in the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
345 # various overviews, but no documentation section is generated. |
4554 | 346 # This option has no effect if EXTRACT_ALL is enabled. |
347 | |
348 HIDE_UNDOC_MEMBERS = NO | |
349 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
350 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
351 # undocumented classes that are normally visible in the class hierarchy. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
352 # If set to NO (the default) these classes will be included in the various |
4554 | 353 # overviews. This option has no effect if EXTRACT_ALL is enabled. |
354 | |
355 HIDE_UNDOC_CLASSES = NO | |
356 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
357 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
358 # friend (class|struct|union) declarations. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
359 # If set to NO (the default) these declarations will be included in the |
4554 | 360 # documentation. |
361 | |
362 HIDE_FRIEND_COMPOUNDS = NO | |
363 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
364 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
365 # documentation blocks found inside the body of a function. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
366 # If set to NO (the default) these blocks will be appended to the |
6317
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
367 # function's detailed documentation block. |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
368 |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
369 HIDE_IN_BODY_DOCS = NO |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
370 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
371 # The INTERNAL_DOCS tag determines if documentation |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
372 # that is typed after a \internal command is included. If the tag is set |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
373 # to NO (the default) then the documentation will be excluded. |
4554 | 374 # Set it to YES to include the internal documentation. |
375 | |
376 INTERNAL_DOCS = NO | |
377 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
378 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
379 # file names in lower-case letters. If set to YES upper-case letters are also |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
380 # allowed. This is useful if you have classes or files whose names only differ |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
381 # 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
|
382 # and Mac users are advised to set this option to NO. |
4554 | 383 |
384 CASE_SENSE_NAMES = YES | |
385 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
386 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
387 # will show members with their full class and namespace scopes in the |
4554 | 388 # documentation. If set to YES the scope will be hidden. |
389 | |
390 HIDE_SCOPE_NAMES = NO | |
391 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
392 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
393 # will put a list of the files that are included by a file in the documentation |
4554 | 394 # of that file. |
395 | |
396 SHOW_INCLUDE_FILES = YES | |
397 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
398 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
399 # will list include files with double quotes in the documentation |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
400 # rather than with sharp brackets. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
401 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
402 FORCE_LOCAL_INCLUDES = NO |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
403 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
404 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
4554 | 405 # is inserted in the documentation for inline members. |
406 | |
407 INLINE_INFO = YES | |
408 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
409 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
410 # will sort the (detailed) documentation of file and class members |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
411 # alphabetically by member name. If set to NO the members will appear in |
4554 | 412 # declaration order. |
413 | |
414 SORT_MEMBER_DOCS = YES | |
415 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
416 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
417 # brief documentation of file, namespace and class members alphabetically |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
418 # by member name. If set to NO (the default) the members will appear in |
12800 | 419 # declaration order. |
420 | |
18824
8e09a0c971b9
Disable sorting brief Doxygen documentation. This means that lists of
Will Thompson <will.thompson@collabora.co.uk>
parents:
18303
diff
changeset
|
421 SORT_BRIEF_DOCS = NO |
12800 | 422 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
423 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
424 # will sort the (brief and detailed) documentation of class members so that |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
425 # constructors and destructors are listed first. If set to NO (the default) |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
426 # the constructors will appear in the respective orders defined by |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
427 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
428 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
429 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
430 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
431 SORT_MEMBERS_CTORS_1ST = NO |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
432 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
433 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
434 # hierarchy of group names into alphabetical order. If set to NO (the default) |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
435 # the group names will appear in their defined order. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
436 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
437 SORT_GROUP_NAMES = NO |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
438 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
439 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
440 # sorted by fully-qualified names, including namespaces. If set to |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
441 # NO (the default), the class list will be sorted only by class name, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
442 # not including the namespace part. |
12800 | 443 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
444 # Note: This option applies only to the class list, not to the |
12800 | 445 # alphabetical list. |
446 | |
447 SORT_BY_SCOPE_NAME = YES | |
448 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
449 # The GENERATE_TODOLIST tag can be used to enable (YES) or |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
450 # disable (NO) the todo list. This list is created by putting \todo |
4554 | 451 # commands in the documentation. |
452 | |
453 GENERATE_TODOLIST = YES | |
454 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
455 # The GENERATE_TESTLIST tag can be used to enable (YES) or |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
456 # disable (NO) the test list. This list is created by putting \test |
4554 | 457 # commands in the documentation. |
458 | |
459 GENERATE_TESTLIST = YES | |
460 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
461 # The GENERATE_BUGLIST tag can be used to enable (YES) or |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
462 # disable (NO) the bug list. This list is created by putting \bug |
4554 | 463 # commands in the documentation. |
464 | |
465 GENERATE_BUGLIST = YES | |
466 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
467 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
468 # disable (NO) the deprecated list. This list is created by putting |
6317
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
469 # \deprecated commands in the documentation. |
4554 | 470 |
471 GENERATE_DEPRECATEDLIST= YES | |
472 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
473 # The ENABLED_SECTIONS tag can be used to enable conditional |
4554 | 474 # documentation sections, marked by \if sectionname ... \endif. |
475 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
476 ENABLED_SECTIONS = |
4554 | 477 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
478 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
479 # the initial value of a variable or define consists of for it to appear in |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
480 # the documentation. If the initializer consists of more lines than specified |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
481 # here it will be hidden. Use a value of 0 to hide initializers completely. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
482 # The appearance of the initializer of individual variables and defines in the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
483 # documentation can be controlled using \showinitializer or \hideinitializer |
4554 | 484 # command in the documentation regardless of this setting. |
485 | |
486 MAX_INITIALIZER_LINES = 30 | |
487 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
488 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
489 # at the bottom of the documentation of classes and structs. If set to YES the |
4554 | 490 # list will mention the files that were used to generate the documentation. |
491 | |
492 SHOW_USED_FILES = YES | |
493 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
494 # If the sources in your project are distributed over multiple directories |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
495 # 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
|
496 # in the documentation. The default is NO. |
12800 | 497 |
498 SHOW_DIRECTORIES = YES | |
499 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
500 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
501 # This will remove the Files entry from the Quick Index and from the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
502 # Folder Tree View (if specified). The default is YES. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
503 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
504 SHOW_FILES = YES |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
505 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
506 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
507 # Namespaces page. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
508 # This will remove the Namespaces entry from the Quick Index |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
509 # and from the Folder Tree View (if specified). The default is YES. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
510 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
511 SHOW_NAMESPACES = YES |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
512 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
513 # The FILE_VERSION_FILTER tag can be used to specify a program or script that |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
514 # doxygen should invoke to get the current version for each file (typically from |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
515 # the version control system). Doxygen will invoke the program by executing (via |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
516 # popen()) the command <command> <input-file>, where <command> is the value of |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
517 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
518 # provided by doxygen. Whatever the program writes to standard output |
12800 | 519 # is used as the file version. See the manual for examples. |
520 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
521 FILE_VERSION_FILTER = |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
522 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
523 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
524 # by doxygen. The layout file controls the global structure of the generated |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
525 # output files in an output format independent way. The create the layout file |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
526 # that represents doxygen's defaults, run doxygen with the -l option. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
527 # You can optionally specify a file name after the option, if omitted |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
528 # DoxygenLayout.xml will be used as the name of the layout file. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
529 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
530 LAYOUT_FILE = |
12800 | 531 |
4554 | 532 #--------------------------------------------------------------------------- |
533 # configuration options related to warning and progress messages | |
534 #--------------------------------------------------------------------------- | |
535 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
536 # The QUIET tag can be used to turn on/off the messages that are generated |
4554 | 537 # by doxygen. Possible values are YES and NO. If left blank NO is used. |
538 | |
539 QUIET = NO | |
540 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
541 # The WARNINGS tag can be used to turn on/off the warning messages that are |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
542 # generated by doxygen. Possible values are YES and NO. If left blank |
4554 | 543 # NO is used. |
544 | |
545 WARNINGS = YES | |
546 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
547 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
548 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will |
4554 | 549 # automatically be disabled. |
550 | |
551 WARN_IF_UNDOCUMENTED = NO | |
552 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
553 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
554 # potential errors in the documentation, such as not documenting some |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
555 # parameters in a documented function, or documenting parameters that |
6317
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
556 # don't exist or using markup commands wrongly. |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
557 |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
558 WARN_IF_DOC_ERROR = YES |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
559 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
560 # This WARN_NO_PARAMDOC option can be abled to get warnings for |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
561 # functions that are documented, but have no documentation for their parameters |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
562 # or return value. If set to NO (the default) doxygen will only warn about |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
563 # wrong or incomplete parameter documentation, but not about the absence of |
12800 | 564 # documentation. |
565 | |
566 WARN_NO_PARAMDOC = YES | |
567 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
568 # The WARN_FORMAT tag determines the format of the warning messages that |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
569 # doxygen can produce. The string should contain the $file, $line, and $text |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
570 # tags, which will be replaced by the file and line number from which the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
571 # warning originated and the warning text. Optionally the format may contain |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
572 # $version, which will be replaced by the version of the file (if it could |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
573 # be obtained via FILE_VERSION_FILTER) |
4554 | 574 |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
575 WARN_FORMAT = "$file:$line: $text " |
4554 | 576 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
577 # The WARN_LOGFILE tag can be used to specify a file to which warning |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
578 # and error messages should be written. If left blank the output is written |
4554 | 579 # to stderr. |
580 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
581 WARN_LOGFILE = |
4554 | 582 |
583 #--------------------------------------------------------------------------- | |
584 # configuration options related to the input files | |
585 #--------------------------------------------------------------------------- | |
586 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
587 # The INPUT tag can be used to specify the files and/or directories that contain |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
588 # documented source files. You may enter file names like "myfile.cpp" or |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
589 # directories like "/usr/src/myproject". Separate the files or directories |
4554 | 590 # with spaces. |
591 | |
23163
1db2bc34ea61
Fix 'make docs' when builddir is not the same as srcdir.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21456
diff
changeset
|
592 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
|
593 @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
|
594 @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
|
595 @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
|
596 @top_srcdir@/doc |
4554 | 597 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
598 # This tag can be used to specify the character encoding of the source files |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
599 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
600 # also the default input encoding. Doxygen uses libiconv (or the iconv built |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
601 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
602 # the list of possible encodings. |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
603 |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
604 INPUT_ENCODING = UTF-8 |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
605 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
606 # If the value of the INPUT tag contains directories, you can use the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
607 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
608 # and *.h) to filter out the source-files in the directories. If left |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
609 # blank the following patterns are tested: |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
610 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
611 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 |
4554 | 612 |
7806 | 613 FILE_PATTERNS = *.h \ |
614 *.dox | |
4554 | 615 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
616 # The RECURSIVE tag can be used to turn specify whether or not subdirectories |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
617 # should be searched for input files as well. Possible values are YES and NO. |
4554 | 618 # If left blank NO is used. |
619 | |
620 RECURSIVE = NO | |
621 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
622 # The EXCLUDE tag can be used to specify files and/or directories that should |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
623 # excluded from the INPUT source files. This way you can easily exclude a |
4554 | 624 # subdirectory from a directory tree whose root is specified with the INPUT tag. |
625 | |
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
|
626 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
|
627 libpurple/purple-client-bindings.h |
4554 | 628 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
629 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
630 # directories that are symbolic links (a Unix filesystem feature) are excluded |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
631 # from the input. |
4554 | 632 |
633 EXCLUDE_SYMLINKS = NO | |
634 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
635 # If the value of the INPUT tag contains directories, you can use the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
636 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
637 # certain files from those directories. Note that the wildcards are matched |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
638 # against the file with absolute path, so to exclude all test directories |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
639 # for example use the pattern */test/* |
4554 | 640 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
641 EXCLUDE_PATTERNS = |
4554 | 642 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
643 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
644 # (namespaces, classes, functions, etc.) that should be excluded from the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
645 # output. The symbol name can be a fully qualified name, a word, or if the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
646 # wildcard * is used, a substring. Examples: ANamespace, AClass, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
647 # AClass::ANamespace, ANamespace::*Test |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
648 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
649 EXCLUDE_SYMBOLS = |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
650 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
651 # The EXAMPLE_PATH tag can be used to specify one or more files or |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
652 # directories that contain example code fragments that are included (see |
4554 | 653 # the \include command). |
654 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
655 EXAMPLE_PATH = |
4554 | 656 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
657 # If the value of the EXAMPLE_PATH tag contains directories, you can use the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
658 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
659 # and *.h) to filter out the source-files in the directories. If left |
4554 | 660 # blank all files are included. |
661 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
662 EXAMPLE_PATTERNS = |
4554 | 663 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
664 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
665 # searched for input files to be used with the \include or \dontinclude |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
666 # commands irrespective of the value of the RECURSIVE tag. |
4554 | 667 # Possible values are YES and NO. If left blank NO is used. |
668 | |
669 EXAMPLE_RECURSIVE = NO | |
670 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
671 # The IMAGE_PATH tag can be used to specify one or more files or |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
672 # directories that contain image that are included in the documentation (see |
4554 | 673 # the \image command). |
674 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
675 IMAGE_PATH = |
4554 | 676 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
677 # The INPUT_FILTER tag can be used to specify a program that doxygen should |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
678 # invoke to filter for each input file. Doxygen will invoke the filter program |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
679 # by executing (via popen()) the command <filter> <input-file>, where <filter> |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
680 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
681 # input file. Doxygen will then use the output that the filter program writes |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
682 # to standard output. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
683 # If FILTER_PATTERNS is specified, this tag will be |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
684 # ignored. |
4554 | 685 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
686 INPUT_FILTER = |
4554 | 687 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
688 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
689 # basis. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
690 # Doxygen will compare the file name with each pattern and apply the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
691 # filter if there is a match. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
692 # The filters are a list of the form: |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
693 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
694 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER |
12800 | 695 # is applied to all files. |
696 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
697 FILTER_PATTERNS = |
12800 | 698 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
699 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
700 # INPUT_FILTER) will be used to filter the input files when producing source |
4554 | 701 # files to browse (i.e. when SOURCE_BROWSER is set to YES). |
702 | |
703 FILTER_SOURCE_FILES = NO | |
704 | |
705 #--------------------------------------------------------------------------- | |
706 # configuration options related to source browsing | |
707 #--------------------------------------------------------------------------- | |
708 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
709 # If the SOURCE_BROWSER tag is set to YES then a list of source files will |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
710 # be generated. Documented entities will be cross-referenced with these sources. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
711 # Note: To get rid of all source code in the generated output, make sure also |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
712 # VERBATIM_HEADERS is set to NO. |
4554 | 713 |
21456
cc0df68f6fa9
Fix a warning from make docs:
Mark Doliner <mark@kingant.net>
parents:
21445
diff
changeset
|
714 SOURCE_BROWSER = YES |
4554 | 715 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
716 # Setting the INLINE_SOURCES tag to YES will include the body |
4554 | 717 # of functions and classes directly in the documentation. |
718 | |
719 INLINE_SOURCES = NO | |
720 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
721 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
722 # doxygen to hide any special comment blocks from generated source code |
4554 | 723 # fragments. Normal C and C++ comments will always remain visible. |
724 | |
725 STRIP_CODE_COMMENTS = YES | |
726 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
727 # If the REFERENCED_BY_RELATION tag is set to YES |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
728 # then for each documented function all documented |
4554 | 729 # functions referencing it will be listed. |
730 | |
731 REFERENCED_BY_RELATION = YES | |
732 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
733 # If the REFERENCES_RELATION tag is set to YES |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
734 # then for each documented function all documented entities |
4554 | 735 # called/used by that function will be listed. |
736 | |
737 REFERENCES_RELATION = YES | |
738 | |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
739 # 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
|
740 # 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
|
741 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
742 # link to the source code. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
743 # Otherwise they will link to the documentation. |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
744 |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
745 REFERENCES_LINK_SOURCE = YES |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
746 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
747 # If the USE_HTAGS tag is set to YES then the references to source code |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
748 # will point to the HTML generated by the htags(1) tool instead of doxygen |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
749 # built-in source browser. The htags tool is part of GNU's global source |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
750 # tagging system (see http://www.gnu.org/software/global/global.html). You |
12800 | 751 # will need version 4.8.6 or higher. |
752 | |
753 USE_HTAGS = NO | |
754 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
755 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
756 # will generate a verbatim copy of the header file for each class for |
6317
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
757 # which an include is specified. Set to NO to disable this. |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
758 |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
759 VERBATIM_HEADERS = YES |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
760 |
4554 | 761 #--------------------------------------------------------------------------- |
762 # configuration options related to the alphabetical class index | |
763 #--------------------------------------------------------------------------- | |
764 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
765 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
766 # of all compounds will be generated. Enable this if the project |
4554 | 767 # contains a lot of classes, structs, unions or interfaces. |
768 | |
7336
ef6a33dcd0dd
[gaim-migrate @ 7924]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
769 ALPHABETICAL_INDEX = YES |
4554 | 770 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
771 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
772 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns |
4554 | 773 # in which this list will be split (can be a number in the range [1..20]) |
774 | |
7337
32800d26dc68
[gaim-migrate @ 7925]
Christian Hammond <chipx86@chipx86.com>
parents:
7336
diff
changeset
|
775 COLS_IN_ALPHA_INDEX = 3 |
4554 | 776 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
777 # In case all classes in a project start with a common prefix, all |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
778 # classes will be put under the same header in the alphabetical index. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
779 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that |
4554 | 780 # should be ignored while generating the index headers. |
781 | |
15933
b449dc6b8a20
A little doxygen love and some tiny gaim->purpleisms
Mark Doliner <mark@kingant.net>
parents:
14553
diff
changeset
|
782 IGNORE_PREFIX = Purple \ |
b449dc6b8a20
A little doxygen love and some tiny gaim->purpleisms
Mark Doliner <mark@kingant.net>
parents:
14553
diff
changeset
|
783 _Purple \ |
b449dc6b8a20
A little doxygen love and some tiny gaim->purpleisms
Mark Doliner <mark@kingant.net>
parents:
14553
diff
changeset
|
784 purple |
4554 | 785 |
786 #--------------------------------------------------------------------------- | |
787 # configuration options related to the HTML output | |
788 #--------------------------------------------------------------------------- | |
789 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
790 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
4554 | 791 # generate HTML output. |
792 | |
793 GENERATE_HTML = YES | |
794 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
795 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
796 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
4554 | 797 # put in front of it. If left blank `html' will be used as the default path. |
798 | |
799 HTML_OUTPUT = html | |
800 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
801 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
802 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank |
4554 | 803 # doxygen will generate files with .html extension. |
804 | |
805 HTML_FILE_EXTENSION = .html | |
806 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
807 # The HTML_HEADER tag can be used to specify a personal HTML header for |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
808 # each generated HTML page. If it is left blank doxygen will generate a |
4554 | 809 # standard header. |
810 | |
16257
b20fa7ebb911
Ari sent in a patch, saying:
Richard Laager <rlaager@wiktel.com>
parents:
16048
diff
changeset
|
811 HTML_HEADER = @top_srcdir@/doc/TracHeader.html |
4554 | 812 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
813 # The HTML_FOOTER tag can be used to specify a personal HTML footer for |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
814 # each generated HTML page. If it is left blank doxygen will generate a |
4554 | 815 # standard footer. |
816 | |
16257
b20fa7ebb911
Ari sent in a patch, saying:
Richard Laager <rlaager@wiktel.com>
parents:
16048
diff
changeset
|
817 HTML_FOOTER = @top_srcdir@/doc/TracFooter.html |
4554 | 818 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
819 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
820 # style sheet that is used by each HTML page. It can be used to |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
821 # fine-tune the look of the HTML output. If the tag is left blank doxygen |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
822 # will generate a default style sheet. Note that doxygen will try to copy |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
823 # the style sheet file to the HTML output directory, so don't put your own |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
824 # stylesheet in the HTML output directory as well, or it will be erased! |
4554 | 825 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
826 HTML_STYLESHEET = |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
827 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
828 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
829 # Doxygen will adjust the colors in the stylesheet and background images |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
830 # according to this color. Hue is specified as an angle on a colorwheel, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
831 # see http://en.wikipedia.org/wiki/Hue for more information. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
832 # For instance the value 0 represents red, 60 is yellow, 120 is green, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
833 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
834 # The allowed range is 0 to 359. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
835 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
836 HTML_COLORSTYLE_HUE = 220 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
837 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
838 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
839 # the colors in the HTML output. For a value of 0 the output will use |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
840 # grayscales only. A value of 255 will produce the most vivid colors. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
841 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
842 HTML_COLORSTYLE_SAT = 100 |
4554 | 843 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
844 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
845 # the luminance component of the colors in the HTML output. Values below |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
846 # 100 gradually make the output lighter, whereas values above 100 make |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
847 # the output darker. The value divided by 100 is the actual gamma applied, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
848 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
849 # and 100 does not change the gamma. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
850 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
851 HTML_COLORSTYLE_GAMMA = 80 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
852 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
853 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
854 # page will contain the date and time when the page was generated. Setting |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
855 # this to NO can help when comparing the output of multiple runs. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
856 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
857 HTML_TIMESTAMP = YES |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
858 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
859 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
860 # files or namespaces will be aligned in HTML using tables. If set to |
4554 | 861 # NO a bullet list will be used. |
862 | |
863 HTML_ALIGN_MEMBERS = YES | |
864 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
865 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
866 # documentation will contain sections that can be hidden and shown after the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
867 # page has loaded. For this to work a browser that supports |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
868 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
869 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
870 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
871 HTML_DYNAMIC_SECTIONS = NO |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
872 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
873 # If the GENERATE_DOCSET tag is set to YES, additional index files |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
874 # will be generated that can be used as input for Apple's Xcode 3 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
875 # integrated development environment, introduced with OSX 10.5 (Leopard). |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
876 # To create a documentation set, doxygen will generate a Makefile in the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
877 # HTML output directory. Running make will produce the docset in that |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
878 # directory and running "make install" will install the docset in |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
879 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
880 # it at startup. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
881 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
882 # for more information. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
883 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
884 GENERATE_DOCSET = NO |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
885 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
886 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
887 # feed. A documentation feed provides an umbrella under which multiple |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
888 # documentation sets from a single provider (such as a company or product suite) |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
889 # can be grouped. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
890 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
891 DOCSET_FEEDNAME = "Doxygen generated docs" |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
892 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
893 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
894 # should uniquely identify the documentation set bundle. This should be a |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
895 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
896 # will append .docset to the name. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
897 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
898 DOCSET_BUNDLE_ID = org.doxygen.Project |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
899 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
900 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
901 # the documentation publisher. This should be a reverse domain-name style |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
902 # string, e.g. com.mycompany.MyDocSet.documentation. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
903 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
904 DOCSET_PUBLISHER_ID = org.doxygen.Publisher |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
905 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
906 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
907 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
908 DOCSET_PUBLISHER_NAME = Publisher |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
909 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
910 # If the GENERATE_HTMLHELP tag is set to YES, additional index files |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
911 # will be generated that can be used as input for tools like the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
912 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) |
4554 | 913 # of the generated HTML documentation. |
914 | |
12800 | 915 GENERATE_HTMLHELP = YES |
4554 | 916 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
917 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
918 # be used to specify the file name of the resulting .chm file. You |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
919 # 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
|
920 # written to the html output directory. |
4554 | 921 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
922 CHM_FILE = |
4554 | 923 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
924 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
925 # be used to specify the location (absolute path including file name) of |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
926 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run |
6317
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
927 # the HTML help compiler on the generated index.hhp. |
4554 | 928 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
929 HHC_LOCATION = |
4554 | 930 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
931 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
932 # controls if a separate .chi index file is generated (YES) or that |
4554 | 933 # it should be included in the master .chm file (NO). |
934 | |
935 GENERATE_CHI = NO | |
936 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
937 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
938 # is used to encode HtmlHelp index (hhk), content (hhc) and project file |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
939 # content. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
940 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
941 CHM_INDEX_ENCODING = |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
942 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
943 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
944 # controls whether a binary table of contents is generated (YES) or a |
4554 | 945 # normal table of contents (NO) in the .chm file. |
946 | |
947 BINARY_TOC = NO | |
948 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
949 # 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
|
950 # to the contents of the HTML help documentation and to the tree view. |
4554 | 951 |
12800 | 952 TOC_EXPAND = YES |
4554 | 953 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
954 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
955 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
956 # that can be used as input for Qt's qhelpgenerator to generate a |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
957 # Qt Compressed Help (.qch) of the generated HTML documentation. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
958 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
959 GENERATE_QHP = NO |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
960 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
961 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
962 # be used to specify the file name of the resulting .qch file. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
963 # The path specified is relative to the HTML output folder. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
964 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
965 QCH_FILE = |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
966 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
967 # The QHP_NAMESPACE tag specifies the namespace to use when generating |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
968 # Qt Help Project output. For more information please see |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
969 # http://doc.trolltech.com/qthelpproject.html#namespace |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
970 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
971 QHP_NAMESPACE = org.doxygen.Project |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
972 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
973 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
974 # Qt Help Project output. For more information please see |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
975 # http://doc.trolltech.com/qthelpproject.html#virtual-folders |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
976 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
977 QHP_VIRTUAL_FOLDER = doc |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
978 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
979 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
980 # add. For more information please see |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
981 # http://doc.trolltech.com/qthelpproject.html#custom-filters |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
982 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
983 QHP_CUST_FILTER_NAME = |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
984 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
985 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
986 # custom filter to add. For more information please see |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
987 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
988 # Qt Help Project / Custom Filters</a>. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
989 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
990 QHP_CUST_FILTER_ATTRS = |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
991 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
992 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
993 # project's |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
994 # filter section matches. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
995 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
996 # Qt Help Project / Filter Attributes</a>. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
997 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
998 QHP_SECT_FILTER_ATTRS = |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
999 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1000 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1001 # be used to specify the location of Qt's qhelpgenerator. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1002 # If non-empty doxygen will try to run qhelpgenerator on the generated |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1003 # .qhp file. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1004 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1005 QHG_LOCATION = |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1006 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1007 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1008 # will be generated, which together with the HTML files, form an Eclipse help |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1009 # plugin. To install this plugin and make it available under the help contents |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1010 # menu in Eclipse, the contents of the directory containing the HTML and XML |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1011 # files needs to be copied into the plugins directory of eclipse. The name of |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1012 # the directory within the plugins directory should be the same as |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1013 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1014 # the help appears. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1015 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1016 GENERATE_ECLIPSEHELP = NO |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1017 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1018 # A unique identifier for the eclipse help plugin. When installing the plugin |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1019 # the directory name containing the HTML and XML files should also have |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1020 # this name. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1021 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1022 ECLIPSE_DOC_ID = org.doxygen.Project |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1023 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1024 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1025 # top of each HTML page. The value NO (the default) enables the index and |
4554 | 1026 # the value YES disables it. |
1027 | |
1028 DISABLE_INDEX = NO | |
1029 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1030 # This tag can be used to set the number of enum values (range [1..20]) |
4554 | 1031 # that doxygen will group on one line in the generated HTML documentation. |
1032 | |
1033 ENUM_VALUES_PER_LINE = 4 | |
1034 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1035 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1036 # structure should be generated to display hierarchical information. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1037 # If the tag value is set to YES, a side panel will be generated |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1038 # containing a tree-like index structure (just like the one that |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1039 # is generated for HTML Help). For this to work a browser that supports |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1040 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1041 # Windows users are probably better off using the HTML help feature. |
4554 | 1042 |
12800 | 1043 GENERATE_TREEVIEW = YES |
4554 | 1044 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1045 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1046 # and Class Hierarchy pages using a tree view instead of an ordered list. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1047 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1048 USE_INLINE_TREES = NO |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1049 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1050 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1051 # used to set the initial width (in pixels) of the frame in which the tree |
4554 | 1052 # is shown. |
1053 | |
1054 TREEVIEW_WIDTH = 250 | |
1055 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1056 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1057 # links to external symbols imported via tag files in a separate window. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1058 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1059 EXT_LINKS_IN_WINDOW = NO |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1060 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1061 # Use this tag to change the font size of Latex formulas included |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1062 # as images in the HTML documentation. The default is 10. Note that |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1063 # when you change the font size after a successful doxygen run you need |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1064 # to manually remove any form_*.png images from the HTML output directory |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1065 # to force them to be regenerated. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1066 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1067 FORMULA_FONTSIZE = 10 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1068 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1069 # Use the FORMULA_TRANPARENT tag to determine whether or not the images |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1070 # generated for formulas are transparent PNGs. Transparent PNGs are |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1071 # not supported properly for IE 6.0, but are supported on all modern browsers. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1072 # Note that when changing this option you need to delete any form_*.png files |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1073 # in the HTML output before the changes have effect. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1074 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1075 FORMULA_TRANSPARENT = YES |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1076 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1077 # When the SEARCHENGINE tag is enabled doxygen will generate a search box |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1078 # for the HTML output. The underlying search engine uses javascript |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1079 # and DHTML and should work on any modern browser. Note that when using |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1080 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1081 # (GENERATE_DOCSET) there is already a search function so this one should |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1082 # typically be disabled. For large projects the javascript based search engine |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1083 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1084 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1085 SEARCHENGINE = YES |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1086 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1087 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1088 # implemented using a PHP enabled web server instead of at the web client |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1089 # using Javascript. Doxygen will generate the search PHP script and index |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1090 # file to put on the web server. The advantage of the server |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1091 # based approach is that it scales better to large projects and allows |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1092 # full text search. The disadvances is that it is more difficult to setup |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1093 # and does not have live searching capabilities. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1094 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1095 SERVER_BASED_SEARCH = NO |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1096 |
4554 | 1097 #--------------------------------------------------------------------------- |
1098 # configuration options related to the LaTeX output | |
1099 #--------------------------------------------------------------------------- | |
1100 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1101 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
4554 | 1102 # generate Latex output. |
1103 | |
1104 GENERATE_LATEX = NO | |
1105 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1106 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1107 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
4554 | 1108 # put in front of it. If left blank `latex' will be used as the default path. |
1109 | |
1110 LATEX_OUTPUT = latex | |
1111 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1112 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
6317
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1113 # invoked. If left blank `latex' will be used as the default command name. |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1114 # Note that when enabling USE_PDFLATEX this option is only used for |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1115 # generating bitmaps for formulas in the HTML output, but not in the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1116 # Makefile that is written to the output directory. |
4554 | 1117 |
1118 LATEX_CMD_NAME = latex | |
1119 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1120 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1121 # generate index for LaTeX. If left blank `makeindex' will be used as the |
4554 | 1122 # default command name. |
1123 | |
1124 MAKEINDEX_CMD_NAME = makeindex | |
1125 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1126 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1127 # LaTeX documents. This may be useful for small projects and may help to |
4554 | 1128 # save some trees in general. |
1129 | |
1130 COMPACT_LATEX = NO | |
1131 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1132 # The PAPER_TYPE tag can be used to set the paper type that is used |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1133 # by the printer. Possible values are: a4, a4wide, letter, legal and |
4554 | 1134 # executive. If left blank a4wide will be used. |
1135 | |
1136 PAPER_TYPE = a4wide | |
1137 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1138 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
4554 | 1139 # packages that should be included in the LaTeX output. |
1140 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1141 EXTRA_PACKAGES = |
4554 | 1142 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1143 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1144 # the generated latex document. The header should contain everything until |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1145 # the first chapter. If it is left blank doxygen will generate a |
4554 | 1146 # standard header. Notice: only use this tag if you know what you are doing! |
1147 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1148 LATEX_HEADER = |
4554 | 1149 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1150 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1151 # is prepared for conversion to pdf (using ps2pdf). The pdf file will |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1152 # contain links (just like the HTML output) instead of page references |
4554 | 1153 # This makes the output suitable for online browsing using a pdf viewer. |
1154 | |
1155 PDF_HYPERLINKS = NO | |
1156 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1157 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1158 # plain latex in the generated Makefile. Set this option to YES to get a |
4554 | 1159 # higher quality PDF documentation. |
1160 | |
1161 USE_PDFLATEX = NO | |
1162 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1163 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1164 # command to the generated LaTeX files. This will instruct LaTeX to keep |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1165 # running if errors occur, instead of asking the user for help. |
4554 | 1166 # This option is also used when generating formulas in HTML. |
1167 | |
1168 LATEX_BATCHMODE = NO | |
1169 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1170 # If LATEX_HIDE_INDICES is set to YES then doxygen will not |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1171 # include the index chapters (such as File Index, Compound Index, etc.) |
6317
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1172 # in the output. |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1173 |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1174 LATEX_HIDE_INDICES = NO |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1175 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1176 # If LATEX_SOURCE_CODE is set to YES then doxygen will include |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1177 # source code with syntax highlighting in the LaTeX output. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1178 # Note that which sources are shown also depends on other settings |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1179 # such as SOURCE_BROWSER. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1180 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1181 LATEX_SOURCE_CODE = NO |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1182 |
4554 | 1183 #--------------------------------------------------------------------------- |
1184 # configuration options related to the RTF output | |
1185 #--------------------------------------------------------------------------- | |
1186 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1187 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1188 # The RTF output is optimized for Word 97 and may not look very pretty with |
4554 | 1189 # other RTF readers or editors. |
1190 | |
1191 GENERATE_RTF = NO | |
1192 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1193 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1194 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
4554 | 1195 # put in front of it. If left blank `rtf' will be used as the default path. |
1196 | |
1197 RTF_OUTPUT = rtf | |
1198 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1199 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1200 # RTF documents. This may be useful for small projects and may help to |
4554 | 1201 # save some trees in general. |
1202 | |
1203 COMPACT_RTF = NO | |
1204 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1205 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1206 # will contain hyperlink fields. The RTF file will |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1207 # contain links (just like the HTML output) instead of page references. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1208 # This makes the output suitable for online browsing using WORD or other |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1209 # programs which support those fields. |
4554 | 1210 # Note: wordpad (write) and others do not support links. |
1211 | |
1212 RTF_HYPERLINKS = NO | |
1213 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1214 # Load stylesheet definitions from file. Syntax is similar to doxygen's |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1215 # config file, i.e. a series of assignments. You only have to provide |
4554 | 1216 # replacements, missing definitions are set to their default value. |
1217 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1218 RTF_STYLESHEET_FILE = |
4554 | 1219 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1220 # Set optional variables used in the generation of an rtf document. |
4554 | 1221 # Syntax is similar to doxygen's config file. |
1222 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1223 RTF_EXTENSIONS_FILE = |
4554 | 1224 |
1225 #--------------------------------------------------------------------------- | |
1226 # configuration options related to the man page output | |
1227 #--------------------------------------------------------------------------- | |
1228 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1229 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
4554 | 1230 # generate man pages |
1231 | |
1232 GENERATE_MAN = NO | |
1233 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1234 # The MAN_OUTPUT tag is used to specify where the man pages will be put. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1235 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
4554 | 1236 # put in front of it. If left blank `man' will be used as the default path. |
1237 | |
1238 MAN_OUTPUT = man | |
1239 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1240 # The MAN_EXTENSION tag determines the extension that is added to |
4554 | 1241 # the generated man pages (default is the subroutine's section .3) |
1242 | |
1243 MAN_EXTENSION = .3 | |
1244 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1245 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1246 # then it will generate one additional man file for each entity |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1247 # documented in the real man page(s). These additional files |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1248 # only source the real man page, but without them the man command |
4554 | 1249 # would be unable to find the correct page. The default is NO. |
1250 | |
1251 MAN_LINKS = NO | |
1252 | |
1253 #--------------------------------------------------------------------------- | |
1254 # configuration options related to the XML output | |
1255 #--------------------------------------------------------------------------- | |
1256 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1257 # If the GENERATE_XML tag is set to YES Doxygen will |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1258 # 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
|
1259 # the code including all documentation. |
4554 | 1260 |
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
|
1261 GENERATE_XML = YES |
4554 | 1262 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1263 # The XML_OUTPUT tag is used to specify where the XML pages will be put. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1264 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
6317
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1265 # 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
|
1266 |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1267 XML_OUTPUT = xml |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1268 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1269 # The XML_SCHEMA tag can be used to specify an XML schema, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1270 # which can be used by a validating XML parser to check the |
4554 | 1271 # syntax of the XML files. |
1272 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1273 XML_SCHEMA = |
4554 | 1274 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1275 # The XML_DTD tag can be used to specify an XML DTD, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1276 # which can be used by a validating XML parser to check the |
4554 | 1277 # syntax of the XML files. |
1278 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1279 XML_DTD = |
4554 | 1280 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1281 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1282 # dump the program listings (including syntax highlighting |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1283 # and cross-referencing information) to the XML output. Note that |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
1284 # 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
|
1285 |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
1286 XML_PROGRAMLISTING = YES |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
1287 |
4554 | 1288 #--------------------------------------------------------------------------- |
1289 # configuration options for the AutoGen Definitions output | |
1290 #--------------------------------------------------------------------------- | |
1291 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1292 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1293 # generate an AutoGen Definitions (see autogen.sf.net) file |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1294 # that captures the structure of the code including all |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1295 # documentation. Note that this feature is still experimental |
4554 | 1296 # and incomplete at the moment. |
1297 | |
1298 GENERATE_AUTOGEN_DEF = NO | |
1299 | |
1300 #--------------------------------------------------------------------------- | |
1301 # configuration options related to the Perl module output | |
1302 #--------------------------------------------------------------------------- | |
1303 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1304 # If the GENERATE_PERLMOD tag is set to YES Doxygen will |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1305 # generate a Perl module file that captures the structure of |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1306 # the code including all documentation. Note that this |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1307 # feature is still experimental and incomplete at the |
4554 | 1308 # moment. |
1309 | |
1310 GENERATE_PERLMOD = NO | |
1311 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1312 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1313 # the necessary Makefile rules, Perl scripts and LaTeX code to be able |
6317
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1314 # to generate PDF and DVI output from the Perl module output. |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1315 |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1316 PERLMOD_LATEX = NO |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1317 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1318 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1319 # nicely formatted so it can be parsed by a human reader. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1320 # This is useful |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1321 # if you want to understand what is going on. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1322 # On the other hand, if this |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1323 # tag is set to NO the size of the Perl module output will be much smaller |
6317
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1324 # and Perl will parse it just the same. |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1325 |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1326 PERLMOD_PRETTY = YES |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1327 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1328 # The names of the make variables in the generated doxyrules.make file |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1329 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1330 # This is useful so different doxyrules.make files included by the same |
6317
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1331 # Makefile don't overwrite each other's variables. |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1332 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1333 PERLMOD_MAKEVAR_PREFIX = |
6317
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1334 |
4554 | 1335 #--------------------------------------------------------------------------- |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1336 # Configuration options related to the preprocessor |
4554 | 1337 #--------------------------------------------------------------------------- |
1338 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1339 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1340 # evaluate all C-preprocessor directives found in the sources and include |
4554 | 1341 # files. |
1342 | |
1343 ENABLE_PREPROCESSING = YES | |
1344 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1345 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1346 # names in the source code. If set to NO (the default) only conditional |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1347 # compilation will be performed. Macro expansion can be done in a controlled |
4554 | 1348 # way by setting EXPAND_ONLY_PREDEF to YES. |
1349 | |
1350 MACRO_EXPANSION = NO | |
1351 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1352 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1353 # 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
|
1354 # PREDEFINED and EXPAND_AS_DEFINED tags. |
4554 | 1355 |
1356 EXPAND_ONLY_PREDEF = NO | |
1357 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1358 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
4554 | 1359 # in the INCLUDE_PATH (see below) will be search if a #include is found. |
1360 | |
1361 SEARCH_INCLUDES = YES | |
1362 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1363 # The INCLUDE_PATH tag can be used to specify one or more directories that |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1364 # contain include files that are not input files but should be processed by |
4554 | 1365 # the preprocessor. |
1366 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1367 INCLUDE_PATH = |
4554 | 1368 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1369 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1370 # patterns (like *.h and *.hpp) to filter out the header-files in the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1371 # directories. If left blank, the patterns specified with FILE_PATTERNS will |
4554 | 1372 # be used. |
1373 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1374 INCLUDE_FILE_PATTERNS = |
4554 | 1375 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1376 # The PREDEFINED tag can be used to specify one or more macro names that |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1377 # are defined before the preprocessor is started (similar to the -D option of |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1378 # gcc). The argument of the tag is a list of macros of the form: name |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1379 # or name=definition (no spaces). If the definition and the = are |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1380 # omitted =1 is assumed. To prevent a macro definition from being |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1381 # undefined via #undef or recursively expanded use the := operator |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
1382 # instead of the = operator. |
4554 | 1383 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1384 PREDEFINED = |
4554 | 1385 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1386 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1387 # this tag can be used to specify a list of macro names that should be expanded. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1388 # The macro definition that is found in the sources will be used. |
4554 | 1389 # Use the PREDEFINED tag if you want to use a different macro definition. |
1390 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1391 EXPAND_AS_DEFINED = |
4554 | 1392 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1393 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1394 # doxygen's preprocessor will remove all function-like macros that are alone |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1395 # on a line, have an all uppercase name, and do not end with a semicolon. Such |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1396 # function macros are typically used for boiler-plate code, and will confuse |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
1397 # the parser if not removed. |
4554 | 1398 |
1399 SKIP_FUNCTION_MACROS = YES | |
1400 | |
1401 #--------------------------------------------------------------------------- | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1402 # Configuration::additions related to external references |
4554 | 1403 #--------------------------------------------------------------------------- |
1404 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1405 # The TAGFILES option can be used to specify one or more tagfiles. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1406 # Optionally an initial location of the external documentation |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1407 # can be added for each tagfile. The format of a tag file without |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1408 # this location is as follows: |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1409 # |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1410 # TAGFILES = file1 file2 ... |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1411 # Adding location for the tag files is done as follows: |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1412 # |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1413 # TAGFILES = file1=loc1 "file2 = loc2" ... |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1414 # where "loc1" and "loc2" can be relative or absolute paths or |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1415 # URLs. If a location is present for each tag, the installdox tool |
6317
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1416 # does not have to be run to correct the links. |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1417 # Note that each tag file must have a unique name |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1418 # (where the name does NOT include the path) |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1419 # If a tag file is not located in the directory in which doxygen |
6317
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1420 # is run, you must also specify the path to the tagfile here. |
4554 | 1421 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1422 TAGFILES = |
4554 | 1423 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1424 # When a file name is specified after GENERATE_TAGFILE, doxygen will create |
4554 | 1425 # a tag file that is based on the input files it reads. |
1426 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1427 GENERATE_TAGFILE = |
4554 | 1428 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1429 # If the ALLEXTERNALS tag is set to YES all external classes will be listed |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1430 # in the class index. If set to NO only the inherited external classes |
4554 | 1431 # will be listed. |
1432 | |
1433 ALLEXTERNALS = NO | |
1434 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1435 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1436 # in the modules index. If set to NO, only the current project's groups will |
4554 | 1437 # be listed. |
1438 | |
1439 EXTERNAL_GROUPS = YES | |
1440 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1441 # The PERL_PATH should be the absolute path and name of the perl script |
4554 | 1442 # interpreter (i.e. the result of `which perl'). |
1443 | |
1444 PERL_PATH = /usr/bin/perl | |
1445 | |
1446 #--------------------------------------------------------------------------- | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1447 # Configuration options related to the dot tool |
4554 | 1448 #--------------------------------------------------------------------------- |
1449 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1450 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1451 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1452 # or super classes. Setting the tag to NO turns the diagrams off. Note that |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1453 # this option is superseded by the HAVE_DOT option below. This is only a |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1454 # fallback. It is recommended to install and use dot, since it yields more |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
1455 # powerful graphs. |
4554 | 1456 |
1457 CLASS_DIAGRAMS = YES | |
1458 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1459 # You can define message sequence charts within doxygen comments using the \msc |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1460 # command. Doxygen will then run the mscgen tool (see |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1461 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1462 # documentation. The MSCGEN_PATH tag allows you to specify the directory where |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1463 # the mscgen tool resides. If left empty the tool is assumed to be found in the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1464 # default search path. |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
1465 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1466 MSCGEN_PATH = |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
1467 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1468 # If set to YES, the inheritance and collaboration graphs will hide |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1469 # inheritance and usage relations if the target is undocumented |
4554 | 1470 # or is not a class. |
1471 | |
1472 HIDE_UNDOC_RELATIONS = YES | |
1473 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1474 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1475 # available from the path. This tool is part of Graphviz, a graph visualization |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1476 # toolkit from AT&T and Lucent Bell Labs. The other options in this section |
4554 | 1477 # have no effect if this option is set to NO (the default) |
1478 | |
10925
993db24dae16
[gaim-migrate @ 12696]
Gary Kramlich <grim@reaperworld.com>
parents:
7806
diff
changeset
|
1479 HAVE_DOT = @enable_dot@ |
4554 | 1480 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1481 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1482 # allowed to run in parallel. When set to 0 (the default) doxygen will |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1483 # base this on the number of processors available in the system. You can set it |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1484 # explicitly to a value larger than 0 to get control over the balance |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1485 # between CPU load and processing speed. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1486 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1487 DOT_NUM_THREADS = 0 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1488 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1489 # By default doxygen will write a font called FreeSans.ttf to the output |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1490 # directory and reference it in all dot files that doxygen generates. This |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1491 # font does not include all possible unicode characters however, so when you need |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1492 # these (or just want a differently looking font) you can specify the font name |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1493 # using DOT_FONTNAME. You need need to make sure dot is able to find the font, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1494 # which can be done by putting it in a standard location or by setting the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1495 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1496 # containing the font. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1497 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1498 DOT_FONTNAME = FreeSans.ttf |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1499 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1500 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1501 # The default size is 10pt. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1502 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1503 DOT_FONTSIZE = 10 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1504 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1505 # By default doxygen will tell dot to use the output directory to look for the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1506 # FreeSans.ttf font (which doxygen will put there itself). If you specify a |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1507 # different font using DOT_FONTNAME you can set the path where dot |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1508 # can find it using this tag. |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1509 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1510 DOT_FONTPATH = |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1511 |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1512 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1513 # will generate a graph for each documented class showing the direct and |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1514 # indirect inheritance relations. Setting this tag to YES will force the |
4554 | 1515 # the CLASS_DIAGRAMS tag to NO. |
1516 | |
1517 CLASS_GRAPH = YES | |
1518 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1519 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1520 # will generate a graph for each documented class showing the direct and |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1521 # indirect implementation dependencies (inheritance, containment, and |
4554 | 1522 # class references variables) of the class with other documented classes. |
1523 | |
1524 COLLABORATION_GRAPH = YES | |
1525 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1526 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen |
12800 | 1527 # will generate a graph for groups, showing the direct groups dependencies |
1528 | |
1529 GROUP_GRAPHS = YES | |
1530 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1531 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1532 # 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
|
1533 # Language. |
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1534 |
12800 | 1535 UML_LOOK = YES |
6317
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1536 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1537 # If set to YES, the inheritance and collaboration graphs will show the |
4554 | 1538 # relations between templates and their instances. |
1539 | |
1540 TEMPLATE_RELATIONS = YES | |
1541 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1542 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1543 # tags are set to YES then doxygen will generate a graph for each documented |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1544 # file showing the direct and indirect include dependencies of the file with |
4554 | 1545 # other documented files. |
1546 | |
1547 INCLUDE_GRAPH = YES | |
1548 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1549 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1550 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1551 # documented header file showing the documented files that directly or |
4554 | 1552 # indirectly include this file. |
1553 | |
1554 INCLUDED_BY_GRAPH = YES | |
1555 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1556 # If the CALL_GRAPH and HAVE_DOT options are set to YES then |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1557 # doxygen will generate a call dependency graph for every global function |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1558 # or class method. Note that enabling this option will significantly increase |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1559 # the time of a run. So in most cases it will be better to enable call graphs |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1560 # for selected functions only using the \callgraph command. |
6317
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1561 |
12800 | 1562 CALL_GRAPH = YES |
6317
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1563 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1564 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1565 # doxygen will generate a caller dependency graph for every global function |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1566 # or class method. Note that enabling this option will significantly increase |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1567 # the time of a run. So in most cases it will be better to enable caller |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1568 # graphs for selected functions only using the \callergraph command. |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
1569 |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
1570 CALLER_GRAPH = NO |
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
1571 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1572 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
4554 | 1573 # will graphical hierarchy of all classes instead of a textual one. |
1574 | |
1575 GRAPHICAL_HIERARCHY = YES | |
1576 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1577 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1578 # then doxygen will show the dependencies a directory has on other directories |
12800 | 1579 # in a graphical way. The dependency relations are determined by the #include |
1580 # relations between the files in the directories. | |
1581 | |
1582 DIRECTORY_GRAPH = YES | |
1583 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1584 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
4554 | 1585 # generated by dot. Possible values are png, jpg, or gif |
1586 # If left blank png will be used. | |
1587 | |
1588 DOT_IMAGE_FORMAT = png | |
1589 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1590 # 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
|
1591 # found. If left blank, it is assumed the dot tool can be found in the path. |
4554 | 1592 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1593 DOT_PATH = |
4554 | 1594 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1595 # The DOTFILE_DIRS tag can be used to specify one or more directories that |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1596 # contain dot files that are included in the documentation (see the |
4554 | 1597 # \dotfile command). |
1598 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1599 DOTFILE_DIRS = |
4554 | 1600 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1601 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1602 # nodes that will be shown in the graph. If the number of nodes in a graph |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1603 # becomes larger than this value, doxygen will truncate the graph, which is |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1604 # visualized by representing a node as a red box. Note that doxygen if the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1605 # number of direct children of the root node in a graph is already larger than |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1606 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
1607 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
4554 | 1608 |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
1609 DOT_GRAPH_MAX_NODES = 50 |
4554 | 1610 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1611 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1612 # graphs generated by dot. A depth value of 3 means that only nodes reachable |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1613 # from the root by following a path via at most 3 edges will be shown. Nodes |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1614 # that lay further from the root node will be omitted. Note that setting this |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1615 # option to 1 or 2 may greatly reduce the computation time needed for large |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1616 # code bases. Also note that the size of a graph can be further restricted by |
21445
43c329bb5983
Update our Doxyfile.in using "doxygen -u Doxyfile.in"
Mark Doliner <mark@kingant.net>
parents:
20925
diff
changeset
|
1617 # 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
|
1618 |
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
|
1619 MAX_DOT_GRAPH_DEPTH = 2 |
6317
285444815c6a
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1620 |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1621 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1622 # background. This is disabled by default, because dot on Windows does not |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1623 # seem to support this out of the box. Warning: Depending on the platform used, |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1624 # enabling this option may lead to badly anti-aliased labels on the edges of |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1625 # a graph (i.e. they become hard to read). |
12800 | 1626 |
1627 DOT_TRANSPARENT = NO | |
1628 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1629 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1630 # files in one run (i.e. multiple -o and -T options on the command line). This |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1631 # makes dot run faster, but since only newer versions of dot (>1.8.10) |
12800 | 1632 # support this, this feature is disabled by default. |
1633 | |
1634 DOT_MULTI_TARGETS = YES | |
1635 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1636 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1637 # generate a legend page explaining the meaning of the various boxes and |
4554 | 1638 # arrows in the dot generated graphs. |
1639 | |
1640 GENERATE_LEGEND = YES | |
1641 | |
31347
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1642 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will |
15c5a40ef7be
Use doxygen -u to update this file. Before this change I was seeing
Mark Doliner <mark@kingant.net>
parents:
26350
diff
changeset
|
1643 # remove the intermediate dot files that are used to generate |
4554 | 1644 # the various graphs. |
1645 | |
1646 DOT_CLEANUP = YES |