rice2 2.2.0

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