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

Annotation of /trunk/doc/doxygen/doxygen_esys

Parent Directory Parent Directory | Revision Log Revision Log


Revision 6410 - (hide annotations)
Tue Nov 1 06:12:42 2016 UTC (3 years, 11 months ago) by jfenwick
File size: 103140 byte(s)
Very minor fix towards more repeatable builds

1 sshaw 5735 # Doxyfile 1.8.8
2 jgs 82
3     # This file describes the settings to be used by the documentation system
4 caltinay 3991 # doxygen (www.doxygen.org) for a project.
5 jgs 82 #
6 sshaw 5735 # All text after a double hash (##) is considered a comment and is placed in
7     # front of the TAG it is preceding.
8     #
9     # All text after a single hash (#) is considered a comment and will be ignored.
10 jgs 82 # The format is:
11 sshaw 5735 # TAG = value [value, ...]
12     # For lists, items can also be appended using:
13     # TAG += value [value, ...]
14     # Values that contain spaces should be placed between quotes (\" \").
15 jgs 82
16     #---------------------------------------------------------------------------
17 jgs 121 # Project related configuration options
18 jgs 82 #---------------------------------------------------------------------------
19    
20 caltinay 3991 # This tag specifies the encoding used for all characters in the config file
21 sshaw 5735 # that follow. The default is UTF-8 which is also the encoding used for all text
22     # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23     # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24     # for the list of possible encodings.
25     # The default value is: UTF-8.
26 jfenwick 1796
27     DOXYFILE_ENCODING = UTF-8
28    
29 sshaw 5735 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30     # double-quotes, unless you are using Doxywizard) that should identify the
31     # project for which the documentation is generated. This name is used in the
32     # title of most generated pages and in a few other places.
33     # The default value is: My Project.
34 jgs 82
35 jfenwick 4792 PROJECT_NAME = escript
36 jgs 82
37 sshaw 5735 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38     # could be handy for archiving the generated documentation or if some version
39     # control system is used.
40 jgs 82
41 jfenwick 1796 PROJECT_NUMBER = Revision$Revision:1215$
42 jgs 82
43 caltinay 3991 # Using the PROJECT_BRIEF tag one can provide an optional one line description
44 sshaw 5735 # for a project that appears at the top of each page and should give viewer a
45     # quick idea about the purpose of the project. Keep the description short.
46 caltinay 3991
47     PROJECT_BRIEF =
48    
49 sshaw 5735 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
50     # the documentation. The maximum height of the logo should not exceed 55 pixels
51     # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
52     # to the output directory.
53 caltinay 3991
54     PROJECT_LOGO =
55    
56 sshaw 5735 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57     # into which the generated documentation will be written. If a relative path is
58     # entered, it will be relative to the location where doxygen was started. If
59     # left blank the current directory will be used.
60 jgs 82
61 ksteube 1215 OUTPUT_DIRECTORY = release/doc/doxygen
62 jgs 82
63 sshaw 5735 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
64     # directories (in 2 levels) under the output directory of each output format and
65     # will distribute the generated files over these directories. Enabling this
66     # option can be useful when feeding doxygen a huge amount of source files, where
67     # putting all generated files in the same directory would otherwise causes
68     # performance problems for the file system.
69     # The default value is: NO.
70 jfenwick 1796
71     CREATE_SUBDIRS = NO
72    
73 sshaw 5735 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74     # characters to appear in the names of generated files. If set to NO, non-ASCII
75     # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76     # U+3044.
77     # The default value is: NO.
78    
79     ALLOW_UNICODE_NAMES = NO
80    
81 caltinay 3991 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
82     # documentation generated by doxygen is written. Doxygen will use this
83     # information to generate all constant output in the proper language.
84 sshaw 5735 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85     # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86     # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87     # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88     # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89     # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90     # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91     # Ukrainian and Vietnamese.
92     # The default value is: English.
93 jgs 82
94     OUTPUT_LANGUAGE = English
95    
96 sshaw 5735 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
97     # descriptions after the members that are listed in the file and class
98     # documentation (similar to Javadoc). Set to NO to disable this.
99     # The default value is: YES.
100 jgs 82
101     BRIEF_MEMBER_DESC = YES
102    
103 sshaw 5735 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
104     # description of a member or function before the detailed description
105     #
106     # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107 jgs 82 # brief descriptions will be completely suppressed.
108 sshaw 5735 # The default value is: YES.
109 jgs 82
110     REPEAT_BRIEF = YES
111    
112 sshaw 5735 # This tag implements a quasi-intelligent brief description abbreviator that is
113     # used to form the text in various listings. Each string in this list, if found
114     # as the leading text of the brief description, will be stripped from the text
115     # and the result, after processing the whole list, is used as the annotated
116     # text. Otherwise, the brief description is used as-is. If left blank, the
117     # following values are used ($name is automatically replaced with the name of
118     # the entity):The $name class, The $name widget, The $name file, is, provides,
119     # specifies, contains, represents, a, an and the.
120 jgs 121
121 caltinay 3991 ABBREVIATE_BRIEF =
122 jgs 121
123 caltinay 3991 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
124 sshaw 5735 # doxygen will generate a detailed section even if there is only a brief
125 jgs 82 # description.
126 sshaw 5735 # The default value is: NO.
127 jgs 82
128 jgs 121 ALWAYS_DETAILED_SEC = YES
129 jgs 82
130 caltinay 3991 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131     # inherited members of a class in the documentation of that class as if those
132     # members were ordinary class members. Constructors, destructors and assignment
133 jfenwick 1796 # operators of the base classes will not be shown.
134 sshaw 5735 # The default value is: NO.
135 jgs 121
136     INLINE_INHERITED_MEMB = NO
137    
138 sshaw 5735 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
139     # before files name in the file list and in the header files. If set to NO the
140     # shortest path that makes the file name unique will be used
141     # The default value is: YES.
142 jgs 82
143     FULL_PATH_NAMES = NO
144    
145 sshaw 5735 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146     # Stripping is only done if one of the specified strings matches the left-hand
147     # part of the path. The tag can be used to show relative paths in the file list.
148     # If left blank the directory from which doxygen is run is used as the path to
149     # strip.
150     #
151     # Note that you can specify absolute paths here, but also relative paths, which
152     # will be relative from the directory where doxygen is started.
153     # This tag requires that the tag FULL_PATH_NAMES is set to YES.
154 jgs 82
155 caltinay 3991 STRIP_FROM_PATH =
156 jgs 82
157 sshaw 5735 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158     # path mentioned in the documentation of a class, which tells the reader which
159     # header file to include in order to use a class. If left blank only the name of
160     # the header file containing the class definition is used. Otherwise one should
161     # specify the list of include paths that are normally passed to the compiler
162     # using the -I flag.
163 jfenwick 1796
164 caltinay 3991 STRIP_FROM_INC_PATH =
165 jfenwick 1796
166 sshaw 5735 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
167     # less readable) file names. This can be useful is your file systems doesn't
168     # support long names like on DOS, Mac, or CD-ROM.
169     # The default value is: NO.
170 jgs 82
171 jgs 121 SHORT_NAMES = NO
172 jgs 82
173 sshaw 5735 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
174     # first line (until the first dot) of a Javadoc-style comment as the brief
175     # description. If set to NO, the Javadoc-style will behave just like regular Qt-
176     # style comments (thus requiring an explicit @brief command for a brief
177     # description.)
178     # The default value is: NO.
179 jgs 82
180 jgs 121 JAVADOC_AUTOBRIEF = NO
181 jgs 82
182 sshaw 5735 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
183     # line (until the first dot) of a Qt-style comment as the brief description. If
184     # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
185     # requiring an explicit \brief command for a brief description.)
186     # The default value is: NO.
187 jfenwick 1796
188     QT_AUTOBRIEF = NO
189    
190 sshaw 5735 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
191     # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
192     # a brief description. This used to be the default behavior. The new default is
193     # to treat a multi-line C++ comment block as a detailed description. Set this
194     # tag to YES if you prefer the old behavior instead.
195     #
196     # Note that setting this tag to YES also means that rational rose comments are
197     # not recognized any more.
198     # The default value is: NO.
199 jgs 82
200 jgs 121 MULTILINE_CPP_IS_BRIEF = NO
201 jgs 82
202 sshaw 5735 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
203     # documentation from any documented member that it re-implements.
204     # The default value is: YES.
205 jgs 82
206 jgs 121 INHERIT_DOCS = YES
207 jgs 82
208 sshaw 5735 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
209     # new page for each member. If set to NO, the documentation of a member will be
210     # part of the file/class/namespace that contains it.
211     # The default value is: NO.
212 jgs 121
213 jfenwick 1796 SEPARATE_MEMBER_PAGES = NO
214 jgs 121
215 sshaw 5735 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
216     # uses this value to replace tabs by spaces in code fragments.
217     # Minimum value: 1, maximum value: 16, default value: 4.
218 jgs 121
219     TAB_SIZE = 4
220    
221 sshaw 5735 # This tag can be used to specify a number of aliases that act as commands in
222     # the documentation. An alias has the form:
223     # name=value
224     # For example adding
225     # "sideeffect=@par Side Effects:\n"
226     # will allow you to put the command \sideeffect (or @sideeffect) in the
227     # documentation, which will result in a user-defined paragraph with heading
228     # "Side Effects:". You can put \n's in the value part of an alias to insert
229     # newlines.
230 jgs 121
231 caltinay 3991 ALIASES =
232 jgs 121
233 caltinay 3991 # This tag can be used to specify a number of word-keyword mappings (TCL only).
234 sshaw 5735 # A mapping has the form "name=value". For example adding "class=itcl::class"
235     # will allow you to use the command class in the itcl::class meaning.
236 caltinay 3991
237     TCL_SUBST =
238    
239 sshaw 5735 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
240     # only. Doxygen will then generate output that is more tailored for C. For
241     # instance, some of the names that are used will be different. The list of all
242     # members will be omitted, etc.
243     # The default value is: NO.
244 jgs 121
245     OPTIMIZE_OUTPUT_FOR_C = NO
246    
247 sshaw 5735 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
248     # Python sources only. Doxygen will then generate output that is more tailored
249     # for that language. For instance, namespaces will be presented as packages,
250     # qualified scopes will look different, etc.
251     # The default value is: NO.
252 jgs 121
253     OPTIMIZE_OUTPUT_JAVA = NO
254    
255 caltinay 3991 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
256 sshaw 5735 # sources. Doxygen will then generate output that is tailored for Fortran.
257     # The default value is: NO.
258 jfenwick 1796
259     OPTIMIZE_FOR_FORTRAN = NO
260    
261 caltinay 3991 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
262 sshaw 5735 # sources. Doxygen will then generate output that is tailored for VHDL.
263     # The default value is: NO.
264 jfenwick 1796
265     OPTIMIZE_OUTPUT_VHDL = NO
266    
267 caltinay 3991 # Doxygen selects the parser to use depending on the extension of the files it
268 sshaw 5735 # parses. With this tag you can assign which parser to use for a given
269     # extension. Doxygen has a built-in mapping, but you can override or extend it
270     # using this tag. The format is ext=language, where ext is a file extension, and
271     # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
272     # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
273     # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
274     # Fortran. In the later case the parser tries to guess whether the code is fixed
275     # or free formatted code, this is the default for Fortran type files), VHDL. For
276     # instance to make doxygen treat .inc files as Fortran files (default is PHP),
277     # and .f files as C (default is Fortran), use: inc=Fortran f=C.
278     #
279     # Note For files without extension you can use no_extension as a placeholder.
280     #
281     # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
282     # the files are not read by doxygen.
283 caltinay 3991
284     EXTENSION_MAPPING =
285    
286 sshaw 5735 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
287     # according to the Markdown format, which allows for more readable
288 caltinay 3991 # documentation. See http://daringfireball.net/projects/markdown/ for details.
289 sshaw 5735 # The output of markdown processing is further processed by doxygen, so you can
290     # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
291     # case of backward compatibilities issues.
292     # The default value is: YES.
293 caltinay 3991
294     MARKDOWN_SUPPORT = YES
295    
296 sshaw 5735 # When enabled doxygen tries to link words that correspond to documented
297     # classes, or namespaces to their corresponding documentation. Such a link can
298     # be prevented in individual cases by by putting a % sign in front of the word
299     # or globally by setting AUTOLINK_SUPPORT to NO.
300     # The default value is: YES.
301    
302     AUTOLINK_SUPPORT = YES
303    
304 caltinay 3991 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
305 sshaw 5735 # to include (a tag file for) the STL sources as input, then you should set this
306     # tag to YES in order to let doxygen match functions declarations and
307     # definitions whose arguments contain STL classes (e.g. func(std::string);
308     # versus func(std::string) {}). This also make the inheritance and collaboration
309 jfenwick 1796 # diagrams that involve STL classes more complete and accurate.
310 sshaw 5735 # The default value is: NO.
311 jfenwick 1796
312     BUILTIN_STL_SUPPORT = YES
313    
314     # If you use Microsoft's C++/CLI language, you should set this option to YES to
315     # enable parsing support.
316 sshaw 5735 # The default value is: NO.
317 jfenwick 1796
318     CPP_CLI_SUPPORT = NO
319    
320 sshaw 5735 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
321     # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
322     # will parse them like normal C++ but will assume all classes use public instead
323     # of private inheritance when no explicit protection keyword is present.
324     # The default value is: NO.
325 jfenwick 1796
326     SIP_SUPPORT = NO
327    
328 sshaw 5735 # For Microsoft's IDL there are propget and propput attributes to indicate
329     # getter and setter methods for a property. Setting this option to YES will make
330     # doxygen to replace the get and set methods by a property in the documentation.
331     # This will only work if the methods are indeed getting or setting a simple
332     # type. If this is not the case, or you want to show the methods anyway, you
333     # should set this option to NO.
334     # The default value is: YES.
335 jfenwick 1796
336     IDL_PROPERTY_SUPPORT = YES
337    
338 caltinay 3991 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
339     # tag is set to YES, then doxygen will reuse the documentation of the first
340     # member in the group (if any) for the other members of the group. By default
341 jfenwick 1796 # all members of a group must be documented explicitly.
342 sshaw 5735 # The default value is: NO.
343 jfenwick 1796
344     DISTRIBUTE_GROUP_DOC = NO
345    
346 sshaw 5735 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
347     # (for instance a group of public functions) to be put as a subgroup of that
348     # type (e.g. under the Public Functions section). Set it to NO to prevent
349     # subgrouping. Alternatively, this can be done per class using the
350     # \nosubgrouping command.
351     # The default value is: YES.
352 jgs 121
353     SUBGROUPING = YES
354    
355 sshaw 5735 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
356     # are shown inside the group in which they are included (e.g. using \ingroup)
357     # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
358     # and RTF).
359     #
360     # Note that this feature does not work in combination with
361     # SEPARATE_MEMBER_PAGES.
362     # The default value is: NO.
363 caltinay 3991
364     INLINE_GROUPED_CLASSES = NO
365    
366 sshaw 5735 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
367     # with only public data fields or simple typedef fields will be shown inline in
368     # the documentation of the scope in which they are defined (i.e. file,
369     # namespace, or group documentation), provided this scope is documented. If set
370     # to NO, structs, classes, and unions are shown on a separate page (for HTML and
371     # Man pages) or section (for LaTeX and RTF).
372     # The default value is: NO.
373 caltinay 3991
374     INLINE_SIMPLE_STRUCTS = NO
375    
376 sshaw 5735 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
377     # enum is documented as struct, union, or enum with the name of the typedef. So
378 caltinay 3991 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
379     # with name TypeT. When disabled the typedef will appear as a member of a file,
380 sshaw 5735 # namespace, or class. And the struct will be named TypeS. This can typically be
381     # useful for C code in case the coding convention dictates that all compound
382 jfenwick 1796 # types are typedef'ed and only the typedef is referenced, never the tag name.
383 sshaw 5735 # The default value is: NO.
384 jfenwick 1796
385     TYPEDEF_HIDES_STRUCT = NO
386    
387 sshaw 5735 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
388     # cache is used to resolve symbols given their name and scope. Since this can be
389     # an expensive process and often the same symbol appears multiple times in the
390     # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
391     # doxygen will become slower. If the cache is too large, memory is wasted. The
392     # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
393     # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
394     # symbols. At the end of a run doxygen will report the cache usage and suggest
395     # the optimal cache size from a speed point of view.
396     # Minimum value: 0, maximum value: 9, default value: 0.
397 caltinay 3991
398     LOOKUP_CACHE_SIZE = 0
399    
400 jgs 121 #---------------------------------------------------------------------------
401     # Build related configuration options
402     #---------------------------------------------------------------------------
403    
404 caltinay 3991 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
405 sshaw 5735 # documentation are documented, even if no documentation was available. Private
406     # class members and static file members will be hidden unless the
407     # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
408     # Note: This will also disable the warnings about undocumented members that are
409     # normally produced when WARNINGS is set to YES.
410     # The default value is: NO.
411 jgs 121
412     EXTRACT_ALL = YES
413    
414 sshaw 5735 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
415     # be included in the documentation.
416     # The default value is: NO.
417 jgs 121
418     EXTRACT_PRIVATE = YES
419    
420 sshaw 5735 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
421     # scope will be included in the documentation.
422     # The default value is: NO.
423 caltinay 3991
424     EXTRACT_PACKAGE = NO
425    
426 sshaw 5735 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
427     # included in the documentation.
428     # The default value is: NO.
429 jgs 121
430     EXTRACT_STATIC = YES
431    
432 sshaw 5735 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
433     # locally in source files will be included in the documentation. If set to NO
434     # only classes defined in header files are included. Does not have any effect
435     # for Java sources.
436     # The default value is: YES.
437 jgs 121
438     EXTRACT_LOCAL_CLASSES = YES
439    
440 sshaw 5735 # This flag is only useful for Objective-C code. When set to YES local methods,
441     # which are defined in the implementation section but not in the interface are
442     # included in the documentation. If set to NO only methods in the interface are
443     # included.
444     # The default value is: NO.
445 jfenwick 1796
446     EXTRACT_LOCAL_METHODS = NO
447    
448 caltinay 3991 # If this flag is set to YES, the members of anonymous namespaces will be
449     # extracted and appear in the documentation as a namespace called
450 sshaw 5735 # 'anonymous_namespace{file}', where file will be replaced with the base name of
451     # the file that contains the anonymous namespace. By default anonymous namespace
452     # are hidden.
453     # The default value is: NO.
454 jfenwick 1796
455     EXTRACT_ANON_NSPACES = NO
456    
457 sshaw 5735 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
458     # undocumented members inside documented classes or files. If set to NO these
459     # members will be included in the various overviews, but no documentation
460     # section is generated. This option has no effect if EXTRACT_ALL is enabled.
461     # The default value is: NO.
462 jgs 121
463     HIDE_UNDOC_MEMBERS = NO
464    
465 sshaw 5735 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
466     # undocumented classes that are normally visible in the class hierarchy. If set
467     # to NO these classes will be included in the various overviews. This option has
468     # no effect if EXTRACT_ALL is enabled.
469     # The default value is: NO.
470 jgs 121
471     HIDE_UNDOC_CLASSES = NO
472    
473 sshaw 5735 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
474     # (class|struct|union) declarations. If set to NO these declarations will be
475     # included in the documentation.
476     # The default value is: NO.
477 jgs 121
478     HIDE_FRIEND_COMPOUNDS = NO
479    
480 sshaw 5735 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
481     # documentation blocks found inside the body of a function. If set to NO these
482     # blocks will be appended to the function's detailed documentation block.
483     # The default value is: NO.
484 jgs 121
485     HIDE_IN_BODY_DOCS = NO
486    
487 sshaw 5735 # The INTERNAL_DOCS tag determines if documentation that is typed after a
488     # \internal command is included. If the tag is set to NO then the documentation
489     # will be excluded. Set it to YES to include the internal documentation.
490     # The default value is: NO.
491 jgs 121
492     INTERNAL_DOCS = NO
493    
494 sshaw 5735 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
495     # names in lower-case letters. If set to YES upper-case letters are also
496 caltinay 3991 # allowed. This is useful if you have classes or files whose names only differ
497     # in case and if your file system supports case sensitive file names. Windows
498 jfenwick 1796 # and Mac users are advised to set this option to NO.
499 sshaw 5735 # The default value is: system dependent.
500 jgs 82
501     CASE_SENSE_NAMES = YES
502    
503 sshaw 5735 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
504     # their full class and namespace scopes in the documentation. If set to YES the
505     # scope will be hidden.
506     # The default value is: NO.
507 jgs 82
508     HIDE_SCOPE_NAMES = NO
509    
510 sshaw 5735 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
511     # the files that are included by a file in the documentation of that file.
512     # The default value is: YES.
513 jgs 82
514     SHOW_INCLUDE_FILES = YES
515    
516 sshaw 5735 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
517     # grouped member an include statement to the documentation, telling the reader
518     # which file to include in order to use the member.
519     # The default value is: NO.
520 caltinay 3991
521 sshaw 5735 SHOW_GROUPED_MEMB_INC = NO
522    
523     # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
524     # files with double quotes in the documentation rather than with sharp brackets.
525     # The default value is: NO.
526    
527 caltinay 3991 FORCE_LOCAL_INCLUDES = NO
528    
529 sshaw 5735 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
530     # documentation for inline members.
531     # The default value is: YES.
532 jgs 82
533     INLINE_INFO = YES
534    
535 sshaw 5735 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
536     # (detailed) documentation of file and class members alphabetically by member
537     # name. If set to NO the members will appear in declaration order.
538     # The default value is: YES.
539 jgs 82
540     SORT_MEMBER_DOCS = YES
541    
542 sshaw 5735 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
543     # descriptions of file, namespace and class members alphabetically by member
544     # name. If set to NO the members will appear in declaration order. Note that
545     # this will also influence the order of the classes in the class list.
546     # The default value is: NO.
547 jfenwick 1796
548     SORT_BRIEF_DOCS = NO
549    
550 sshaw 5735 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
551     # (brief and detailed) documentation of class members so that constructors and
552     # destructors are listed first. If set to NO the constructors will appear in the
553     # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
554     # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
555     # member documentation.
556     # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
557     # detailed member documentation.
558     # The default value is: NO.
559 caltinay 3991
560     SORT_MEMBERS_CTORS_1ST = NO
561    
562 sshaw 5735 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
563     # of group names into alphabetical order. If set to NO the group names will
564     # appear in their defined order.
565     # The default value is: NO.
566 jfenwick 1796
567     SORT_GROUP_NAMES = NO
568    
569 sshaw 5735 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
570     # fully-qualified names, including namespaces. If set to NO, the class list will
571     # be sorted only by class name, not including the namespace part.
572 jfenwick 1796 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
573 sshaw 5735 # Note: This option applies only to the class list, not to the alphabetical
574     # list.
575     # The default value is: NO.
576 jfenwick 1796
577     SORT_BY_SCOPE_NAME = NO
578    
579 sshaw 5735 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
580     # type resolution of all parameters of a function it will reject a match between
581     # the prototype and the implementation of a member function even if there is
582     # only one candidate or it is obvious which candidate to choose by doing a
583     # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
584     # accept a match between prototype and implementation in such cases.
585     # The default value is: NO.
586 caltinay 3991
587     STRICT_PROTO_MATCHING = NO
588    
589 sshaw 5735 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
590     # todo list. This list is created by putting \todo commands in the
591     # documentation.
592     # The default value is: YES.
593 jgs 82
594     GENERATE_TODOLIST = YES
595    
596 sshaw 5735 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
597     # test list. This list is created by putting \test commands in the
598     # documentation.
599     # The default value is: YES.
600 jgs 82
601     GENERATE_TESTLIST = YES
602    
603 sshaw 5735 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
604     # list. This list is created by putting \bug commands in the documentation.
605     # The default value is: YES.
606 jgs 82
607     GENERATE_BUGLIST = YES
608    
609 sshaw 5735 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
610     # the deprecated list. This list is created by putting \deprecated commands in
611     # the documentation.
612     # The default value is: YES.
613 jgs 82
614 jgs 121 GENERATE_DEPRECATEDLIST= YES
615 jgs 82
616 sshaw 5735 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
617     # sections, marked by \if <section_label> ... \endif and \cond <section_label>
618     # ... \endcond blocks.
619 jgs 121
620 caltinay 3991 ENABLED_SECTIONS =
621 jgs 121
622 sshaw 5735 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
623     # initial value of a variable or macro / define can have for it to appear in the
624     # documentation. If the initializer consists of more lines than specified here
625     # it will be hidden. Use a value of 0 to hide initializers completely. The
626     # appearance of the value of individual variables and macros / defines can be
627     # controlled using \showinitializer or \hideinitializer command in the
628     # documentation regardless of this setting.
629     # Minimum value: 0, maximum value: 10000, default value: 30.
630 jgs 82
631     MAX_INITIALIZER_LINES = 30
632    
633 sshaw 5735 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
634     # the bottom of the documentation of classes and structs. If set to YES the list
635     # will mention the files that were used to generate the documentation.
636     # The default value is: YES.
637 jgs 82
638     SHOW_USED_FILES = YES
639    
640 sshaw 5735 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
641     # will remove the Files entry from the Quick Index and from the Folder Tree View
642     # (if specified).
643     # The default value is: YES.
644 jfenwick 1796
645     SHOW_FILES = YES
646    
647 sshaw 5735 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
648     # page. This will remove the Namespaces entry from the Quick Index and from the
649     # Folder Tree View (if specified).
650     # The default value is: YES.
651 jfenwick 1796
652     SHOW_NAMESPACES = YES
653    
654 caltinay 3991 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
655     # doxygen should invoke to get the current version for each file (typically from
656     # the version control system). Doxygen will invoke the program by executing (via
657 sshaw 5735 # popen()) the command command input-file, where command is the value of the
658     # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
659     # by doxygen. Whatever the program writes to standard output is used as the file
660     # version. For an example see the documentation.
661 jfenwick 1796
662 caltinay 3991 FILE_VERSION_FILTER =
663 jfenwick 1796
664 caltinay 3991 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
665     # by doxygen. The layout file controls the global structure of the generated
666     # output files in an output format independent way. To create the layout file
667 sshaw 5735 # that represents doxygen's defaults, run doxygen with the -l option. You can
668     # optionally specify a file name after the option, if omitted DoxygenLayout.xml
669     # will be used as the name of the layout file.
670     #
671     # Note that if you run doxygen from a directory containing a file called
672     # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
673     # tag is left empty.
674 caltinay 3991
675     LAYOUT_FILE =
676    
677 sshaw 5735 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
678     # the reference definitions. This must be a list of .bib files. The .bib
679     # extension is automatically appended if omitted. This requires the bibtex tool
680     # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
681     # For LaTeX the style of the bibliography can be controlled using
682     # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
683     # search path. See also \cite for info how to create references.
684 caltinay 3991
685     CITE_BIB_FILES =
686    
687 jgs 82 #---------------------------------------------------------------------------
688 sshaw 5735 # Configuration options related to warning and progress messages
689 jgs 82 #---------------------------------------------------------------------------
690    
691 sshaw 5735 # The QUIET tag can be used to turn on/off the messages that are generated to
692     # standard output by doxygen. If QUIET is set to YES this implies that the
693     # messages are off.
694     # The default value is: NO.
695 jgs 82
696     QUIET = NO
697    
698 caltinay 3991 # The WARNINGS tag can be used to turn on/off the warning messages that are
699 sshaw 5735 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
700     # this implies that the warnings are on.
701     #
702     # Tip: Turn warnings on while writing the documentation.
703     # The default value is: YES.
704 jgs 82
705     WARNINGS = YES
706    
707 sshaw 5735 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
708     # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
709     # will automatically be disabled.
710     # The default value is: YES.
711 jgs 82
712     WARN_IF_UNDOCUMENTED = YES
713    
714 sshaw 5735 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
715     # potential errors in the documentation, such as not documenting some parameters
716     # in a documented function, or documenting parameters that don't exist or using
717     # markup commands wrongly.
718     # The default value is: YES.
719 jgs 121
720     WARN_IF_DOC_ERROR = YES
721    
722 sshaw 5735 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
723     # are documented, but have no documentation for their parameters or return
724     # value. If set to NO doxygen will only warn about wrong or incomplete parameter
725     # documentation, but not about the absence of documentation.
726     # The default value is: NO.
727 jfenwick 1796
728     WARN_NO_PARAMDOC = NO
729    
730 sshaw 5735 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
731     # can produce. The string should contain the $file, $line, and $text tags, which
732     # will be replaced by the file and line number from which the warning originated
733     # and the warning text. Optionally the format may contain $version, which will
734     # be replaced by the version of the file (if it could be obtained via
735     # FILE_VERSION_FILTER)
736     # The default value is: $file:$line: $text.
737 jgs 82
738 caltinay 3991 WARN_FORMAT =
739 jgs 82
740 sshaw 5735 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
741     # messages should be written. If left blank the output is written to standard
742     # error (stderr).
743 jgs 82
744 caltinay 3991 WARN_LOGFILE =
745 jgs 82
746     #---------------------------------------------------------------------------
747 sshaw 5735 # Configuration options related to the input files
748 jgs 82 #---------------------------------------------------------------------------
749    
750 sshaw 5735 # The INPUT tag is used to specify the files and/or directories that contain
751     # documented source files. You may enter file names like myfile.cpp or
752     # directories like /usr/src/myproject. Separate the files or directories with
753     # spaces.
754     # Note: If this tag is empty the current directory is searched.
755 jgs 82
756 jfenwick 4792 INPUT = escriptcore/src \
757 caltinay 3454 dudley/src \
758 jfenwick 1796 finley/src \
759     paso/src \
760 caltinay 2544 pythonMPI/src \
761 caltinay 3991 ripley/src \
762 sshaw 5735 speckley/src \
763 caltinay 3454 weipa/src
764 jgs 82
765 caltinay 3991 # This tag can be used to specify the character encoding of the source files
766 sshaw 5735 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
767     # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
768     # documentation (see: http://www.gnu.org/software/libiconv) for the list of
769     # possible encodings.
770     # The default value is: UTF-8.
771 jfenwick 1796
772     INPUT_ENCODING = UTF-8
773    
774 caltinay 3991 # If the value of the INPUT tag contains directories, you can use the
775 sshaw 5735 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
776     # *.h) to filter out the source-files in the directories. If left blank the
777     # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
778     # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
779     # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
780     # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
781     # *.qsf, *.as and *.js.
782 jgs 82
783 jfenwick 1796 FILE_PATTERNS = *.c \
784     *.cpp \
785 jgs 121 *.h
786 jgs 82
787 sshaw 5735 # The RECURSIVE tag can be used to specify whether or not subdirectories should
788     # be searched for input files as well.
789     # The default value is: NO.
790 jgs 82
791     RECURSIVE = YES
792    
793 caltinay 3991 # The EXCLUDE tag can be used to specify files and/or directories that should be
794     # excluded from the INPUT source files. This way you can easily exclude a
795 jgs 82 # subdirectory from a directory tree whose root is specified with the INPUT tag.
796 sshaw 5735 #
797 caltinay 3991 # Note that relative paths are relative to the directory from which doxygen is
798     # run.
799 jgs 82
800     EXCLUDE = test
801    
802 caltinay 3991 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
803     # directories that are symbolic links (a Unix file system feature) are excluded
804 jfenwick 1796 # from the input.
805 sshaw 5735 # The default value is: NO.
806 jgs 121
807     EXCLUDE_SYMLINKS = NO
808    
809 caltinay 3991 # If the value of the INPUT tag contains directories, you can use the
810     # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
811 sshaw 5735 # certain files from those directories.
812     #
813     # Note that the wildcards are matched against the file with absolute path, so to
814     # exclude all test directories for example use the pattern */test/*
815 jgs 82
816 caltinay 3991 EXCLUDE_PATTERNS = */.svn/* \
817     */.svn \
818     */deprecated/*
819 jgs 82
820 caltinay 3991 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
821     # (namespaces, classes, functions, etc.) that should be excluded from the
822     # output. The symbol name can be a fully qualified name, a word, or if the
823     # wildcard * is used, a substring. Examples: ANamespace, AClass,
824 jfenwick 1796 # AClass::ANamespace, ANamespace::*Test
825 sshaw 5735 #
826     # Note that the wildcards are matched against the file with absolute path, so to
827     # exclude all test directories use the pattern */test/*
828 jfenwick 1796
829 caltinay 3991 EXCLUDE_SYMBOLS =
830 jfenwick 1796
831 sshaw 5735 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
832     # that contain example code fragments that are included (see the \include
833     # command).
834 jgs 82
835 caltinay 3991 EXAMPLE_PATH =
836 jgs 82
837 caltinay 3991 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
838 sshaw 5735 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
839     # *.h) to filter out the source-files in the directories. If left blank all
840     # files are included.
841 jgs 82
842 caltinay 3991 EXAMPLE_PATTERNS =
843 jgs 82
844 caltinay 3991 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
845 sshaw 5735 # searched for input files to be used with the \include or \dontinclude commands
846     # irrespective of the value of the RECURSIVE tag.
847     # The default value is: NO.
848 jgs 121
849     EXAMPLE_RECURSIVE = NO
850    
851 sshaw 5735 # The IMAGE_PATH tag can be used to specify one or more files or directories
852     # that contain images that are to be included in the documentation (see the
853     # \image command).
854 jgs 82
855 caltinay 3991 IMAGE_PATH =
856 jgs 82
857 caltinay 3991 # The INPUT_FILTER tag can be used to specify a program that doxygen should
858     # invoke to filter for each input file. Doxygen will invoke the filter program
859 sshaw 5735 # by executing (via popen()) the command:
860     #
861     # <filter> <input-file>
862     #
863     # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
864     # name of an input file. Doxygen will then use the output that the filter
865     # program writes to standard output. If FILTER_PATTERNS is specified, this tag
866     # will be ignored.
867     #
868     # Note that the filter must not add or remove lines; it is applied before the
869     # code is scanned, but not when the output code is generated. If lines are added
870     # or removed, the anchors will not be placed correctly.
871 jgs 82
872 caltinay 3991 INPUT_FILTER =
873 jgs 82
874 caltinay 3991 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
875 sshaw 5735 # basis. Doxygen will compare the file name with each pattern and apply the
876     # filter if there is a match. The filters are a list of the form: pattern=filter
877     # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
878     # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
879     # patterns match the file name, INPUT_FILTER is applied.
880 jfenwick 1796
881 caltinay 3991 FILTER_PATTERNS =
882 jfenwick 1796
883 caltinay 3991 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
884 sshaw 5735 # INPUT_FILTER ) will also be used to filter the input files that are used for
885     # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
886     # The default value is: NO.
887 jgs 82
888     FILTER_SOURCE_FILES = NO
889    
890 caltinay 3991 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
891 sshaw 5735 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
892     # it is also possible to disable source filtering for a specific pattern using
893     # *.ext= (so without naming a filter).
894     # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
895 caltinay 3991
896     FILTER_SOURCE_PATTERNS =
897    
898 sshaw 5735 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
899     # is part of the input, its contents will be placed on the main page
900     # (index.html). This can be useful if you have a project on for instance GitHub
901     # and want to reuse the introduction page also for the doxygen output.
902    
903     USE_MDFILE_AS_MAINPAGE =
904    
905 jgs 82 #---------------------------------------------------------------------------
906 sshaw 5735 # Configuration options related to source browsing
907 jgs 121 #---------------------------------------------------------------------------
908    
909 sshaw 5735 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
910     # generated. Documented entities will be cross-referenced with these sources.
911     #
912     # Note: To get rid of all source code in the generated output, make sure that
913     # also VERBATIM_HEADERS is set to NO.
914     # The default value is: NO.
915 jgs 121
916     SOURCE_BROWSER = NO
917    
918 sshaw 5735 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
919     # classes and enums directly into the documentation.
920     # The default value is: NO.
921 jgs 121
922     INLINE_SOURCES = NO
923    
924 sshaw 5735 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
925     # special comment blocks from generated source code fragments. Normal C, C++ and
926     # Fortran comments will always remain visible.
927     # The default value is: YES.
928 jgs 121
929     STRIP_CODE_COMMENTS = YES
930    
931 sshaw 5735 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
932     # function all documented functions referencing it will be listed.
933     # The default value is: NO.
934 jgs 121
935     REFERENCED_BY_RELATION = YES
936    
937 sshaw 5735 # If the REFERENCES_RELATION tag is set to YES then for each documented function
938     # all documented entities called/used by that function will be listed.
939     # The default value is: NO.
940 jgs 121
941     REFERENCES_RELATION = YES
942    
943 sshaw 5735 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
944     # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
945     # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
946     # link to the documentation.
947     # The default value is: YES.
948 jfenwick 1796
949     REFERENCES_LINK_SOURCE = YES
950    
951 sshaw 5735 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
952     # source code will show a tooltip with additional information such as prototype,
953     # brief description and links to the definition and documentation. Since this
954     # will make the HTML file larger and loading of large files a bit slower, you
955     # can opt to disable this feature.
956     # The default value is: YES.
957     # This tag requires that the tag SOURCE_BROWSER is set to YES.
958 jfenwick 1796
959 sshaw 5735 SOURCE_TOOLTIPS = YES
960    
961     # If the USE_HTAGS tag is set to YES then the references to source code will
962     # point to the HTML generated by the htags(1) tool instead of doxygen built-in
963     # source browser. The htags tool is part of GNU's global source tagging system
964     # (see http://www.gnu.org/software/global/global.html). You will need version
965     # 4.8.6 or higher.
966     #
967     # To use it do the following:
968     # - Install the latest version of global
969     # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
970     # - Make sure the INPUT points to the root of the source tree
971     # - Run doxygen as normal
972     #
973     # Doxygen will invoke htags (and that will in turn invoke gtags), so these
974     # tools must be available from the command line (i.e. in the search path).
975     #
976     # The result: instead of the source browser generated by doxygen, the links to
977     # source code will now point to the output of htags.
978     # The default value is: NO.
979     # This tag requires that the tag SOURCE_BROWSER is set to YES.
980    
981 jfenwick 1796 USE_HTAGS = NO
982    
983 sshaw 5735 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
984     # verbatim copy of the header file for each class for which an include is
985     # specified. Set to NO to disable this.
986     # See also: Section \class.
987     # The default value is: YES.
988 jgs 121
989     VERBATIM_HEADERS = YES
990    
991 sshaw 5735 # If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the
992     # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
993     # cost of reduced performance. This can be particularly helpful with template
994     # rich C++ code for which doxygen's built-in parser lacks the necessary type
995     # information.
996     # Note: The availability of this option depends on whether or not doxygen was
997     # compiled with the --with-libclang option.
998     # The default value is: NO.
999    
1000     CLANG_ASSISTED_PARSING = NO
1001    
1002     # If clang assisted parsing is enabled you can provide the compiler with command
1003     # line options that you would normally use when invoking the compiler. Note that
1004     # the include paths will already be set by doxygen for the files and directories
1005     # specified with INPUT and INCLUDE_PATH.
1006     # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1007    
1008     CLANG_OPTIONS =
1009    
1010 jgs 121 #---------------------------------------------------------------------------
1011 sshaw 5735 # Configuration options related to the alphabetical class index
1012 jgs 82 #---------------------------------------------------------------------------
1013    
1014 sshaw 5735 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1015     # compounds will be generated. Enable this if the project contains a lot of
1016     # classes, structs, unions or interfaces.
1017     # The default value is: YES.
1018 jgs 82
1019     ALPHABETICAL_INDEX = YES
1020    
1021 sshaw 5735 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1022     # which the alphabetical index list will be split.
1023     # Minimum value: 1, maximum value: 20, default value: 5.
1024     # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1025 jgs 82
1026     COLS_IN_ALPHA_INDEX = 5
1027    
1028 sshaw 5735 # In case all classes in a project start with a common prefix, all classes will
1029     # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1030     # can be used to specify a prefix (or a list of prefixes) that should be ignored
1031     # while generating the index headers.
1032     # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1033 jgs 82
1034 caltinay 3991 IGNORE_PREFIX =
1035 jgs 82
1036     #---------------------------------------------------------------------------
1037 sshaw 5735 # Configuration options related to the HTML output
1038 jgs 82 #---------------------------------------------------------------------------
1039    
1040 sshaw 5735 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1041     # The default value is: YES.
1042 jgs 82
1043     GENERATE_HTML = YES
1044    
1045 sshaw 5735 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1046     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1047     # it.
1048     # The default directory is: html.
1049     # This tag requires that the tag GENERATE_HTML is set to YES.
1050 jgs 82
1051 caltinay 3991 HTML_OUTPUT =
1052 jgs 82
1053 sshaw 5735 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1054     # generated HTML page (for example: .htm, .php, .asp).
1055     # The default value is: .html.
1056     # This tag requires that the tag GENERATE_HTML is set to YES.
1057 jgs 121
1058     HTML_FILE_EXTENSION = .html
1059    
1060 sshaw 5735 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1061     # each generated HTML page. If the tag is left blank doxygen will generate a
1062     # standard header.
1063     #
1064     # To get valid HTML the header file that includes any scripts and style sheets
1065     # that doxygen needs, which is dependent on the configuration options used (e.g.
1066     # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1067     # default header using
1068     # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1069     # YourConfigFile
1070     # and then modify the file new_header.html. See also section "Doxygen usage"
1071     # for information on how to generate the default header that doxygen normally
1072     # uses.
1073     # Note: The header is subject to change so you typically have to regenerate the
1074     # default header when upgrading to a newer version of doxygen. For a description
1075     # of the possible markers and block names see the documentation.
1076     # This tag requires that the tag GENERATE_HTML is set to YES.
1077 jgs 82
1078 caltinay 3991 HTML_HEADER =
1079 jgs 82
1080 sshaw 5735 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1081     # generated HTML page. If the tag is left blank doxygen will generate a standard
1082     # footer. See HTML_HEADER for more information on how to generate a default
1083     # footer and what special commands can be used inside the footer. See also
1084     # section "Doxygen usage" for information on how to generate the default footer
1085     # that doxygen normally uses.
1086     # This tag requires that the tag GENERATE_HTML is set to YES.
1087 jgs 82
1088 caltinay 3991 HTML_FOOTER =
1089 jgs 82
1090 sshaw 5735 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1091     # sheet that is used by each HTML page. It can be used to fine-tune the look of
1092     # the HTML output. If left blank doxygen will generate a default style sheet.
1093     # See also section "Doxygen usage" for information on how to generate the style
1094     # sheet that doxygen normally uses.
1095     # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1096     # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1097     # obsolete.
1098     # This tag requires that the tag GENERATE_HTML is set to YES.
1099 jgs 82
1100 caltinay 3991 HTML_STYLESHEET =
1101 jgs 82
1102 sshaw 5735 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1103     # cascading style sheets that are included after the standard style sheets
1104     # created by doxygen. Using this option one can overrule certain style aspects.
1105     # This is preferred over using HTML_STYLESHEET since it does not replace the
1106     # standard style sheet and is therefor more robust against future updates.
1107     # Doxygen will copy the style sheet files to the output directory.
1108     # Note: The order of the extra stylesheet files is of importance (e.g. the last
1109     # stylesheet in the list overrules the setting of the previous ones in the
1110     # list). For an example see the documentation.
1111     # This tag requires that the tag GENERATE_HTML is set to YES.
1112    
1113     HTML_EXTRA_STYLESHEET =
1114    
1115 caltinay 3991 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1116     # other source files which should be copied to the HTML output directory. Note
1117     # that these files will be copied to the base HTML output directory. Use the
1118 sshaw 5735 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1119     # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1120     # files will be copied as-is; there are no commands or markers available.
1121     # This tag requires that the tag GENERATE_HTML is set to YES.
1122 jgs 82
1123 caltinay 3991 HTML_EXTRA_FILES =
1124 jgs 82
1125 sshaw 5735 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1126     # will adjust the colors in the stylesheet and background images according to
1127     # this color. Hue is specified as an angle on a colorwheel, see
1128     # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1129     # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1130     # purple, and 360 is red again.
1131     # Minimum value: 0, maximum value: 359, default value: 220.
1132     # This tag requires that the tag GENERATE_HTML is set to YES.
1133 jgs 82
1134 caltinay 3991 HTML_COLORSTYLE_HUE = 220
1135 jgs 82
1136 sshaw 5735 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1137     # in the HTML output. For a value of 0 the output will use grayscales only. A
1138     # value of 255 will produce the most vivid colors.
1139     # Minimum value: 0, maximum value: 255, default value: 100.
1140     # This tag requires that the tag GENERATE_HTML is set to YES.
1141 caltinay 3991
1142     HTML_COLORSTYLE_SAT = 100
1143    
1144 sshaw 5735 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1145     # luminance component of the colors in the HTML output. Values below 100
1146     # gradually make the output lighter, whereas values above 100 make the output
1147     # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1148     # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1149     # change the gamma.
1150     # Minimum value: 40, maximum value: 240, default value: 80.
1151     # This tag requires that the tag GENERATE_HTML is set to YES.
1152 caltinay 3991
1153     HTML_COLORSTYLE_GAMMA = 80
1154    
1155     # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1156 sshaw 5735 # page will contain the date and time when the page was generated. Setting this
1157     # to NO can help when comparing the output of multiple runs.
1158     # The default value is: YES.
1159     # This tag requires that the tag GENERATE_HTML is set to YES.
1160 caltinay 3991
1161 jfenwick 6410 HTML_TIMESTAMP = NO
1162 caltinay 3991
1163     # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1164     # documentation will contain sections that can be hidden and shown after the
1165     # page has loaded.
1166 sshaw 5735 # The default value is: NO.
1167     # This tag requires that the tag GENERATE_HTML is set to YES.
1168 caltinay 3991
1169     HTML_DYNAMIC_SECTIONS = NO
1170    
1171 sshaw 5735 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1172     # shown in the various tree structured indices initially; the user can expand
1173     # and collapse entries dynamically later on. Doxygen will expand the tree to
1174     # such a level that at most the specified number of entries are visible (unless
1175     # a fully collapsed tree already exceeds this amount). So setting the number of
1176     # entries 1 will produce a full collapsed tree by default. 0 is a special value
1177     # representing an infinite number of entries and will result in a full expanded
1178     # tree by default.
1179     # Minimum value: 0, maximum value: 9999, default value: 100.
1180     # This tag requires that the tag GENERATE_HTML is set to YES.
1181 caltinay 3991
1182     HTML_INDEX_NUM_ENTRIES = 100
1183    
1184 sshaw 5735 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1185     # generated that can be used as input for Apple's Xcode 3 integrated development
1186     # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1187     # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1188     # Makefile in the HTML output directory. Running make will produce the docset in
1189     # that directory and running make install will install the docset in
1190     # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1191     # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1192 caltinay 3991 # for more information.
1193 sshaw 5735 # The default value is: NO.
1194     # This tag requires that the tag GENERATE_HTML is set to YES.
1195 jfenwick 1796
1196     GENERATE_DOCSET = NO
1197    
1198 sshaw 5735 # This tag determines the name of the docset feed. A documentation feed provides
1199     # an umbrella under which multiple documentation sets from a single provider
1200     # (such as a company or product suite) can be grouped.
1201     # The default value is: Doxygen generated docs.
1202     # This tag requires that the tag GENERATE_DOCSET is set to YES.
1203 jfenwick 1796
1204     DOCSET_FEEDNAME = "Doxygen generated docs"
1205    
1206 sshaw 5735 # This tag specifies a string that should uniquely identify the documentation
1207     # set bundle. This should be a reverse domain-name style string, e.g.
1208     # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1209     # The default value is: org.doxygen.Project.
1210     # This tag requires that the tag GENERATE_DOCSET is set to YES.
1211 jfenwick 1796
1212     DOCSET_BUNDLE_ID = org.doxygen.Project
1213    
1214 sshaw 5735 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1215 caltinay 3991 # the documentation publisher. This should be a reverse domain-name style
1216     # string, e.g. com.mycompany.MyDocSet.documentation.
1217 sshaw 5735 # The default value is: org.doxygen.Publisher.
1218     # This tag requires that the tag GENERATE_DOCSET is set to YES.
1219 jfenwick 1796
1220 caltinay 3991 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1221 jfenwick 1796
1222 sshaw 5735 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1223     # The default value is: Publisher.
1224     # This tag requires that the tag GENERATE_DOCSET is set to YES.
1225 caltinay 3991
1226     DOCSET_PUBLISHER_NAME = Publisher
1227    
1228 sshaw 5735 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1229     # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1230     # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1231     # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1232     # Windows.
1233     #
1234     # The HTML Help Workshop contains a compiler that can convert all HTML output
1235     # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1236     # files are now used as the Windows 98 help format, and will replace the old
1237     # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1238     # HTML files also contain an index, a table of contents, and you can search for
1239     # words in the documentation. The HTML workshop also contains a viewer for
1240     # compressed HTML files.
1241     # The default value is: NO.
1242     # This tag requires that the tag GENERATE_HTML is set to YES.
1243 caltinay 3991
1244     GENERATE_HTMLHELP = NO
1245    
1246 sshaw 5735 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1247     # file. You can add a path in front of the file if the result should not be
1248 jgs 121 # written to the html output directory.
1249 sshaw 5735 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1250 jgs 121
1251 caltinay 3991 CHM_FILE =
1252 jgs 121
1253 sshaw 5735 # The HHC_LOCATION tag can be used to specify the location (absolute path
1254     # including file name) of the HTML help compiler ( hhc.exe). If non-empty
1255     # doxygen will try to run the HTML help compiler on the generated index.hhp.
1256     # The file has to be specified with full path.
1257     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1258 jgs 121
1259 caltinay 3991 HHC_LOCATION =
1260 jgs 121
1261 sshaw 5735 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1262     # YES) or that it should be included in the master .chm file ( NO).
1263     # The default value is: NO.
1264     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1265 jgs 82
1266     GENERATE_CHI = NO
1267    
1268 sshaw 5735 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1269     # and project file content.
1270     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1271 jfenwick 1796
1272 caltinay 3991 CHM_INDEX_ENCODING =
1273 jfenwick 1796
1274 sshaw 5735 # The BINARY_TOC flag controls whether a binary table of contents is generated (
1275     # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
1276     # enables the Previous and Next buttons.
1277     # The default value is: NO.
1278     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1279 jgs 82
1280     BINARY_TOC = NO
1281    
1282 sshaw 5735 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1283     # the table of contents of the HTML help documentation and to the tree view.
1284     # The default value is: NO.
1285     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1286 jgs 82
1287     TOC_EXPAND = NO
1288    
1289 caltinay 3991 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1290 sshaw 5735 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1291     # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1292     # (.qch) of the generated HTML documentation.
1293     # The default value is: NO.
1294     # This tag requires that the tag GENERATE_HTML is set to YES.
1295 jgs 82
1296 caltinay 3991 GENERATE_QHP = NO
1297 jgs 82
1298 sshaw 5735 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1299     # the file name of the resulting .qch file. The path specified is relative to
1300     # the HTML output folder.
1301     # This tag requires that the tag GENERATE_QHP is set to YES.
1302 jgs 82
1303 caltinay 3991 QCH_FILE =
1304 jgs 82
1305 sshaw 5735 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1306     # Project output. For more information please see Qt Help Project / Namespace
1307     # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1308     # The default value is: org.doxygen.Project.
1309     # This tag requires that the tag GENERATE_QHP is set to YES.
1310 caltinay 3991
1311     QHP_NAMESPACE = org.doxygen.Project
1312    
1313 sshaw 5735 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1314     # Help Project output. For more information please see Qt Help Project / Virtual
1315     # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1316     # folders).
1317     # The default value is: doc.
1318     # This tag requires that the tag GENERATE_QHP is set to YES.
1319 caltinay 3991
1320     QHP_VIRTUAL_FOLDER = doc
1321    
1322 sshaw 5735 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1323     # filter to add. For more information please see Qt Help Project / Custom
1324     # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1325     # filters).
1326     # This tag requires that the tag GENERATE_QHP is set to YES.
1327 caltinay 3991
1328     QHP_CUST_FILTER_NAME =
1329    
1330 sshaw 5735 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1331     # custom filter to add. For more information please see Qt Help Project / Custom
1332     # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1333     # filters).
1334     # This tag requires that the tag GENERATE_QHP is set to YES.
1335 caltinay 3991
1336     QHP_CUST_FILTER_ATTRS =
1337    
1338     # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1339 sshaw 5735 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1340     # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1341     # This tag requires that the tag GENERATE_QHP is set to YES.
1342 caltinay 3991
1343     QHP_SECT_FILTER_ATTRS =
1344    
1345 sshaw 5735 # The QHG_LOCATION tag can be used to specify the location of Qt's
1346     # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1347     # generated .qhp file.
1348     # This tag requires that the tag GENERATE_QHP is set to YES.
1349 caltinay 3991
1350     QHG_LOCATION =
1351    
1352 sshaw 5735 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1353     # generated, together with the HTML files, they form an Eclipse help plugin. To
1354     # install this plugin and make it available under the help contents menu in
1355     # Eclipse, the contents of the directory containing the HTML and XML files needs
1356     # to be copied into the plugins directory of eclipse. The name of the directory
1357     # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1358     # After copying Eclipse needs to be restarted before the help appears.
1359     # The default value is: NO.
1360     # This tag requires that the tag GENERATE_HTML is set to YES.
1361 caltinay 3991
1362     GENERATE_ECLIPSEHELP = NO
1363    
1364 sshaw 5735 # A unique identifier for the Eclipse help plugin. When installing the plugin
1365     # the directory name containing the HTML and XML files should also have this
1366     # name. Each documentation set should have its own identifier.
1367     # The default value is: org.doxygen.Project.
1368     # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1369 caltinay 3991
1370     ECLIPSE_DOC_ID = org.doxygen.Project
1371    
1372 sshaw 5735 # If you want full control over the layout of the generated HTML pages it might
1373     # be necessary to disable the index and replace it with your own. The
1374     # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1375     # of each HTML page. A value of NO enables the index and the value YES disables
1376     # it. Since the tabs in the index contain the same information as the navigation
1377     # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1378     # The default value is: NO.
1379     # This tag requires that the tag GENERATE_HTML is set to YES.
1380 caltinay 3991
1381     DISABLE_INDEX = NO
1382    
1383 jfenwick 1796 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1384 sshaw 5735 # structure should be generated to display hierarchical information. If the tag
1385     # value is set to YES, a side panel will be generated containing a tree-like
1386     # index structure (just like the one that is generated for HTML Help). For this
1387     # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1388     # (i.e. any modern browser). Windows users are probably better off using the
1389     # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1390     # further fine-tune the look of the index. As an example, the default style
1391     # sheet generated by doxygen has an example that shows how to put an image at
1392     # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1393     # the same information as the tab index, you could consider setting
1394     # DISABLE_INDEX to YES when enabling this option.
1395     # The default value is: NO.
1396     # This tag requires that the tag GENERATE_HTML is set to YES.
1397 jgs 82
1398     GENERATE_TREEVIEW = NO
1399    
1400 sshaw 5735 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1401     # doxygen will group on one line in the generated HTML documentation.
1402     #
1403     # Note that a value of 0 will completely suppress the enum values from appearing
1404     # in the overview section.
1405     # Minimum value: 0, maximum value: 20, default value: 4.
1406     # This tag requires that the tag GENERATE_HTML is set to YES.
1407 caltinay 3991
1408     ENUM_VALUES_PER_LINE = 4
1409    
1410 sshaw 5735 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1411     # to set the initial width (in pixels) of the frame in which the tree is shown.
1412     # Minimum value: 0, maximum value: 1500, default value: 250.
1413     # This tag requires that the tag GENERATE_HTML is set to YES.
1414 jgs 82
1415     TREEVIEW_WIDTH = 250
1416    
1417 sshaw 5735 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1418     # external symbols imported via tag files in a separate window.
1419     # The default value is: NO.
1420     # This tag requires that the tag GENERATE_HTML is set to YES.
1421 caltinay 3991
1422     EXT_LINKS_IN_WINDOW = NO
1423    
1424 sshaw 5735 # Use this tag to change the font size of LaTeX formulas included as images in
1425     # the HTML documentation. When you change the font size after a successful
1426     # doxygen run you need to manually remove any form_*.png images from the HTML
1427     # output directory to force them to be regenerated.
1428     # Minimum value: 8, maximum value: 50, default value: 10.
1429     # This tag requires that the tag GENERATE_HTML is set to YES.
1430 jfenwick 1796
1431     FORMULA_FONTSIZE = 10
1432    
1433 caltinay 3991 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1434 sshaw 5735 # generated for formulas are transparent PNGs. Transparent PNGs are not
1435     # supported properly for IE 6.0, but are supported on all modern browsers.
1436     #
1437     # Note that when changing this option you need to delete any form_*.png files in
1438     # the HTML output directory before the changes have effect.
1439     # The default value is: YES.
1440     # This tag requires that the tag GENERATE_HTML is set to YES.
1441 caltinay 3991
1442     FORMULA_TRANSPARENT = YES
1443    
1444 sshaw 5735 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1445     # http://www.mathjax.org) which uses client side Javascript for the rendering
1446     # instead of using prerendered bitmaps. Use this if you do not have LaTeX
1447     # installed or if you want to formulas look prettier in the HTML output. When
1448     # enabled you may also need to install MathJax separately and configure the path
1449     # to it using the MATHJAX_RELPATH option.
1450     # The default value is: NO.
1451     # This tag requires that the tag GENERATE_HTML is set to YES.
1452 caltinay 3991
1453     USE_MATHJAX = NO
1454    
1455 sshaw 5735 # When MathJax is enabled you can set the default output format to be used for
1456     # the MathJax output. See the MathJax site (see:
1457     # http://docs.mathjax.org/en/latest/output.html) for more details.
1458     # Possible values are: HTML-CSS (which is slower, but has the best
1459     # compatibility), NativeMML (i.e. MathML) and SVG.
1460     # The default value is: HTML-CSS.
1461     # This tag requires that the tag USE_MATHJAX is set to YES.
1462 caltinay 3991
1463 sshaw 5735 MATHJAX_FORMAT = HTML-CSS
1464    
1465     # When MathJax is enabled you need to specify the location relative to the HTML
1466     # output directory using the MATHJAX_RELPATH option. The destination directory
1467     # should contain the MathJax.js script. For instance, if the mathjax directory
1468     # is located at the same level as the HTML output directory, then
1469     # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1470     # Content Delivery Network so you can quickly see the result without installing
1471     # MathJax. However, it is strongly recommended to install a local copy of
1472     # MathJax from http://www.mathjax.org before deployment.
1473     # The default value is: http://cdn.mathjax.org/mathjax/latest.
1474     # This tag requires that the tag USE_MATHJAX is set to YES.
1475    
1476 caltinay 3991 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1477    
1478 sshaw 5735 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1479     # extension names that should be enabled during MathJax rendering. For example
1480     # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1481     # This tag requires that the tag USE_MATHJAX is set to YES.
1482 caltinay 3991
1483     MATHJAX_EXTENSIONS =
1484    
1485 sshaw 5735 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1486     # of code that will be used on startup of the MathJax code. See the MathJax site
1487     # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1488     # example see the documentation.
1489     # This tag requires that the tag USE_MATHJAX is set to YES.
1490 caltinay 3991
1491 sshaw 5735 MATHJAX_CODEFILE =
1492    
1493     # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1494     # the HTML output. The underlying search engine uses javascript and DHTML and
1495     # should work on any modern browser. Note that when using HTML help
1496     # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1497     # there is already a search function so this one should typically be disabled.
1498     # For large projects the javascript based search engine can be slow, then
1499     # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1500     # search using the keyboard; to jump to the search box use <access key> + S
1501     # (what the <access key> is depends on the OS and browser, but it is typically
1502     # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1503     # key> to jump into the search results window, the results can be navigated
1504     # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1505     # the search. The filter options can be selected when the cursor is inside the
1506     # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1507     # to select a filter and <Enter> or <escape> to activate or cancel the filter
1508     # option.
1509     # The default value is: YES.
1510     # This tag requires that the tag GENERATE_HTML is set to YES.
1511    
1512 caltinay 3991 SEARCHENGINE = NO
1513    
1514     # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1515 sshaw 5735 # implemented using a web server instead of a web client using Javascript. There
1516     # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1517     # setting. When disabled, doxygen will generate a PHP script for searching and
1518     # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1519     # and searching needs to be provided by external tools. See the section
1520     # "External Indexing and Searching" for details.
1521     # The default value is: NO.
1522     # This tag requires that the tag SEARCHENGINE is set to YES.
1523 caltinay 3991
1524     SERVER_BASED_SEARCH = NO
1525    
1526 sshaw 5735 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1527     # script for searching. Instead the search results are written to an XML file
1528     # which needs to be processed by an external indexer. Doxygen will invoke an
1529     # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1530     # search results.
1531     #
1532     # Doxygen ships with an example indexer ( doxyindexer) and search engine
1533     # (doxysearch.cgi) which are based on the open source search engine library
1534     # Xapian (see: http://xapian.org/).
1535     #
1536     # See the section "External Indexing and Searching" for details.
1537     # The default value is: NO.
1538     # This tag requires that the tag SEARCHENGINE is set to YES.
1539    
1540     EXTERNAL_SEARCH = NO
1541    
1542     # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1543     # which will return the search results when EXTERNAL_SEARCH is enabled.
1544     #
1545     # Doxygen ships with an example indexer ( doxyindexer) and search engine
1546     # (doxysearch.cgi) which are based on the open source search engine library
1547     # Xapian (see: http://xapian.org/). See the section "External Indexing and
1548     # Searching" for details.
1549     # This tag requires that the tag SEARCHENGINE is set to YES.
1550    
1551     SEARCHENGINE_URL =
1552    
1553     # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1554     # search data is written to a file for indexing by an external tool. With the
1555     # SEARCHDATA_FILE tag the name of this file can be specified.
1556     # The default file is: searchdata.xml.
1557     # This tag requires that the tag SEARCHENGINE is set to YES.
1558    
1559     SEARCHDATA_FILE = searchdata.xml
1560    
1561     # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1562     # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1563     # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1564     # projects and redirect the results back to the right project.
1565     # This tag requires that the tag SEARCHENGINE is set to YES.
1566    
1567     EXTERNAL_SEARCH_ID =
1568    
1569     # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1570     # projects other than the one defined by this configuration file, but that are
1571     # all added to the same external search index. Each project needs to have a
1572     # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1573     # to a relative location where the documentation can be found. The format is:
1574     # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1575     # This tag requires that the tag SEARCHENGINE is set to YES.
1576    
1577     EXTRA_SEARCH_MAPPINGS =
1578    
1579 jgs 82 #---------------------------------------------------------------------------
1580 sshaw 5735 # Configuration options related to the LaTeX output
1581 jgs 82 #---------------------------------------------------------------------------
1582    
1583 sshaw 5735 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1584     # The default value is: YES.
1585 jgs 82
1586     GENERATE_LATEX = NO
1587    
1588 sshaw 5735 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1589     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1590     # it.
1591     # The default directory is: latex.
1592     # This tag requires that the tag GENERATE_LATEX is set to YES.
1593 jgs 82
1594 caltinay 3991 LATEX_OUTPUT =
1595 jgs 82
1596 caltinay 3991 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1597 sshaw 5735 # invoked.
1598     #
1599     # Note that when enabling USE_PDFLATEX this option is only used for generating
1600     # bitmaps for formulas in the HTML output, but not in the Makefile that is
1601     # written to the output directory.
1602     # The default file is: latex.
1603     # This tag requires that the tag GENERATE_LATEX is set to YES.
1604 jgs 121
1605     LATEX_CMD_NAME = latex
1606    
1607 sshaw 5735 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1608     # index for LaTeX.
1609     # The default file is: makeindex.
1610     # This tag requires that the tag GENERATE_LATEX is set to YES.
1611 jgs 121
1612     MAKEINDEX_CMD_NAME = makeindex
1613    
1614 sshaw 5735 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1615     # documents. This may be useful for small projects and may help to save some
1616     # trees in general.
1617     # The default value is: NO.
1618     # This tag requires that the tag GENERATE_LATEX is set to YES.
1619 jgs 82
1620     COMPACT_LATEX = NO
1621    
1622 sshaw 5735 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1623     # printer.
1624     # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1625     # 14 inches) and executive (7.25 x 10.5 inches).
1626     # The default value is: a4.
1627     # This tag requires that the tag GENERATE_LATEX is set to YES.
1628 jgs 82
1629     PAPER_TYPE = a4wide
1630    
1631 sshaw 5735 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1632     # that should be included in the LaTeX output. To get the times font for
1633     # instance you can specify
1634     # EXTRA_PACKAGES=times
1635     # If left blank no extra packages will be included.
1636     # This tag requires that the tag GENERATE_LATEX is set to YES.
1637 jgs 82
1638 caltinay 3991 EXTRA_PACKAGES =
1639 jgs 82
1640 sshaw 5735 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1641     # generated LaTeX document. The header should contain everything until the first
1642     # chapter. If it is left blank doxygen will generate a standard header. See
1643     # section "Doxygen usage" for information on how to let doxygen write the
1644     # default header to a separate file.
1645     #
1646     # Note: Only use a user-defined header if you know what you are doing! The
1647     # following commands have a special meaning inside the header: $title,
1648     # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1649     # $projectbrief, $projectlogo. Doxygen will replace $title with the empy string,
1650     # for the replacement values of the other commands the user is refered to
1651     # HTML_HEADER.
1652     # This tag requires that the tag GENERATE_LATEX is set to YES.
1653 jgs 82
1654 caltinay 3991 LATEX_HEADER =
1655 jgs 82
1656 sshaw 5735 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1657     # generated LaTeX document. The footer should contain everything after the last
1658     # chapter. If it is left blank doxygen will generate a standard footer. See
1659     # LATEX_HEADER for more information on how to generate a default footer and what
1660     # special commands can be used inside the footer.
1661     #
1662     # Note: Only use a user-defined footer if you know what you are doing!
1663     # This tag requires that the tag GENERATE_LATEX is set to YES.
1664 caltinay 3991
1665     LATEX_FOOTER =
1666    
1667 sshaw 5735 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1668     # other source files which should be copied to the LATEX_OUTPUT output
1669     # directory. Note that the files will be copied as-is; there are no commands or
1670     # markers available.
1671     # This tag requires that the tag GENERATE_LATEX is set to YES.
1672 jgs 82
1673 sshaw 5735 LATEX_EXTRA_FILES =
1674    
1675     # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1676     # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1677     # contain links (just like the HTML output) instead of page references. This
1678     # makes the output suitable for online browsing using a PDF viewer.
1679     # The default value is: YES.
1680     # This tag requires that the tag GENERATE_LATEX is set to YES.
1681    
1682 jgs 82 PDF_HYPERLINKS = NO
1683    
1684 sshaw 5735 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1685     # the PDF file directly from the LaTeX files. Set this option to YES to get a
1686 jgs 82 # higher quality PDF documentation.
1687 sshaw 5735 # The default value is: YES.
1688     # This tag requires that the tag GENERATE_LATEX is set to YES.
1689 jgs 82
1690     USE_PDFLATEX = NO
1691    
1692 sshaw 5735 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1693     # command to the generated LaTeX files. This will instruct LaTeX to keep running
1694     # if errors occur, instead of asking the user for help. This option is also used
1695     # when generating formulas in HTML.
1696     # The default value is: NO.
1697     # This tag requires that the tag GENERATE_LATEX is set to YES.
1698 jgs 82
1699     LATEX_BATCHMODE = NO
1700    
1701 sshaw 5735 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1702     # index chapters (such as File Index, Compound Index, etc.) in the output.
1703     # The default value is: NO.
1704     # This tag requires that the tag GENERATE_LATEX is set to YES.
1705 jgs 121
1706     LATEX_HIDE_INDICES = NO
1707    
1708 sshaw 5735 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1709     # code with syntax highlighting in the LaTeX output.
1710     #
1711     # Note that which sources are shown also depends on other settings such as
1712     # SOURCE_BROWSER.
1713     # The default value is: NO.
1714     # This tag requires that the tag GENERATE_LATEX is set to YES.
1715 caltinay 3991
1716     LATEX_SOURCE_CODE = NO
1717    
1718     # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1719 sshaw 5735 # bibliography, e.g. plainnat, or ieeetr. See
1720     # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1721     # The default value is: plain.
1722     # This tag requires that the tag GENERATE_LATEX is set to YES.
1723 caltinay 3991
1724     LATEX_BIB_STYLE = plain
1725    
1726 jgs 82 #---------------------------------------------------------------------------
1727 sshaw 5735 # Configuration options related to the RTF output
1728 jgs 82 #---------------------------------------------------------------------------
1729    
1730 sshaw 5735 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1731     # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1732     # readers/editors.
1733     # The default value is: NO.
1734 jgs 82
1735     GENERATE_RTF = NO
1736    
1737 sshaw 5735 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1738     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1739     # it.
1740     # The default directory is: rtf.
1741     # This tag requires that the tag GENERATE_RTF is set to YES.
1742 jgs 82
1743 caltinay 3991 RTF_OUTPUT =
1744 jgs 82
1745 sshaw 5735 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1746     # documents. This may be useful for small projects and may help to save some
1747     # trees in general.
1748     # The default value is: NO.
1749     # This tag requires that the tag GENERATE_RTF is set to YES.
1750 jgs 82
1751     COMPACT_RTF = NO
1752    
1753 sshaw 5735 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1754     # contain hyperlink fields. The RTF file will contain links (just like the HTML
1755     # output) instead of page references. This makes the output suitable for online
1756     # browsing using Word or some other Word compatible readers that support those
1757     # fields.
1758     #
1759     # Note: WordPad (write) and others do not support links.
1760     # The default value is: NO.
1761     # This tag requires that the tag GENERATE_RTF is set to YES.
1762 jgs 82
1763     RTF_HYPERLINKS = NO
1764    
1765 sshaw 5735 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1766     # file, i.e. a series of assignments. You only have to provide replacements,
1767     # missing definitions are set to their default value.
1768     #
1769     # See also section "Doxygen usage" for information on how to generate the
1770     # default style sheet that doxygen normally uses.
1771     # This tag requires that the tag GENERATE_RTF is set to YES.
1772 jgs 82
1773 caltinay 3991 RTF_STYLESHEET_FILE =
1774 jgs 82
1775 sshaw 5735 # Set optional variables used in the generation of an RTF document. Syntax is
1776     # similar to doxygen's config file. A template extensions file can be generated
1777     # using doxygen -e rtf extensionFile.
1778     # This tag requires that the tag GENERATE_RTF is set to YES.
1779 jgs 82
1780 caltinay 3991 RTF_EXTENSIONS_FILE =
1781 jgs 82
1782     #---------------------------------------------------------------------------
1783 sshaw 5735 # Configuration options related to the man page output
1784 jgs 82 #---------------------------------------------------------------------------
1785    
1786 sshaw 5735 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1787     # classes and files.
1788     # The default value is: NO.
1789 jgs 82
1790     GENERATE_MAN = NO
1791    
1792 sshaw 5735 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1793     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1794     # it. A directory man3 will be created inside the directory specified by
1795     # MAN_OUTPUT.
1796     # The default directory is: man.
1797     # This tag requires that the tag GENERATE_MAN is set to YES.
1798 jgs 82
1799 caltinay 3991 MAN_OUTPUT =
1800 jgs 82
1801 sshaw 5735 # The MAN_EXTENSION tag determines the extension that is added to the generated
1802     # man pages. In case the manual section does not start with a number, the number
1803     # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1804     # optional.
1805     # The default value is: .3.
1806     # This tag requires that the tag GENERATE_MAN is set to YES.
1807 jgs 82
1808 caltinay 3991 MAN_EXTENSION =
1809 jgs 82
1810 sshaw 5735 # The MAN_SUBDIR tag determines the name of the directory created within
1811     # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1812     # MAN_EXTENSION with the initial . removed.
1813     # This tag requires that the tag GENERATE_MAN is set to YES.
1814 jgs 82
1815 sshaw 5735 MAN_SUBDIR =
1816    
1817     # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1818     # will generate one additional man file for each entity documented in the real
1819     # man page(s). These additional files only source the real man page, but without
1820     # them the man command would be unable to find the correct page.
1821     # The default value is: NO.
1822     # This tag requires that the tag GENERATE_MAN is set to YES.
1823    
1824 jgs 82 MAN_LINKS = NO
1825    
1826     #---------------------------------------------------------------------------
1827 sshaw 5735 # Configuration options related to the XML output
1828 jgs 121 #---------------------------------------------------------------------------
1829    
1830 sshaw 5735 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1831     # captures the structure of the code including all documentation.
1832     # The default value is: NO.
1833 jgs 121
1834     GENERATE_XML = NO
1835    
1836 sshaw 5735 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1837     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1838     # it.
1839     # The default directory is: xml.
1840     # This tag requires that the tag GENERATE_XML is set to YES.
1841 jgs 121
1842     XML_OUTPUT = xml
1843    
1844 sshaw 5735 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1845     # listings (including syntax highlighting and cross-referencing information) to
1846     # the XML output. Note that enabling this will significantly increase the size
1847     # of the XML output.
1848     # The default value is: YES.
1849     # This tag requires that the tag GENERATE_XML is set to YES.
1850 jgs 121
1851 sshaw 5735 XML_PROGRAMLISTING = YES
1852 jgs 121
1853 sshaw 5735 #---------------------------------------------------------------------------
1854     # Configuration options related to the DOCBOOK output
1855     #---------------------------------------------------------------------------
1856 jgs 121
1857 sshaw 5735 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1858     # that can be used to generate PDF.
1859     # The default value is: NO.
1860 jgs 121
1861 sshaw 5735 GENERATE_DOCBOOK = NO
1862 jgs 121
1863 sshaw 5735 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1864     # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1865     # front of it.
1866     # The default directory is: docbook.
1867     # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1868 jgs 121
1869 sshaw 5735 DOCBOOK_OUTPUT = docbook
1870    
1871     # If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the
1872     # program listings (including syntax highlighting and cross-referencing
1873     # information) to the DOCBOOK output. Note that enabling this will significantly
1874     # increase the size of the DOCBOOK output.
1875     # The default value is: NO.
1876     # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1877    
1878     DOCBOOK_PROGRAMLISTING = NO
1879    
1880 jgs 121 #---------------------------------------------------------------------------
1881 sshaw 5735 # Configuration options for the AutoGen Definitions output
1882 jgs 121 #---------------------------------------------------------------------------
1883    
1884 sshaw 5735 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1885     # Definitions (see http://autogen.sf.net) file that captures the structure of
1886     # the code including all documentation. Note that this feature is still
1887     # experimental and incomplete at the moment.
1888     # The default value is: NO.
1889 jgs 121
1890     GENERATE_AUTOGEN_DEF = NO
1891    
1892     #---------------------------------------------------------------------------
1893 sshaw 5735 # Configuration options related to the Perl module output
1894 jgs 121 #---------------------------------------------------------------------------
1895    
1896 sshaw 5735 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1897     # file that captures the structure of the code including all documentation.
1898     #
1899     # Note that this feature is still experimental and incomplete at the moment.
1900     # The default value is: NO.
1901 jgs 121
1902     GENERATE_PERLMOD = NO
1903    
1904 sshaw 5735 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1905     # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1906     # output from the Perl module output.
1907     # The default value is: NO.
1908     # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1909 jgs 121
1910     PERLMOD_LATEX = NO
1911    
1912 sshaw 5735 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1913     # formatted so it can be parsed by a human reader. This is useful if you want to
1914     # understand what is going on. On the other hand, if this tag is set to NO the
1915     # size of the Perl module output will be much smaller and Perl will parse it
1916     # just the same.
1917     # The default value is: YES.
1918     # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1919 jgs 121
1920     PERLMOD_PRETTY = YES
1921    
1922 sshaw 5735 # The names of the make variables in the generated doxyrules.make file are
1923     # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1924     # so different doxyrules.make files included by the same Makefile don't
1925     # overwrite each other's variables.
1926     # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1927 jgs 121
1928 caltinay 3991 PERLMOD_MAKEVAR_PREFIX =
1929 jgs 121
1930     #---------------------------------------------------------------------------
1931 caltinay 3991 # Configuration options related to the preprocessor
1932 jgs 82 #---------------------------------------------------------------------------
1933    
1934 sshaw 5735 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1935     # C-preprocessor directives found in the sources and include files.
1936     # The default value is: YES.
1937 jgs 82
1938     ENABLE_PREPROCESSING = YES
1939    
1940 sshaw 5735 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1941     # in the source code. If set to NO only conditional compilation will be
1942     # performed. Macro expansion can be done in a controlled way by setting
1943     # EXPAND_ONLY_PREDEF to YES.
1944     # The default value is: NO.
1945     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1946 jgs 82
1947 jfenwick 2521 MACRO_EXPANSION = YES
1948 jgs 82
1949 sshaw 5735 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1950     # the macro expansion is limited to the macros specified with the PREDEFINED and
1951     # EXPAND_AS_DEFINED tags.
1952     # The default value is: NO.
1953     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1954 jgs 82
1955     EXPAND_ONLY_PREDEF = NO
1956    
1957 sshaw 5735 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
1958     # INCLUDE_PATH will be searched if a #include is found.
1959     # The default value is: YES.
1960     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1961 jgs 82
1962     SEARCH_INCLUDES = YES
1963    
1964 caltinay 3991 # The INCLUDE_PATH tag can be used to specify one or more directories that
1965 sshaw 5735 # contain include files that are not input files but should be processed by the
1966     # preprocessor.
1967     # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1968 jgs 82
1969 caltinay 3991 INCLUDE_PATH =
1970 jgs 82
1971 caltinay 3991 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1972     # patterns (like *.h and *.hpp) to filter out the header-files in the
1973 sshaw 5735 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
1974     # used.
1975     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1976 jgs 82
1977 caltinay 3991 INCLUDE_FILE_PATTERNS =
1978 jgs 82
1979 sshaw 5735 # The PREDEFINED tag can be used to specify one or more macro names that are
1980     # defined before the preprocessor is started (similar to the -D option of e.g.
1981     # gcc). The argument of the tag is a list of macros of the form: name or
1982     # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1983     # is assumed. To prevent a macro definition from being undefined via #undef or
1984     # recursively expanded use the := operator instead of the = operator.
1985     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1986 jgs 82
1987 caltinay 3991 PREDEFINED =
1988 jgs 82
1989 sshaw 5735 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1990     # tag can be used to specify a list of macro names that should be expanded. The
1991     # macro definition that is found in the sources will be used. Use the PREDEFINED
1992     # tag if you want to use a different macro definition that overrules the
1993     # definition found in the source code.
1994     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1995 jgs 82
1996 caltinay 3991 EXPAND_AS_DEFINED =
1997 jgs 82
1998 sshaw 5735 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1999     # remove all references to function-like macros that are alone on a line, have
2000     # an all uppercase name, and do not end with a semicolon. Such function macros
2001     # are typically used for boiler-plate code, and will confuse the parser if not
2002     # removed.
2003     # The default value is: YES.
2004     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2005 jgs 121
2006     SKIP_FUNCTION_MACROS = YES
2007    
2008 jgs 82 #---------------------------------------------------------------------------
2009 sshaw 5735 # Configuration options related to external references
2010 jgs 82 #---------------------------------------------------------------------------
2011    
2012 sshaw 5735 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2013     # file the location of the external documentation should be added. The format of
2014     # a tag file without this location is as follows:
2015 caltinay 3991 # TAGFILES = file1 file2 ...
2016     # Adding location for the tag files is done as follows:
2017     # TAGFILES = file1=loc1 "file2 = loc2" ...
2018 sshaw 5735 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2019     # section "Linking to external documentation" for more information about the use
2020     # of tag files.
2021     # Note: Each tag file must have a unique name (where the name does NOT include
2022     # the path). If a tag file is not located in the directory in which doxygen is
2023     # run, you must also specify the path to the tagfile here.
2024 jgs 82
2025 caltinay 3991 TAGFILES =
2026 jgs 82
2027 sshaw 5735 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2028     # tag file that is based on the input files it reads. See section "Linking to
2029     # external documentation" for more information about the usage of tag files.
2030 jgs 82
2031 caltinay 3991 GENERATE_TAGFILE =
2032 jgs 82
2033 sshaw 5735 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2034     # class index. If set to NO only the inherited external classes will be listed.
2035     # The default value is: NO.
2036 jgs 82
2037     ALLEXTERNALS = NO
2038    
2039 sshaw 5735 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2040     # the modules index. If set to NO, only the current project's groups will be
2041     # listed.
2042     # The default value is: YES.
2043 jgs 121
2044     EXTERNAL_GROUPS = YES
2045    
2046 sshaw 5735 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2047     # the related pages index. If set to NO, only the current project's pages will
2048     # be listed.
2049     # The default value is: YES.
2050    
2051     EXTERNAL_PAGES = YES
2052    
2053 caltinay 3991 # The PERL_PATH should be the absolute path and name of the perl script
2054 sshaw 5735 # interpreter (i.e. the result of 'which perl').
2055     # The default file (with absolute path) is: /usr/bin/perl.
2056 jgs 82
2057 caltinay 3991 PERL_PATH =
2058 jgs 82
2059     #---------------------------------------------------------------------------
2060 caltinay 3991 # Configuration options related to the dot tool
2061 jgs 82 #---------------------------------------------------------------------------
2062    
2063 sshaw 5735 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2064     # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2065     # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2066     # disabled, but it is recommended to install and use dot, since it yields more
2067     # powerful graphs.
2068     # The default value is: YES.
2069 jgs 121
2070     CLASS_DIAGRAMS = YES
2071    
2072 caltinay 3991 # You can define message sequence charts within doxygen comments using the \msc
2073 sshaw 5735 # command. Doxygen will then run the mscgen tool (see:
2074     # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2075 caltinay 3991 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2076     # the mscgen tool resides. If left empty the tool is assumed to be found in the
2077 jfenwick 1796 # default search path.
2078    
2079 caltinay 3991 MSCGEN_PATH =
2080 jfenwick 1796
2081 sshaw 5735 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2082     # then run dia to produce the diagram and insert it in the documentation. The
2083     # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2084     # If left empty dia is assumed to be found in the default search path.
2085 jgs 121
2086 sshaw 5735 DIA_PATH =
2087    
2088     # If set to YES, the inheritance and collaboration graphs will hide inheritance
2089     # and usage relations if the target is undocumented or is not a class.
2090     # The default value is: YES.
2091    
2092 jgs 121 HIDE_UNDOC_RELATIONS = YES
2093    
2094 caltinay 3991 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2095 sshaw 5735 # available from the path. This tool is part of Graphviz (see:
2096     # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2097     # Bell Labs. The other options in this section have no effect if this option is
2098     # set to NO
2099     # The default value is: YES.
2100 jgs 82
2101     HAVE_DOT = NO
2102    
2103 sshaw 5735 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2104     # to run in parallel. When set to 0 doxygen will base this on the number of
2105     # processors available in the system. You can set it explicitly to a value
2106     # larger than 0 to get control over the balance between CPU load and processing
2107     # speed.
2108     # Minimum value: 0, maximum value: 32, default value: 0.
2109     # This tag requires that the tag HAVE_DOT is set to YES.
2110 jfenwick 1796
2111 caltinay 3991 DOT_NUM_THREADS = 0
2112    
2113 sshaw 5735 # When you want a differently looking font in the dot files that doxygen
2114     # generates you can specify the font name using DOT_FONTNAME. You need to make
2115     # sure dot is able to find the font, which can be done by putting it in a
2116     # standard location or by setting the DOTFONTPATH environment variable or by
2117     # setting DOT_FONTPATH to the directory containing the font.
2118     # The default value is: Helvetica.
2119     # This tag requires that the tag HAVE_DOT is set to YES.
2120 caltinay 3991
2121 jfenwick 5834 #DOT_FONTNAME = FreeSans
2122 jfenwick 1796
2123 sshaw 5735 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2124     # dot graphs.
2125     # Minimum value: 4, maximum value: 24, default value: 10.
2126     # This tag requires that the tag HAVE_DOT is set to YES.
2127 jfenwick 1796
2128 caltinay 3991 DOT_FONTSIZE = 10
2129 jfenwick 1796
2130 sshaw 5735 # By default doxygen will tell dot to use the default font as specified with
2131     # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2132     # the path where dot can find it using this tag.
2133     # This tag requires that the tag HAVE_DOT is set to YES.
2134 jgs 82
2135 caltinay 3991 DOT_FONTPATH =
2136    
2137 sshaw 5735 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2138     # each documented class showing the direct and indirect inheritance relations.
2139     # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2140     # The default value is: YES.
2141     # This tag requires that the tag HAVE_DOT is set to YES.
2142 caltinay 3991
2143 jgs 82 CLASS_GRAPH = YES
2144    
2145 sshaw 5735 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2146     # graph for each documented class showing the direct and indirect implementation
2147     # dependencies (inheritance, containment, and class references variables) of the
2148     # class with other documented classes.
2149     # The default value is: YES.
2150     # This tag requires that the tag HAVE_DOT is set to YES.
2151 jgs 82
2152     COLLABORATION_GRAPH = YES
2153    
2154 sshaw 5735 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2155     # groups, showing the direct groups dependencies.
2156     # The default value is: YES.
2157     # This tag requires that the tag HAVE_DOT is set to YES.
2158 jfenwick 1796
2159     GROUP_GRAPHS = YES
2160    
2161 caltinay 3991 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2162     # collaboration diagrams in a style similar to the OMG's Unified Modeling
2163 jgs 121 # Language.
2164 sshaw 5735 # The default value is: NO.
2165     # This tag requires that the tag HAVE_DOT is set to YES.
2166 jgs 121
2167     UML_LOOK = NO
2168    
2169 sshaw 5735 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2170     # class node. If there are many fields or methods and many nodes the graph may
2171     # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2172     # number of items for each type to make the size more manageable. Set this to 0
2173     # for no limit. Note that the threshold may be exceeded by 50% before the limit
2174     # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2175     # but if the number exceeds 15, the total amount of fields shown is limited to
2176     # 10.
2177     # Minimum value: 0, maximum value: 100, default value: 10.
2178     # This tag requires that the tag HAVE_DOT is set to YES.
2179 caltinay 3991
2180     UML_LIMIT_NUM_FIELDS = 10
2181    
2182 sshaw 5735 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2183     # collaboration graphs will show the relations between templates and their
2184     # instances.
2185     # The default value is: NO.
2186     # This tag requires that the tag HAVE_DOT is set to YES.
2187 jgs 121
2188     TEMPLATE_RELATIONS = NO
2189    
2190 sshaw 5735 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2191     # YES then doxygen will generate a graph for each documented file showing the
2192     # direct and indirect include dependencies of the file with other documented
2193     # files.
2194     # The default value is: YES.
2195     # This tag requires that the tag HAVE_DOT is set to YES.
2196 jgs 82
2197     INCLUDE_GRAPH = YES
2198    
2199 sshaw 5735 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2200     # set to YES then doxygen will generate a graph for each documented file showing
2201     # the direct and indirect include dependencies of the file with other documented
2202     # files.
2203     # The default value is: YES.
2204     # This tag requires that the tag HAVE_DOT is set to YES.
2205 jgs 82
2206     INCLUDED_BY_GRAPH = YES
2207    
2208 sshaw 5735 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2209     # dependency graph for every global function or class method.
2210     #
2211     # Note that enabling this option will significantly increase the time of a run.
2212     # So in most cases it will be better to enable call graphs for selected
2213     # functions only using the \callgraph command.
2214     # The default value is: NO.
2215     # This tag requires that the tag HAVE_DOT is set to YES.
2216 jgs 121
2217     CALL_GRAPH = NO
2218    
2219 sshaw 5735 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2220     # dependency graph for every global function or class method.
2221     #
2222     # Note that enabling this option will significantly increase the time of a run.
2223     # So in most cases it will be better to enable caller graphs for selected
2224     # functions only using the \callergraph command.
2225     # The default value is: NO.
2226     # This tag requires that the tag HAVE_DOT is set to YES.
2227 jfenwick 1796
2228     CALLER_GRAPH = NO
2229    
2230 sshaw 5735 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2231     # hierarchy of all classes instead of a textual one.
2232     # The default value is: YES.
2233     # This tag requires that the tag HAVE_DOT is set to YES.
2234 jgs 82
2235     GRAPHICAL_HIERARCHY = YES
2236    
2237 sshaw 5735 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2238     # dependencies a directory has on other directories in a graphical way. The
2239     # dependency relations are determined by the #include relations between the
2240     # files in the directories.
2241     # The default value is: YES.
2242     # This tag requires that the tag HAVE_DOT is set to YES.
2243 jfenwick 1796
2244     DIRECTORY_GRAPH = YES
2245    
2246 caltinay 3991 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2247 sshaw 5735 # generated by dot.
2248     # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2249     # to make the SVG files visible in IE 9+ (other browsers do not have this
2250     # requirement).
2251     # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2252     # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2253     # gif:cairo:gd, gif:gd, gif:gd:gd and svg.
2254     # The default value is: png.
2255     # This tag requires that the tag HAVE_DOT is set to YES.
2256 jgs 121
2257     DOT_IMAGE_FORMAT = png
2258    
2259 caltinay 3991 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2260     # enable generation of interactive SVG images that allow zooming and panning.
2261 sshaw 5735 #
2262     # Note that this requires a modern browser other than Internet Explorer. Tested
2263     # and working are Firefox, Chrome, Safari, and Opera.
2264     # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2265     # the SVG files visible. Older versions of IE do not have SVG support.
2266     # The default value is: NO.
2267     # This tag requires that the tag HAVE_DOT is set to YES.
2268 caltinay 3991
2269     INTERACTIVE_SVG = NO
2270    
2271 sshaw 5735 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2272 jfenwick 1796 # found. If left blank, it is assumed the dot tool can be found in the path.
2273 sshaw 5735 # This tag requires that the tag HAVE_DOT is set to YES.
2274 jgs 82
2275 caltinay 3991 DOT_PATH =
2276 jgs 82
2277 caltinay 3991 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2278 sshaw 5735 # contain dot files that are included in the documentation (see the \dotfile
2279     # command).
2280     # This tag requires that the tag HAVE_DOT is set to YES.
2281 jgs 121
2282 caltinay 3991 DOTFILE_DIRS =
2283 jgs 121
2284 caltinay 3991 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2285 sshaw 5735 # contain msc files that are included in the documentation (see the \mscfile
2286     # command).
2287 caltinay 3991
2288     MSCFILE_DIRS =
2289    
2290 sshaw 5735 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2291     # contain dia files that are included in the documentation (see the \diafile
2292     # command).
2293 jgs 82
2294 sshaw 5735 DIAFILE_DIRS =
2295    
2296     # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2297     # path where java can find the plantuml.jar file. If left blank, it is assumed
2298     # PlantUML is not used or called during a preprocessing step. Doxygen will
2299     # generate a warning when it encounters a \startuml command in this case and
2300     # will not generate output for the diagram.
2301     # This tag requires that the tag HAVE_DOT is set to YES.
2302    
2303     PLANTUML_JAR_PATH =
2304    
2305     # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2306     # that will be shown in the graph. If the number of nodes in a graph becomes
2307     # larger than this value, doxygen will truncate the graph, which is visualized
2308     # by representing a node as a red box. Note that doxygen if the number of direct
2309     # children of the root node in a graph is already larger than
2310     # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2311     # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2312     # Minimum value: 0, maximum value: 10000, default value: 50.
2313     # This tag requires that the tag HAVE_DOT is set to YES.
2314    
2315 jfenwick 1796 DOT_GRAPH_MAX_NODES = 50
2316 jgs 82
2317 sshaw 5735 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2318     # generated by dot. A depth value of 3 means that only nodes reachable from the
2319     # root by following a path via at most 3 edges will be shown. Nodes that lay
2320     # further from the root node will be omitted. Note that setting this option to 1
2321     # or 2 may greatly reduce the computation time needed for large code bases. Also
2322     # note that the size of a graph can be further restricted by
2323 jfenwick 1796 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2324 sshaw 5735 # Minimum value: 0, maximum value: 1000, default value: 0.
2325     # This tag requires that the tag HAVE_DOT is set to YES.
2326 jgs 121
2327     MAX_DOT_GRAPH_DEPTH = 0
2328    
2329 caltinay 3991 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2330 sshaw 5735 # background. This is disabled by default, because dot on Windows does not seem
2331     # to support this out of the box.
2332     #
2333     # Warning: Depending on the platform used, enabling this option may lead to
2334     # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2335     # read).
2336     # The default value is: NO.
2337     # This tag requires that the tag HAVE_DOT is set to YES.
2338 jfenwick 1796
2339     DOT_TRANSPARENT = YES
2340    
2341 caltinay 3991 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2342     # files in one run (i.e. multiple -o and -T options on the command line). This
2343 sshaw 5735 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2344     # this, this feature is disabled by default.
2345     # The default value is: NO.
2346     # This tag requires that the tag HAVE_DOT is set to YES.
2347 jfenwick 1796
2348     DOT_MULTI_TARGETS = NO
2349    
2350 sshaw 5735 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2351     # explaining the meaning of the various boxes and arrows in the dot generated
2352     # graphs.
2353     # The default value is: YES.
2354     # This tag requires that the tag HAVE_DOT is set to YES.
2355 jgs 82
2356     GENERATE_LEGEND = YES
2357    
2358 sshaw 5735 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2359     # files that are used to generate the various graphs.
2360     # The default value is: YES.
2361     # This tag requires that the tag HAVE_DOT is set to YES.
2362 jgs 82
2363     DOT_CLEANUP = YES
2364 caltinay 5995

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.26