annotate Doxyfile.in @ 22733:4040c4ee1f44

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