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