/[escript]/branches/arrayview_from_1695_trunk/doc/doxygen/doxygen_esys
ViewVC logotype

Annotation of /branches/arrayview_from_1695_trunk/doc/doxygen/doxygen_esys

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1779 - (hide annotations)
Thu Sep 11 01:06:15 2008 UTC (10 years, 11 months ago) by jfenwick
File size: 59737 byte(s)
Branch commit:

Updated the doxyfile for deprecated/modified options (eg encoding is set 
to UTF-8).
Also set it not to scan directories called .svn or deprecated.

Removed #includes of DataArrayView.h
Moved DataArrayView into a new deprecated directory

Commented out setTaggedValue in DataExpanded which still referred to 
DataArrayView

Fixed some of the doxygen comments in DataMaths.h, DataTypes.h, 
DataTagged.h

Removed the empty JoelMods.cpp_

Unit tests appear to indicate that this branch is now "no more broken" 
than the version I branched from.



1 jfenwick 1779 # Doxyfile 1.5.6
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 jfenwick 1779 # This tag specifies the encoding used for all characters in the config file
18     # that follow. The default is UTF-8 which is also the encoding used for all
19     # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20     # iconv built into libc) for the transcoding. See
21     # http://www.gnu.org/software/libiconv for the list of possible encodings.
22    
23     DOXYFILE_ENCODING = UTF-8
24    
25 jgs 82 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26     # by quotes) that should identify the project.
27    
28 cochrane 354 PROJECT_NAME = ESYS13
29 jgs 82
30     # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31     # This could be handy for archiving the generated documentation or
32     # if some version control system is used.
33    
34 jfenwick 1779 PROJECT_NUMBER = Revision$Revision:1215$
35 jgs 82
36     # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37     # base path where the generated documentation will be put.
38     # If a relative path is entered, it will be relative to the location
39     # where doxygen was started. If left blank the current directory will be used.
40    
41 ksteube 1215 OUTPUT_DIRECTORY = release/doc/doxygen
42 jgs 82
43 jfenwick 1779 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44     # 4096 sub-directories (in 2 levels) under the output directory of each output
45     # format and will distribute the generated files over these directories.
46     # Enabling this option can be useful when feeding doxygen a huge amount of
47     # source files, where putting all generated files in the same directory would
48     # otherwise cause performance problems for the file system.
49    
50     CREATE_SUBDIRS = NO
51    
52 jgs 82 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
53     # documentation generated by doxygen is written. Doxygen will use this
54     # information to generate all constant output in the proper language.
55     # The default language is English, other supported languages are:
56 jfenwick 1779 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57     # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
58     # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
59     # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
60     # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
61     # and Ukrainian.
62 jgs 82
63     OUTPUT_LANGUAGE = English
64    
65     # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66     # include brief member descriptions after the members that are listed in
67     # the file and class documentation (similar to JavaDoc).
68     # Set to NO to disable this.
69    
70     BRIEF_MEMBER_DESC = YES
71    
72     # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73     # the brief description of a member or function before the detailed description.
74     # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75     # brief descriptions will be completely suppressed.
76    
77     REPEAT_BRIEF = YES
78    
79 jgs 121 # This tag implements a quasi-intelligent brief description abbreviator
80     # that is used to form the text in various listings. Each string
81     # in this list, if found as the leading text of the brief description, will be
82 jfenwick 1779 # stripped from the text and the result after processing the whole list, is
83     # used as the annotated text. Otherwise, the brief description is used as-is.
84     # If left blank, the following values are used ("$name" is automatically
85     # replaced with the name of the entity): "The $name class" "The $name widget"
86     # "The $name file" "is" "provides" "specifies" "contains"
87     # "represents" "a" "an" "the"
88 jgs 121
89     ABBREVIATE_BRIEF =
90    
91 jgs 82 # 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 jgs 121 ALWAYS_DETAILED_SEC = YES
96 jgs 82
97 jfenwick 1779 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98     # inherited members of a class in the documentation of that class as if those
99     # members were ordinary class members. Constructors, destructors and assignment
100     # operators of the base classes will not be shown.
101 jgs 121
102     INLINE_INHERITED_MEMB = NO
103    
104 jgs 82 # 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 = NO
109    
110     # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111 jgs 121 # can be used to strip a user-defined part of the path. Stripping is
112 jgs 82 # only done if one of the specified strings matches the left-hand part of
113 jfenwick 1779 # 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 jgs 82
117     STRIP_FROM_PATH =
118    
119 jfenwick 1779 # 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 jgs 121 # 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 jgs 82
132 jgs 121 SHORT_NAMES = NO
133 jgs 82
134 jgs 121 # 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 jfenwick 1779 # comments will behave just like regular Qt-style comments
138     # (thus requiring an explicit @brief command for a brief description.)
139 jgs 82
140 jgs 121 JAVADOC_AUTOBRIEF = NO
141 jgs 82
142 jfenwick 1779 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143     # interpret the first line (until the first dot) of a Qt-style
144     # comment as the brief description. If set to NO, the comments
145     # will behave just like regular Qt-style comments (thus requiring
146     # an explicit \brief command for a brief description.)
147    
148     QT_AUTOBRIEF = NO
149    
150 jgs 121 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151     # treat a multi-line C++ special comment block (i.e. a block of //! or ///
152     # comments) as a brief description. This used to be the default behaviour.
153     # The new default is to treat a multi-line C++ comment block as a detailed
154     # description. Set this tag to YES if you prefer the old behaviour instead.
155 jgs 82
156 jgs 121 MULTILINE_CPP_IS_BRIEF = NO
157 jgs 82
158 jgs 121 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
159     # will output the detailed description near the top, like JavaDoc.
160     # If set to NO, the detailed description appears after the member
161     # documentation.
162 jgs 82
163 jgs 121 DETAILS_AT_TOP = NO
164 jgs 82
165 jgs 121 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
166     # member inherits the documentation from any documented member that it
167     # re-implements.
168 jgs 82
169 jgs 121 INHERIT_DOCS = YES
170 jgs 82
171 jfenwick 1779 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
172     # a new page for each member. If set to NO, the documentation of a member will
173     # be part of the file/class/namespace that contains it.
174 jgs 121
175 jfenwick 1779 SEPARATE_MEMBER_PAGES = NO
176 jgs 121
177     # The TAB_SIZE tag can be used to set the number of spaces in a tab.
178     # Doxygen uses this value to replace tabs by spaces in code fragments.
179    
180     TAB_SIZE = 4
181    
182     # This tag can be used to specify a number of aliases that acts
183     # as commands in the documentation. An alias has the form "name=value".
184     # For example adding "sideeffect=\par Side Effects:\n" will allow you to
185     # put the command \sideeffect (or @sideeffect) in the documentation, which
186     # will result in a user-defined paragraph with heading "Side Effects:".
187     # You can put \n's in the value part of an alias to insert newlines.
188    
189     ALIASES =
190    
191 jfenwick 1779 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
192     # sources only. Doxygen will then generate output that is more tailored for C.
193 jgs 121 # For instance, some of the names that are used will be different. The list
194     # of all members will be omitted, etc.
195    
196     OPTIMIZE_OUTPUT_FOR_C = NO
197    
198 jfenwick 1779 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
199     # sources only. Doxygen will then generate output that is more tailored for
200     # Java. For instance, namespaces will be presented as packages, qualified
201     # scopes will look different, etc.
202 jgs 121
203     OPTIMIZE_OUTPUT_JAVA = NO
204    
205 jfenwick 1779 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
206     # sources only. Doxygen will then generate output that is more tailored for
207     # Fortran.
208    
209     OPTIMIZE_FOR_FORTRAN = NO
210    
211     # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
212     # sources. Doxygen will then generate output that is tailored for
213     # VHDL.
214    
215     OPTIMIZE_OUTPUT_VHDL = NO
216    
217     # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
218     # to include (a tag file for) the STL sources as input, then you should
219     # set this tag to YES in order to let doxygen match functions declarations and
220     # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
221     # func(std::string) {}). This also make the inheritance and collaboration
222     # diagrams that involve STL classes more complete and accurate.
223    
224     BUILTIN_STL_SUPPORT = YES
225    
226     # If you use Microsoft's C++/CLI language, you should set this option to YES to
227     # enable parsing support.
228    
229     CPP_CLI_SUPPORT = NO
230    
231     # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
232     # Doxygen will parse them like normal C++ but will assume all classes use public
233     # instead of private inheritance when no explicit protection keyword is present.
234    
235     SIP_SUPPORT = NO
236    
237     # For Microsoft's IDL there are propget and propput attributes to indicate getter
238     # and setter methods for a property. Setting this option to YES (the default)
239     # will make doxygen to replace the get and set methods by a property in the
240     # documentation. This will only work if the methods are indeed getting or
241     # setting a simple type. If this is not the case, or you want to show the
242     # methods anyway, you should set this option to NO.
243    
244     IDL_PROPERTY_SUPPORT = YES
245    
246     # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
247     # tag is set to YES, then doxygen will reuse the documentation of the first
248     # member in the group (if any) for the other members of the group. By default
249     # all members of a group must be documented explicitly.
250    
251     DISTRIBUTE_GROUP_DOC = NO
252    
253 jgs 121 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
254     # the same type (for instance a group of public functions) to be put as a
255     # subgroup of that type (e.g. under the Public Functions section). Set it to
256     # NO to prevent subgrouping. Alternatively, this can be done per class using
257     # the \nosubgrouping command.
258    
259     SUBGROUPING = YES
260    
261 jfenwick 1779 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
262     # is documented as struct, union, or enum with the name of the typedef. So
263     # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
264     # with name TypeT. When disabled the typedef will appear as a member of a file,
265     # namespace, or class. And the struct will be named TypeS. This can typically
266     # be useful for C code in case the coding convention dictates that all compound
267     # types are typedef'ed and only the typedef is referenced, never the tag name.
268    
269     TYPEDEF_HIDES_STRUCT = NO
270    
271 jgs 121 #---------------------------------------------------------------------------
272     # Build related configuration options
273     #---------------------------------------------------------------------------
274    
275     # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
276     # documentation are documented, even if no documentation was available.
277     # Private class members and static file members will be hidden unless
278     # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
279    
280     EXTRACT_ALL = YES
281    
282     # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
283     # will be included in the documentation.
284    
285     EXTRACT_PRIVATE = YES
286    
287     # If the EXTRACT_STATIC tag is set to YES all static members of a file
288     # will be included in the documentation.
289    
290     EXTRACT_STATIC = YES
291    
292     # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
293     # defined locally in source files will be included in the documentation.
294     # If set to NO only classes defined in header files are included.
295    
296     EXTRACT_LOCAL_CLASSES = YES
297    
298 jfenwick 1779 # This flag is only useful for Objective-C code. When set to YES local
299     # methods, which are defined in the implementation section but not in
300     # the interface are included in the documentation.
301     # If set to NO (the default) only methods in the interface are included.
302    
303     EXTRACT_LOCAL_METHODS = NO
304    
305     # If this flag is set to YES, the members of anonymous namespaces will be
306     # extracted and appear in the documentation as a namespace called
307     # 'anonymous_namespace{file}', where file will be replaced with the base
308     # name of the file that contains the anonymous namespace. By default
309     # anonymous namespace are hidden.
310    
311     EXTRACT_ANON_NSPACES = NO
312    
313 jgs 121 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
314     # undocumented members of documented classes, files or namespaces.
315     # If set to NO (the default) these members will be included in the
316     # various overviews, but no documentation section is generated.
317     # This option has no effect if EXTRACT_ALL is enabled.
318    
319     HIDE_UNDOC_MEMBERS = NO
320    
321     # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
322     # undocumented classes that are normally visible in the class hierarchy.
323     # If set to NO (the default) these classes will be included in the various
324     # overviews. This option has no effect if EXTRACT_ALL is enabled.
325    
326     HIDE_UNDOC_CLASSES = NO
327    
328     # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
329     # friend (class|struct|union) declarations.
330     # If set to NO (the default) these declarations will be included in the
331     # documentation.
332    
333     HIDE_FRIEND_COMPOUNDS = NO
334    
335     # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
336     # documentation blocks found inside the body of a function.
337     # If set to NO (the default) these blocks will be appended to the
338     # function's detailed documentation block.
339    
340     HIDE_IN_BODY_DOCS = NO
341    
342     # The INTERNAL_DOCS tag determines if documentation
343     # that is typed after a \internal command is included. If the tag is set
344     # to NO (the default) then the documentation will be excluded.
345     # Set it to YES to include the internal documentation.
346    
347     INTERNAL_DOCS = NO
348    
349 jgs 82 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
350 jgs 121 # file names in lower-case letters. If set to YES upper-case letters are also
351 jgs 82 # allowed. This is useful if you have classes or files whose names only differ
352     # in case and if your file system supports case sensitive file names. Windows
353 jfenwick 1779 # and Mac users are advised to set this option to NO.
354 jgs 82
355     CASE_SENSE_NAMES = YES
356    
357     # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
358     # will show members with their full class and namespace scopes in the
359     # documentation. If set to YES the scope will be hidden.
360    
361     HIDE_SCOPE_NAMES = NO
362    
363     # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
364 jgs 121 # will put a list of the files that are included by a file in the documentation
365 jgs 82 # of that file.
366    
367     SHOW_INCLUDE_FILES = YES
368    
369     # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
370     # is inserted in the documentation for inline members.
371    
372     INLINE_INFO = YES
373    
374     # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
375     # will sort the (detailed) documentation of file and class members
376     # alphabetically by member name. If set to NO the members will appear in
377     # declaration order.
378    
379     SORT_MEMBER_DOCS = YES
380    
381 jfenwick 1779 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
382     # brief documentation of file, namespace and class members alphabetically
383     # by member name. If set to NO (the default) the members will appear in
384     # declaration order.
385    
386     SORT_BRIEF_DOCS = NO
387    
388     # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
389     # hierarchy of group names into alphabetical order. If set to NO (the default)
390     # the group names will appear in their defined order.
391    
392     SORT_GROUP_NAMES = NO
393    
394     # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
395     # sorted by fully-qualified names, including namespaces. If set to
396     # NO (the default), the class list will be sorted only by class name,
397     # not including the namespace part.
398     # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
399     # Note: This option applies only to the class list, not to the
400     # alphabetical list.
401    
402     SORT_BY_SCOPE_NAME = NO
403    
404 jgs 82 # The GENERATE_TODOLIST tag can be used to enable (YES) or
405     # disable (NO) the todo list. This list is created by putting \todo
406     # commands in the documentation.
407    
408     GENERATE_TODOLIST = YES
409    
410     # The GENERATE_TESTLIST tag can be used to enable (YES) or
411     # disable (NO) the test list. This list is created by putting \test
412     # commands in the documentation.
413    
414     GENERATE_TESTLIST = YES
415    
416     # The GENERATE_BUGLIST tag can be used to enable (YES) or
417     # disable (NO) the bug list. This list is created by putting \bug
418     # commands in the documentation.
419    
420     GENERATE_BUGLIST = YES
421    
422 jgs 121 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
423     # disable (NO) the deprecated list. This list is created by putting
424     # \deprecated commands in the documentation.
425 jgs 82
426 jgs 121 GENERATE_DEPRECATEDLIST= YES
427 jgs 82
428 jgs 121 # The ENABLED_SECTIONS tag can be used to enable conditional
429     # documentation sections, marked by \if sectionname ... \endif.
430    
431     ENABLED_SECTIONS =
432    
433 jgs 82 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
434 jgs 121 # the initial value of a variable or define consists of for it to appear in
435 jgs 82 # the documentation. If the initializer consists of more lines than specified
436     # here it will be hidden. Use a value of 0 to hide initializers completely.
437     # The appearance of the initializer of individual variables and defines in the
438     # documentation can be controlled using \showinitializer or \hideinitializer
439     # command in the documentation regardless of this setting.
440    
441     MAX_INITIALIZER_LINES = 30
442    
443     # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
444     # at the bottom of the documentation of classes and structs. If set to YES the
445     # list will mention the files that were used to generate the documentation.
446    
447     SHOW_USED_FILES = YES
448    
449 jfenwick 1779 # If the sources in your project are distributed over multiple directories
450     # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
451     # in the documentation. The default is NO.
452    
453     SHOW_DIRECTORIES = NO
454    
455     # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
456     # This will remove the Files entry from the Quick Index and from the
457     # Folder Tree View (if specified). The default is YES.
458    
459     SHOW_FILES = YES
460    
461     # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
462     # Namespaces page. This will remove the Namespaces entry from the Quick Index
463     # and from the Folder Tree View (if specified). The default is YES.
464    
465     SHOW_NAMESPACES = YES
466    
467     # The FILE_VERSION_FILTER tag can be used to specify a program or script that
468     # doxygen should invoke to get the current version for each file (typically from
469     # the version control system). Doxygen will invoke the program by executing (via
470     # popen()) the command <command> <input-file>, where <command> is the value of
471     # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
472     # provided by doxygen. Whatever the program writes to standard output
473     # is used as the file version. See the manual for examples.
474    
475     FILE_VERSION_FILTER =
476    
477 jgs 82 #---------------------------------------------------------------------------
478     # configuration options related to warning and progress messages
479     #---------------------------------------------------------------------------
480    
481     # The QUIET tag can be used to turn on/off the messages that are generated
482     # by doxygen. Possible values are YES and NO. If left blank NO is used.
483    
484     QUIET = NO
485    
486     # The WARNINGS tag can be used to turn on/off the warning messages that are
487     # generated by doxygen. Possible values are YES and NO. If left blank
488     # NO is used.
489    
490     WARNINGS = YES
491    
492     # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
493     # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
494     # automatically be disabled.
495    
496     WARN_IF_UNDOCUMENTED = YES
497    
498 jgs 121 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
499     # potential errors in the documentation, such as not documenting some
500     # parameters in a documented function, or documenting parameters that
501     # don't exist or using markup commands wrongly.
502    
503     WARN_IF_DOC_ERROR = YES
504    
505 jfenwick 1779 # This WARN_NO_PARAMDOC option can be abled to get warnings for
506     # functions that are documented, but have no documentation for their parameters
507     # or return value. If set to NO (the default) doxygen will only warn about
508     # wrong or incomplete parameter documentation, but not about the absence of
509     # documentation.
510    
511     WARN_NO_PARAMDOC = NO
512    
513 jgs 82 # The WARN_FORMAT tag determines the format of the warning messages that
514     # doxygen can produce. The string should contain the $file, $line, and $text
515     # tags, which will be replaced by the file and line number from which the
516 jfenwick 1779 # warning originated and the warning text. Optionally the format may contain
517     # $version, which will be replaced by the version of the file (if it could
518     # be obtained via FILE_VERSION_FILTER)
519 jgs 82
520     WARN_FORMAT =
521    
522     # The WARN_LOGFILE tag can be used to specify a file to which warning
523     # and error messages should be written. If left blank the output is written
524     # to stderr.
525    
526     WARN_LOGFILE =
527    
528     #---------------------------------------------------------------------------
529     # configuration options related to the input files
530     #---------------------------------------------------------------------------
531    
532     # The INPUT tag can be used to specify the files and/or directories that contain
533     # documented source files. You may enter file names like "myfile.cpp" or
534     # directories like "/usr/src/myproject". Separate the files or directories
535     # with spaces.
536    
537 jfenwick 1779 INPUT = bruce/src \
538     escript/src \
539     esysUtils/src \
540     finley/src \
541     paso/src \
542     pythonMPI/src
543 jgs 82
544 jfenwick 1779 # This tag can be used to specify the character encoding of the source files
545     # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
546     # also the default input encoding. Doxygen uses libiconv (or the iconv built
547     # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
548     # the list of possible encodings.
549    
550     INPUT_ENCODING = UTF-8
551    
552 jgs 82 # If the value of the INPUT tag contains directories, you can use the
553     # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
554     # and *.h) to filter out the source-files in the directories. If left
555 jgs 121 # blank the following patterns are tested:
556 jfenwick 1779 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
557     # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
558 jgs 82
559 jfenwick 1779 FILE_PATTERNS = *.c \
560     *.cpp \
561 jgs 121 *.h
562 jgs 82
563     # The RECURSIVE tag can be used to turn specify whether or not subdirectories
564     # should be searched for input files as well. Possible values are YES and NO.
565     # If left blank NO is used.
566    
567     RECURSIVE = YES
568    
569     # The EXCLUDE tag can be used to specify files and/or directories that should
570     # excluded from the INPUT source files. This way you can easily exclude a
571     # subdirectory from a directory tree whose root is specified with the INPUT tag.
572    
573     EXCLUDE = test
574    
575 jfenwick 1779 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
576     # directories that are symbolic links (a Unix filesystem feature) are excluded
577     # from the input.
578 jgs 121
579     EXCLUDE_SYMLINKS = NO
580    
581 jgs 82 # If the value of the INPUT tag contains directories, you can use the
582     # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
583 jfenwick 1779 # certain files from those directories. Note that the wildcards are matched
584     # against the file with absolute path, so to exclude all test directories
585     # for example use the pattern */test/*
586 jgs 82
587 jfenwick 1779 EXCLUDE_PATTERNS = */.svn/* */.svn */deprecated/*
588 jgs 82
589 jfenwick 1779 #found this pattern on the net - hopefully will not check svn dirs
590    
591    
592     # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
593     # (namespaces, classes, functions, etc.) that should be excluded from the
594     # output. The symbol name can be a fully qualified name, a word, or if the
595     # wildcard * is used, a substring. Examples: ANamespace, AClass,
596     # AClass::ANamespace, ANamespace::*Test
597    
598     EXCLUDE_SYMBOLS =
599    
600 jgs 82 # The EXAMPLE_PATH tag can be used to specify one or more files or
601     # directories that contain example code fragments that are included (see
602     # the \include command).
603    
604     EXAMPLE_PATH =
605    
606     # If the value of the EXAMPLE_PATH tag contains directories, you can use the
607     # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
608     # and *.h) to filter out the source-files in the directories. If left
609     # blank all files are included.
610    
611     EXAMPLE_PATTERNS =
612    
613 jgs 121 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
614     # searched for input files to be used with the \include or \dontinclude
615     # commands irrespective of the value of the RECURSIVE tag.
616     # Possible values are YES and NO. If left blank NO is used.
617    
618     EXAMPLE_RECURSIVE = NO
619    
620 jgs 82 # The IMAGE_PATH tag can be used to specify one or more files or
621     # directories that contain image that are included in the documentation (see
622     # the \image command).
623    
624     IMAGE_PATH =
625    
626     # The INPUT_FILTER tag can be used to specify a program that doxygen should
627     # invoke to filter for each input file. Doxygen will invoke the filter program
628     # by executing (via popen()) the command <filter> <input-file>, where <filter>
629     # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
630     # input file. Doxygen will then use the output that the filter program writes
631 jfenwick 1779 # to standard output. If FILTER_PATTERNS is specified, this tag will be
632     # ignored.
633 jgs 82
634     INPUT_FILTER =
635    
636 jfenwick 1779 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
637     # basis. Doxygen will compare the file name with each pattern and apply the
638     # filter if there is a match. The filters are a list of the form:
639     # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
640     # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
641     # is applied to all files.
642    
643     FILTER_PATTERNS =
644    
645 jgs 82 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
646     # INPUT_FILTER) will be used to filter the input files when producing source
647 jgs 121 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
648 jgs 82
649     FILTER_SOURCE_FILES = NO
650    
651     #---------------------------------------------------------------------------
652 jgs 121 # configuration options related to source browsing
653     #---------------------------------------------------------------------------
654    
655     # If the SOURCE_BROWSER tag is set to YES then a list of source files will
656     # be generated. Documented entities will be cross-referenced with these sources.
657     # Note: To get rid of all source code in the generated output, make sure also
658     # VERBATIM_HEADERS is set to NO.
659    
660     SOURCE_BROWSER = NO
661    
662     # Setting the INLINE_SOURCES tag to YES will include the body
663     # of functions and classes directly in the documentation.
664    
665     INLINE_SOURCES = NO
666    
667     # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
668     # doxygen to hide any special comment blocks from generated source code
669     # fragments. Normal C and C++ comments will always remain visible.
670    
671     STRIP_CODE_COMMENTS = YES
672    
673 jfenwick 1779 # If the REFERENCED_BY_RELATION tag is set to YES
674 jgs 121 # then for each documented function all documented
675     # functions referencing it will be listed.
676    
677     REFERENCED_BY_RELATION = YES
678    
679 jfenwick 1779 # If the REFERENCES_RELATION tag is set to YES
680 jgs 121 # then for each documented function all documented entities
681     # called/used by that function will be listed.
682    
683     REFERENCES_RELATION = YES
684    
685 jfenwick 1779 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
686     # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
687     # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
688     # link to the source code. Otherwise they will link to the documentstion.
689    
690     REFERENCES_LINK_SOURCE = YES
691    
692     # If the USE_HTAGS tag is set to YES then the references to source code
693     # will point to the HTML generated by the htags(1) tool instead of doxygen
694     # built-in source browser. The htags tool is part of GNU's global source
695     # tagging system (see http://www.gnu.org/software/global/global.html). You
696     # will need version 4.8.6 or higher.
697    
698     USE_HTAGS = NO
699    
700 jgs 121 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
701     # will generate a verbatim copy of the header file for each class for
702     # which an include is specified. Set to NO to disable this.
703    
704     VERBATIM_HEADERS = YES
705    
706     #---------------------------------------------------------------------------
707 jgs 82 # configuration options related to the alphabetical class index
708     #---------------------------------------------------------------------------
709    
710     # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
711     # of all compounds will be generated. Enable this if the project
712     # contains a lot of classes, structs, unions or interfaces.
713    
714     ALPHABETICAL_INDEX = YES
715    
716     # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
717     # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
718     # in which this list will be split (can be a number in the range [1..20])
719    
720     COLS_IN_ALPHA_INDEX = 5
721    
722     # In case all classes in a project start with a common prefix, all
723     # classes will be put under the same header in the alphabetical index.
724     # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
725     # should be ignored while generating the index headers.
726    
727     IGNORE_PREFIX =
728    
729     #---------------------------------------------------------------------------
730     # configuration options related to the HTML output
731     #---------------------------------------------------------------------------
732    
733     # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
734     # generate HTML output.
735    
736     GENERATE_HTML = YES
737    
738     # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
739     # If a relative path is entered the value of OUTPUT_DIRECTORY will be
740     # put in front of it. If left blank `html' will be used as the default path.
741    
742     HTML_OUTPUT =
743    
744 jgs 121 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
745     # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
746     # doxygen will generate files with .html extension.
747    
748     HTML_FILE_EXTENSION = .html
749    
750 jgs 82 # The HTML_HEADER tag can be used to specify a personal HTML header for
751     # each generated HTML page. If it is left blank doxygen will generate a
752     # standard header.
753    
754 jgs 121 HTML_HEADER =
755 jgs 82
756     # The HTML_FOOTER tag can be used to specify a personal HTML footer for
757     # each generated HTML page. If it is left blank doxygen will generate a
758     # standard footer.
759    
760     HTML_FOOTER =
761    
762 jgs 121 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
763 jgs 82 # style sheet that is used by each HTML page. It can be used to
764     # fine-tune the look of the HTML output. If the tag is left blank doxygen
765 jgs 121 # will generate a default style sheet. Note that doxygen will try to copy
766     # the style sheet file to the HTML output directory, so don't put your own
767     # stylesheet in the HTML output directory as well, or it will be erased!
768 jgs 82
769     HTML_STYLESHEET =
770    
771     # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
772     # files or namespaces will be aligned in HTML using tables. If set to
773     # NO a bullet list will be used.
774    
775     HTML_ALIGN_MEMBERS = YES
776    
777     # If the GENERATE_HTMLHELP tag is set to YES, additional index files
778     # will be generated that can be used as input for tools like the
779 jfenwick 1779 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
780 jgs 82 # of the generated HTML documentation.
781    
782     GENERATE_HTMLHELP = NO
783    
784 jfenwick 1779 # If the GENERATE_DOCSET tag is set to YES, additional index files
785     # will be generated that can be used as input for Apple's Xcode 3
786     # integrated development environment, introduced with OSX 10.5 (Leopard).
787     # To create a documentation set, doxygen will generate a Makefile in the
788     # HTML output directory. Running make will produce the docset in that
789     # directory and running "make install" will install the docset in
790     # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
791     # it at startup.
792    
793     GENERATE_DOCSET = NO
794    
795     # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
796     # feed. A documentation feed provides an umbrella under which multiple
797     # documentation sets from a single provider (such as a company or product suite)
798     # can be grouped.
799    
800     DOCSET_FEEDNAME = "Doxygen generated docs"
801    
802     # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
803     # should uniquely identify the documentation set bundle. This should be a
804     # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
805     # will append .docset to the name.
806    
807     DOCSET_BUNDLE_ID = org.doxygen.Project
808    
809     # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
810     # documentation will contain sections that can be hidden and shown after the
811     # page has loaded. For this to work a browser that supports
812     # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
813     # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
814    
815     HTML_DYNAMIC_SECTIONS = NO
816    
817 jgs 121 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
818     # be used to specify the file name of the resulting .chm file. You
819     # can add a path in front of the file if the result should not be
820     # written to the html output directory.
821    
822     CHM_FILE =
823    
824     # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
825     # be used to specify the location (absolute path including file name) of
826     # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
827     # the HTML help compiler on the generated index.hhp.
828    
829     HHC_LOCATION =
830    
831 jgs 82 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
832     # controls if a separate .chi index file is generated (YES) or that
833     # it should be included in the master .chm file (NO).
834    
835     GENERATE_CHI = NO
836    
837 jfenwick 1779 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
838     # is used to encode HtmlHelp index (hhk), content (hhc) and project file
839     # content.
840    
841     CHM_INDEX_ENCODING =
842    
843 jgs 82 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
844     # controls whether a binary table of contents is generated (YES) or a
845     # normal table of contents (NO) in the .chm file.
846    
847     BINARY_TOC = NO
848    
849     # The TOC_EXPAND flag can be set to YES to add extra items for group members
850 jgs 121 # to the contents of the HTML help documentation and to the tree view.
851 jgs 82
852     TOC_EXPAND = NO
853    
854     # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
855     # top of each HTML page. The value NO (the default) enables the index and
856     # the value YES disables it.
857    
858     DISABLE_INDEX = NO
859    
860     # This tag can be used to set the number of enum values (range [1..20])
861     # that doxygen will group on one line in the generated HTML documentation.
862    
863     ENUM_VALUES_PER_LINE = 4
864    
865 jfenwick 1779 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
866     # structure should be generated to display hierarchical information.
867     # If the tag value is set to FRAME, a side panel will be generated
868     # containing a tree-like index structure (just like the one that
869 jgs 82 # is generated for HTML Help). For this to work a browser that supports
870 jgs 121 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
871     # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
872 jfenwick 1779 # probably better off using the HTML help feature. Other possible values
873     # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
874     # and Class Hiererachy pages using a tree view instead of an ordered list;
875     # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
876     # disables this behavior completely. For backwards compatibility with previous
877     # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
878     # respectively.
879 jgs 82
880     GENERATE_TREEVIEW = NO
881    
882     # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
883     # used to set the initial width (in pixels) of the frame in which the tree
884     # is shown.
885    
886     TREEVIEW_WIDTH = 250
887    
888 jfenwick 1779 # Use this tag to change the font size of Latex formulas included
889     # as images in the HTML documentation. The default is 10. Note that
890     # when you change the font size after a successful doxygen run you need
891     # to manually remove any form_*.png images from the HTML output directory
892     # to force them to be regenerated.
893    
894     FORMULA_FONTSIZE = 10
895    
896 jgs 82 #---------------------------------------------------------------------------
897     # configuration options related to the LaTeX output
898     #---------------------------------------------------------------------------
899    
900     # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
901     # generate Latex output.
902    
903     GENERATE_LATEX = NO
904    
905     # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
906     # If a relative path is entered the value of OUTPUT_DIRECTORY will be
907     # put in front of it. If left blank `latex' will be used as the default path.
908    
909     LATEX_OUTPUT =
910    
911 jgs 121 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
912     # invoked. If left blank `latex' will be used as the default command name.
913    
914     LATEX_CMD_NAME = latex
915    
916     # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
917     # generate index for LaTeX. If left blank `makeindex' will be used as the
918     # default command name.
919    
920     MAKEINDEX_CMD_NAME = makeindex
921    
922 jgs 82 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
923     # LaTeX documents. This may be useful for small projects and may help to
924     # save some trees in general.
925    
926     COMPACT_LATEX = NO
927    
928     # The PAPER_TYPE tag can be used to set the paper type that is used
929     # by the printer. Possible values are: a4, a4wide, letter, legal and
930     # executive. If left blank a4wide will be used.
931    
932     PAPER_TYPE = a4wide
933    
934     # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
935     # packages that should be included in the LaTeX output.
936    
937     EXTRA_PACKAGES =
938    
939     # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
940     # the generated latex document. The header should contain everything until
941     # the first chapter. If it is left blank doxygen will generate a
942     # standard header. Notice: only use this tag if you know what you are doing!
943    
944     LATEX_HEADER =
945    
946     # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
947     # is prepared for conversion to pdf (using ps2pdf). The pdf file will
948     # contain links (just like the HTML output) instead of page references
949     # This makes the output suitable for online browsing using a pdf viewer.
950    
951     PDF_HYPERLINKS = NO
952    
953     # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
954     # plain latex in the generated Makefile. Set this option to YES to get a
955     # higher quality PDF documentation.
956    
957     USE_PDFLATEX = NO
958    
959     # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
960     # command to the generated LaTeX files. This will instruct LaTeX to keep
961     # running if errors occur, instead of asking the user for help.
962     # This option is also used when generating formulas in HTML.
963    
964     LATEX_BATCHMODE = NO
965    
966 jgs 121 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
967     # include the index chapters (such as File Index, Compound Index, etc.)
968     # in the output.
969    
970     LATEX_HIDE_INDICES = NO
971    
972 jgs 82 #---------------------------------------------------------------------------
973     # configuration options related to the RTF output
974     #---------------------------------------------------------------------------
975    
976     # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
977 jgs 121 # The RTF output is optimized for Word 97 and may not look very pretty with
978 jgs 82 # other RTF readers or editors.
979    
980     GENERATE_RTF = NO
981    
982     # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
983     # If a relative path is entered the value of OUTPUT_DIRECTORY will be
984     # put in front of it. If left blank `rtf' will be used as the default path.
985    
986     RTF_OUTPUT =
987    
988     # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
989     # RTF documents. This may be useful for small projects and may help to
990     # save some trees in general.
991    
992     COMPACT_RTF = NO
993    
994     # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
995     # will contain hyperlink fields. The RTF file will
996     # contain links (just like the HTML output) instead of page references.
997     # This makes the output suitable for online browsing using WORD or other
998     # programs which support those fields.
999     # Note: wordpad (write) and others do not support links.
1000    
1001     RTF_HYPERLINKS = NO
1002    
1003     # Load stylesheet definitions from file. Syntax is similar to doxygen's
1004 jgs 121 # config file, i.e. a series of assignments. You only have to provide
1005 jgs 82 # replacements, missing definitions are set to their default value.
1006    
1007     RTF_STYLESHEET_FILE =
1008    
1009     # Set optional variables used in the generation of an rtf document.
1010     # Syntax is similar to doxygen's config file.
1011    
1012     RTF_EXTENSIONS_FILE =
1013    
1014     #---------------------------------------------------------------------------
1015     # configuration options related to the man page output
1016     #---------------------------------------------------------------------------
1017    
1018     # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1019     # generate man pages
1020    
1021     GENERATE_MAN = NO
1022    
1023     # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1024     # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1025     # put in front of it. If left blank `man' will be used as the default path.
1026    
1027     MAN_OUTPUT =
1028    
1029     # The MAN_EXTENSION tag determines the extension that is added to
1030     # the generated man pages (default is the subroutine's section .3)
1031    
1032     MAN_EXTENSION =
1033    
1034 jgs 121 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1035     # then it will generate one additional man file for each entity
1036     # documented in the real man page(s). These additional files
1037     # only source the real man page, but without them the man command
1038 jgs 82 # would be unable to find the correct page. The default is NO.
1039    
1040     MAN_LINKS = NO
1041    
1042     #---------------------------------------------------------------------------
1043 jgs 121 # configuration options related to the XML output
1044     #---------------------------------------------------------------------------
1045    
1046     # If the GENERATE_XML tag is set to YES Doxygen will
1047     # generate an XML file that captures the structure of
1048     # the code including all documentation.
1049    
1050     GENERATE_XML = NO
1051    
1052     # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1053     # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1054     # put in front of it. If left blank `xml' will be used as the default path.
1055    
1056     XML_OUTPUT = xml
1057    
1058     # The XML_SCHEMA tag can be used to specify an XML schema,
1059     # which can be used by a validating XML parser to check the
1060     # syntax of the XML files.
1061    
1062     XML_SCHEMA =
1063    
1064     # The XML_DTD tag can be used to specify an XML DTD,
1065     # which can be used by a validating XML parser to check the
1066     # syntax of the XML files.
1067    
1068     XML_DTD =
1069    
1070     # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1071     # dump the program listings (including syntax highlighting
1072     # and cross-referencing information) to the XML output. Note that
1073     # enabling this will significantly increase the size of the XML output.
1074    
1075     XML_PROGRAMLISTING = YES
1076    
1077     #---------------------------------------------------------------------------
1078     # configuration options for the AutoGen Definitions output
1079     #---------------------------------------------------------------------------
1080    
1081     # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1082     # generate an AutoGen Definitions (see autogen.sf.net) file
1083     # that captures the structure of the code including all
1084     # documentation. Note that this feature is still experimental
1085     # and incomplete at the moment.
1086    
1087     GENERATE_AUTOGEN_DEF = NO
1088    
1089     #---------------------------------------------------------------------------
1090     # configuration options related to the Perl module output
1091     #---------------------------------------------------------------------------
1092    
1093     # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1094     # generate a Perl module file that captures the structure of
1095     # the code including all documentation. Note that this
1096     # feature is still experimental and incomplete at the
1097     # moment.
1098    
1099     GENERATE_PERLMOD = NO
1100    
1101     # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1102     # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1103     # to generate PDF and DVI output from the Perl module output.
1104    
1105     PERLMOD_LATEX = NO
1106    
1107     # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1108     # nicely formatted so it can be parsed by a human reader. This is useful
1109     # if you want to understand what is going on. On the other hand, if this
1110     # tag is set to NO the size of the Perl module output will be much smaller
1111     # and Perl will parse it just the same.
1112    
1113     PERLMOD_PRETTY = YES
1114    
1115     # The names of the make variables in the generated doxyrules.make file
1116     # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1117     # This is useful so different doxyrules.make files included by the same
1118     # Makefile don't overwrite each other's variables.
1119    
1120     PERLMOD_MAKEVAR_PREFIX =
1121    
1122     #---------------------------------------------------------------------------
1123 jgs 82 # Configuration options related to the preprocessor
1124     #---------------------------------------------------------------------------
1125    
1126     # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1127     # evaluate all C-preprocessor directives found in the sources and include
1128     # files.
1129    
1130     ENABLE_PREPROCESSING = YES
1131    
1132     # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1133     # names in the source code. If set to NO (the default) only conditional
1134     # compilation will be performed. Macro expansion can be done in a controlled
1135     # way by setting EXPAND_ONLY_PREDEF to YES.
1136    
1137     MACRO_EXPANSION = NO
1138    
1139     # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1140     # then the macro expansion is limited to the macros specified with the
1141 jfenwick 1779 # PREDEFINED and EXPAND_AS_DEFINED tags.
1142 jgs 82
1143     EXPAND_ONLY_PREDEF = NO
1144    
1145     # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1146     # in the INCLUDE_PATH (see below) will be search if a #include is found.
1147    
1148     SEARCH_INCLUDES = YES
1149    
1150     # The INCLUDE_PATH tag can be used to specify one or more directories that
1151     # contain include files that are not input files but should be processed by
1152     # the preprocessor.
1153    
1154     INCLUDE_PATH =
1155    
1156     # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1157     # patterns (like *.h and *.hpp) to filter out the header-files in the
1158     # directories. If left blank, the patterns specified with FILE_PATTERNS will
1159     # be used.
1160    
1161     INCLUDE_FILE_PATTERNS =
1162    
1163     # The PREDEFINED tag can be used to specify one or more macro names that
1164     # are defined before the preprocessor is started (similar to the -D option of
1165     # gcc). The argument of the tag is a list of macros of the form: name
1166     # or name=definition (no spaces). If the definition and the = are
1167 jfenwick 1779 # omitted =1 is assumed. To prevent a macro definition from being
1168     # undefined via #undef or recursively expanded use the := operator
1169     # instead of the = operator.
1170 jgs 82
1171     PREDEFINED =
1172    
1173 jgs 121 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1174 jgs 82 # this tag can be used to specify a list of macro names that should be expanded.
1175     # The macro definition that is found in the sources will be used.
1176     # Use the PREDEFINED tag if you want to use a different macro definition.
1177    
1178     EXPAND_AS_DEFINED =
1179    
1180 jgs 121 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1181     # doxygen's preprocessor will remove all function-like macros that are alone
1182     # on a line, have an all uppercase name, and do not end with a semicolon. Such
1183 jfenwick 1779 # function macros are typically used for boiler-plate code, and will confuse
1184     # the parser if not removed.
1185 jgs 121
1186     SKIP_FUNCTION_MACROS = YES
1187    
1188 jgs 82 #---------------------------------------------------------------------------
1189 jfenwick 1779 # Configuration::additions related to external references
1190 jgs 82 #---------------------------------------------------------------------------
1191    
1192 jgs 121 # The TAGFILES option can be used to specify one or more tagfiles.
1193     # Optionally an initial location of the external documentation
1194     # can be added for each tagfile. The format of a tag file without
1195     # this location is as follows:
1196     # TAGFILES = file1 file2 ...
1197     # Adding location for the tag files is done as follows:
1198     # TAGFILES = file1=loc1 "file2 = loc2" ...
1199     # where "loc1" and "loc2" can be relative or absolute paths or
1200     # URLs. If a location is present for each tag, the installdox tool
1201     # does not have to be run to correct the links.
1202     # Note that each tag file must have a unique name
1203     # (where the name does NOT include the path)
1204     # If a tag file is not located in the directory in which doxygen
1205     # is run, you must also specify the path to the tagfile here.
1206 jgs 82
1207     TAGFILES =
1208    
1209     # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1210     # a tag file that is based on the input files it reads.
1211    
1212     GENERATE_TAGFILE =
1213    
1214     # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1215     # in the class index. If set to NO only the inherited external classes
1216     # will be listed.
1217    
1218     ALLEXTERNALS = NO
1219    
1220 jgs 121 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1221     # in the modules index. If set to NO, only the current project's groups will
1222     # be listed.
1223    
1224     EXTERNAL_GROUPS = YES
1225    
1226 jgs 82 # The PERL_PATH should be the absolute path and name of the perl script
1227     # interpreter (i.e. the result of `which perl').
1228    
1229     PERL_PATH =
1230    
1231     #---------------------------------------------------------------------------
1232     # Configuration options related to the dot tool
1233     #---------------------------------------------------------------------------
1234    
1235 jgs 121 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1236 jfenwick 1779 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1237     # or super classes. Setting the tag to NO turns the diagrams off. Note that
1238     # this option is superseded by the HAVE_DOT option below. This is only a
1239     # fallback. It is recommended to install and use dot, since it yields more
1240     # powerful graphs.
1241 jgs 121
1242     CLASS_DIAGRAMS = YES
1243    
1244 jfenwick 1779 # You can define message sequence charts within doxygen comments using the \msc
1245     # command. Doxygen will then run the mscgen tool (see
1246     # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1247     # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1248     # the mscgen tool resides. If left empty the tool is assumed to be found in the
1249     # default search path.
1250    
1251     MSCGEN_PATH =
1252    
1253 jgs 121 # If set to YES, the inheritance and collaboration graphs will hide
1254     # inheritance and usage relations if the target is undocumented
1255     # or is not a class.
1256    
1257     HIDE_UNDOC_RELATIONS = YES
1258    
1259 jgs 82 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1260     # available from the path. This tool is part of Graphviz, a graph visualization
1261     # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1262     # have no effect if this option is set to NO (the default)
1263    
1264     HAVE_DOT = NO
1265    
1266 jfenwick 1779 # By default doxygen will write a font called FreeSans.ttf to the output
1267     # directory and reference it in all dot files that doxygen generates. This
1268     # font does not include all possible unicode characters however, so when you need
1269     # these (or just want a differently looking font) you can specify the font name
1270     # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1271     # which can be done by putting it in a standard location or by setting the
1272     # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1273     # containing the font.
1274    
1275     DOT_FONTNAME = FreeSans
1276    
1277     # By default doxygen will tell dot to use the output directory to look for the
1278     # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1279     # different font using DOT_FONTNAME you can set the path where dot
1280     # can find it using this tag.
1281    
1282     DOT_FONTPATH =
1283    
1284 jgs 82 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1285     # will generate a graph for each documented class showing the direct and
1286     # indirect inheritance relations. Setting this tag to YES will force the
1287     # the CLASS_DIAGRAMS tag to NO.
1288    
1289     CLASS_GRAPH = YES
1290    
1291     # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1292     # will generate a graph for each documented class showing the direct and
1293     # indirect implementation dependencies (inheritance, containment, and
1294     # class references variables) of the class with other documented classes.
1295    
1296     COLLABORATION_GRAPH = YES
1297    
1298 jfenwick 1779 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1299     # will generate a graph for groups, showing the direct groups dependencies
1300    
1301     GROUP_GRAPHS = YES
1302    
1303 jgs 121 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1304     # collaboration diagrams in a style similar to the OMG's Unified Modeling
1305     # Language.
1306    
1307     UML_LOOK = NO
1308    
1309     # If set to YES, the inheritance and collaboration graphs will show the
1310     # relations between templates and their instances.
1311    
1312     TEMPLATE_RELATIONS = NO
1313    
1314 jgs 82 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1315     # tags are set to YES then doxygen will generate a graph for each documented
1316     # file showing the direct and indirect include dependencies of the file with
1317     # other documented files.
1318    
1319     INCLUDE_GRAPH = YES
1320    
1321     # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1322     # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1323     # documented header file showing the documented files that directly or
1324     # indirectly include this file.
1325    
1326     INCLUDED_BY_GRAPH = YES
1327    
1328 jfenwick 1779 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1329     # doxygen will generate a call dependency graph for every global function
1330     # or class method. Note that enabling this option will significantly increase
1331     # the time of a run. So in most cases it will be better to enable call graphs
1332     # for selected functions only using the \callgraph command.
1333 jgs 121
1334     CALL_GRAPH = NO
1335    
1336 jfenwick 1779 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1337     # doxygen will generate a caller dependency graph for every global function
1338     # or class method. Note that enabling this option will significantly increase
1339     # the time of a run. So in most cases it will be better to enable caller
1340     # graphs for selected functions only using the \callergraph command.
1341    
1342     CALLER_GRAPH = NO
1343    
1344 jgs 82 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1345     # will graphical hierarchy of all classes instead of a textual one.
1346    
1347     GRAPHICAL_HIERARCHY = YES
1348    
1349 jfenwick 1779 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1350     # then doxygen will show the dependencies a directory has on other directories
1351     # in a graphical way. The dependency relations are determined by the #include
1352     # relations between the files in the directories.
1353    
1354     DIRECTORY_GRAPH = YES
1355    
1356 jgs 121 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1357     # generated by dot. Possible values are png, jpg, or gif
1358     # If left blank png will be used.
1359    
1360     DOT_IMAGE_FORMAT = png
1361    
1362 jgs 82 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1363 jfenwick 1779 # found. If left blank, it is assumed the dot tool can be found in the path.
1364 jgs 82
1365     DOT_PATH =
1366    
1367 jgs 121 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1368     # contain dot files that are included in the documentation (see the
1369     # \dotfile command).
1370    
1371     DOTFILE_DIRS =
1372    
1373 jfenwick 1779 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1374     # nodes that will be shown in the graph. If the number of nodes in a graph
1375     # becomes larger than this value, doxygen will truncate the graph, which is
1376     # visualized by representing a node as a red box. Note that doxygen if the
1377     # number of direct children of the root node in a graph is already larger than
1378     # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1379     # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1380 jgs 82
1381 jfenwick 1779 DOT_GRAPH_MAX_NODES = 50
1382 jgs 82
1383 jgs 121 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1384     # graphs generated by dot. A depth value of 3 means that only nodes reachable
1385 jfenwick 1779 # from the root by following a path via at most 3 edges will be shown. Nodes
1386     # that lay further from the root node will be omitted. Note that setting this
1387     # option to 1 or 2 may greatly reduce the computation time needed for large
1388     # code bases. Also note that the size of a graph can be further restricted by
1389     # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1390 jgs 121
1391     MAX_DOT_GRAPH_DEPTH = 0
1392    
1393 jfenwick 1779 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1394     # background. This is enabled by default, which results in a transparent
1395     # background. Warning: Depending on the platform used, enabling this option
1396     # may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1397     # become hard to read).
1398    
1399     DOT_TRANSPARENT = YES
1400    
1401     # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1402     # files in one run (i.e. multiple -o and -T options on the command line). This
1403     # makes dot run faster, but since only newer versions of dot (>1.8.10)
1404     # support this, this feature is disabled by default.
1405    
1406     DOT_MULTI_TARGETS = NO
1407    
1408 jgs 82 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1409     # generate a legend page explaining the meaning of the various boxes and
1410     # arrows in the dot generated graphs.
1411    
1412     GENERATE_LEGEND = YES
1413    
1414     # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1415 jgs 121 # remove the intermediate dot files that are used to generate
1416 jgs 82 # the various graphs.
1417    
1418     DOT_CLEANUP = YES
1419    
1420     #---------------------------------------------------------------------------
1421 jfenwick 1779 # Configuration::additions related to the search engine
1422 jgs 82 #---------------------------------------------------------------------------
1423    
1424     # The SEARCHENGINE tag specifies whether or not a search engine should be
1425     # used. If set to NO the values of all tags below this one will be ignored.
1426    
1427     SEARCHENGINE = NO

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.26