##// END OF EJS Templates
GIT_REPOSITORIES » LPP » PythonQt
RSS

Clone from https://github.com/Orochimarufan/PythonQt.git

improved doxygen cfg...
florianlink -
r140:e954eb5a7619
parent child
Show More
Show file before | Show file after | Hide comments
@@ -0,0 +1,498
1 /* The standard CSS for doxygen */
2
3 body, table, div, p, dl {
4 font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;
5 font-size: 12px;
6 }
7
8 /* @group Heading Levels */
9
10 h1 {
11 text-align: center;
12 font-size: 250%;
13 }
14
15 h2 {
16 font-size: 200%;
17 }
18
19 h3 {
20 font-size: 150%;
21 }
22
23 dt {
24 font-weight: bold;
25 }
26
27 div.multicol {
28 -moz-column-gap: 1em;
29 -webkit-column-gap: 1em;
30 -moz-column-count: 3;
31 -webkit-column-count: 3;
32 }
33
34 p.startli, p.startdd {
35 margin-top: 2px;
36 }
37
38 p.endli {
39 margin-bottom: 0px;
40 }
41
42 p.enddd {
43 margin-bottom: 4px;
44 }
45
46 /* @end */
47
48 caption {
49 font-weight: bold;
50 }
51
52 span.legend {
53 font-size: 70%;
54 text-align: center;
55 }
56
57 div.qindex, div.navtab{
58 background-color: #e8eef2;
59 border: 1px solid #84b0c7;
60 text-align: center;
61 margin: 2px;
62 padding: 2px;
63 }
64
65 div.qindex, div.navpath {
66 width: 100%;
67 line-height: 140%;
68 }
69
70 div.navtab {
71 margin-right: 15px;
72 }
73
74 /* @group Link Styling */
75
76 a {
77 color: #153788;
78 font-weight: normal;
79 text-decoration: none;
80 }
81
82 .contents a:visited {
83 color: #1b77c5;
84 }
85
86 a:hover {
87 text-decoration: underline;
88 }
89
90 a.qindex {
91 font-weight: bold;
92 }
93
94 a.qindexHL {
95 font-weight: bold;
96 background-color: #6666cc;
97 color: #ffffff;
98 border: 1px double #9295C2;
99 }
100
101 .contents a.qindexHL:visited {
102 color: #ffffff;
103 }
104
105 a.el {
106 font-weight: bold;
107 }
108
109 a.elRef {
110 }
111
112 a.code {
113 }
114
115 a.codeRef {
116 }
117
118 /* @end */
119
120 dl.el {
121 margin-left: -1cm;
122 }
123
124 .fragment {
125 font-family: monospace, fixed;
126 font-size: 105%;
127 }
128
129 pre.fragment {
130 border: 1px solid #CCCCCC;
131 background-color: #f5f5f5;
132 padding: 4px 6px;
133 margin: 4px 8px 4px 2px;
134 }
135
136 div.ah {
137 background-color: black;
138 font-weight: bold;
139 color: #ffffff;
140 margin-bottom: 3px;
141 margin-top: 3px
142 }
143
144 div.groupHeader {
145 margin-left: 16px;
146 margin-top: 12px;
147 margin-bottom: 6px;
148 font-weight: bold;
149 }
150
151 div.groupText {
152 margin-left: 16px;
153 font-style: italic;
154 }
155
156 body {
157 background: white;
158 color: black;
159 margin-right: 20px;
160 margin-left: 20px;
161 }
162
163 td.indexkey {
164 background-color: #e8eef2;
165 font-weight: bold;
166 border: 1px solid #CCCCCC;
167 margin: 2px 0px 2px 0;
168 padding: 2px 10px;
169 }
170
171 td.indexvalue {
172 background-color: #e8eef2;
173 border: 1px solid #CCCCCC;
174 padding: 2px 10px;
175 margin: 2px 0px;
176 }
177
178 tr.memlist {
179 background-color: #f0f0f0;
180 }
181
182 p.formulaDsp {
183 text-align: center;
184 }
185
186 img.formulaDsp {
187
188 }
189
190 img.formulaInl {
191 vertical-align: middle;
192 }
193
194 div.center {
195 text-align: center;
196 margin-top: 0px;
197 margin-bottom: 0px;
198 padding: 0px;
199 }
200
201 div.center img {
202 border: 0px;
203 }
204
205 img.footer {
206 border: 0px;
207 vertical-align: middle;
208 }
209
210 /* @group Code Colorization */
211
212 span.keyword {
213 color: #008000
214 }
215
216 span.keywordtype {
217 color: #604020
218 }
219
220 span.keywordflow {
221 color: #e08000
222 }
223
224 span.comment {
225 color: #800000
226 }
227
228 span.preprocessor {
229 color: #806020
230 }
231
232 span.stringliteral {
233 color: #002080
234 }
235
236 span.charliteral {
237 color: #008080
238 }
239
240 span.vhdldigit {
241 color: #ff00ff
242 }
243
244 span.vhdlchar {
245 color: #000000
246 }
247
248 span.vhdlkeyword {
249 color: #700070
250 }
251
252 span.vhdllogic {
253 color: #ff0000
254 }
255
256 /* @end */
257
258 .search {
259 color: #003399;
260 font-weight: bold;
261 }
262
263 form.search {
264 margin-bottom: 0px;
265 margin-top: 0px;
266 }
267
268 input.search {
269 font-size: 75%;
270 color: #000080;
271 font-weight: normal;
272 background-color: #e8eef2;
273 }
274
275 td.tiny {
276 font-size: 75%;
277 }
278
279 .dirtab {
280 padding: 4px;
281 border-collapse: collapse;
282 border: 1px solid #84b0c7;
283 }
284
285 th.dirtab {
286 background: #e8eef2;
287 font-weight: bold;
288 }
289
290 hr {
291 height: 0;
292 border: none;
293 border-top: 1px solid #666;
294 }
295
296 /* @group Member Descriptions */
297
298 .mdescLeft, .mdescRight,
299 .memItemLeft, .memItemRight,
300 .memTemplItemLeft, .memTemplItemRight, .memTemplParams {
301 background-color: #FAFAFA;
302 border: none;
303 margin: 4px;
304 padding: 1px 0 0 8px;
305 }
306
307 .mdescLeft, .mdescRight {
308 padding: 0px 8px 4px 8px;
309 color: #555;
310 }
311
312 .memItemLeft, .memItemRight, .memTemplParams {
313 border-top: 1px solid #ccc;
314 }
315
316 .memItemLeft, .memTemplItemLeft {
317 white-space: nowrap;
318 }
319
320 .memTemplParams {
321 color: #606060;
322 white-space: nowrap;
323 }
324
325 /* @end */
326
327 /* @group Member Details */
328
329 /* Styles for detailed member documentation */
330
331 .memtemplate {
332 font-size: 80%;
333 color: #606060;
334 font-weight: normal;
335 margin-left: 3px;
336 }
337
338 .memnav {
339 background-color: #e8eef2;
340 border: 1px solid #84b0c7;
341 text-align: center;
342 margin: 2px;
343 margin-right: 15px;
344 padding: 2px;
345 }
346
347 .memitem {
348 padding: 0;
349 margin-bottom: 10px;
350 }
351
352 .memname {
353 white-space: nowrap;
354 font-weight: bold;
355 }
356
357 .memproto, .memdoc {
358 border: 1px solid #84b0c7;
359 }
360
361 .memproto {
362 padding: 0;
363 background-color: #d5e1e8;
364 font-weight: bold;
365 -webkit-border-top-left-radius: 8px;
366 -webkit-border-top-right-radius: 8px;
367 -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
368 -moz-border-radius-topleft: 8px;
369 -moz-border-radius-topright: 8px;
370 -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
371
372 }
373
374 .memdoc {
375 padding: 2px 5px;
376 background-color: #eef3f5;
377 border-top-width: 0;
378 -webkit-border-bottom-left-radius: 8px;
379 -webkit-border-bottom-right-radius: 8px;
380 -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
381 -moz-border-radius-bottomleft: 8px;
382 -moz-border-radius-bottomright: 8px;
383 -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
384 }
385
386 .paramkey {
387 text-align: right;
388 }
389
390 .paramtype {
391 white-space: nowrap;
392 }
393
394 .paramname {
395 color: #602020;
396 white-space: nowrap;
397 }
398 .paramname em {
399 font-style: normal;
400 }
401
402 /* @end */
403
404 /* @group Directory (tree) */
405
406 /* for the tree view */
407
408 .ftvtree {
409 font-family: sans-serif;
410 margin: 0.5em;
411 }
412
413 /* these are for tree view when used as main index */
414
415 .directory {
416 font-size: 9pt;
417 font-weight: bold;
418 }
419
420 .directory h3 {
421 margin: 0px;
422 margin-top: 1em;
423 font-size: 11pt;
424 }
425
426 /*
427 The following two styles can be used to replace the root node title
428 with an image of your choice. Simply uncomment the next two styles,
429 specify the name of your image and be sure to set 'height' to the
430 proper pixel height of your image.
431 */
432
433 /*
434 .directory h3.swap {
435 height: 61px;
436 background-repeat: no-repeat;
437 background-image: url("yourimage.gif");
438 }
439 .directory h3.swap span {
440 display: none;
441 }
442 */
443
444 .directory > h3 {
445 margin-top: 0;
446 }
447
448 .directory p {
449 margin: 0px;
450 white-space: nowrap;
451 }
452
453 .directory div {
454 display: none;
455 margin: 0px;
456 }
457
458 .directory img {
459 vertical-align: -30%;
460 }
461
462 /* these are for tree view when not used as main index */
463
464 .directory-alt {
465 font-size: 100%;
466 font-weight: bold;
467 }
468
469 .directory-alt h3 {
470 margin: 0px;
471 margin-top: 1em;
472 font-size: 11pt;
473 }
474
475 .directory-alt > h3 {
476 margin-top: 0;
477 }
478
479 .directory-alt p {
480 margin: 0px;
481 white-space: nowrap;
482 }
483
484 .directory-alt div {
485 display: none;
486 margin: 0px;
487 }
488
489 .directory-alt img {
490 vertical-align: -30%;
491 }
492
493 /* @end */
494
495 address {
496 font-style: normal;
497 color: #333;
498 }
Show file before | Show file after | Hide comments
This diff has been collapsed as it changes many lines, (636 lines changed) Show them Hide them
@@ -1,4 +1,4
1 # Doxyfile 1.3.5
1 # Doxyfile 1.6.1
2 2
3 3 # This file describes the settings to be used by the documentation system
4 4 # doxygen (www.doxygen.org) for a project
@@ -14,6 +14,14
14 14 # Project related configuration options
15 15 #---------------------------------------------------------------------------
16 16
17 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23 DOXYFILE_ENCODING = UTF-8
24
17 25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18 26 # by quotes) that should identify the project.
19 27
@@ -23,7 +31,7 PROJECT_NAME = PythonQt
23 31 # This could be handy for archiving the generated documentation or
24 32 # if some version control system is used.
25 33
26 PROJECT_NUMBER = 2.0
34 PROJECT_NUMBER =
27 35
28 36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29 37 # base path where the generated documentation will be put.
@@ -32,27 +40,28 PROJECT_NUMBER = 2.0
32 40
33 41 OUTPUT_DIRECTORY = .
34 42
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
45 # format and will distribute the generated files over these directories.
46 # Enabling this option can be useful when feeding doxygen a huge amount of
47 # source files, where putting all generated files in the same directory would
48 # otherwise cause performance problems for the file system.
49
50 CREATE_SUBDIRS = NO
51
35 52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
36 53 # documentation generated by doxygen is written. Doxygen will use this
37 54 # information to generate all constant output in the proper language.
38 55 # The default language is English, other supported languages are:
39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
43 62
44 63 OUTPUT_LANGUAGE = English
45 64
46 # This tag can be used to specify the encoding used in the generated output.
47 # The encoding is not always determined by the language that is chosen,
48 # but also whether or not the output is meant for Windows or non-Windows users.
49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
50 # forces the Windows encoding (this is the default for the Windows binary),
51 # whereas setting the tag to NO uses a Unix-style encoding (the default for
52 # all platforms other than Windows).
53
54 USE_WINDOWS_ENCODING = NO
55
56 65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57 66 # include brief member descriptions after the members that are listed in
58 67 # the file and class documentation (similar to JavaDoc).
@@ -70,11 +79,12 REPEAT_BRIEF = YES
70 79 # This tag implements a quasi-intelligent brief description abbreviator
71 80 # that is used to form the text in various listings. Each string
72 81 # in this list, if found as the leading text of the brief description, will be
73 # stripped from the text and the result after processing the whole list, is used
74 # as the annotated text. Otherwise, the brief description is used as-is. If left
75 # blank, the following values are used ("$name" is automatically replaced with the
76 # name of the entity): "The $name class" "The $name widget" "The $name file"
77 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
82 # stripped from the text and the result after processing the whole list, is
83 # used as the annotated text. Otherwise, the brief description is used as-is.
84 # If left blank, the following values are used ("$name" is automatically
85 # replaced with the name of the entity): "The $name class" "The $name widget"
86 # "The $name file" "is" "provides" "specifies" "contains"
87 # "represents" "a" "an" "the"
78 88
79 89 ABBREVIATE_BRIEF =
80 90
@@ -84,10 +94,10 ABBREVIATE_BRIEF =
84 94
85 95 ALWAYS_DETAILED_SEC = NO
86 96
87 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
88 # members of a class in the documentation of that class as if those members were
89 # ordinary class members. Constructors, destructors and assignment operators of
90 # the base classes will not be shown.
97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98 # inherited members of a class in the documentation of that class as if those
99 # members were ordinary class members. Constructors, destructors and assignment
100 # operators of the base classes will not be shown.
91 101
92 102 INLINE_INHERITED_MEMB = NO
93 103
@@ -100,10 +110,21 FULL_PATH_NAMES = NO
100 110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
101 111 # can be used to strip a user-defined part of the path. Stripping is
102 112 # only done if one of the specified strings matches the left-hand part of
103 # the path. It is allowed to use relative paths in the argument list.
113 # the path. The tag can be used to show relative paths in the file list.
114 # If left blank the directory from which doxygen is run is used as the
115 # path to strip.
104 116
105 117 STRIP_FROM_PATH =
106 118
119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120 # the path mentioned in the documentation of a class, which tells
121 # the reader which header file to include in order to use a class.
122 # If left blank only the name of the header file containing the class
123 # definition is used. Otherwise one should specify the include paths that
124 # are normally passed to the compiler using the -I flag.
125
126 STRIP_FROM_INC_PATH =
127
107 128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
108 129 # (but less readable) file names. This can be useful is your file systems
109 130 # doesn't support long names like on DOS, Mac, or CD-ROM.
@@ -113,11 +134,19 SHORT_NAMES = NO
113 134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
114 135 # will interpret the first line (until the first dot) of a JavaDoc-style
115 136 # comment as the brief description. If set to NO, the JavaDoc
116 # comments will behave just like the Qt-style comments (thus requiring an
117 # explicit @brief command for a brief description.
137 # comments will behave just like regular Qt-style comments
138 # (thus requiring an explicit @brief command for a brief description.)
118 139
119 140 JAVADOC_AUTOBRIEF = NO
120 141
142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143 # interpret the first line (until the first dot) of a Qt-style
144 # comment as the brief description. If set to NO, the comments
145 # will behave just like regular Qt-style comments (thus requiring
146 # an explicit \brief command for a brief description.)
147
148 QT_AUTOBRIEF = NO
149
121 150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
122 151 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
123 152 # comments) as a brief description. This used to be the default behaviour.
@@ -126,25 +155,17 JAVADOC_AUTOBRIEF = NO
126 155
127 156 MULTILINE_CPP_IS_BRIEF = NO
128 157
129 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
130 # will output the detailed description near the top, like JavaDoc.
131 # If set to NO, the detailed description appears after the member
132 # documentation.
133
134 DETAILS_AT_TOP = NO
135
136 158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
137 159 # member inherits the documentation from any documented member that it
138 160 # re-implements.
139 161
140 162 INHERIT_DOCS = YES
141 163
142 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
143 # tag is set to YES, then doxygen will reuse the documentation of the first
144 # member in the group (if any) for the other members of the group. By default
145 # all members of a group must be documented explicitly.
164 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
165 # a new page for each member. If set to NO, the documentation of a member will
166 # be part of the file/class/namespace that contains it.
146 167
147 DISTRIBUTE_GROUP_DOC = NO
168 SEPARATE_MEMBER_PAGES = NO
148 169
149 170 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
150 171 # Doxygen uses this value to replace tabs by spaces in code fragments.
@@ -160,20 +181,79 TAB_SIZE = 4
160 181
161 182 ALIASES =
162 183
163 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
164 # only. Doxygen will then generate output that is more tailored for C.
184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
185 # sources only. Doxygen will then generate output that is more tailored for C.
165 186 # For instance, some of the names that are used will be different. The list
166 187 # of all members will be omitted, etc.
167 188
168 189 OPTIMIZE_OUTPUT_FOR_C = NO
169 190
170 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
171 # only. Doxygen will then generate output that is more tailored for Java.
172 # For instance, namespaces will be presented as packages, qualified scopes
173 # will look different, etc.
191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
192 # sources only. Doxygen will then generate output that is more tailored for
193 # Java. For instance, namespaces will be presented as packages, qualified
194 # scopes will look different, etc.
174 195
175 196 OPTIMIZE_OUTPUT_JAVA = NO
176 197
198 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
199 # sources only. Doxygen will then generate output that is more tailored for
200 # Fortran.
201
202 OPTIMIZE_FOR_FORTRAN = NO
203
204 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
205 # sources. Doxygen will then generate output that is tailored for
206 # VHDL.
207
208 OPTIMIZE_OUTPUT_VHDL = NO
209
210 # Doxygen selects the parser to use depending on the extension of the files it parses.
211 # With this tag you can assign which parser to use for a given extension.
212 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
213 # The format is ext=language, where ext is a file extension, and language is one of
214 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
215 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
216 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
217 # use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
218
219 EXTENSION_MAPPING =
220
221 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
222 # to include (a tag file for) the STL sources as input, then you should
223 # set this tag to YES in order to let doxygen match functions declarations and
224 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
225 # func(std::string) {}). This also make the inheritance and collaboration
226 # diagrams that involve STL classes more complete and accurate.
227
228 BUILTIN_STL_SUPPORT = NO
229
230 # If you use Microsoft's C++/CLI language, you should set this option to YES to
231 # enable parsing support.
232
233 CPP_CLI_SUPPORT = NO
234
235 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
236 # Doxygen will parse them like normal C++ but will assume all classes use public
237 # instead of private inheritance when no explicit protection keyword is present.
238
239 SIP_SUPPORT = NO
240
241 # For Microsoft's IDL there are propget and propput attributes to indicate getter
242 # and setter methods for a property. Setting this option to YES (the default)
243 # will make doxygen to replace the get and set methods by a property in the
244 # documentation. This will only work if the methods are indeed getting or
245 # setting a simple type. If this is not the case, or you want to show the
246 # methods anyway, you should set this option to NO.
247
248 IDL_PROPERTY_SUPPORT = YES
249
250 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
251 # tag is set to YES, then doxygen will reuse the documentation of the first
252 # member in the group (if any) for the other members of the group. By default
253 # all members of a group must be documented explicitly.
254
255 DISTRIBUTE_GROUP_DOC = NO
256
177 257 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
178 258 # the same type (for instance a group of public functions) to be put as a
179 259 # subgroup of that type (e.g. under the Public Functions section). Set it to
@@ -182,6 +262,32 OPTIMIZE_OUTPUT_JAVA = NO
182 262
183 263 SUBGROUPING = YES
184 264
265 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
266 # is documented as struct, union, or enum with the name of the typedef. So
267 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
268 # with name TypeT. When disabled the typedef will appear as a member of a file,
269 # namespace, or class. And the struct will be named TypeS. This can typically
270 # be useful for C code in case the coding convention dictates that all compound
271 # types are typedef'ed and only the typedef is referenced, never the tag name.
272
273 TYPEDEF_HIDES_STRUCT = NO
274
275 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
276 # determine which symbols to keep in memory and which to flush to disk.
277 # When the cache is full, less often used symbols will be written to disk.
278 # For small to medium size projects (<1000 input files) the default value is
279 # probably good enough. For larger projects a too small cache size can cause
280 # doxygen to be busy swapping symbols to and from disk most of the time
281 # causing a significant performance penality.
282 # If the system has enough physical memory increasing the cache will improve the
283 # performance by keeping more symbols in memory. Note that the value works on
284 # a logarithmic scale so increasing the size by one will rougly double the
285 # memory usage. The cache size is given by this formula:
286 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
287 # corresponding to a cache size of 2^16 = 65536 symbols
288
289 SYMBOL_CACHE_SIZE = 0
290
185 291 #---------------------------------------------------------------------------
186 292 # Build related configuration options
187 293 #---------------------------------------------------------------------------
@@ -209,6 +315,21 EXTRACT_STATIC = YES
209 315
210 316 EXTRACT_LOCAL_CLASSES = YES
211 317
318 # This flag is only useful for Objective-C code. When set to YES local
319 # methods, which are defined in the implementation section but not in
320 # the interface are included in the documentation.
321 # If set to NO (the default) only methods in the interface are included.
322
323 EXTRACT_LOCAL_METHODS = NO
324
325 # If this flag is set to YES, the members of anonymous namespaces will be
326 # extracted and appear in the documentation as a namespace called
327 # 'anonymous_namespace{file}', where file will be replaced with the base
328 # name of the file that contains the anonymous namespace. By default
329 # anonymous namespace are hidden.
330
331 EXTRACT_ANON_NSPACES = NO
332
212 333 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
213 334 # undocumented members of documented classes, files or namespaces.
214 335 # If set to NO (the default) these members will be included in the
@@ -249,7 +370,7 INTERNAL_DOCS = NO
249 370 # file names in lower-case letters. If set to YES upper-case letters are also
250 371 # allowed. This is useful if you have classes or files whose names only differ
251 372 # in case and if your file system supports case sensitive file names. Windows
252 # users are advised to set this option to NO.
373 # and Mac users are advised to set this option to NO.
253 374
254 375 CASE_SENSE_NAMES = YES
255 376
@@ -277,6 +398,33 INLINE_INFO = YES
277 398
278 399 SORT_MEMBER_DOCS = YES
279 400
401 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
402 # brief documentation of file, namespace and class members alphabetically
403 # by member name. If set to NO (the default) the members will appear in
404 # declaration order.
405
406 SORT_BRIEF_DOCS = NO
407
408 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
409
410 SORT_MEMBERS_CTORS_1ST = NO
411
412 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
413 # hierarchy of group names into alphabetical order. If set to NO (the default)
414 # the group names will appear in their defined order.
415
416 SORT_GROUP_NAMES = NO
417
418 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
419 # sorted by fully-qualified names, including namespaces. If set to
420 # NO (the default), the class list will be sorted only by class name,
421 # not including the namespace part.
422 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
423 # Note: This option applies only to the class list, not to the
424 # alphabetical list.
425
426 SORT_BY_SCOPE_NAME = NO
427
280 428 # The GENERATE_TODOLIST tag can be used to enable (YES) or
281 429 # disable (NO) the todo list. This list is created by putting \todo
282 430 # commands in the documentation.
@@ -322,6 +470,44 MAX_INITIALIZER_LINES = 30
322 470
323 471 SHOW_USED_FILES = YES
324 472
473 # If the sources in your project are distributed over multiple directories
474 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
475 # in the documentation. The default is NO.
476
477 SHOW_DIRECTORIES = NO
478
479 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
480 # This will remove the Files entry from the Quick Index and from the
481 # Folder Tree View (if specified). The default is YES.
482
483 SHOW_FILES = YES
484
485 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
486 # Namespaces page.
487 # This will remove the Namespaces entry from the Quick Index
488 # and from the Folder Tree View (if specified). The default is YES.
489
490 SHOW_NAMESPACES = YES
491
492 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
493 # doxygen should invoke to get the current version for each file (typically from
494 # the version control system). Doxygen will invoke the program by executing (via
495 # popen()) the command <command> <input-file>, where <command> is the value of
496 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
497 # provided by doxygen. Whatever the program writes to standard output
498 # is used as the file version. See the manual for examples.
499
500 FILE_VERSION_FILTER =
501
502 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
503 # doxygen. The layout file controls the global structure of the generated output files
504 # in an output format independent way. The create the layout file that represents
505 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
506 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
507 # of the layout file.
508
509 LAYOUT_FILE =
510
325 511 #---------------------------------------------------------------------------
326 512 # configuration options related to warning and progress messages
327 513 #---------------------------------------------------------------------------
@@ -350,10 +536,20 WARN_IF_UNDOCUMENTED = YES
350 536
351 537 WARN_IF_DOC_ERROR = YES
352 538
539 # This WARN_NO_PARAMDOC option can be abled to get warnings for
540 # functions that are documented, but have no documentation for their parameters
541 # or return value. If set to NO (the default) doxygen will only warn about
542 # wrong or incomplete parameter documentation, but not about the absence of
543 # documentation.
544
545 WARN_NO_PARAMDOC = NO
546
353 547 # The WARN_FORMAT tag determines the format of the warning messages that
354 548 # doxygen can produce. The string should contain the $file, $line, and $text
355 549 # tags, which will be replaced by the file and line number from which the
356 # warning originated and the warning text.
550 # warning originated and the warning text. Optionally the format may contain
551 # $version, which will be replaced by the version of the file (if it could
552 # be obtained via FILE_VERSION_FILTER)
357 553
358 554 WARN_FORMAT = "$file:$line: $text"
359 555
@@ -374,12 +570,20 WARN_LOGFILE = doxygen.log
374 570
375 571 INPUT = ../src
376 572
573 # This tag can be used to specify the character encoding of the source files
574 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
575 # also the default input encoding. Doxygen uses libiconv (or the iconv built
576 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
577 # the list of possible encodings.
578
579 INPUT_ENCODING = UTF-8
580
377 581 # If the value of the INPUT tag contains directories, you can use the
378 582 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
379 583 # and *.h) to filter out the source-files in the directories. If left
380 584 # blank the following patterns are tested:
381 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
382 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
585 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
586 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
383 587
384 588 FILE_PATTERNS = *.h
385 589
@@ -395,17 +599,28 RECURSIVE = NO
395 599
396 600 EXCLUDE =
397 601
398 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
399 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
602 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
603 # directories that are symbolic links (a Unix filesystem feature) are excluded
604 # from the input.
400 605
401 606 EXCLUDE_SYMLINKS = NO
402 607
403 608 # If the value of the INPUT tag contains directories, you can use the
404 609 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
405 # certain files from those directories.
610 # certain files from those directories. Note that the wildcards are matched
611 # against the file with absolute path, so to exclude all test directories
612 # for example use the pattern */test/*
406 613
407 614 EXCLUDE_PATTERNS =
408 615
616 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
617 # (namespaces, classes, functions, etc.) that should be excluded from the
618 # output. The symbol name can be a fully qualified name, a word, or if the
619 # wildcard * is used, a substring. Examples: ANamespace, AClass,
620 # AClass::ANamespace, ANamespace::*Test
621
622 EXCLUDE_SYMBOLS =
623
409 624 # The EXAMPLE_PATH tag can be used to specify one or more files or
410 625 # directories that contain example code fragments that are included (see
411 626 # the \include command).
@@ -438,9 +653,22 IMAGE_PATH =
438 653 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
439 654 # input file. Doxygen will then use the output that the filter program writes
440 655 # to standard output.
656 # If FILTER_PATTERNS is specified, this tag will be
657 # ignored.
441 658
442 659 INPUT_FILTER =
443 660
661 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
662 # basis.
663 # Doxygen will compare the file name with each pattern and apply the
664 # filter if there is a match.
665 # The filters are a list of the form:
666 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
667 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
668 # is applied to all files.
669
670 FILTER_PATTERNS =
671
444 672 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
445 673 # INPUT_FILTER) will be used to filter the input files when producing source
446 674 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
@@ -469,18 +697,34 INLINE_SOURCES = YES
469 697
470 698 STRIP_CODE_COMMENTS = YES
471 699
472 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
700 # If the REFERENCED_BY_RELATION tag is set to YES
473 701 # then for each documented function all documented
474 702 # functions referencing it will be listed.
475 703
476 704 REFERENCED_BY_RELATION = YES
477 705
478 # If the REFERENCES_RELATION tag is set to YES (the default)
706 # If the REFERENCES_RELATION tag is set to YES
479 707 # then for each documented function all documented entities
480 708 # called/used by that function will be listed.
481 709
482 710 REFERENCES_RELATION = YES
483 711
712 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
713 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
714 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
715 # link to the source code.
716 # Otherwise they will link to the documentation.
717
718 REFERENCES_LINK_SOURCE = YES
719
720 # If the USE_HTAGS tag is set to YES then the references to source code
721 # will point to the HTML generated by the htags(1) tool instead of doxygen
722 # built-in source browser. The htags tool is part of GNU's global source
723 # tagging system (see http://www.gnu.org/software/global/global.html). You
724 # will need version 4.8.6 or higher.
725
726 USE_HTAGS = NO
727
484 728 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
485 729 # will generate a verbatim copy of the header file for each class for
486 730 # which an include is specified. Set to NO to disable this.
@@ -550,7 +794,7 HTML_FOOTER =
550 794 # the style sheet file to the HTML output directory, so don't put your own
551 795 # stylesheet in the HTML output directory as well, or it will be erased!
552 796
553 HTML_STYLESHEET =
797 HTML_STYLESHEET = stylesheet.css
554 798
555 799 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
556 800 # files or namespaces will be aligned in HTML using tables. If set to
@@ -558,9 +802,43 HTML_STYLESHEET =
558 802
559 803 HTML_ALIGN_MEMBERS = YES
560 804
805 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
806 # documentation will contain sections that can be hidden and shown after the
807 # page has loaded. For this to work a browser that supports
808 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
809 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
810
811 HTML_DYNAMIC_SECTIONS = NO
812
813 # If the GENERATE_DOCSET tag is set to YES, additional index files
814 # will be generated that can be used as input for Apple's Xcode 3
815 # integrated development environment, introduced with OSX 10.5 (Leopard).
816 # To create a documentation set, doxygen will generate a Makefile in the
817 # HTML output directory. Running make will produce the docset in that
818 # directory and running "make install" will install the docset in
819 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
820 # it at startup.
821 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
822
823 GENERATE_DOCSET = NO
824
825 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
826 # feed. A documentation feed provides an umbrella under which multiple
827 # documentation sets from a single provider (such as a company or product suite)
828 # can be grouped.
829
830 DOCSET_FEEDNAME = "Doxygen generated docs"
831
832 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
833 # should uniquely identify the documentation set bundle. This should be a
834 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
835 # will append .docset to the name.
836
837 DOCSET_BUNDLE_ID = org.doxygen.Project
838
561 839 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
562 840 # will be generated that can be used as input for tools like the
563 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
841 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
564 842 # of the generated HTML documentation.
565 843
566 844 GENERATE_HTMLHELP = NO
@@ -585,6 +863,12 HHC_LOCATION =
585 863
586 864 GENERATE_CHI = NO
587 865
866 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
867 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
868 # content.
869
870 CHM_INDEX_ENCODING =
871
588 872 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
589 873 # controls whether a binary table of contents is generated (YES) or a
590 874 # normal table of contents (NO) in the .chm file.
@@ -596,6 +880,55 BINARY_TOC = NO
596 880
597 881 TOC_EXPAND = NO
598 882
883 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
884 # are set, an additional index file will be generated that can be used as input for
885 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
886 # HTML documentation.
887
888 GENERATE_QHP = NO
889
890 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
891 # be used to specify the file name of the resulting .qch file.
892 # The path specified is relative to the HTML output folder.
893
894 QCH_FILE =
895
896 # The QHP_NAMESPACE tag specifies the namespace to use when generating
897 # Qt Help Project output. For more information please see
898 # http://doc.trolltech.com/qthelpproject.html#namespace
899
900 QHP_NAMESPACE =
901
902 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
903 # Qt Help Project output. For more information please see
904 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
905
906 QHP_VIRTUAL_FOLDER = doc
907
908 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
909 # For more information please see
910 # http://doc.trolltech.com/qthelpproject.html#custom-filters
911
912 QHP_CUST_FILTER_NAME =
913
914 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
915 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
916
917 QHP_CUST_FILTER_ATTRS =
918
919 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
920 # filter section matches.
921 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
922
923 QHP_SECT_FILTER_ATTRS =
924
925 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
926 # be used to specify the location of Qt's qhelpgenerator.
927 # If non-empty doxygen will try to run qhelpgenerator on the generated
928 # .qhp file.
929
930 QHG_LOCATION =
931
599 932 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
600 933 # top of each HTML page. The value NO (the default) enables the index and
601 934 # the value YES disables it.
@@ -607,14 +940,20 DISABLE_INDEX = NO
607 940
608 941 ENUM_VALUES_PER_LINE = 4
609 942
610 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
611 # generated containing a tree-like index structure (just like the one that
943 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
944 # structure should be generated to display hierarchical information.
945 # If the tag value is set to YES, a side panel will be generated
946 # containing a tree-like index structure (just like the one that
612 947 # is generated for HTML Help). For this to work a browser that supports
613 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
614 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
615 # probably better off using the HTML help feature.
948 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
949 # Windows users are probably better off using the HTML help feature.
950
951 GENERATE_TREEVIEW = YES
616 952
617 GENERATE_TREEVIEW = NO
953 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
954 # and Class Hierarchy pages using a tree view instead of an ordered list.
955
956 USE_INLINE_TREES = NO
618 957
619 958 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
620 959 # used to set the initial width (in pixels) of the frame in which the tree
@@ -622,6 +961,21 GENERATE_TREEVIEW = NO
622 961
623 962 TREEVIEW_WIDTH = 250
624 963
964 # Use this tag to change the font size of Latex formulas included
965 # as images in the HTML documentation. The default is 10. Note that
966 # when you change the font size after a successful doxygen run you need
967 # to manually remove any form_*.png images from the HTML output directory
968 # to force them to be regenerated.
969
970 FORMULA_FONTSIZE = 10
971
972 # When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
973 # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
974 # there is already a search function so this one should typically
975 # be disabled.
976
977 SEARCHENGINE = YES
978
625 979 #---------------------------------------------------------------------------
626 980 # configuration options related to the LaTeX output
627 981 #---------------------------------------------------------------------------
@@ -698,6 +1052,10 LATEX_BATCHMODE = NO
698 1052
699 1053 LATEX_HIDE_INDICES = NO
700 1054
1055 # If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
1056
1057 LATEX_SOURCE_CODE = NO
1058
701 1059 #---------------------------------------------------------------------------
702 1060 # configuration options related to the RTF output
703 1061 #---------------------------------------------------------------------------
@@ -834,8 +1192,10 GENERATE_PERLMOD = NO
834 1192 PERLMOD_LATEX = NO
835 1193
836 1194 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
837 # nicely formatted so it can be parsed by a human reader. This is useful
838 # if you want to understand what is going on. On the other hand, if this
1195 # nicely formatted so it can be parsed by a human reader.
1196 # This is useful
1197 # if you want to understand what is going on.
1198 # On the other hand, if this
839 1199 # tag is set to NO the size of the Perl module output will be much smaller
840 1200 # and Perl will parse it just the same.
841 1201
@@ -867,7 +1227,7 MACRO_EXPANSION = YES
867 1227
868 1228 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
869 1229 # then the macro expansion is limited to the macros specified with the
870 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
1230 # PREDEFINED and EXPAND_AS_DEFINED tags.
871 1231
872 1232 EXPAND_ONLY_PREDEF = YES
873 1233
@@ -880,7 +1240,7 SEARCH_INCLUDES = YES
880 1240 # contain include files that are not input files but should be processed by
881 1241 # the preprocessor.
882 1242
883 INCLUDE_PATH = $(QTDIR)/include
1243 INCLUDE_PATH =
884 1244
885 1245 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
886 1246 # patterns (like *.h and *.hpp) to filter out the header-files in the
@@ -893,7 +1253,9 INCLUDE_FILE_PATTERNS = *.h
893 1253 # are defined before the preprocessor is started (similar to the -D option of
894 1254 # gcc). The argument of the tag is a list of macros of the form: name
895 1255 # or name=definition (no spaces). If the definition and the = are
896 # omitted =1 is assumed.
1256 # omitted =1 is assumed. To prevent a macro definition from being
1257 # undefined via #undef or recursively expanded use the := operator
1258 # instead of the = operator.
897 1259
898 1260 PREDEFINED =
899 1261
@@ -907,21 +1269,23 EXPAND_AS_DEFINED =
907 1269 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
908 1270 # doxygen's preprocessor will remove all function-like macros that are alone
909 1271 # on a line, have an all uppercase name, and do not end with a semicolon. Such
910 # function macros are typically used for boiler-plate code, and will confuse the
911 # parser if not removed.
1272 # function macros are typically used for boiler-plate code, and will confuse
1273 # the parser if not removed.
912 1274
913 1275 SKIP_FUNCTION_MACROS = YES
914 1276
915 1277 #---------------------------------------------------------------------------
916 # Configuration::addtions related to external references
1278 # Configuration::additions related to external references
917 1279 #---------------------------------------------------------------------------
918 1280
919 1281 # The TAGFILES option can be used to specify one or more tagfiles.
920 1282 # Optionally an initial location of the external documentation
921 1283 # can be added for each tagfile. The format of a tag file without
922 1284 # this location is as follows:
1285 #
923 1286 # TAGFILES = file1 file2 ...
924 1287 # Adding location for the tag files is done as follows:
1288 #
925 1289 # TAGFILES = file1=loc1 "file2 = loc2" ...
926 1290 # where "loc1" and "loc2" can be relative or absolute paths or
927 1291 # URLs. If a location is present for each tag, the installdox tool
@@ -960,13 +1324,23 PERL_PATH = /usr/bin/perl
960 1324 #---------------------------------------------------------------------------
961 1325
962 1326 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
963 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
964 # super classes. Setting the tag to NO turns the diagrams off. Note that this
965 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is
966 # recommended to install and use dot, since it yields more powerful graphs.
1327 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1328 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1329 # this option is superseded by the HAVE_DOT option below. This is only a
1330 # fallback. It is recommended to install and use dot, since it yields more
1331 # powerful graphs.
967 1332
968 1333 CLASS_DIAGRAMS = YES
969 1334
1335 # You can define message sequence charts within doxygen comments using the \msc
1336 # command. Doxygen will then run the mscgen tool (see
1337 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1338 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1339 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1340 # default search path.
1341
1342 MSCGEN_PATH =
1343
970 1344 # If set to YES, the inheritance and collaboration graphs will hide
971 1345 # inheritance and usage relations if the target is undocumented
972 1346 # or is not a class.
@@ -980,6 +1354,29 HIDE_UNDOC_RELATIONS = YES
980 1354
981 1355 HAVE_DOT = NO
982 1356
1357 # By default doxygen will write a font called FreeSans.ttf to the output
1358 # directory and reference it in all dot files that doxygen generates. This
1359 # font does not include all possible unicode characters however, so when you need
1360 # these (or just want a differently looking font) you can specify the font name
1361 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1362 # which can be done by putting it in a standard location or by setting the
1363 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1364 # containing the font.
1365
1366 DOT_FONTNAME = FreeSans
1367
1368 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1369 # The default size is 10pt.
1370
1371 DOT_FONTSIZE = 10
1372
1373 # By default doxygen will tell dot to use the output directory to look for the
1374 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1375 # different font using DOT_FONTNAME you can set the path where dot
1376 # can find it using this tag.
1377
1378 DOT_FONTPATH =
1379
983 1380 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
984 1381 # will generate a graph for each documented class showing the direct and
985 1382 # indirect inheritance relations. Setting this tag to YES will force the
@@ -994,6 +1391,11 CLASS_GRAPH = YES
994 1391
995 1392 COLLABORATION_GRAPH = YES
996 1393
1394 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1395 # will generate a graph for groups, showing the direct groups dependencies
1396
1397 GROUP_GRAPHS = YES
1398
997 1399 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
998 1400 # collaboration diagrams in a style similar to the OMG's Unified Modeling
999 1401 # Language.
@@ -1019,19 +1421,34 INCLUDE_GRAPH = YES
1019 1421
1020 1422 INCLUDED_BY_GRAPH = YES
1021 1423
1022 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1023 # generate a call dependency graph for every global function or class method.
1024 # Note that enabling this option will significantly increase the time of a run.
1025 # So in most cases it will be better to enable call graphs for selected
1026 # functions only using the \callgraph command.
1424 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1425 # doxygen will generate a call dependency graph for every global function
1426 # or class method. Note that enabling this option will significantly increase
1427 # the time of a run. So in most cases it will be better to enable call graphs
1428 # for selected functions only using the \callgraph command.
1027 1429
1028 1430 CALL_GRAPH = NO
1029 1431
1432 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1433 # doxygen will generate a caller dependency graph for every global function
1434 # or class method. Note that enabling this option will significantly increase
1435 # the time of a run. So in most cases it will be better to enable caller
1436 # graphs for selected functions only using the \callergraph command.
1437
1438 CALLER_GRAPH = NO
1439
1030 1440 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1031 1441 # will graphical hierarchy of all classes instead of a textual one.
1032 1442
1033 1443 GRAPHICAL_HIERARCHY = YES
1034 1444
1445 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1446 # then doxygen will show the dependencies a directory has on other directories
1447 # in a graphical way. The dependency relations are determined by the #include
1448 # relations between the files in the directories.
1449
1450 DIRECTORY_GRAPH = YES
1451
1035 1452 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1036 1453 # generated by dot. Possible values are png, jpg, or gif
1037 1454 # If left blank png will be used.
@@ -1039,7 +1456,7 GRAPHICAL_HIERARCHY = YES
1039 1456 DOT_IMAGE_FORMAT = png
1040 1457
1041 1458 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1042 # found. If left blank, it is assumed the dot tool can be found on the path.
1459 # found. If left blank, it is assumed the dot tool can be found in the path.
1043 1460
1044 1461 DOT_PATH =
1045 1462
@@ -1049,33 +1466,41 DOT_PATH =
1049 1466
1050 1467 DOTFILE_DIRS =
1051 1468
1052 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1053 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1054 # this value, doxygen will try to truncate the graph, so that it fits within
1055 # the specified constraint. Beware that most browsers cannot cope with very
1056 # large images.
1057
1058 MAX_DOT_GRAPH_WIDTH = 1024
1469 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1470 # nodes that will be shown in the graph. If the number of nodes in a graph
1471 # becomes larger than this value, doxygen will truncate the graph, which is
1472 # visualized by representing a node as a red box. Note that doxygen if the
1473 # number of direct children of the root node in a graph is already larger than
1474 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1475 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1059 1476
1060 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1061 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1062 # this value, doxygen will try to truncate the graph, so that it fits within
1063 # the specified constraint. Beware that most browsers cannot cope with very
1064 # large images.
1065
1066 MAX_DOT_GRAPH_HEIGHT = 1024
1477 DOT_GRAPH_MAX_NODES = 50
1067 1478
1068 1479 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1069 1480 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1070 # from the root by following a path via at most 3 edges will be shown. Nodes that
1071 # lay further from the root node will be omitted. Note that setting this option to
1072 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1073 # note that a graph may be further truncated if the graph's image dimensions are
1074 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1075 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
1481 # from the root by following a path via at most 3 edges will be shown. Nodes
1482 # that lay further from the root node will be omitted. Note that setting this
1483 # option to 1 or 2 may greatly reduce the computation time needed for large
1484 # code bases. Also note that the size of a graph can be further restricted by
1485 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1076 1486
1077 1487 MAX_DOT_GRAPH_DEPTH = 0
1078 1488
1489 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1490 # background. This is disabled by default, because dot on Windows does not
1491 # seem to support this out of the box. Warning: Depending on the platform used,
1492 # enabling this option may lead to badly anti-aliased labels on the edges of
1493 # a graph (i.e. they become hard to read).
1494
1495 DOT_TRANSPARENT = NO
1496
1497 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1498 # files in one run (i.e. multiple -o and -T options on the command line). This
1499 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1500 # support this, this feature is disabled by default.
1501
1502 DOT_MULTI_TARGETS = NO
1503
1079 1504 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1080 1505 # generate a legend page explaining the meaning of the various boxes and
1081 1506 # arrows in the dot generated graphs.
@@ -1087,12 +1512,3 GENERATE_LEGEND = YES
1087 1512 # the various graphs.
1088 1513
1089 1514 DOT_CLEANUP = YES
1090
1091 #---------------------------------------------------------------------------
1092 # Configuration::addtions related to the search engine
1093 #---------------------------------------------------------------------------
1094
1095 # The SEARCHENGINE tag specifies whether or not a search engine should be
1096 # used. If set to NO the values of all tags below this one will be ignored.
1097
1098 SEARCHENGINE = NO
Show file before | Show file after | Hide comments
@@ -1,7 +1,13
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
1 <!-- This comment will put IE 6, 7 and 8 in quirks mode -->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
3 6 <title>$title</title>
4 <link href="$relpath$doxygen.css" rel="stylesheet" type="text/css">
5 <link href="$relpath$tabs.css" rel="stylesheet" type="text/css">
6 </head><body>
7 <link href="$relpath$tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="$relpath$search/search.css" rel="stylesheet" type="text/css"/>
9 <script type="text/javaScript" src="$relpath$search/search.js"></script>
10 <link href="$relpath$stylesheet.css" rel="stylesheet" type="text/css"/>
11 </head>
12 <body onload='searchBox.OnSelectItem(0);'>
7 13 <div style="float:right;"> <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=181737&amp;type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a></div>
General Comments 0
You need to be logged in to leave comments. Login now