[svn] / tags / branch-release-1-0 / xvidcore / doc / API.dox Repository:
ViewVC logotype

Annotation of /tags/branch-release-1-0/xvidcore/doc/API.dox

Parent Directory Parent Directory | Revision Log Revision Log


Revision 908 - (view) (download)

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

No admin address has been configured
ViewVC Help
Powered by ViewVC 1.0.4