ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/branches/development/doc/Doxyfile.in
(Generate patch)

Comparing:
trunk/make/Doxyfile (file contents), Revision 48 by tim, Wed Oct 6 22:20:47 2004 UTC vs.
branches/development/doc/Doxyfile.in (file contents), Revision 1808 by gezelter, Mon Oct 22 20:42:10 2012 UTC

# Line 1 | Line 1
1 < # Doxyfile 1.3.9
1 > # Doxyfile 1.8.1.1
2  
3 + # This file describes the settings to be used by the documentation system
4 + # doxygen (www.doxygen.org) for a project.
5 + #
6 + # All text after a hash (#) is considered a comment and will be ignored.
7 + # The format is:
8 + #       TAG = value [value, ...]
9 + # For lists items can also be appended using:
10 + #       TAG += value [value, ...]
11 + # Values that contain spaces should be placed between quotes (" ").
12 +
13   #---------------------------------------------------------------------------
14   # Project related configuration options
15   #---------------------------------------------------------------------------
16 < PROJECT_NAME           = OOPSE
16 >
17 > # This tag specifies the encoding used for all characters in the config file
18 > # that follow. The default is UTF-8 which is also the encoding used for all
19 > # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 > # iconv built into libc) for the transcoding. See
21 > # http://www.gnu.org/software/libiconv for the list of possible encodings.
22 >
23 > DOXYFILE_ENCODING      = UTF-8
24 >
25 > # The PROJECT_NAME tag is a single word (or sequence of words) that should
26 > # identify the project. Note that if you do not use Doxywizard you need
27 > # to put quotes around the project name if it contains spaces.
28 >
29 > PROJECT_NAME           = OpenMD
30 >
31 > # The PROJECT_NUMBER tag can be used to enter a project or revision number.
32 > # This could be handy for archiving the generated documentation or
33 > # if some version control system is used.
34 >
35   PROJECT_NUMBER         = 2.0
36 < OUTPUT_DIRECTORY       = /export/home/gezelter/tim/code/OOPSE-2.0/doc/
36 >
37 > # Using the PROJECT_BRIEF tag one can provide an optional one line description
38 > # for a project that appears at the top of each page and should give viewer
39 > # a quick idea about the purpose of the project. Keep the description short.
40 >
41 > PROJECT_BRIEF          = "Molecular Dynamics in the Open"
42 >
43 > # With the PROJECT_LOGO tag one can specify an logo or icon that is
44 > # included in the documentation. The maximum height of the logo should not
45 > # exceed 55 pixels and the maximum width should not exceed 200 pixels.
46 > # Doxygen will copy the logo to the output directory.
47 >
48 > PROJECT_LOGO           =
49 >
50 > # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
51 > # base path where the generated documentation will be put.
52 > # If a relative path is entered, it will be relative to the location
53 > # where doxygen was started. If left blank the current directory will be used.
54 >
55 > OUTPUT_DIRECTORY       = @CMAKE_CURRENT_BINARY_DIR@/doc/
56 >
57 > # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
58 > # 4096 sub-directories (in 2 levels) under the output directory of each output
59 > # format and will distribute the generated files over these directories.
60 > # Enabling this option can be useful when feeding doxygen a huge amount of
61 > # source files, where putting all generated files in the same directory would
62 > # otherwise cause performance problems for the file system.
63 >
64   CREATE_SUBDIRS         = NO
65 +
66 + # The OUTPUT_LANGUAGE tag is used to specify the language in which all
67 + # documentation generated by doxygen is written. Doxygen will use this
68 + # information to generate all constant output in the proper language.
69 + # The default language is English, other supported languages are:
70 + # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
71 + # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72 + # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73 + # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74 + # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75 + # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
76 +
77   OUTPUT_LANGUAGE        = English
78 < USE_WINDOWS_ENCODING   = NO
78 >
79 > # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
80 > # include brief member descriptions after the members that are listed in
81 > # the file and class documentation (similar to JavaDoc).
82 > # Set to NO to disable this.
83 >
84   BRIEF_MEMBER_DESC      = YES
85 +
86 + # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
87 + # the brief description of a member or function before the detailed description.
88 + # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
89 + # brief descriptions will be completely suppressed.
90 +
91   REPEAT_BRIEF           = YES
92 < ABBREVIATE_BRIEF       = "The $name class" \
93 <                         "The $name widget" \
94 <                         "The $name file" \
95 <                         is \
96 <                         provides \
97 <                         specifies \
98 <                         contains \
99 <                         represents \
100 <                         a \
101 <                         an \
102 <                         the
92 >
93 > # This tag implements a quasi-intelligent brief description abbreviator
94 > # that is used to form the text in various listings. Each string
95 > # in this list, if found as the leading text of the brief description, will be
96 > # stripped from the text and the result after processing the whole list, is
97 > # used as the annotated text. Otherwise, the brief description is used as-is.
98 > # If left blank, the following values are used ("$name" is automatically
99 > # replaced with the name of the entity): "The $name class" "The $name widget"
100 > # "The $name file" "is" "provides" "specifies" "contains"
101 > # "represents" "a" "an" "the"
102 >
103 > ABBREVIATE_BRIEF       =
104 >
105 > # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
106 > # Doxygen will generate a detailed section even if there is only a brief
107 > # description.
108 >
109   ALWAYS_DETAILED_SEC    = NO
110 +
111 + # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
112 + # inherited members of a class in the documentation of that class as if those
113 + # members were ordinary class members. Constructors, destructors and assignment
114 + # operators of the base classes will not be shown.
115 +
116   INLINE_INHERITED_MEMB  = NO
117 +
118 + # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
119 + # path before files name in the file list and in the header files. If set
120 + # to NO the shortest path that makes the file name unique will be used.
121 +
122   FULL_PATH_NAMES        = YES
123 < STRIP_FROM_PATH        = /export/home/gezelter/tim/code/OOPSE-2.0/
124 < STRIP_FROM_INC_PATH    =
123 >
124 > # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
125 > # can be used to strip a user-defined part of the path. Stripping is
126 > # only done if one of the specified strings matches the left-hand part of
127 > # the path. The tag can be used to show relative paths in the file list.
128 > # If left blank the directory from which doxygen is run is used as the
129 > # path to strip.
130 >
131 > STRIP_FROM_PATH        = src/
132 >
133 > # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
134 > # the path mentioned in the documentation of a class, which tells
135 > # the reader which header file to include in order to use a class.
136 > # If left blank only the name of the header file containing the class
137 > # definition is used. Otherwise one should specify the include paths that
138 > # are normally passed to the compiler using the -I flag.
139 >
140 > STRIP_FROM_INC_PATH    =
141 >
142 > # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
143 > # (but less readable) file names. This can be useful if your file system
144 > # doesn't support long names like on DOS, Mac, or CD-ROM.
145 >
146   SHORT_NAMES            = NO
147 +
148 + # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
149 + # will interpret the first line (until the first dot) of a JavaDoc-style
150 + # comment as the brief description. If set to NO, the JavaDoc
151 + # comments will behave just like regular Qt-style comments
152 + # (thus requiring an explicit @brief command for a brief description.)
153 +
154   JAVADOC_AUTOBRIEF      = NO
155 +
156 + # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
157 + # interpret the first line (until the first dot) of a Qt-style
158 + # comment as the brief description. If set to NO, the comments
159 + # will behave just like regular Qt-style comments (thus requiring
160 + # an explicit \brief command for a brief description.)
161 +
162 + QT_AUTOBRIEF           = NO
163 +
164 + # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
165 + # treat a multi-line C++ special comment block (i.e. a block of //! or ///
166 + # comments) as a brief description. This used to be the default behaviour.
167 + # The new default is to treat a multi-line C++ comment block as a detailed
168 + # description. Set this tag to YES if you prefer the old behaviour instead.
169 +
170   MULTILINE_CPP_IS_BRIEF = NO
171 < DETAILS_AT_TOP         = NO
171 >
172 > # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
173 > # member inherits the documentation from any documented member that it
174 > # re-implements.
175 >
176   INHERIT_DOCS           = YES
177 < DISTRIBUTE_GROUP_DOC   = NO
177 >
178 > # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
179 > # a new page for each member. If set to NO, the documentation of a member will
180 > # be part of the file/class/namespace that contains it.
181 >
182 > SEPARATE_MEMBER_PAGES  = NO
183 >
184 > # The TAB_SIZE tag can be used to set the number of spaces in a tab.
185 > # Doxygen uses this value to replace tabs by spaces in code fragments.
186 >
187   TAB_SIZE               = 8
188 < ALIASES                =
188 >
189 > # This tag can be used to specify a number of aliases that acts
190 > # as commands in the documentation. An alias has the form "name=value".
191 > # For example adding "sideeffect=\par Side Effects:\n" will allow you to
192 > # put the command \sideeffect (or @sideeffect) in the documentation, which
193 > # will result in a user-defined paragraph with heading "Side Effects:".
194 > # You can put \n's in the value part of an alias to insert newlines.
195 >
196 > ALIASES                =
197 >
198 > # This tag can be used to specify a number of word-keyword mappings (TCL only).
199 > # A mapping has the form "name=value". For example adding
200 > # "class=itcl::class" will allow you to use the command class in the
201 > # itcl::class meaning.
202 >
203 > TCL_SUBST              =
204 >
205 > # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
206 > # sources only. Doxygen will then generate output that is more tailored for C.
207 > # For instance, some of the names that are used will be different. The list
208 > # of all members will be omitted, etc.
209 >
210   OPTIMIZE_OUTPUT_FOR_C  = NO
211 +
212 + # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
213 + # sources only. Doxygen will then generate output that is more tailored for
214 + # Java. For instance, namespaces will be presented as packages, qualified
215 + # scopes will look different, etc.
216 +
217   OPTIMIZE_OUTPUT_JAVA   = NO
218 +
219 + # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
220 + # sources only. Doxygen will then generate output that is more tailored for
221 + # Fortran.
222 +
223 + OPTIMIZE_FOR_FORTRAN   = NO
224 +
225 + # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
226 + # sources. Doxygen will then generate output that is tailored for
227 + # VHDL.
228 +
229 + OPTIMIZE_OUTPUT_VHDL   = NO
230 +
231 + # Doxygen selects the parser to use depending on the extension of the files it
232 + # parses. With this tag you can assign which parser to use for a given extension.
233 + # Doxygen has a built-in mapping, but you can override or extend it using this
234 + # tag. The format is ext=language, where ext is a file extension, and language
235 + # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
236 + # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
237 + # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
238 + # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
239 + # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
240 +
241 + EXTENSION_MAPPING      = F90=Fortran \
242 +                         cpp=C++ \
243 +                         hpp=C++ \
244 +                         c=C \
245 +                         h=C
246 +
247 + # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
248 + # comments according to the Markdown format, which allows for more readable
249 + # documentation. See http://daringfireball.net/projects/markdown/ for details.
250 + # The output of markdown processing is further processed by doxygen, so you
251 + # can mix doxygen, HTML, and XML commands with Markdown formatting.
252 + # Disable only in case of backward compatibilities issues.
253 +
254 + MARKDOWN_SUPPORT       = YES
255 +
256 + # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
257 + # to include (a tag file for) the STL sources as input, then you should
258 + # set this tag to YES in order to let doxygen match functions declarations and
259 + # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
260 + # func(std::string) {}). This also makes the inheritance and collaboration
261 + # diagrams that involve STL classes more complete and accurate.
262 +
263 + BUILTIN_STL_SUPPORT    = YES
264 +
265 + # If you use Microsoft's C++/CLI language, you should set this option to YES to
266 + # enable parsing support.
267 +
268 + CPP_CLI_SUPPORT        = NO
269 +
270 + # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
271 + # Doxygen will parse them like normal C++ but will assume all classes use public
272 + # instead of private inheritance when no explicit protection keyword is present.
273 +
274 + SIP_SUPPORT            = NO
275 +
276 + # For Microsoft's IDL there are propget and propput attributes to indicate getter
277 + # and setter methods for a property. Setting this option to YES (the default)
278 + # will make doxygen replace the get and set methods by a property in the
279 + # documentation. This will only work if the methods are indeed getting or
280 + # setting a simple type. If this is not the case, or you want to show the
281 + # methods anyway, you should set this option to NO.
282 +
283 + IDL_PROPERTY_SUPPORT   = YES
284 +
285 + # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
286 + # tag is set to YES, then doxygen will reuse the documentation of the first
287 + # member in the group (if any) for the other members of the group. By default
288 + # all members of a group must be documented explicitly.
289 +
290 + DISTRIBUTE_GROUP_DOC   = NO
291 +
292 + # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
293 + # the same type (for instance a group of public functions) to be put as a
294 + # subgroup of that type (e.g. under the Public Functions section). Set it to
295 + # NO to prevent subgrouping. Alternatively, this can be done per class using
296 + # the \nosubgrouping command.
297 +
298   SUBGROUPING            = YES
299 +
300 + # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
301 + # unions are shown inside the group in which they are included (e.g. using
302 + # @ingroup) instead of on a separate page (for HTML and Man pages) or
303 + # section (for LaTeX and RTF).
304 +
305 + INLINE_GROUPED_CLASSES = NO
306 +
307 + # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
308 + # unions with only public data fields will be shown inline in the documentation
309 + # of the scope in which they are defined (i.e. file, namespace, or group
310 + # documentation), provided this scope is documented. If set to NO (the default),
311 + # structs, classes, and unions are shown on a separate page (for HTML and Man
312 + # pages) or section (for LaTeX and RTF).
313 +
314 + INLINE_SIMPLE_STRUCTS  = NO
315 +
316 + # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
317 + # is documented as struct, union, or enum with the name of the typedef. So
318 + # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
319 + # with name TypeT. When disabled the typedef will appear as a member of a file,
320 + # namespace, or class. And the struct will be named TypeS. This can typically
321 + # be useful for C code in case the coding convention dictates that all compound
322 + # types are typedef'ed and only the typedef is referenced, never the tag name.
323 +
324 + TYPEDEF_HIDES_STRUCT   = NO
325 +
326 + # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
327 + # determine which symbols to keep in memory and which to flush to disk.
328 + # When the cache is full, less often used symbols will be written to disk.
329 + # For small to medium size projects (<1000 input files) the default value is
330 + # probably good enough. For larger projects a too small cache size can cause
331 + # doxygen to be busy swapping symbols to and from disk most of the time
332 + # causing a significant performance penalty.
333 + # If the system has enough physical memory increasing the cache will improve the
334 + # performance by keeping more symbols in memory. Note that the value works on
335 + # a logarithmic scale so increasing the size by one will roughly double the
336 + # memory usage. The cache size is given by this formula:
337 + # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
338 + # corresponding to a cache size of 2^16 = 65536 symbols.
339 +
340 + SYMBOL_CACHE_SIZE      = 0
341 +
342 + # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
343 + # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
344 + # their name and scope. Since this can be an expensive process and often the
345 + # same symbol appear multiple times in the code, doxygen keeps a cache of
346 + # pre-resolved symbols. If the cache is too small doxygen will become slower.
347 + # If the cache is too large, memory is wasted. The cache size is given by this
348 + # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
349 + # corresponding to a cache size of 2^16 = 65536 symbols.
350 +
351 + LOOKUP_CACHE_SIZE      = 0
352 +
353   #---------------------------------------------------------------------------
354   # Build related configuration options
355   #---------------------------------------------------------------------------
356 < EXTRACT_ALL            = NO
357 < EXTRACT_PRIVATE        = NO
358 < EXTRACT_STATIC         = NO
356 >
357 > # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
358 > # documentation are documented, even if no documentation was available.
359 > # Private class members and static file members will be hidden unless
360 > # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
361 >
362 > EXTRACT_ALL            = YES
363 >
364 > # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
365 > # will be included in the documentation.
366 >
367 > EXTRACT_PRIVATE        = YES
368 >
369 > # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation.
370 >
371 > EXTRACT_PACKAGE        = NO
372 >
373 > # If the EXTRACT_STATIC tag is set to YES all static members of a file
374 > # will be included in the documentation.
375 >
376 > EXTRACT_STATIC         = YES
377 >
378 > # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
379 > # defined locally in source files will be included in the documentation.
380 > # If set to NO only classes defined in header files are included.
381 >
382   EXTRACT_LOCAL_CLASSES  = YES
383 < EXTRACT_LOCAL_METHODS  = NO
384 < HIDE_UNDOC_MEMBERS     = YES
385 < HIDE_UNDOC_CLASSES     = YES
383 >
384 > # This flag is only useful for Objective-C code. When set to YES local
385 > # methods, which are defined in the implementation section but not in
386 > # the interface are included in the documentation.
387 > # If set to NO (the default) only methods in the interface are included.
388 >
389 > EXTRACT_LOCAL_METHODS  = YES
390 >
391 > # If this flag is set to YES, the members of anonymous namespaces will be
392 > # extracted and appear in the documentation as a namespace called
393 > # 'anonymous_namespace{file}', where file will be replaced with the base
394 > # name of the file that contains the anonymous namespace. By default
395 > # anonymous namespaces are hidden.
396 >
397 > EXTRACT_ANON_NSPACES   = YES
398 >
399 > # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
400 > # undocumented members of documented classes, files or namespaces.
401 > # If set to NO (the default) these members will be included in the
402 > # various overviews, but no documentation section is generated.
403 > # This option has no effect if EXTRACT_ALL is enabled.
404 >
405 > HIDE_UNDOC_MEMBERS     = NO
406 >
407 > # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
408 > # undocumented classes that are normally visible in the class hierarchy.
409 > # If set to NO (the default) these classes will be included in the various
410 > # overviews. This option has no effect if EXTRACT_ALL is enabled.
411 >
412 > HIDE_UNDOC_CLASSES     = NO
413 >
414 > # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
415 > # friend (class|struct|union) declarations.
416 > # If set to NO (the default) these declarations will be included in the
417 > # documentation.
418 >
419   HIDE_FRIEND_COMPOUNDS  = NO
420 +
421 + # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
422 + # documentation blocks found inside the body of a function.
423 + # If set to NO (the default) these blocks will be appended to the
424 + # function's detailed documentation block.
425 +
426   HIDE_IN_BODY_DOCS      = NO
427 +
428 + # The INTERNAL_DOCS tag determines if documentation
429 + # that is typed after a \internal command is included. If the tag is set
430 + # to NO (the default) then the documentation will be excluded.
431 + # Set it to YES to include the internal documentation.
432 +
433   INTERNAL_DOCS          = NO
434 < CASE_SENSE_NAMES       = YES
434 >
435 > # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
436 > # file names in lower-case letters. If set to YES upper-case letters are also
437 > # allowed. This is useful if you have classes or files whose names only differ
438 > # in case and if your file system supports case sensitive file names. Windows
439 > # and Mac users are advised to set this option to NO.
440 >
441 > CASE_SENSE_NAMES       = NO
442 >
443 > # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
444 > # will show members with their full class and namespace scopes in the
445 > # documentation. If set to YES the scope will be hidden.
446 >
447   HIDE_SCOPE_NAMES       = NO
448 +
449 + # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
450 + # will put a list of the files that are included by a file in the documentation
451 + # of that file.
452 +
453   SHOW_INCLUDE_FILES     = YES
454 +
455 + # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
456 + # will list include files with double quotes in the documentation
457 + # rather than with sharp brackets.
458 +
459 + FORCE_LOCAL_INCLUDES   = NO
460 +
461 + # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
462 + # is inserted in the documentation for inline members.
463 +
464   INLINE_INFO            = YES
465 +
466 + # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
467 + # will sort the (detailed) documentation of file and class members
468 + # alphabetically by member name. If set to NO the members will appear in
469 + # declaration order.
470 +
471   SORT_MEMBER_DOCS       = YES
472 +
473 + # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
474 + # brief documentation of file, namespace and class members alphabetically
475 + # by member name. If set to NO (the default) the members will appear in
476 + # declaration order.
477 +
478   SORT_BRIEF_DOCS        = NO
479 +
480 + # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
481 + # will sort the (brief and detailed) documentation of class members so that
482 + # constructors and destructors are listed first. If set to NO (the default)
483 + # the constructors will appear in the respective orders defined by
484 + # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
485 + # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
486 + # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
487 +
488 + SORT_MEMBERS_CTORS_1ST = NO
489 +
490 + # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
491 + # hierarchy of group names into alphabetical order. If set to NO (the default)
492 + # the group names will appear in their defined order.
493 +
494 + SORT_GROUP_NAMES       = NO
495 +
496 + # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
497 + # sorted by fully-qualified names, including namespaces. If set to
498 + # NO (the default), the class list will be sorted only by class name,
499 + # not including the namespace part.
500 + # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
501 + # Note: This option applies only to the class list, not to the
502 + # alphabetical list.
503 +
504   SORT_BY_SCOPE_NAME     = NO
505 +
506 + # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
507 + # do proper type resolution of all parameters of a function it will reject a
508 + # match between the prototype and the implementation of a member function even
509 + # if there is only one candidate or it is obvious which candidate to choose
510 + # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
511 + # will still accept a match between prototype and implementation in such cases.
512 +
513 + STRICT_PROTO_MATCHING  = NO
514 +
515 + # The GENERATE_TODOLIST tag can be used to enable (YES) or
516 + # disable (NO) the todo list. This list is created by putting \todo
517 + # commands in the documentation.
518 +
519   GENERATE_TODOLIST      = YES
520 +
521 + # The GENERATE_TESTLIST tag can be used to enable (YES) or
522 + # disable (NO) the test list. This list is created by putting \test
523 + # commands in the documentation.
524 +
525   GENERATE_TESTLIST      = YES
526 +
527 + # The GENERATE_BUGLIST tag can be used to enable (YES) or
528 + # disable (NO) the bug list. This list is created by putting \bug
529 + # commands in the documentation.
530 +
531   GENERATE_BUGLIST       = YES
532 +
533 + # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
534 + # disable (NO) the deprecated list. This list is created by putting
535 + # \deprecated commands in the documentation.
536 +
537   GENERATE_DEPRECATEDLIST= YES
538 < ENABLED_SECTIONS       =
538 >
539 > # The ENABLED_SECTIONS tag can be used to enable conditional
540 > # documentation sections, marked by \if sectionname ... \endif.
541 >
542 > ENABLED_SECTIONS       =
543 >
544 > # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
545 > # the initial value of a variable or macro consists of for it to appear in
546 > # the documentation. If the initializer consists of more lines than specified
547 > # here it will be hidden. Use a value of 0 to hide initializers completely.
548 > # The appearance of the initializer of individual variables and macros in the
549 > # documentation can be controlled using \showinitializer or \hideinitializer
550 > # command in the documentation regardless of this setting.
551 >
552   MAX_INITIALIZER_LINES  = 30
553 +
554 + # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
555 + # at the bottom of the documentation of classes and structs. If set to YES the
556 + # list will mention the files that were used to generate the documentation.
557 +
558   SHOW_USED_FILES        = YES
559 < SHOW_DIRECTORIES       = YES
559 >
560 > # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
561 > # This will remove the Files entry from the Quick Index and from the
562 > # Folder Tree View (if specified). The default is YES.
563 >
564 > SHOW_FILES             = YES
565 >
566 > # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
567 > # Namespaces page.
568 > # This will remove the Namespaces entry from the Quick Index
569 > # and from the Folder Tree View (if specified). The default is YES.
570 >
571 > SHOW_NAMESPACES        = YES
572 >
573 > # The FILE_VERSION_FILTER tag can be used to specify a program or script that
574 > # doxygen should invoke to get the current version for each file (typically from
575 > # the version control system). Doxygen will invoke the program by executing (via
576 > # popen()) the command <command> <input-file>, where <command> is the value of
577 > # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
578 > # provided by doxygen. Whatever the program writes to standard output
579 > # is used as the file version. See the manual for examples.
580 >
581 > FILE_VERSION_FILTER    =
582 >
583 > # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
584 > # by doxygen. The layout file controls the global structure of the generated
585 > # output files in an output format independent way. To create the layout file
586 > # that represents doxygen's defaults, run doxygen with the -l option.
587 > # You can optionally specify a file name after the option, if omitted
588 > # DoxygenLayout.xml will be used as the name of the layout file.
589 >
590 > LAYOUT_FILE            =
591 >
592 > # The CITE_BIB_FILES tag can be used to specify one or more bib files
593 > # containing the references data. This must be a list of .bib files. The
594 > # .bib extension is automatically appended if omitted. Using this command
595 > # requires the bibtex tool to be installed. See also
596 > # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
597 > # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
598 > # feature you need bibtex and perl available in the search path.
599 >
600 > CITE_BIB_FILES         =
601 >
602   #---------------------------------------------------------------------------
603   # configuration options related to warning and progress messages
604   #---------------------------------------------------------------------------
605 +
606 + # The QUIET tag can be used to turn on/off the messages that are generated
607 + # by doxygen. Possible values are YES and NO. If left blank NO is used.
608 +
609   QUIET                  = NO
610 +
611 + # The WARNINGS tag can be used to turn on/off the warning messages that are
612 + # generated by doxygen. Possible values are YES and NO. If left blank
613 + # NO is used.
614 +
615   WARNINGS               = YES
616 +
617 + # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
618 + # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
619 + # automatically be disabled.
620 +
621   WARN_IF_UNDOCUMENTED   = YES
622 +
623 + # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
624 + # potential errors in the documentation, such as not documenting some
625 + # parameters in a documented function, or documenting parameters that
626 + # don't exist or using markup commands wrongly.
627 +
628   WARN_IF_DOC_ERROR      = YES
629 +
630 + # The WARN_NO_PARAMDOC option can be enabled to get warnings for
631 + # functions that are documented, but have no documentation for their parameters
632 + # or return value. If set to NO (the default) doxygen will only warn about
633 + # wrong or incomplete parameter documentation, but not about the absence of
634 + # documentation.
635 +
636 + WARN_NO_PARAMDOC       = NO
637 +
638 + # The WARN_FORMAT tag determines the format of the warning messages that
639 + # doxygen can produce. The string should contain the $file, $line, and $text
640 + # tags, which will be replaced by the file and line number from which the
641 + # warning originated and the warning text. Optionally the format may contain
642 + # $version, which will be replaced by the version of the file (if it could
643 + # be obtained via FILE_VERSION_FILTER)
644 +
645   WARN_FORMAT            = "$file:$line: $text"
646 < WARN_LOGFILE           =
646 >
647 > # The WARN_LOGFILE tag can be used to specify a file to which warning
648 > # and error messages should be written. If left blank the output is written
649 > # to stderr.
650 >
651 > WARN_LOGFILE           =
652 >
653   #---------------------------------------------------------------------------
654   # configuration options related to the input files
655   #---------------------------------------------------------------------------
656 < INPUT                  = /export/home/gezelter/tim/code/OOPSE-2.0/src/
656 >
657 > # The INPUT tag can be used to specify the files and/or directories that contain
658 > # documented source files. You may enter file names like "myfile.cpp" or
659 > # directories like "/usr/src/myproject". Separate the files or directories
660 > # with spaces.
661 >
662 > INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/src/
663 >
664 > # This tag can be used to specify the character encoding of the source files
665 > # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
666 > # also the default input encoding. Doxygen uses libiconv (or the iconv built
667 > # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
668 > # the list of possible encodings.
669 >
670 > INPUT_ENCODING         = UTF-8
671 >
672 > # If the value of the INPUT tag contains directories, you can use the
673 > # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
674 > # and *.h) to filter out the source-files in the directories. If left
675 > # blank the following patterns are tested:
676 > # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
677 > # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
678 > # *.f90 *.f *.for *.vhd *.vhdl
679 >
680   FILE_PATTERNS          = *.c \
681                           *.cc \
682                           *.cxx \
# Line 116 | Line 714 | FILE_PATTERNS          = *.c \
714                           *.PHP \
715                           *.PHP3 \
716                           *.M \
717 <                         *.MM
717 >                         *.MM \
718 >                         *.f90 \
719 >                         *.f95 \
720 >                         *.f77 \
721 >                         *.ftn \
722 >                         *.for \
723 >                         *.F90 \
724 >                         *.F95 \
725 >                         *.F77 \
726 >                         *.FTN \
727 >                         *.FOR \
728 >                         *.F
729 >
730 > # The RECURSIVE tag can be used to turn specify whether or not subdirectories
731 > # should be searched for input files as well. Possible values are YES and NO.
732 > # If left blank NO is used.
733 >
734   RECURSIVE              = YES
735 +
736 + # The EXCLUDE tag can be used to specify files and/or directories that should be
737 + # excluded from the INPUT source files. This way you can easily exclude a
738 + # subdirectory from a directory tree whose root is specified with the INPUT tag.
739 + # Note that relative paths are relative to the directory from which doxygen is
740 + # run.
741 +
742   EXCLUDE                =
743 +
744 + # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
745 + # directories that are symbolic links (a Unix file system feature) are excluded
746 + # from the input.
747 +
748   EXCLUDE_SYMLINKS       = NO
749 < EXCLUDE_PATTERNS       =
750 < EXAMPLE_PATH           =
751 < EXAMPLE_PATTERNS       = *
749 >
750 > # If the value of the INPUT tag contains directories, you can use the
751 > # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
752 > # certain files from those directories. Note that the wildcards are matched
753 > # against the file with absolute path, so to exclude all test directories
754 > # for example use the pattern */test/*
755 >
756 > EXCLUDE_PATTERNS       =
757 >
758 > # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
759 > # (namespaces, classes, functions, etc.) that should be excluded from the
760 > # output. The symbol name can be a fully qualified name, a word, or if the
761 > # wildcard * is used, a substring. Examples: ANamespace, AClass,
762 > # AClass::ANamespace, ANamespace::*Test
763 >
764 > EXCLUDE_SYMBOLS        =
765 >
766 > # The EXAMPLE_PATH tag can be used to specify one or more files or
767 > # directories that contain example code fragments that are included (see
768 > # the \include command).
769 >
770 > EXAMPLE_PATH           =
771 >
772 > # If the value of the EXAMPLE_PATH tag contains directories, you can use the
773 > # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
774 > # and *.h) to filter out the source-files in the directories. If left
775 > # blank all files are included.
776 >
777 > EXAMPLE_PATTERNS       =
778 >
779 > # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
780 > # searched for input files to be used with the \include or \dontinclude
781 > # commands irrespective of the value of the RECURSIVE tag.
782 > # Possible values are YES and NO. If left blank NO is used.
783 >
784   EXAMPLE_RECURSIVE      = NO
785 < IMAGE_PATH             =
786 < INPUT_FILTER           =
787 < FILTER_PATTERNS        =
785 >
786 > # The IMAGE_PATH tag can be used to specify one or more files or
787 > # directories that contain image that are included in the documentation (see
788 > # the \image command).
789 >
790 > IMAGE_PATH             =
791 >
792 > # The INPUT_FILTER tag can be used to specify a program that doxygen should
793 > # invoke to filter for each input file. Doxygen will invoke the filter program
794 > # by executing (via popen()) the command <filter> <input-file>, where <filter>
795 > # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
796 > # input file. Doxygen will then use the output that the filter program writes
797 > # to standard output.
798 > # If FILTER_PATTERNS is specified, this tag will be
799 > # ignored.
800 >
801 > INPUT_FILTER           =
802 >
803 > # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
804 > # basis.
805 > # Doxygen will compare the file name with each pattern and apply the
806 > # filter if there is a match.
807 > # The filters are a list of the form:
808 > # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
809 > # info on how filters are used. If FILTER_PATTERNS is empty or if
810 > # non of the patterns match the file name, INPUT_FILTER is applied.
811 >
812 > FILTER_PATTERNS        =
813 >
814 > # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
815 > # INPUT_FILTER) will be used to filter the input files when producing source
816 > # files to browse (i.e. when SOURCE_BROWSER is set to YES).
817 >
818   FILTER_SOURCE_FILES    = NO
819 +
820 + # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
821 + # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
822 + # and it is also possible to disable source filtering for a specific pattern
823 + # using *.ext= (so without naming a filter). This option only has effect when
824 + # FILTER_SOURCE_FILES is enabled.
825 +
826 + FILTER_SOURCE_PATTERNS =
827 +
828   #---------------------------------------------------------------------------
829   # configuration options related to source browsing
830   #---------------------------------------------------------------------------
831 < SOURCE_BROWSER         = NO
831 >
832 > # If the SOURCE_BROWSER tag is set to YES then a list of source files will
833 > # be generated. Documented entities will be cross-referenced with these sources.
834 > # Note: To get rid of all source code in the generated output, make sure also
835 > # VERBATIM_HEADERS is set to NO.
836 >
837 > SOURCE_BROWSER         = YES
838 >
839 > # Setting the INLINE_SOURCES tag to YES will include the body
840 > # of functions and classes directly in the documentation.
841 >
842   INLINE_SOURCES         = NO
843 +
844 + # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
845 + # doxygen to hide any special comment blocks from generated source code
846 + # fragments. Normal C, C++ and Fortran comments will always remain visible.
847 +
848   STRIP_CODE_COMMENTS    = YES
849 < REFERENCED_BY_RELATION = NO
850 < REFERENCES_RELATION    = NO
851 < VERBATIM_HEADERS       = NO
849 >
850 > # If the REFERENCED_BY_RELATION tag is set to YES
851 > # then for each documented function all documented
852 > # functions referencing it will be listed.
853 >
854 > REFERENCED_BY_RELATION = YES
855 >
856 > # If the REFERENCES_RELATION tag is set to YES
857 > # then for each documented function all documented entities
858 > # called/used by that function will be listed.
859 >
860 > REFERENCES_RELATION    = YES
861 >
862 > # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
863 > # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
864 > # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
865 > # link to the source code.
866 > # Otherwise they will link to the documentation.
867 >
868 > REFERENCES_LINK_SOURCE = YES
869 >
870 > # If the USE_HTAGS tag is set to YES then the references to source code
871 > # will point to the HTML generated by the htags(1) tool instead of doxygen
872 > # built-in source browser. The htags tool is part of GNU's global source
873 > # tagging system (see http://www.gnu.org/software/global/global.html). You
874 > # will need version 4.8.6 or higher.
875 >
876 > USE_HTAGS              = NO
877 >
878 > # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
879 > # will generate a verbatim copy of the header file for each class for
880 > # which an include is specified. Set to NO to disable this.
881 >
882 > VERBATIM_HEADERS       = YES
883 >
884   #---------------------------------------------------------------------------
885   # configuration options related to the alphabetical class index
886   #---------------------------------------------------------------------------
887 < ALPHABETICAL_INDEX     = NO
887 >
888 > # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
889 > # of all compounds will be generated. Enable this if the project
890 > # contains a lot of classes, structs, unions or interfaces.
891 >
892 > ALPHABETICAL_INDEX     = YES
893 >
894 > # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
895 > # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
896 > # in which this list will be split (can be a number in the range [1..20])
897 >
898   COLS_IN_ALPHA_INDEX    = 5
899 < IGNORE_PREFIX          =
899 >
900 > # In case all classes in a project start with a common prefix, all
901 > # classes will be put under the same header in the alphabetical index.
902 > # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
903 > # should be ignored while generating the index headers.
904 >
905 > IGNORE_PREFIX          =
906 >
907   #---------------------------------------------------------------------------
908   # configuration options related to the HTML output
909   #---------------------------------------------------------------------------
910 +
911 + # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
912 + # generate HTML output.
913 +
914   GENERATE_HTML          = YES
915 +
916 + # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
917 + # If a relative path is entered the value of OUTPUT_DIRECTORY will be
918 + # put in front of it. If left blank `html' will be used as the default path.
919 +
920   HTML_OUTPUT            = html
921 +
922 + # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
923 + # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
924 + # doxygen will generate files with .html extension.
925 +
926   HTML_FILE_EXTENSION    = .html
927 < HTML_HEADER            =
928 < HTML_FOOTER            =
929 < HTML_STYLESHEET        =
930 < HTML_ALIGN_MEMBERS     = YES
931 < GENERATE_HTMLHELP      = NO
932 < CHM_FILE               =
933 < HHC_LOCATION           =
927 >
928 > # The HTML_HEADER tag can be used to specify a personal HTML header for
929 > # each generated HTML page. If it is left blank doxygen will generate a
930 > # standard header. Note that when using a custom header you are responsible
931 > #  for the proper inclusion of any scripts and style sheets that doxygen
932 > # needs, which is dependent on the configuration options used.
933 > # It is advised to generate a default header using "doxygen -w html
934 > # header.html footer.html stylesheet.css YourConfigFile" and then modify
935 > # that header. Note that the header is subject to change so you typically
936 > # have to redo this when upgrading to a newer version of doxygen or when
937 > # changing the value of configuration settings such as GENERATE_TREEVIEW!
938 >
939 > HTML_HEADER            =
940 >
941 > # The HTML_FOOTER tag can be used to specify a personal HTML footer for
942 > # each generated HTML page. If it is left blank doxygen will generate a
943 > # standard footer.
944 >
945 > HTML_FOOTER            =
946 >
947 > # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
948 > # style sheet that is used by each HTML page. It can be used to
949 > # fine-tune the look of the HTML output. If the tag is left blank doxygen
950 > # will generate a default style sheet. Note that doxygen will try to copy
951 > # the style sheet file to the HTML output directory, so don't put your own
952 > # style sheet in the HTML output directory as well, or it will be erased!
953 >
954 > HTML_STYLESHEET        =
955 >
956 > # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
957 > # other source files which should be copied to the HTML output directory. Note
958 > # that these files will be copied to the base HTML output directory. Use the
959 > # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
960 > # files. In the HTML_STYLESHEET file, use the file name only. Also note that
961 > # the files will be copied as-is; there are no commands or markers available.
962 >
963 > HTML_EXTRA_FILES       =
964 >
965 > # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
966 > # Doxygen will adjust the colors in the style sheet and background images
967 > # according to this color. Hue is specified as an angle on a colorwheel,
968 > # see http://en.wikipedia.org/wiki/Hue for more information.
969 > # For instance the value 0 represents red, 60 is yellow, 120 is green,
970 > # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
971 > # The allowed range is 0 to 359.
972 >
973 > HTML_COLORSTYLE_HUE    = 220
974 >
975 > # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
976 > # the colors in the HTML output. For a value of 0 the output will use
977 > # grayscales only. A value of 255 will produce the most vivid colors.
978 >
979 > HTML_COLORSTYLE_SAT    = 100
980 >
981 > # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
982 > # the luminance component of the colors in the HTML output. Values below
983 > # 100 gradually make the output lighter, whereas values above 100 make
984 > # the output darker. The value divided by 100 is the actual gamma applied,
985 > # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
986 > # and 100 does not change the gamma.
987 >
988 > HTML_COLORSTYLE_GAMMA  = 80
989 >
990 > # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
991 > # page will contain the date and time when the page was generated. Setting
992 > # this to NO can help when comparing the output of multiple runs.
993 >
994 > HTML_TIMESTAMP         = YES
995 >
996 > # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
997 > # documentation will contain sections that can be hidden and shown after the
998 > # page has loaded.
999 >
1000 > HTML_DYNAMIC_SECTIONS  = NO
1001 >
1002 > # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
1003 > # entries shown in the various tree structured indices initially; the user
1004 > # can expand and collapse entries dynamically later on. Doxygen will expand
1005 > # the tree to such a level that at most the specified number of entries are
1006 > # visible (unless a fully collapsed tree already exceeds this amount).
1007 > # So setting the number of entries 1 will produce a full collapsed tree by
1008 > # default. 0 is a special value representing an infinite number of entries
1009 > # and will result in a full expanded tree by default.
1010 >
1011 > HTML_INDEX_NUM_ENTRIES = 100
1012 >
1013 > # If the GENERATE_DOCSET tag is set to YES, additional index files
1014 > # will be generated that can be used as input for Apple's Xcode 3
1015 > # integrated development environment, introduced with OSX 10.5 (Leopard).
1016 > # To create a documentation set, doxygen will generate a Makefile in the
1017 > # HTML output directory. Running make will produce the docset in that
1018 > # directory and running "make install" will install the docset in
1019 > # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1020 > # it at startup.
1021 > # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1022 > # for more information.
1023 >
1024 > GENERATE_DOCSET        = NO
1025 >
1026 > # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1027 > # feed. A documentation feed provides an umbrella under which multiple
1028 > # documentation sets from a single provider (such as a company or product suite)
1029 > # can be grouped.
1030 >
1031 > DOCSET_FEEDNAME        = "Doxygen generated docs"
1032 >
1033 > # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1034 > # should uniquely identify the documentation set bundle. This should be a
1035 > # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1036 > # will append .docset to the name.
1037 >
1038 > DOCSET_BUNDLE_ID       = org.openscience.OpenMD
1039 >
1040 > # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
1041 > # the documentation publisher. This should be a reverse domain-name style
1042 > # string, e.g. com.mycompany.MyDocSet.documentation.
1043 >
1044 > DOCSET_PUBLISHER_ID    = org.openscience.OpenMD.documentation
1045 >
1046 > # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1047 >
1048 > DOCSET_PUBLISHER_NAME  = Publisher
1049 >
1050 > # If the GENERATE_HTMLHELP tag is set to YES, additional index files
1051 > # will be generated that can be used as input for tools like the
1052 > # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1053 > # of the generated HTML documentation.
1054 >
1055 > GENERATE_HTMLHELP      = NO
1056 >
1057 > # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1058 > # be used to specify the file name of the resulting .chm file. You
1059 > # can add a path in front of the file if the result should not be
1060 > # written to the html output directory.
1061 >
1062 > CHM_FILE               =
1063 >
1064 > # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1065 > # be used to specify the location (absolute path including file name) of
1066 > # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1067 > # the HTML help compiler on the generated index.hhp.
1068 >
1069 > HHC_LOCATION           =
1070 >
1071 > # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1072 > # controls if a separate .chi index file is generated (YES) or that
1073 > # it should be included in the master .chm file (NO).
1074 >
1075   GENERATE_CHI           = NO
1076 +
1077 + # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1078 + # is used to encode HtmlHelp index (hhk), content (hhc) and project file
1079 + # content.
1080 +
1081 + CHM_INDEX_ENCODING     =
1082 +
1083 + # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1084 + # controls whether a binary table of contents is generated (YES) or a
1085 + # normal table of contents (NO) in the .chm file.
1086 +
1087   BINARY_TOC             = NO
1088 +
1089 + # The TOC_EXPAND flag can be set to YES to add extra items for group members
1090 + # to the contents of the HTML help documentation and to the tree view.
1091 +
1092   TOC_EXPAND             = NO
1093 +
1094 + # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1095 + # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1096 + # that can be used as input for Qt's qhelpgenerator to generate a
1097 + # Qt Compressed Help (.qch) of the generated HTML documentation.
1098 +
1099 + GENERATE_QHP           = NO
1100 +
1101 + # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1102 + # be used to specify the file name of the resulting .qch file.
1103 + # The path specified is relative to the HTML output folder.
1104 +
1105 + QCH_FILE               =
1106 +
1107 + # The QHP_NAMESPACE tag specifies the namespace to use when generating
1108 + # Qt Help Project output. For more information please see
1109 + # http://doc.trolltech.com/qthelpproject.html#namespace
1110 +
1111 + QHP_NAMESPACE          = org.openscience.OpenMD
1112 +
1113 + # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1114 + # Qt Help Project output. For more information please see
1115 + # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1116 +
1117 + QHP_VIRTUAL_FOLDER     = doc
1118 +
1119 + # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1120 + # add. For more information please see
1121 + # http://doc.trolltech.com/qthelpproject.html#custom-filters
1122 +
1123 + QHP_CUST_FILTER_NAME   =
1124 +
1125 + # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1126 + # custom filter to add. For more information please see
1127 + # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1128 + # Qt Help Project / Custom Filters</a>.
1129 +
1130 + QHP_CUST_FILTER_ATTRS  =
1131 +
1132 + # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1133 + # project's
1134 + # filter section matches.
1135 + # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1136 + # Qt Help Project / Filter Attributes</a>.
1137 +
1138 + QHP_SECT_FILTER_ATTRS  =
1139 +
1140 + # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1141 + # be used to specify the location of Qt's qhelpgenerator.
1142 + # If non-empty doxygen will try to run qhelpgenerator on the generated
1143 + # .qhp file.
1144 +
1145 + QHG_LOCATION           =
1146 +
1147 + # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1148 + #  will be generated, which together with the HTML files, form an Eclipse help
1149 + # plugin. To install this plugin and make it available under the help contents
1150 + # menu in Eclipse, the contents of the directory containing the HTML and XML
1151 + # files needs to be copied into the plugins directory of eclipse. The name of
1152 + # the directory within the plugins directory should be the same as
1153 + # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1154 + # the help appears.
1155 +
1156 + GENERATE_ECLIPSEHELP   = NO
1157 +
1158 + # A unique identifier for the eclipse help plugin. When installing the plugin
1159 + # the directory name containing the HTML and XML files should also have
1160 + # this name.
1161 +
1162 + ECLIPSE_DOC_ID         = org.openscience.OpenMD
1163 +
1164 + # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1165 + # at top of each HTML page. The value NO (the default) enables the index and
1166 + # the value YES disables it. Since the tabs have the same information as the
1167 + # navigation tree you can set this option to NO if you already set
1168 + # GENERATE_TREEVIEW to YES.
1169 +
1170   DISABLE_INDEX          = NO
1171 +
1172 + # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1173 + # structure should be generated to display hierarchical information.
1174 + # If the tag value is set to YES, a side panel will be generated
1175 + # containing a tree-like index structure (just like the one that
1176 + # is generated for HTML Help). For this to work a browser that supports
1177 + # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1178 + # Windows users are probably better off using the HTML help feature.
1179 + # Since the tree basically has the same information as the tab index you
1180 + # could consider to set DISABLE_INDEX to NO when enabling this option.
1181 +
1182 + GENERATE_TREEVIEW      = YES
1183 +
1184 + # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1185 + # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1186 + # documentation. Note that a value of 0 will completely suppress the enum
1187 + # values from appearing in the overview section.
1188 +
1189   ENUM_VALUES_PER_LINE   = 4
1190 < GENERATE_TREEVIEW      = NO
1190 >
1191 > # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1192 > # used to set the initial width (in pixels) of the frame in which the tree
1193 > # is shown.
1194 >
1195   TREEVIEW_WIDTH         = 250
1196 +
1197 + # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1198 + # links to external symbols imported via tag files in a separate window.
1199 +
1200 + EXT_LINKS_IN_WINDOW    = NO
1201 +
1202 + # Use this tag to change the font size of Latex formulas included
1203 + # as images in the HTML documentation. The default is 10. Note that
1204 + # when you change the font size after a successful doxygen run you need
1205 + # to manually remove any form_*.png images from the HTML output directory
1206 + # to force them to be regenerated.
1207 +
1208 + FORMULA_FONTSIZE       = 10
1209 +
1210 + # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1211 + # generated for formulas are transparent PNGs. Transparent PNGs are
1212 + # not supported properly for IE 6.0, but are supported on all modern browsers.
1213 + # Note that when changing this option you need to delete any form_*.png files
1214 + # in the HTML output before the changes have effect.
1215 +
1216 + FORMULA_TRANSPARENT    = YES
1217 +
1218 + # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1219 + # (see http://www.mathjax.org) which uses client side Javascript for the
1220 + # rendering instead of using prerendered bitmaps. Use this if you do not
1221 + # have LaTeX installed or if you want to formulas look prettier in the HTML
1222 + # output. When enabled you may also need to install MathJax separately and
1223 + # configure the path to it using the MATHJAX_RELPATH option.
1224 +
1225 + USE_MATHJAX            = NO
1226 +
1227 + # When MathJax is enabled you need to specify the location relative to the
1228 + # HTML output directory using the MATHJAX_RELPATH option. The destination
1229 + # directory should contain the MathJax.js script. For instance, if the mathjax
1230 + # directory is located at the same level as the HTML output directory, then
1231 + # MATHJAX_RELPATH should be ../mathjax. The default value points to
1232 + # the MathJax Content Delivery Network so you can quickly see the result without
1233 + # installing MathJax.
1234 + # However, it is strongly recommended to install a local
1235 + # copy of MathJax from http://www.mathjax.org before deployment.
1236 +
1237 + MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
1238 +
1239 + # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1240 + # names that should be enabled during MathJax rendering.
1241 +
1242 + MATHJAX_EXTENSIONS     =
1243 +
1244 + # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1245 + # for the HTML output. The underlying search engine uses javascript
1246 + # and DHTML and should work on any modern browser. Note that when using
1247 + # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1248 + # (GENERATE_DOCSET) there is already a search function so this one should
1249 + # typically be disabled. For large projects the javascript based search engine
1250 + # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1251 +
1252 + SEARCHENGINE           = YES
1253 +
1254 + # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1255 + # implemented using a PHP enabled web server instead of at the web client
1256 + # using Javascript. Doxygen will generate the search PHP script and index
1257 + # file to put on the web server. The advantage of the server
1258 + # based approach is that it scales better to large projects and allows
1259 + # full text search. The disadvantages are that it is more difficult to setup
1260 + # and does not have live searching capabilities.
1261 +
1262 + SERVER_BASED_SEARCH    = NO
1263 +
1264   #---------------------------------------------------------------------------
1265   # configuration options related to the LaTeX output
1266   #---------------------------------------------------------------------------
1267 < GENERATE_LATEX         = YES
1267 >
1268 > # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1269 > # generate Latex output.
1270 >
1271 > GENERATE_LATEX         = NO
1272 >
1273 > # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1274 > # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1275 > # put in front of it. If left blank `latex' will be used as the default path.
1276 >
1277   LATEX_OUTPUT           = latex
1278 +
1279 + # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1280 + # invoked. If left blank `latex' will be used as the default command name.
1281 + # Note that when enabling USE_PDFLATEX this option is only used for
1282 + # generating bitmaps for formulas in the HTML output, but not in the
1283 + # Makefile that is written to the output directory.
1284 +
1285   LATEX_CMD_NAME         = latex
1286 +
1287 + # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1288 + # generate index for LaTeX. If left blank `makeindex' will be used as the
1289 + # default command name.
1290 +
1291   MAKEINDEX_CMD_NAME     = makeindex
1292 +
1293 + # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1294 + # LaTeX documents. This may be useful for small projects and may help to
1295 + # save some trees in general.
1296 +
1297   COMPACT_LATEX          = NO
1298 < PAPER_TYPE             = a4wide
1299 < EXTRA_PACKAGES         =
1300 < LATEX_HEADER           =
1301 < PDF_HYPERLINKS         = NO
1302 < USE_PDFLATEX           = NO
1298 >
1299 > # The PAPER_TYPE tag can be used to set the paper type that is used
1300 > # by the printer. Possible values are: a4, letter, legal and
1301 > # executive. If left blank a4wide will be used.
1302 >
1303 > PAPER_TYPE             = letter
1304 >
1305 > # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1306 > # packages that should be included in the LaTeX output.
1307 >
1308 > EXTRA_PACKAGES         =
1309 >
1310 > # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1311 > # the generated latex document. The header should contain everything until
1312 > # the first chapter. If it is left blank doxygen will generate a
1313 > # standard header. Notice: only use this tag if you know what you are doing!
1314 >
1315 > LATEX_HEADER           =
1316 >
1317 > # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1318 > # the generated latex document. The footer should contain everything after
1319 > # the last chapter. If it is left blank doxygen will generate a
1320 > # standard footer. Notice: only use this tag if you know what you are doing!
1321 >
1322 > LATEX_FOOTER           =
1323 >
1324 > # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1325 > # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1326 > # contain links (just like the HTML output) instead of page references
1327 > # This makes the output suitable for online browsing using a pdf viewer.
1328 >
1329 > PDF_HYPERLINKS         = YES
1330 >
1331 > # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1332 > # plain latex in the generated Makefile. Set this option to YES to get a
1333 > # higher quality PDF documentation.
1334 >
1335 > USE_PDFLATEX           = YES
1336 >
1337 > # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1338 > # command to the generated LaTeX files. This will instruct LaTeX to keep
1339 > # running if errors occur, instead of asking the user for help.
1340 > # This option is also used when generating formulas in HTML.
1341 >
1342   LATEX_BATCHMODE        = NO
1343 +
1344 + # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1345 + # include the index chapters (such as File Index, Compound Index, etc.)
1346 + # in the output.
1347 +
1348   LATEX_HIDE_INDICES     = NO
1349 +
1350 + # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1351 + # source code with syntax highlighting in the LaTeX output.
1352 + # Note that which sources are shown also depends on other settings
1353 + # such as SOURCE_BROWSER.
1354 +
1355 + LATEX_SOURCE_CODE      = NO
1356 +
1357 + # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1358 + # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1359 + # http://en.wikipedia.org/wiki/BibTeX for more info.
1360 +
1361 + LATEX_BIB_STYLE        = plain
1362 +
1363   #---------------------------------------------------------------------------
1364   # configuration options related to the RTF output
1365   #---------------------------------------------------------------------------
1366 +
1367 + # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1368 + # The RTF output is optimized for Word 97 and may not look very pretty with
1369 + # other RTF readers or editors.
1370 +
1371   GENERATE_RTF           = NO
1372 +
1373 + # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1374 + # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1375 + # put in front of it. If left blank `rtf' will be used as the default path.
1376 +
1377   RTF_OUTPUT             = rtf
1378 +
1379 + # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1380 + # RTF documents. This may be useful for small projects and may help to
1381 + # save some trees in general.
1382 +
1383   COMPACT_RTF            = NO
1384 +
1385 + # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1386 + # will contain hyperlink fields. The RTF file will
1387 + # contain links (just like the HTML output) instead of page references.
1388 + # This makes the output suitable for online browsing using WORD or other
1389 + # programs which support those fields.
1390 + # Note: wordpad (write) and others do not support links.
1391 +
1392   RTF_HYPERLINKS         = NO
1393 < RTF_STYLESHEET_FILE    =
1394 < RTF_EXTENSIONS_FILE    =
1393 >
1394 > # Load style sheet definitions from file. Syntax is similar to doxygen's
1395 > # config file, i.e. a series of assignments. You only have to provide
1396 > # replacements, missing definitions are set to their default value.
1397 >
1398 > RTF_STYLESHEET_FILE    =
1399 >
1400 > # Set optional variables used in the generation of an rtf document.
1401 > # Syntax is similar to doxygen's config file.
1402 >
1403 > RTF_EXTENSIONS_FILE    =
1404 >
1405   #---------------------------------------------------------------------------
1406   # configuration options related to the man page output
1407   #---------------------------------------------------------------------------
1408 +
1409 + # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1410 + # generate man pages
1411 +
1412   GENERATE_MAN           = NO
1413 +
1414 + # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1415 + # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1416 + # put in front of it. If left blank `man' will be used as the default path.
1417 +
1418   MAN_OUTPUT             = man
1419 +
1420 + # The MAN_EXTENSION tag determines the extension that is added to
1421 + # the generated man pages (default is the subroutine's section .3)
1422 +
1423   MAN_EXTENSION          = .3
1424 +
1425 + # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1426 + # then it will generate one additional man file for each entity
1427 + # documented in the real man page(s). These additional files
1428 + # only source the real man page, but without them the man command
1429 + # would be unable to find the correct page. The default is NO.
1430 +
1431   MAN_LINKS              = NO
1432 +
1433   #---------------------------------------------------------------------------
1434   # configuration options related to the XML output
1435   #---------------------------------------------------------------------------
1436 +
1437 + # If the GENERATE_XML tag is set to YES Doxygen will
1438 + # generate an XML file that captures the structure of
1439 + # the code including all documentation.
1440 +
1441   GENERATE_XML           = NO
1442 +
1443 + # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1444 + # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1445 + # put in front of it. If left blank `xml' will be used as the default path.
1446 +
1447   XML_OUTPUT             = xml
1448 < XML_SCHEMA             =
1449 < XML_DTD                =
1448 >
1449 > # The XML_SCHEMA tag can be used to specify an XML schema,
1450 > # which can be used by a validating XML parser to check the
1451 > # syntax of the XML files.
1452 >
1453 > XML_SCHEMA             =
1454 >
1455 > # The XML_DTD tag can be used to specify an XML DTD,
1456 > # which can be used by a validating XML parser to check the
1457 > # syntax of the XML files.
1458 >
1459 > XML_DTD                =
1460 >
1461 > # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1462 > # dump the program listings (including syntax highlighting
1463 > # and cross-referencing information) to the XML output. Note that
1464 > # enabling this will significantly increase the size of the XML output.
1465 >
1466   XML_PROGRAMLISTING     = YES
1467 +
1468   #---------------------------------------------------------------------------
1469   # configuration options for the AutoGen Definitions output
1470   #---------------------------------------------------------------------------
1471 +
1472 + # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1473 + # generate an AutoGen Definitions (see autogen.sf.net) file
1474 + # that captures the structure of the code including all
1475 + # documentation. Note that this feature is still experimental
1476 + # and incomplete at the moment.
1477 +
1478   GENERATE_AUTOGEN_DEF   = NO
1479 +
1480   #---------------------------------------------------------------------------
1481   # configuration options related to the Perl module output
1482   #---------------------------------------------------------------------------
1483 +
1484 + # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1485 + # generate a Perl module file that captures the structure of
1486 + # the code including all documentation. Note that this
1487 + # feature is still experimental and incomplete at the
1488 + # moment.
1489 +
1490   GENERATE_PERLMOD       = NO
1491 +
1492 + # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1493 + # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1494 + # to generate PDF and DVI output from the Perl module output.
1495 +
1496   PERLMOD_LATEX          = NO
1497 +
1498 + # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1499 + # nicely formatted so it can be parsed by a human reader.
1500 + # This is useful
1501 + # if you want to understand what is going on.
1502 + # On the other hand, if this
1503 + # tag is set to NO the size of the Perl module output will be much smaller
1504 + # and Perl will parse it just the same.
1505 +
1506   PERLMOD_PRETTY         = YES
1507 < PERLMOD_MAKEVAR_PREFIX =
1507 >
1508 > # The names of the make variables in the generated doxyrules.make file
1509 > # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1510 > # This is useful so different doxyrules.make files included by the same
1511 > # Makefile don't overwrite each other's variables.
1512 >
1513 > PERLMOD_MAKEVAR_PREFIX =
1514 >
1515   #---------------------------------------------------------------------------
1516 < # Configuration options related to the preprocessor  
1516 > # Configuration options related to the preprocessor
1517   #---------------------------------------------------------------------------
1518 +
1519 + # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1520 + # evaluate all C-preprocessor directives found in the sources and include
1521 + # files.
1522 +
1523   ENABLE_PREPROCESSING   = YES
1524 +
1525 + # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1526 + # names in the source code. If set to NO (the default) only conditional
1527 + # compilation will be performed. Macro expansion can be done in a controlled
1528 + # way by setting EXPAND_ONLY_PREDEF to YES.
1529 +
1530   MACRO_EXPANSION        = NO
1531 +
1532 + # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1533 + # then the macro expansion is limited to the macros specified with the
1534 + # PREDEFINED and EXPAND_AS_DEFINED tags.
1535 +
1536   EXPAND_ONLY_PREDEF     = NO
1537 +
1538 + # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1539 + # pointed to by INCLUDE_PATH will be searched when a #include is found.
1540 +
1541   SEARCH_INCLUDES        = YES
1542 < INCLUDE_PATH           =
1543 < INCLUDE_FILE_PATTERNS  =
1544 < PREDEFINED             =
1545 < EXPAND_AS_DEFINED      =
1542 >
1543 > # The INCLUDE_PATH tag can be used to specify one or more directories that
1544 > # contain include files that are not input files but should be processed by
1545 > # the preprocessor.
1546 >
1547 > INCLUDE_PATH           =
1548 >
1549 > # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1550 > # patterns (like *.h and *.hpp) to filter out the header-files in the
1551 > # directories. If left blank, the patterns specified with FILE_PATTERNS will
1552 > # be used.
1553 >
1554 > INCLUDE_FILE_PATTERNS  =
1555 >
1556 > # The PREDEFINED tag can be used to specify one or more macro names that
1557 > # are defined before the preprocessor is started (similar to the -D option of
1558 > # gcc). The argument of the tag is a list of macros of the form: name
1559 > # or name=definition (no spaces). If the definition and the = are
1560 > # omitted =1 is assumed. To prevent a macro definition from being
1561 > # undefined via #undef or recursively expanded use the := operator
1562 > # instead of the = operator.
1563 >
1564 > PREDEFINED           =  ANTLR_CXX_SUPPORTS_NAMESPACE \
1565 >                        "ANTLR_USE_NAMESPACE(_x_)=_x_::" \
1566 >                        "ANTLR_USING_NAMESPACE(_x_)=using namespace _x_;" \
1567 >                        "ANTLR_C_USING(_x_)=" \
1568 >                        "ANTLR_API=" \
1569 >                        IS_MPI \
1570 >                        HAVE_QHULL \
1571 >                        HAVE_FFTW3
1572 >
1573 > # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1574 > # this tag can be used to specify a list of macro names that should be expanded.
1575 > # The macro definition that is found in the sources will be used.
1576 > # Use the PREDEFINED tag if you want to use a different macro definition that
1577 > # overrules the definition found in the source code.
1578 >
1579 > EXPAND_AS_DEFINED      =
1580 >
1581 > # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1582 > # doxygen's preprocessor will remove all references to function-like macros
1583 > # that are alone on a line, have an all uppercase name, and do not end with a
1584 > # semicolon, because these will confuse the parser if not removed.
1585 >
1586   SKIP_FUNCTION_MACROS   = YES
1587 +
1588   #---------------------------------------------------------------------------
1589 < # Configuration::additions related to external references  
1589 > # Configuration::additions related to external references
1590   #---------------------------------------------------------------------------
1591 < TAGFILES               =
1592 < GENERATE_TAGFILE       =
1591 >
1592 > # The TAGFILES option can be used to specify one or more tagfiles. For each
1593 > # tag file the location of the external documentation should be added. The
1594 > # format of a tag file without this location is as follows:
1595 > #
1596 > # TAGFILES = file1 file2 ...
1597 > # Adding location for the tag files is done as follows:
1598 > #
1599 > # TAGFILES = file1=loc1 "file2 = loc2" ...
1600 > # where "loc1" and "loc2" can be relative or absolute paths
1601 > # or URLs. Note that each tag file must have a unique name (where the name does
1602 > # NOT include the path). If a tag file is not located in the directory in which
1603 > # doxygen is run, you must also specify the path to the tagfile here.
1604 >
1605 > TAGFILES               =
1606 >
1607 > # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1608 > # a tag file that is based on the input files it reads.
1609 >
1610 > GENERATE_TAGFILE       =
1611 >
1612 > # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1613 > # in the class index. If set to NO only the inherited external classes
1614 > # will be listed.
1615 >
1616   ALLEXTERNALS           = NO
1617 +
1618 + # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1619 + # in the modules index. If set to NO, only the current project's groups will
1620 + # be listed.
1621 +
1622   EXTERNAL_GROUPS        = YES
1623 +
1624 + # The PERL_PATH should be the absolute path and name of the perl script
1625 + # interpreter (i.e. the result of `which perl').
1626 +
1627   PERL_PATH              = /usr/bin/perl
1628 +
1629   #---------------------------------------------------------------------------
1630 < # Configuration options related to the dot tool  
1630 > # Configuration options related to the dot tool
1631   #---------------------------------------------------------------------------
1632 +
1633 + # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1634 + # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1635 + # or super classes. Setting the tag to NO turns the diagrams off. Note that
1636 + # this option also works with HAVE_DOT disabled, but it is recommended to
1637 + # install and use dot, since it yields more powerful graphs.
1638 +
1639   CLASS_DIAGRAMS         = YES
1640 +
1641 + # You can define message sequence charts within doxygen comments using the \msc
1642 + # command. Doxygen will then run the mscgen tool (see
1643 + # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1644 + # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1645 + # the mscgen tool resides. If left empty the tool is assumed to be found in the
1646 + # default search path.
1647 +
1648 + MSCGEN_PATH            =
1649 +
1650 + # If set to YES, the inheritance and collaboration graphs will hide
1651 + # inheritance and usage relations if the target is undocumented
1652 + # or is not a class.
1653 +
1654   HIDE_UNDOC_RELATIONS   = YES
1655 +
1656 + # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1657 + # available from the path. This tool is part of Graphviz, a graph visualization
1658 + # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1659 + # have no effect if this option is set to NO (the default)
1660 +
1661   HAVE_DOT               = NO
1662 +
1663 + # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1664 + # allowed to run in parallel. When set to 0 (the default) doxygen will
1665 + # base this on the number of processors available in the system. You can set it
1666 + # explicitly to a value larger than 0 to get control over the balance
1667 + # between CPU load and processing speed.
1668 +
1669 + DOT_NUM_THREADS        = 0
1670 +
1671 + # By default doxygen will use the Helvetica font for all dot files that
1672 + # doxygen generates. When you want a differently looking font you can specify
1673 + # the font name using DOT_FONTNAME. You need to make sure dot is able to find
1674 + # the font, which can be done by putting it in a standard location or by setting
1675 + # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1676 + # directory containing the font.
1677 +
1678 + DOT_FONTNAME           = FreeSans
1679 +
1680 + # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1681 + # The default size is 10pt.
1682 +
1683 + DOT_FONTSIZE           = 10
1684 +
1685 + # By default doxygen will tell dot to use the Helvetica font.
1686 + # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1687 + # set the path where dot can find it.
1688 +
1689 + DOT_FONTPATH           =
1690 +
1691 + # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1692 + # will generate a graph for each documented class showing the direct and
1693 + # indirect inheritance relations. Setting this tag to YES will force the
1694 + # CLASS_DIAGRAMS tag to NO.
1695 +
1696   CLASS_GRAPH            = YES
1697 +
1698 + # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1699 + # will generate a graph for each documented class showing the direct and
1700 + # indirect implementation dependencies (inheritance, containment, and
1701 + # class references variables) of the class with other documented classes.
1702 +
1703   COLLABORATION_GRAPH    = YES
1704 +
1705 + # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1706 + # will generate a graph for groups, showing the direct groups dependencies
1707 +
1708 + GROUP_GRAPHS           = YES
1709 +
1710 + # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1711 + # collaboration diagrams in a style similar to the OMG's Unified Modeling
1712 + # Language.
1713 +
1714   UML_LOOK               = NO
1715 +
1716 + # If the UML_LOOK tag is enabled, the fields and methods are shown inside
1717 + # the class node. If there are many fields or methods and many nodes the
1718 + # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
1719 + # threshold limits the number of items for each type to make the size more
1720 + # managable. Set this to 0 for no limit. Note that the threshold may be
1721 + # exceeded by 50% before the limit is enforced.
1722 +
1723 + UML_LIMIT_NUM_FIELDS   = 10
1724 +
1725 + # If set to YES, the inheritance and collaboration graphs will show the
1726 + # relations between templates and their instances.
1727 +
1728   TEMPLATE_RELATIONS     = NO
1729 +
1730 + # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1731 + # tags are set to YES then doxygen will generate a graph for each documented
1732 + # file showing the direct and indirect include dependencies of the file with
1733 + # other documented files.
1734 +
1735   INCLUDE_GRAPH          = YES
1736 +
1737 + # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1738 + # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1739 + # documented header file showing the documented files that directly or
1740 + # indirectly include this file.
1741 +
1742   INCLUDED_BY_GRAPH      = YES
1743 < CALL_GRAPH             = NO
1743 >
1744 > # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1745 > # doxygen will generate a call dependency graph for every global function
1746 > # or class method. Note that enabling this option will significantly increase
1747 > # the time of a run. So in most cases it will be better to enable call graphs
1748 > # for selected functions only using the \callgraph command.
1749 >
1750 > CALL_GRAPH             = YES
1751 >
1752 > # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1753 > # doxygen will generate a caller dependency graph for every global function
1754 > # or class method. Note that enabling this option will significantly increase
1755 > # the time of a run. So in most cases it will be better to enable caller
1756 > # graphs for selected functions only using the \callergraph command.
1757 >
1758 > CALLER_GRAPH           = YES
1759 >
1760 > # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1761 > # will generate a graphical hierarchy of all classes instead of a textual one.
1762 >
1763   GRAPHICAL_HIERARCHY    = YES
1764 +
1765 + # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
1766 + # then doxygen will show the dependencies a directory has on other directories
1767 + # in a graphical way. The dependency relations are determined by the #include
1768 + # relations between the files in the directories.
1769 +
1770 + DIRECTORY_GRAPH        = YES
1771 +
1772 + # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1773 + # generated by dot. Possible values are svg, png, jpg, or gif.
1774 + # If left blank png will be used. If you choose svg you need to set
1775 + # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1776 + # visible in IE 9+ (other browsers do not have this requirement).
1777 +
1778   DOT_IMAGE_FORMAT       = png
1779 < DOT_PATH               =
1780 < DOTFILE_DIRS           =
1781 < MAX_DOT_GRAPH_WIDTH    = 1024
1782 < MAX_DOT_GRAPH_HEIGHT   = 1024
1783 < MAX_DOT_GRAPH_DEPTH    = 1000
1779 >
1780 > # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1781 > # enable generation of interactive SVG images that allow zooming and panning.
1782 > # Note that this requires a modern browser other than Internet Explorer.
1783 > # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1784 > # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1785 > # visible. Older versions of IE do not have SVG support.
1786 >
1787 > INTERACTIVE_SVG        = NO
1788 >
1789 > # The tag DOT_PATH can be used to specify the path where the dot tool can be
1790 > # found. If left blank, it is assumed the dot tool can be found in the path.
1791 >
1792 > DOT_PATH               =
1793 >
1794 > # The DOTFILE_DIRS tag can be used to specify one or more directories that
1795 > # contain dot files that are included in the documentation (see the
1796 > # \dotfile command).
1797 >
1798 > DOTFILE_DIRS           =
1799 >
1800 > # The MSCFILE_DIRS tag can be used to specify one or more directories that
1801 > # contain msc files that are included in the documentation (see the
1802 > # \mscfile command).
1803 >
1804 > MSCFILE_DIRS           =
1805 >
1806 > # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1807 > # nodes that will be shown in the graph. If the number of nodes in a graph
1808 > # becomes larger than this value, doxygen will truncate the graph, which is
1809 > # visualized by representing a node as a red box. Note that doxygen if the
1810 > # number of direct children of the root node in a graph is already larger than
1811 > # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1812 > # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1813 >
1814 > DOT_GRAPH_MAX_NODES    = 50
1815 >
1816 > # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1817 > # graphs generated by dot. A depth value of 3 means that only nodes reachable
1818 > # from the root by following a path via at most 3 edges will be shown. Nodes
1819 > # that lay further from the root node will be omitted. Note that setting this
1820 > # option to 1 or 2 may greatly reduce the computation time needed for large
1821 > # code bases. Also note that the size of a graph can be further restricted by
1822 > # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1823 >
1824 > MAX_DOT_GRAPH_DEPTH    = 0
1825 >
1826 > # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1827 > # background. This is disabled by default, because dot on Windows does not
1828 > # seem to support this out of the box. Warning: Depending on the platform used,
1829 > # enabling this option may lead to badly anti-aliased labels on the edges of
1830 > # a graph (i.e. they become hard to read).
1831 >
1832 > DOT_TRANSPARENT        = NO
1833 >
1834 > # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1835 > # files in one run (i.e. multiple -o and -T options on the command line). This
1836 > # makes dot run faster, but since only newer versions of dot (>1.8.10)
1837 > # support this, this feature is disabled by default.
1838 >
1839 > DOT_MULTI_TARGETS      = NO
1840 >
1841 > # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1842 > # generate a legend page explaining the meaning of the various boxes and
1843 > # arrows in the dot generated graphs.
1844 >
1845   GENERATE_LEGEND        = YES
1846 +
1847 + # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1848 + # remove the intermediate dot files that are used to generate
1849 + # the various graphs.
1850 +
1851   DOT_CLEANUP            = YES
258 #---------------------------------------------------------------------------
259 # Configuration::additions related to the search engine  
260 #---------------------------------------------------------------------------
261 SEARCHENGINE           = NO

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines