• R/O
  • HTTP
  • SSH
  • HTTPS

fermisurfer: Commit

fermisurfer Git


Commit MetaInfo

Revision2766c290b53079e00b40819d8da3dfd1be968571 (tree)
Zeit2015-10-02 22:44:40
Autormitsuaki1987 <kawamitsuaki@gmai...>
Commitermitsuaki1987

Log Message

Modify character encode

Ändern Zusammenfassung

Diff

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