/[escript]/trunk/doc/doxygen/doxygen_esys
ViewVC logotype

Annotation of /trunk/doc/doxygen/doxygen_esys

Parent Directory Parent Directory | Revision Log Revision Log


Revision 369 - (hide annotations)
Fri Dec 16 00:51:22 2005 UTC (14 years ago) by cochrane
File size: 44850 byte(s)
Building of API documentation now works.  Both epydoc- and doxygen-generated
docs are built.

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

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision

  ViewVC Help
Powered by ViewVC 1.1.26