ffi-yajl 0.0.4-universal-java → 0.1.0-universal-java

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