/[ascend]/trunk/base/doc/Doxyfile.base
ViewVC logotype

Annotation of /trunk/base/doc/Doxyfile.base

Parent Directory Parent Directory | Revision Log Revision Log


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

john.pye@anu.edu.au
ViewVC Help
Powered by ViewVC 1.1.22