Doxyfile.in

Sat, 05 Apr 2003 08:03:10 +0000

author
Herman Bloggs <herman@bluedigits.com>
date
Sat, 05 Apr 2003 08:03:10 +0000
changeset 5031
c224575f8eb8
parent 4554
09f005a2628b
child 6317
b40515160b51
permissions
-rw-r--r--

[gaim-migrate @ 5368]
Update..

4554
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1 # Doxyfile 1.2.18-20021020
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
2
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
3 # This file describes the settings to be used by the documentation system
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
4 # doxygen (www.doxygen.org) for a project
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
5 #
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
6 # All text after a hash (#) is considered a comment and will be ignored
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
7 # The format is:
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
8 # TAG = value [value, ...]
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
9 # For lists items can also be appended using:
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
10 # TAG += value [value, ...]
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
11 # Values that contain spaces should be placed between quotes (" ")
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
12
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
13 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
14 # General configuration options
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
15 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
16
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
18 # by quotes) that should identify the project.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
19
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
20 PROJECT_NAME = @PACKAGE@
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
21
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
23 # This could be handy for archiving the generated documentation or
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
24 # if some version control system is used.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
25
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
26 PROJECT_NUMBER = @VERSION@
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
27
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29 # base path where the generated documentation will be put.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
30 # If a relative path is entered, it will be relative to the location
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
31 # where doxygen was started. If left blank the current directory will be used.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
32
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
33 OUTPUT_DIRECTORY = doc
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
34
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
36 # documentation generated by doxygen is written. Doxygen will use this
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
37 # information to generate all constant output in the proper language.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
38 # The default language is English, other supported languages are:
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
41 # (Japanese with english messages), Korean, Norwegian, Polish, Portuguese,
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
43
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
44 OUTPUT_LANGUAGE = English
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
45
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
46 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
47 # documentation are documented, even if no documentation was available.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
48 # Private class members and static file members will be hidden unless
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
49 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
50
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
51 EXTRACT_ALL = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
52
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
53 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
54 # will be included in the documentation.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
55
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
56 EXTRACT_PRIVATE = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
57
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
58 # If the EXTRACT_STATIC tag is set to YES all static members of a file
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
59 # will be included in the documentation.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
60
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
61 EXTRACT_STATIC = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
62
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
63 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
64 # defined locally in source files will be included in the documentation.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
65 # If set to NO only classes defined in header files are included.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
66
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
67 EXTRACT_LOCAL_CLASSES = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
68
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
69 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
70 # undocumented members of documented classes, files or namespaces.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
71 # If set to NO (the default) these members will be included in the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
72 # various overviews, but no documentation section is generated.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
73 # This option has no effect if EXTRACT_ALL is enabled.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
74
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
75 HIDE_UNDOC_MEMBERS = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
76
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
77 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
78 # undocumented classes that are normally visible in the class hierarchy.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
79 # If set to NO (the default) these class will be included in the various
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
80 # overviews. This option has no effect if EXTRACT_ALL is enabled.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
81
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
82 HIDE_UNDOC_CLASSES = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
83
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
84 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
85 # friend (class|struct|union) declarations.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
86 # If set to NO (the default) these declarations will be included in the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
87 # documentation.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
88
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
89 HIDE_FRIEND_COMPOUNDS = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
90
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
91 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
92 # include brief member descriptions after the members that are listed in
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
93 # the file and class documentation (similar to JavaDoc).
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
94 # Set to NO to disable this.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
95
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
96 BRIEF_MEMBER_DESC = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
97
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
98 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
99 # the brief description of a member or function before the detailed description.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
100 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
101 # brief descriptions will be completely suppressed.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
102
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
103 REPEAT_BRIEF = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
104
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
105 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
106 # Doxygen will generate a detailed section even if there is only a brief
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
107 # description.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
108
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
109 ALWAYS_DETAILED_SEC = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
110
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
111 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
112 # members of a class in the documentation of that class as if those members were
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
113 # ordinary class members. Constructors, destructors and assignment operators of
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
114 # the base classes will not be shown.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
115
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
116 INLINE_INHERITED_MEMB = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
117
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
118 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
119 # path before files name in the file list and in the header files. If set
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
120 # to NO the shortest path that makes the file name unique will be used.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
121
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
122 FULL_PATH_NAMES = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
123
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
124 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
125 # can be used to strip a user defined part of the path. Stripping is
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
126 # only done if one of the specified strings matches the left-hand part of
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
127 # the path. It is allowed to use relative paths in the argument list.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
128
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
129 STRIP_FROM_PATH =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
130
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
131 # The INTERNAL_DOCS tag determines if documentation
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
132 # that is typed after a \internal command is included. If the tag is set
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
133 # to NO (the default) then the documentation will be excluded.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
134 # Set it to YES to include the internal documentation.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
135
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
136 INTERNAL_DOCS = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
137
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
138 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
139 # file names in lower case letters. If set to YES upper case letters are also
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
140 # allowed. This is useful if you have classes or files whose names only differ
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
141 # in case and if your file system supports case sensitive file names. Windows
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
142 # users are adviced to set this option to NO.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
143
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
144 CASE_SENSE_NAMES = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
145
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
146 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
147 # (but less readable) file names. This can be useful is your file systems
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
148 # doesn't support long names like on DOS, Mac, or CD-ROM.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
149
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
150 SHORT_NAMES = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
151
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
152 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
153 # will show members with their full class and namespace scopes in the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
154 # documentation. If set to YES the scope will be hidden.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
155
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
156 HIDE_SCOPE_NAMES = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
157
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
158 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
159 # will generate a verbatim copy of the header file for each class for
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
160 # which an include is specified. Set to NO to disable this.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
161
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
162 VERBATIM_HEADERS = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
163
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
164 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
165 # will put list of the files that are included by a file in the documentation
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
166 # of that file.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
167
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
168 SHOW_INCLUDE_FILES = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
169
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
170 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
171 # will interpret the first line (until the first dot) of a JavaDoc-style
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
172 # comment as the brief description. If set to NO, the JavaDoc
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
173 # comments will behave just like the Qt-style comments (thus requiring an
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
174 # explict @brief command for a brief description.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
175
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
176 JAVADOC_AUTOBRIEF = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
177
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
178 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
179 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
180 # comments) as a brief description. This used to be the default behaviour.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
181 # The new default is to treat a multi-line C++ comment block as a detailed
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
182 # description. Set this tag to YES if you prefer the old behaviour instead.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
183
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
184 MULTILINE_CPP_IS_BRIEF = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
185
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
186 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
187 # will output the detailed description near the top, like JavaDoc.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
188 # If set to NO, the detailed description appears after the member
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
189 # documentation.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
190
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
191 DETAILS_AT_TOP = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
192
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
193 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
194 # member inherits the documentation from any documented member that it
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
195 # reimplements.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
196
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
197 INHERIT_DOCS = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
198
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
199 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
200 # is inserted in the documentation for inline members.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
201
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
202 INLINE_INFO = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
203
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
204 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
205 # will sort the (detailed) documentation of file and class members
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
206 # alphabetically by member name. If set to NO the members will appear in
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
207 # declaration order.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
208
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
209 SORT_MEMBER_DOCS = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
210
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
211 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
212 # tag is set to YES, then doxygen will reuse the documentation of the first
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
213 # member in the group (if any) for the other members of the group. By default
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
214 # all members of a group must be documented explicitly.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
215
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
216 DISTRIBUTE_GROUP_DOC = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
217
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
218 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
219 # Doxygen uses this value to replace tabs by spaces in code fragments.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
220
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
221 TAB_SIZE = 4
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
222
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
223 # The GENERATE_TODOLIST tag can be used to enable (YES) or
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
224 # disable (NO) the todo list. This list is created by putting \todo
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
225 # commands in the documentation.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
226
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
227 GENERATE_TODOLIST = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
228
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
229 # The GENERATE_TESTLIST tag can be used to enable (YES) or
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
230 # disable (NO) the test list. This list is created by putting \test
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
231 # commands in the documentation.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
232
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
233 GENERATE_TESTLIST = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
234
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
235 # The GENERATE_BUGLIST tag can be used to enable (YES) or
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
236 # disable (NO) the bug list. This list is created by putting \bug
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
237 # commands in the documentation.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
238
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
239 GENERATE_BUGLIST = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
240
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
241 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
242 # disable (NO) the deprecated list. This list is created by putting \deprecated commands in the documentation.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
243
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
244 GENERATE_DEPRECATEDLIST= YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
245
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
246 # This tag can be used to specify a number of aliases that acts
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
247 # as commands in the documentation. An alias has the form "name=value".
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
248 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
249 # put the command \sideeffect (or @sideeffect) in the documentation, which
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
250 # will result in a user defined paragraph with heading "Side Effects:".
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
251 # You can put \n's in the value part of an alias to insert newlines.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
252
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
253 ALIASES =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
254
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
255 # The ENABLED_SECTIONS tag can be used to enable conditional
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
256 # documentation sections, marked by \if sectionname ... \endif.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
257
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
258 ENABLED_SECTIONS =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
259
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
260 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
261 # the initial value of a variable or define consist of for it to appear in
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
262 # the documentation. If the initializer consists of more lines than specified
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
263 # here it will be hidden. Use a value of 0 to hide initializers completely.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
264 # The appearance of the initializer of individual variables and defines in the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
265 # documentation can be controlled using \showinitializer or \hideinitializer
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
266 # command in the documentation regardless of this setting.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
267
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
268 MAX_INITIALIZER_LINES = 30
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
269
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
270 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
271 # only. Doxygen will then generate output that is more tailored for C.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
272 # For instance some of the names that are used will be different. The list
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
273 # of all members will be omitted, etc.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
274
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
275 OPTIMIZE_OUTPUT_FOR_C = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
276
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
277 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
278 # only. Doxygen will then generate output that is more tailored for Java.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
279 # For instance namespaces will be presented as packages, qualified scopes
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
280 # will look different, etc.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
281
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
282 OPTIMIZE_OUTPUT_JAVA = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
283
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
284 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
285 # at the bottom of the documentation of classes and structs. If set to YES the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
286 # list will mention the files that were used to generate the documentation.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
287
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
288 SHOW_USED_FILES = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
289
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
290 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
291 # configuration options related to warning and progress messages
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
292 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
293
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
294 # The QUIET tag can be used to turn on/off the messages that are generated
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
295 # by doxygen. Possible values are YES and NO. If left blank NO is used.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
296
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
297 QUIET = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
298
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
299 # The WARNINGS tag can be used to turn on/off the warning messages that are
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
300 # generated by doxygen. Possible values are YES and NO. If left blank
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
301 # NO is used.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
302
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
303 WARNINGS = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
304
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
305 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
306 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
307 # automatically be disabled.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
308
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
309 WARN_IF_UNDOCUMENTED = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
310
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
311 # The WARN_FORMAT tag determines the format of the warning messages that
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
312 # doxygen can produce. The string should contain the $file, $line, and $text
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
313 # tags, which will be replaced by the file and line number from which the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
314 # warning originated and the warning text.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
315
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
316 WARN_FORMAT = "$file:$line: $text"
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
317
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
318 # The WARN_LOGFILE tag can be used to specify a file to which warning
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
319 # and error messages should be written. If left blank the output is written
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
320 # to stderr.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
321
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
322 WARN_LOGFILE =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
323
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
324 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
325 # configuration options related to the input files
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
326 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
327
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
328 # The INPUT tag can be used to specify the files and/or directories that contain
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
329 # documented source files. You may enter file names like "myfile.cpp" or
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
330 # directories like "/usr/src/myproject". Separate the files or directories
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
331 # with spaces.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
332
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
333 INPUT = src
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
334
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
335 # If the value of the INPUT tag contains directories, you can use the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
336 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
337 # and *.h) to filter out the source-files in the directories. If left
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
338 # blank the following patterns are tested:
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
339 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
340 # *.h++ *.idl *.odl
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
341
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
342 FILE_PATTERNS = *.h
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
343
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
344 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
345 # should be searched for input files as well. Possible values are YES and NO.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
346 # If left blank NO is used.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
347
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
348 RECURSIVE = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
349
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
350 # The EXCLUDE tag can be used to specify files and/or directories that should
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
351 # excluded from the INPUT source files. This way you can easily exclude a
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
352 # subdirectory from a directory tree whose root is specified with the INPUT tag.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
353
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
354 EXCLUDE =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
355
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
356 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
357 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
358
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
359 EXCLUDE_SYMLINKS = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
360
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
361 # If the value of the INPUT tag contains directories, you can use the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
362 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
363 # certain files from those directories.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
364
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
365 EXCLUDE_PATTERNS =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
366
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
367 # The EXAMPLE_PATH tag can be used to specify one or more files or
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
368 # directories that contain example code fragments that are included (see
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
369 # the \include command).
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
370
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
371 EXAMPLE_PATH =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
372
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
373 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
374 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
375 # and *.h) to filter out the source-files in the directories. If left
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
376 # blank all files are included.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
377
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
378 EXAMPLE_PATTERNS =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
379
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
380 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
381 # searched for input files to be used with the \include or \dontinclude
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
382 # commands irrespective of the value of the RECURSIVE tag.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
383 # Possible values are YES and NO. If left blank NO is used.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
384
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
385 EXAMPLE_RECURSIVE = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
386
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
387 # The IMAGE_PATH tag can be used to specify one or more files or
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
388 # directories that contain image that are included in the documentation (see
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
389 # the \image command).
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
390
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
391 IMAGE_PATH =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
392
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
393 # The INPUT_FILTER tag can be used to specify a program that doxygen should
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
394 # invoke to filter for each input file. Doxygen will invoke the filter program
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
395 # by executing (via popen()) the command <filter> <input-file>, where <filter>
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
396 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
397 # input file. Doxygen will then use the output that the filter program writes
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
398 # to standard output.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
399
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
400 INPUT_FILTER =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
401
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
402 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
403 # INPUT_FILTER) will be used to filter the input files when producing source
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
404 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
405
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
406 FILTER_SOURCE_FILES = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
407
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
408 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
409 # configuration options related to source browsing
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
410 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
411
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
412 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
413 # be generated. Documented entities will be cross-referenced with these sources.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
414
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
415 SOURCE_BROWSER = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
416
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
417 # Setting the INLINE_SOURCES tag to YES will include the body
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
418 # of functions and classes directly in the documentation.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
419
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
420 INLINE_SOURCES = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
421
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
422 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
423 # doxygen to hide any special comment blocks from generated source code
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
424 # fragments. Normal C and C++ comments will always remain visible.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
425
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
426 STRIP_CODE_COMMENTS = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
427
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
428 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
429 # then for each documented function all documented
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
430 # functions referencing it will be listed.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
431
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
432 REFERENCED_BY_RELATION = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
433
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
434 # If the REFERENCES_RELATION tag is set to YES (the default)
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
435 # then for each documented function all documented entities
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
436 # called/used by that function will be listed.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
437
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
438 REFERENCES_RELATION = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
439
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
440 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
441 # configuration options related to the alphabetical class index
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
442 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
443
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
444 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
445 # of all compounds will be generated. Enable this if the project
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
446 # contains a lot of classes, structs, unions or interfaces.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
447
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
448 ALPHABETICAL_INDEX = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
449
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
450 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
451 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
452 # in which this list will be split (can be a number in the range [1..20])
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
453
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
454 COLS_IN_ALPHA_INDEX = 5
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
455
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
456 # In case all classes in a project start with a common prefix, all
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
457 # classes will be put under the same header in the alphabetical index.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
458 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
459 # should be ignored while generating the index headers.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
460
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
461 IGNORE_PREFIX =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
462
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
463 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
464 # configuration options related to the HTML output
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
465 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
466
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
467 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
468 # generate HTML output.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
469
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
470 GENERATE_HTML = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
471
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
472 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
473 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
474 # put in front of it. If left blank `html' will be used as the default path.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
475
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
476 HTML_OUTPUT = html
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
477
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
478 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
479 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
480 # doxygen will generate files with .html extension.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
481
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
482 HTML_FILE_EXTENSION = .html
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
483
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
484 # The HTML_HEADER tag can be used to specify a personal HTML header for
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
485 # each generated HTML page. If it is left blank doxygen will generate a
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
486 # standard header.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
487
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
488 HTML_HEADER =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
489
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
490 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
491 # each generated HTML page. If it is left blank doxygen will generate a
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
492 # standard footer.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
493
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
494 HTML_FOOTER =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
495
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
496 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
497 # style sheet that is used by each HTML page. It can be used to
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
498 # fine-tune the look of the HTML output. If the tag is left blank doxygen
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
499 # will generate a default style sheet
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
500
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
501 HTML_STYLESHEET =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
502
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
503 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
504 # files or namespaces will be aligned in HTML using tables. If set to
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
505 # NO a bullet list will be used.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
506
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
507 HTML_ALIGN_MEMBERS = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
508
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
509 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
510 # will be generated that can be used as input for tools like the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
511 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
512 # of the generated HTML documentation.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
513
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
514 GENERATE_HTMLHELP = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
515
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
516 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
517 # be used to specify the file name of the resulting .chm file. You
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
518 # can add a path in front of the file if the result should not be
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
519 # written to the html output dir.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
520
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
521 CHM_FILE =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
522
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
523 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
524 # be used to specify the location (absolute path including file name) of
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
525 # the HTML help compiler (hhc.exe). If non empty doxygen will try to run
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
526 # the html help compiler on the generated index.hhp.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
527
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
528 HHC_LOCATION =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
529
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
530 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
531 # controls if a separate .chi index file is generated (YES) or that
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
532 # it should be included in the master .chm file (NO).
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
533
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
534 GENERATE_CHI = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
535
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
536 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
537 # controls whether a binary table of contents is generated (YES) or a
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
538 # normal table of contents (NO) in the .chm file.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
539
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
540 BINARY_TOC = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
541
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
542 # The TOC_EXPAND flag can be set to YES to add extra items for group members
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
543 # to the contents of the Html help documentation and to the tree view.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
544
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
545 TOC_EXPAND = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
546
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
547 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
548 # top of each HTML page. The value NO (the default) enables the index and
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
549 # the value YES disables it.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
550
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
551 DISABLE_INDEX = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
552
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
553 # This tag can be used to set the number of enum values (range [1..20])
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
554 # that doxygen will group on one line in the generated HTML documentation.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
555
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
556 ENUM_VALUES_PER_LINE = 4
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
557
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
558 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
559 # generated containing a tree-like index structure (just like the one that
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
560 # is generated for HTML Help). For this to work a browser that supports
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
561 # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
562 # or Internet explorer 4.0+). Note that for large projects the tree generation
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
563 # can take a very long time. In such cases it is better to disable this feature.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
564 # Windows users are probably better off using the HTML help feature.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
565
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
566 GENERATE_TREEVIEW = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
567
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
568 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
569 # used to set the initial width (in pixels) of the frame in which the tree
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
570 # is shown.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
571
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
572 TREEVIEW_WIDTH = 250
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
573
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
574 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
575 # configuration options related to the LaTeX output
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
576 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
577
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
578 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
579 # generate Latex output.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
580
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
581 GENERATE_LATEX = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
582
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
583 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
584 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
585 # put in front of it. If left blank `latex' will be used as the default path.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
586
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
587 LATEX_OUTPUT = latex
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
588
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
589 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
590
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
591 LATEX_CMD_NAME = latex
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
592
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
593 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
594 # generate index for LaTeX. If left blank `makeindex' will be used as the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
595 # default command name.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
596
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
597 MAKEINDEX_CMD_NAME = makeindex
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
598
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
599 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
600 # LaTeX documents. This may be useful for small projects and may help to
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
601 # save some trees in general.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
602
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
603 COMPACT_LATEX = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
604
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
605 # The PAPER_TYPE tag can be used to set the paper type that is used
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
606 # by the printer. Possible values are: a4, a4wide, letter, legal and
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
607 # executive. If left blank a4wide will be used.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
608
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
609 PAPER_TYPE = a4wide
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
610
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
611 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
612 # packages that should be included in the LaTeX output.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
613
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
614 EXTRA_PACKAGES =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
615
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
616 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
617 # the generated latex document. The header should contain everything until
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
618 # the first chapter. If it is left blank doxygen will generate a
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
619 # standard header. Notice: only use this tag if you know what you are doing!
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
620
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
621 LATEX_HEADER =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
622
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
623 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
624 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
625 # contain links (just like the HTML output) instead of page references
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
626 # This makes the output suitable for online browsing using a pdf viewer.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
627
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
628 PDF_HYPERLINKS = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
629
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
630 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
631 # plain latex in the generated Makefile. Set this option to YES to get a
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
632 # higher quality PDF documentation.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
633
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
634 USE_PDFLATEX = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
635
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
636 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
637 # command to the generated LaTeX files. This will instruct LaTeX to keep
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
638 # running if errors occur, instead of asking the user for help.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
639 # This option is also used when generating formulas in HTML.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
640
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
641 LATEX_BATCHMODE = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
642
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
643 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
644 # configuration options related to the RTF output
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
645 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
646
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
647 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
648 # The RTF output is optimised for Word 97 and may not look very pretty with
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
649 # other RTF readers or editors.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
650
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
651 GENERATE_RTF = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
652
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
653 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
654 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
655 # put in front of it. If left blank `rtf' will be used as the default path.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
656
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
657 RTF_OUTPUT = rtf
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
658
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
659 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
660 # RTF documents. This may be useful for small projects and may help to
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
661 # save some trees in general.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
662
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
663 COMPACT_RTF = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
664
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
665 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
666 # will contain hyperlink fields. The RTF file will
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
667 # contain links (just like the HTML output) instead of page references.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
668 # This makes the output suitable for online browsing using WORD or other
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
669 # programs which support those fields.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
670 # Note: wordpad (write) and others do not support links.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
671
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
672 RTF_HYPERLINKS = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
673
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
674 # Load stylesheet definitions from file. Syntax is similar to doxygen's
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
675 # config file, i.e. a series of assigments. You only have to provide
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
676 # replacements, missing definitions are set to their default value.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
677
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
678 RTF_STYLESHEET_FILE =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
679
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
680 # Set optional variables used in the generation of an rtf document.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
681 # Syntax is similar to doxygen's config file.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
682
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
683 RTF_EXTENSIONS_FILE =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
684
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
685 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
686 # configuration options related to the man page output
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
687 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
688
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
689 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
690 # generate man pages
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
691
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
692 GENERATE_MAN = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
693
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
694 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
695 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
696 # put in front of it. If left blank `man' will be used as the default path.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
697
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
698 MAN_OUTPUT = man
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
699
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
700 # The MAN_EXTENSION tag determines the extension that is added to
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
701 # the generated man pages (default is the subroutine's section .3)
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
702
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
703 MAN_EXTENSION = .3
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
704
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
705 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
706 # then it will generate one additional man file for each entity
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
707 # documented in the real man page(s). These additional files
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
708 # only source the real man page, but without them the man command
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
709 # would be unable to find the correct page. The default is NO.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
710
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
711 MAN_LINKS = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
712
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
713 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
714 # configuration options related to the XML output
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
715 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
716
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
717 # If the GENERATE_XML tag is set to YES Doxygen will
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
718 # generate an XML file that captures the structure of
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
719 # the code including all documentation. Note that this
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
720 # feature is still experimental and incomplete at the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
721 # moment.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
722
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
723 GENERATE_XML = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
724
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
725 # The XML_SCHEMA tag can be used to specify an XML schema,
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
726 # which can be used by a validating XML parser to check the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
727 # syntax of the XML files.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
728
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
729 XML_SCHEMA =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
730
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
731 # The XML_DTD tag can be used to specify an XML DTD,
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
732 # which can be used by a validating XML parser to check the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
733 # syntax of the XML files.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
734
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
735 XML_DTD =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
736
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
737 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
738 # configuration options for the AutoGen Definitions output
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
739 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
740
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
741 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
742 # generate an AutoGen Definitions (see autogen.sf.net) file
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
743 # that captures the structure of the code including all
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
744 # documentation. Note that this feature is still experimental
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
745 # and incomplete at the moment.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
746
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
747 GENERATE_AUTOGEN_DEF = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
748
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
749 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
750 # configuration options related to the Perl module output
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
751 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
752
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
753 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
754 # generate a Perl module file that captures the structure of
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
755 # the code including all documentation. Note that this
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
756 # feature is still experimental and incomplete at the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
757 # moment.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
758
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
759 GENERATE_PERLMOD = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
760
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
761 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
762 # Configuration options related to the preprocessor
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
763 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
764
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
765 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
766 # evaluate all C-preprocessor directives found in the sources and include
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
767 # files.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
768
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
769 ENABLE_PREPROCESSING = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
770
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
771 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
772 # names in the source code. If set to NO (the default) only conditional
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
773 # compilation will be performed. Macro expansion can be done in a controlled
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
774 # way by setting EXPAND_ONLY_PREDEF to YES.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
775
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
776 MACRO_EXPANSION = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
777
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
778 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
779 # then the macro expansion is limited to the macros specified with the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
780 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
781
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
782 EXPAND_ONLY_PREDEF = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
783
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
784 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
785 # in the INCLUDE_PATH (see below) will be search if a #include is found.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
786
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
787 SEARCH_INCLUDES = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
788
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
789 # The INCLUDE_PATH tag can be used to specify one or more directories that
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
790 # contain include files that are not input files but should be processed by
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
791 # the preprocessor.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
792
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
793 INCLUDE_PATH =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
794
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
795 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
796 # patterns (like *.h and *.hpp) to filter out the header-files in the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
797 # directories. If left blank, the patterns specified with FILE_PATTERNS will
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
798 # be used.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
799
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
800 INCLUDE_FILE_PATTERNS =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
801
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
802 # The PREDEFINED tag can be used to specify one or more macro names that
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
803 # are defined before the preprocessor is started (similar to the -D option of
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
804 # gcc). The argument of the tag is a list of macros of the form: name
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
805 # or name=definition (no spaces). If the definition and the = are
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
806 # omitted =1 is assumed.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
807
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
808 PREDEFINED =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
809
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
810 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
811 # this tag can be used to specify a list of macro names that should be expanded.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
812 # The macro definition that is found in the sources will be used.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
813 # Use the PREDEFINED tag if you want to use a different macro definition.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
814
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
815 EXPAND_AS_DEFINED =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
816
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
817 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
818 # doxygen's preprocessor will remove all function-like macros that are alone
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
819 # on a line, have an all uppercase name, and do not end with a semicolon. Such
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
820 # function macros are typically used for boiler-plate code, and will confuse the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
821 # parser if not removed.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
822
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
823 SKIP_FUNCTION_MACROS = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
824
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
825 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
826 # Configuration::addtions related to external references
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
827 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
828
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
829 # The TAGFILES tag can be used to specify one or more tagfiles.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
830
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
831 TAGFILES =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
832
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
833 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
834 # a tag file that is based on the input files it reads.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
835
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
836 GENERATE_TAGFILE =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
837
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
838 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
839 # in the class index. If set to NO only the inherited external classes
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
840 # will be listed.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
841
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
842 ALLEXTERNALS = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
843
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
844 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
845 # in the modules index. If set to NO, only the current project's groups will
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
846 # be listed.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
847
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
848 EXTERNAL_GROUPS = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
849
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
850 # The PERL_PATH should be the absolute path and name of the perl script
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
851 # interpreter (i.e. the result of `which perl').
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
852
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
853 PERL_PATH = /usr/bin/perl
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
854
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
855 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
856 # Configuration options related to the dot tool
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
857 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
858
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
859 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
860 # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
861 # super classes. Setting the tag to NO turns the diagrams off. Note that this
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
862 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
863 # recommended to install and use dot, since it yield more powerful graphs.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
864
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
865 CLASS_DIAGRAMS = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
866
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
867 # If set to YES, the inheritance and collaboration graphs will hide
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
868 # inheritance and usage relations if the target is undocumented
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
869 # or is not a class.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
870
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
871 HIDE_UNDOC_RELATIONS = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
872
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
873 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
874 # available from the path. This tool is part of Graphviz, a graph visualization
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
875 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
876 # have no effect if this option is set to NO (the default)
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
877
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
878 HAVE_DOT = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
879
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
880 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
881 # will generate a graph for each documented class showing the direct and
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
882 # indirect inheritance relations. Setting this tag to YES will force the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
883 # the CLASS_DIAGRAMS tag to NO.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
884
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
885 CLASS_GRAPH = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
886
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
887 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
888 # will generate a graph for each documented class showing the direct and
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
889 # indirect implementation dependencies (inheritance, containment, and
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
890 # class references variables) of the class with other documented classes.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
891
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
892 COLLABORATION_GRAPH = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
893
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
894 # If set to YES, the inheritance and collaboration graphs will show the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
895 # relations between templates and their instances.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
896
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
897 TEMPLATE_RELATIONS = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
898
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
899 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
900 # tags are set to YES then doxygen will generate a graph for each documented
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
901 # file showing the direct and indirect include dependencies of the file with
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
902 # other documented files.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
903
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
904 INCLUDE_GRAPH = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
905
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
906 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
907 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
908 # documented header file showing the documented files that directly or
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
909 # indirectly include this file.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
910
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
911 INCLUDED_BY_GRAPH = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
912
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
913 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
914 # will graphical hierarchy of all classes instead of a textual one.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
915
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
916 GRAPHICAL_HIERARCHY = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
917
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
918 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
919 # generated by dot. Possible values are png, jpg, or gif
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
920 # If left blank png will be used.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
921
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
922 DOT_IMAGE_FORMAT = png
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
923
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
924 # The tag DOT_PATH can be used to specify the path where the dot tool can be
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
925 # found. If left blank, it is assumed the dot tool can be found on the path.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
926
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
927 DOT_PATH =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
928
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
929 # The DOTFILE_DIRS tag can be used to specify one or more directories that
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
930 # contain dot files that are included in the documentation (see the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
931 # \dotfile command).
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
932
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
933 DOTFILE_DIRS =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
934
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
935 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
936 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
937 # this value, doxygen will try to truncate the graph, so that it fits within
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
938 # the specified constraint. Beware that most browsers cannot cope with very
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
939 # large images.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
940
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
941 MAX_DOT_GRAPH_WIDTH = 1024
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
942
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
943 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
944 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
945 # this value, doxygen will try to truncate the graph, so that it fits within
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
946 # the specified constraint. Beware that most browsers cannot cope with very
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
947 # large images.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
948
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
949 MAX_DOT_GRAPH_HEIGHT = 1024
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
950
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
951 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
952 # generate a legend page explaining the meaning of the various boxes and
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
953 # arrows in the dot generated graphs.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
954
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
955 GENERATE_LEGEND = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
956
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
957 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
958 # remove the intermedate dot files that are used to generate
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
959 # the various graphs.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
960
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
961 DOT_CLEANUP = YES
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
962
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
963 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
964 # Configuration::addtions related to the search engine
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
965 #---------------------------------------------------------------------------
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
966
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
967 # The SEARCHENGINE tag specifies whether or not a search engine should be
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
968 # used. If set to NO the values of all tags below this one will be ignored.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
969
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
970 SEARCHENGINE = NO
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
971
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
972 # The CGI_NAME tag should be the name of the CGI script that
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
973 # starts the search engine (doxysearch) with the correct parameters.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
974 # A script with this name will be generated by doxygen.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
975
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
976 CGI_NAME = search.cgi
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
977
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
978 # The CGI_URL tag should be the absolute URL to the directory where the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
979 # cgi binaries are located. See the documentation of your http daemon for
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
980 # details.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
981
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
982 CGI_URL =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
983
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
984 # The DOC_URL tag should be the absolute URL to the directory where the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
985 # documentation is located. If left blank the absolute path to the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
986 # documentation, with file:// prepended to it, will be used.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
987
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
988 DOC_URL =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
989
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
990 # The DOC_ABSPATH tag should be the absolute path to the directory where the
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
991 # documentation is located. If left blank the directory on the local machine
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
992 # will be used.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
993
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
994 DOC_ABSPATH =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
995
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
996 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
997 # is installed.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
998
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
999 BIN_ABSPATH = /usr/local/bin/
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1000
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1001 # The EXT_DOC_PATHS tag can be used to specify one or more paths to
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1002 # documentation generated for other projects. This allows doxysearch to search
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1003 # the documentation for these projects as well.
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1004
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1005 EXT_DOC_PATHS =
09f005a2628b [gaim-migrate @ 4834]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
1006

mercurial