kinetic_sdk 5.0.18 → 5.0.20

Sign up to get free protection for your applications and to get access to all the features.
Files changed (667) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +15 -1
  3. data/README.md +1 -1
  4. data/gems/{mime-types-3.1/Code-of-Conduct.rdoc → mime-types-3.4.1/Code-of-Conduct.md} +29 -30
  5. data/gems/mime-types-3.4.1/Contributing.md +132 -0
  6. data/gems/mime-types-3.4.1/History.md +269 -0
  7. data/gems/{mime-types-3.1/Licence.rdoc → mime-types-3.4.1/Licence.md} +3 -3
  8. data/gems/{mime-types-3.1 → mime-types-3.4.1}/Manifest.txt +4 -4
  9. data/gems/{mime-types-3.1 → mime-types-3.4.1}/README.rdoc +6 -14
  10. data/gems/mime-types-3.4.1/Rakefile +270 -0
  11. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/type/columnar.rb +6 -4
  12. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/type.rb +162 -101
  13. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/types/_columnar.rb +22 -20
  14. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/types/cache.rb +13 -11
  15. data/gems/mime-types-3.4.1/lib/mime/types/columnar.rb +3 -0
  16. data/gems/mime-types-3.4.1/lib/mime/types/container.rb +96 -0
  17. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/types/deprecations.rb +17 -13
  18. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/types/full.rb +4 -2
  19. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/types/loader.rb +29 -18
  20. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/types/logger.rb +5 -5
  21. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/types/registry.rb +14 -5
  22. data/gems/{mime-types-3.1 → mime-types-3.4.1}/lib/mime/types.rb +26 -21
  23. data/gems/mime-types-3.4.1/lib/mime-types.rb +3 -0
  24. data/gems/{mime-types-3.1 → mime-types-3.4.1}/test/bad-fixtures/malformed +0 -0
  25. data/gems/{mime-types-3.1 → mime-types-3.4.1}/test/fixture/json.json +0 -0
  26. data/gems/{mime-types-3.1 → mime-types-3.4.1}/test/fixture/old-data +0 -0
  27. data/gems/{mime-types-3.1 → mime-types-3.4.1}/test/fixture/yaml.yaml +0 -0
  28. data/gems/mime-types-3.4.1/test/minitest_helper.rb +11 -0
  29. data/gems/mime-types-3.4.1/test/test_mime_type.rb +621 -0
  30. data/gems/mime-types-3.4.1/test/test_mime_types.rb +169 -0
  31. data/gems/mime-types-3.4.1/test/test_mime_types_cache.rb +118 -0
  32. data/gems/mime-types-3.4.1/test/test_mime_types_class.rb +159 -0
  33. data/gems/mime-types-3.4.1/test/test_mime_types_lazy.rb +49 -0
  34. data/gems/mime-types-3.4.1/test/test_mime_types_loader.rb +32 -0
  35. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/Code-of-Conduct.md +22 -22
  36. data/gems/mime-types-data-3.2022.0105/Contributing.md +241 -0
  37. data/gems/mime-types-data-3.2022.0105/History.md +502 -0
  38. data/gems/{websocket-driver-0.6.5-java/LICENSE.md → mime-types-data-3.2022.0105/Licence.md} +7 -5
  39. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/Manifest.txt +16 -0
  40. data/gems/mime-types-data-3.2022.0105/README.md +73 -0
  41. data/gems/mime-types-data-3.2022.0105/Rakefile +155 -0
  42. data/gems/mime-types-data-3.2022.0105/data/content_type_mime.db +878 -0
  43. data/gems/mime-types-data-3.2022.0105/data/ext_mime.db +1198 -0
  44. data/gems/mime-types-data-3.2022.0105/data/mime-types.json +1 -0
  45. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/data/mime.content_type.column +432 -13
  46. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/data/mime.docs.column +419 -0
  47. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/data/mime.encoding.column +419 -0
  48. data/gems/mime-types-data-3.2022.0105/data/mime.flags.column +2383 -0
  49. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/data/mime.friendly.column +419 -0
  50. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/data/mime.pext.column +419 -0
  51. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/data/mime.use_instead.column +420 -1
  52. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/data/mime.xrefs.column +567 -148
  53. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/lib/mime/types/data.rb +2 -2
  54. data/gems/{mime-types-data-3.2016.0521 → mime-types-data-3.2022.0105}/lib/mime-types-data.rb +1 -1
  55. data/gems/mime-types-data-3.2022.0105/types/application.yaml +17299 -0
  56. data/gems/mime-types-data-3.2022.0105/types/audio.yaml +1716 -0
  57. data/gems/mime-types-data-3.2022.0105/types/chemical.yaml +71 -0
  58. data/gems/mime-types-data-3.2022.0105/types/conference.yaml +9 -0
  59. data/gems/mime-types-data-3.2022.0105/types/drawing.yaml +15 -0
  60. data/gems/mime-types-data-3.2022.0105/types/font.yaml +65 -0
  61. data/gems/mime-types-data-3.2022.0105/types/image.yaml +1252 -0
  62. data/gems/mime-types-data-3.2022.0105/types/message.yaml +205 -0
  63. data/gems/mime-types-data-3.2022.0105/types/model.yaml +390 -0
  64. data/gems/mime-types-data-3.2022.0105/types/multipart.yaml +179 -0
  65. data/gems/mime-types-data-3.2022.0105/types/provisional-standard-types.yaml +145 -0
  66. data/gems/mime-types-data-3.2022.0105/types/text.yaml +1166 -0
  67. data/gems/mime-types-data-3.2022.0105/types/video.yaml +1121 -0
  68. data/gems/mime-types-data-3.2022.0105/types/world.yaml +8 -0
  69. data/gems/rake-13.0.1/CONTRIBUTING.rdoc +43 -0
  70. data/gems/rake-13.0.1/Gemfile +10 -0
  71. data/gems/rake-13.0.1/History.rdoc +2368 -0
  72. data/gems/{parallel-1.12.1/MIT-LICENSE.txt → rake-13.0.1/MIT-LICENSE} +2 -1
  73. data/gems/rake-13.0.1/README.rdoc +155 -0
  74. data/gems/rake-13.0.1/Rakefile +41 -0
  75. data/gems/rake-13.0.1/bin/bundle +105 -0
  76. data/gems/rake-13.0.1/bin/console +7 -0
  77. data/gems/rake-13.0.1/bin/rake +29 -0
  78. data/gems/rake-13.0.1/bin/rdoc +29 -0
  79. data/gems/rake-13.0.1/bin/rubocop +29 -0
  80. data/gems/rake-13.0.1/bin/setup +6 -0
  81. data/gems/rake-13.0.1/doc/command_line_usage.rdoc +158 -0
  82. data/gems/rake-13.0.1/doc/example/Rakefile1 +38 -0
  83. data/gems/rake-13.0.1/doc/example/Rakefile2 +35 -0
  84. data/gems/rake-13.0.1/doc/example/a.c +6 -0
  85. data/gems/rake-13.0.1/doc/example/b.c +6 -0
  86. data/gems/rake-13.0.1/doc/example/main.c +11 -0
  87. data/gems/rake-13.0.1/doc/glossary.rdoc +42 -0
  88. data/gems/rake-13.0.1/doc/jamis.rb +592 -0
  89. data/gems/rake-13.0.1/doc/proto_rake.rdoc +127 -0
  90. data/gems/rake-13.0.1/doc/rake.1 +156 -0
  91. data/gems/rake-13.0.1/doc/rakefile.rdoc +622 -0
  92. data/gems/rake-13.0.1/doc/rational.rdoc +151 -0
  93. data/gems/rake-13.0.1/exe/rake +27 -0
  94. data/gems/rake-13.0.1/lib/rake/application.rb +824 -0
  95. data/gems/rake-13.0.1/lib/rake/backtrace.rb +24 -0
  96. data/gems/rake-13.0.1/lib/rake/clean.rb +78 -0
  97. data/gems/rake-13.0.1/lib/rake/cloneable.rb +17 -0
  98. data/gems/rake-13.0.1/lib/rake/cpu_counter.rb +107 -0
  99. data/gems/rake-13.0.1/lib/rake/default_loader.rb +15 -0
  100. data/gems/rake-13.0.1/lib/rake/dsl_definition.rb +195 -0
  101. data/gems/rake-13.0.1/lib/rake/early_time.rb +22 -0
  102. data/gems/rake-13.0.1/lib/rake/ext/core.rb +26 -0
  103. data/gems/rake-13.0.1/lib/rake/ext/string.rb +176 -0
  104. data/gems/rake-13.0.1/lib/rake/file_creation_task.rb +25 -0
  105. data/gems/rake-13.0.1/lib/rake/file_list.rb +435 -0
  106. data/gems/rake-13.0.1/lib/rake/file_task.rb +54 -0
  107. data/gems/rake-13.0.1/lib/rake/file_utils.rb +134 -0
  108. data/gems/rake-13.0.1/lib/rake/file_utils_ext.rb +134 -0
  109. data/gems/rake-13.0.1/lib/rake/invocation_chain.rb +57 -0
  110. data/gems/rake-13.0.1/lib/rake/invocation_exception_mixin.rb +17 -0
  111. data/gems/rake-13.0.1/lib/rake/late_time.rb +18 -0
  112. data/gems/rake-13.0.1/lib/rake/linked_list.rb +112 -0
  113. data/gems/rake-13.0.1/lib/rake/loaders/makefile.rb +54 -0
  114. data/gems/rake-13.0.1/lib/rake/multi_task.rb +14 -0
  115. data/gems/rake-13.0.1/lib/rake/name_space.rb +38 -0
  116. data/gems/rake-13.0.1/lib/rake/packagetask.rb +222 -0
  117. data/gems/rake-13.0.1/lib/rake/phony.rb +16 -0
  118. data/gems/rake-13.0.1/lib/rake/private_reader.rb +21 -0
  119. data/gems/rake-13.0.1/lib/rake/promise.rb +100 -0
  120. data/gems/rake-13.0.1/lib/rake/pseudo_status.rb +30 -0
  121. data/gems/rake-13.0.1/lib/rake/rake_module.rb +67 -0
  122. data/gems/rake-13.0.1/lib/rake/rake_test_loader.rb +27 -0
  123. data/gems/rake-13.0.1/lib/rake/rule_recursion_overflow_error.rb +20 -0
  124. data/gems/rake-13.0.1/lib/rake/scope.rb +43 -0
  125. data/gems/rake-13.0.1/lib/rake/task.rb +434 -0
  126. data/gems/rake-13.0.1/lib/rake/task_argument_error.rb +8 -0
  127. data/gems/rake-13.0.1/lib/rake/task_arguments.rb +109 -0
  128. data/gems/rake-13.0.1/lib/rake/task_manager.rb +331 -0
  129. data/gems/rake-13.0.1/lib/rake/tasklib.rb +12 -0
  130. data/gems/rake-13.0.1/lib/rake/testtask.rb +224 -0
  131. data/gems/rake-13.0.1/lib/rake/thread_history_display.rb +49 -0
  132. data/gems/rake-13.0.1/lib/rake/thread_pool.rb +163 -0
  133. data/gems/rake-13.0.1/lib/rake/trace_output.rb +23 -0
  134. data/gems/rake-13.0.1/lib/rake/version.rb +10 -0
  135. data/gems/rake-13.0.1/lib/rake/win32.rb +51 -0
  136. data/gems/rake-13.0.1/lib/rake.rb +71 -0
  137. data/gems/rake-13.0.1/rake.gemspec +43 -0
  138. data/gems/yard-0.9.25/CHANGELOG.md +804 -0
  139. data/gems/yard-0.9.25/CODE_OF_CONDUCT.md +15 -0
  140. data/gems/yard-0.9.25/CONTRIBUTING.md +140 -0
  141. data/gems/yard-0.9.25/Dockerfile.samus +28 -0
  142. data/gems/yard-0.9.25/Gemfile +32 -0
  143. data/gems/yard-0.9.25/LEGAL +66 -0
  144. data/gems/yard-0.9.25/LICENSE +22 -0
  145. data/gems/yard-0.9.25/README.md +325 -0
  146. data/gems/yard-0.9.25/Rakefile +39 -0
  147. data/gems/yard-0.9.25/SECURITY.md +26 -0
  148. data/gems/yard-0.9.25/benchmarks/builtins_vs_eval.rb +24 -0
  149. data/gems/yard-0.9.25/benchmarks/concat_vs_join.rb +13 -0
  150. data/gems/yard-0.9.25/benchmarks/erb_vs_erubis.rb +54 -0
  151. data/gems/yard-0.9.25/benchmarks/format_args.rb +47 -0
  152. data/gems/yard-0.9.25/benchmarks/generation.rb +38 -0
  153. data/gems/yard-0.9.25/benchmarks/marshal_vs_dbm.rb +64 -0
  154. data/gems/yard-0.9.25/benchmarks/parsing.rb +46 -0
  155. data/gems/yard-0.9.25/benchmarks/pathname_vs_string.rb +51 -0
  156. data/gems/yard-0.9.25/benchmarks/rdoc_vs_yardoc.rb +11 -0
  157. data/gems/yard-0.9.25/benchmarks/registry_store_types.rb +49 -0
  158. data/gems/yard-0.9.25/benchmarks/ri_vs_yri.rb +19 -0
  159. data/gems/yard-0.9.25/benchmarks/ripper_parser.rb +13 -0
  160. data/gems/yard-0.9.25/benchmarks/splat_vs_flatten.rb +13 -0
  161. data/gems/yard-0.9.25/benchmarks/template_erb.rb +23 -0
  162. data/gems/yard-0.9.25/benchmarks/template_format.rb +7 -0
  163. data/gems/yard-0.9.25/benchmarks/template_profile.rb +18 -0
  164. data/gems/yard-0.9.25/benchmarks/yri_cache.rb +20 -0
  165. data/gems/yard-0.9.25/bin/yard +13 -0
  166. data/gems/yard-0.9.25/bin/yardoc +13 -0
  167. data/gems/yard-0.9.25/bin/yri +13 -0
  168. data/gems/yard-0.9.25/docs/CodeObjects.md +115 -0
  169. data/gems/yard-0.9.25/docs/GettingStarted.md +679 -0
  170. data/gems/yard-0.9.25/docs/Handlers.md +152 -0
  171. data/gems/yard-0.9.25/docs/Overview.md +61 -0
  172. data/gems/yard-0.9.25/docs/Parser.md +191 -0
  173. data/gems/yard-0.9.25/docs/Tags.md +283 -0
  174. data/gems/yard-0.9.25/docs/TagsArch.md +123 -0
  175. data/gems/yard-0.9.25/docs/Templates.md +496 -0
  176. data/gems/yard-0.9.25/docs/WhatsNew.md +1245 -0
  177. data/gems/yard-0.9.25/docs/images/code-objects-class-diagram.png +0 -0
  178. data/gems/yard-0.9.25/docs/images/handlers-class-diagram.png +0 -0
  179. data/gems/yard-0.9.25/docs/images/overview-class-diagram.png +0 -0
  180. data/gems/yard-0.9.25/docs/images/parser-class-diagram.png +0 -0
  181. data/gems/yard-0.9.25/docs/images/tags-class-diagram.png +0 -0
  182. data/gems/yard-0.9.25/docs/templates/default/fulldoc/html/full_list_tag.erb +9 -0
  183. data/gems/yard-0.9.25/docs/templates/default/fulldoc/html/setup.rb +6 -0
  184. data/gems/yard-0.9.25/docs/templates/default/layout/html/setup.rb +9 -0
  185. data/gems/yard-0.9.25/docs/templates/default/layout/html/tag_list.erb +11 -0
  186. data/gems/yard-0.9.25/docs/templates/default/yard_tags/html/list.erb +18 -0
  187. data/gems/yard-0.9.25/docs/templates/default/yard_tags/html/setup.rb +26 -0
  188. data/gems/yard-0.9.25/docs/templates/plugin.rb +70 -0
  189. data/gems/yard-0.9.25/lib/rubygems_plugin.rb +9 -0
  190. data/gems/yard-0.9.25/lib/yard/autoload.rb +308 -0
  191. data/gems/yard-0.9.25/lib/yard/cli/command.rb +85 -0
  192. data/gems/yard-0.9.25/lib/yard/cli/command_parser.rb +93 -0
  193. data/gems/yard-0.9.25/lib/yard/cli/config.rb +198 -0
  194. data/gems/yard-0.9.25/lib/yard/cli/diff.rb +273 -0
  195. data/gems/yard-0.9.25/lib/yard/cli/display.rb +69 -0
  196. data/gems/yard-0.9.25/lib/yard/cli/gems.rb +84 -0
  197. data/gems/yard-0.9.25/lib/yard/cli/graph.rb +125 -0
  198. data/gems/yard-0.9.25/lib/yard/cli/help.rb +20 -0
  199. data/gems/yard-0.9.25/lib/yard/cli/i18n.rb +70 -0
  200. data/gems/yard-0.9.25/lib/yard/cli/list.rb +23 -0
  201. data/gems/yard-0.9.25/lib/yard/cli/markup_types.rb +32 -0
  202. data/gems/yard-0.9.25/lib/yard/cli/server.rb +266 -0
  203. data/gems/yard-0.9.25/lib/yard/cli/stats.rb +231 -0
  204. data/gems/yard-0.9.25/lib/yard/cli/yardoc.rb +789 -0
  205. data/gems/yard-0.9.25/lib/yard/cli/yardopts_command.rb +110 -0
  206. data/gems/yard-0.9.25/lib/yard/cli/yri.rb +215 -0
  207. data/gems/yard-0.9.25/lib/yard/code_objects/base.rb +622 -0
  208. data/gems/yard-0.9.25/lib/yard/code_objects/class_object.rb +146 -0
  209. data/gems/yard-0.9.25/lib/yard/code_objects/class_variable_object.rb +11 -0
  210. data/gems/yard-0.9.25/lib/yard/code_objects/constant_object.rb +16 -0
  211. data/gems/yard-0.9.25/lib/yard/code_objects/extended_method_object.rb +24 -0
  212. data/gems/yard-0.9.25/lib/yard/code_objects/extra_file_object.rb +134 -0
  213. data/gems/yard-0.9.25/lib/yard/code_objects/macro_object.rb +172 -0
  214. data/gems/yard-0.9.25/lib/yard/code_objects/method_object.rb +196 -0
  215. data/gems/yard-0.9.25/lib/yard/code_objects/module_object.rb +21 -0
  216. data/gems/yard-0.9.25/lib/yard/code_objects/namespace_mapper.rb +141 -0
  217. data/gems/yard-0.9.25/lib/yard/code_objects/namespace_object.rb +200 -0
  218. data/gems/yard-0.9.25/lib/yard/code_objects/proxy.rb +245 -0
  219. data/gems/yard-0.9.25/lib/yard/code_objects/root_object.rb +19 -0
  220. data/gems/yard-0.9.25/lib/yard/config.rb +270 -0
  221. data/gems/yard-0.9.25/lib/yard/core_ext/array.rb +16 -0
  222. data/gems/yard-0.9.25/lib/yard/core_ext/file.rb +69 -0
  223. data/gems/yard-0.9.25/lib/yard/core_ext/hash.rb +16 -0
  224. data/gems/yard-0.9.25/lib/yard/core_ext/insertion.rb +63 -0
  225. data/gems/yard-0.9.25/lib/yard/core_ext/module.rb +11 -0
  226. data/gems/yard-0.9.25/lib/yard/core_ext/string.rb +68 -0
  227. data/gems/yard-0.9.25/lib/yard/core_ext/symbol_hash.rb +75 -0
  228. data/gems/yard-0.9.25/lib/yard/docstring.rb +386 -0
  229. data/gems/yard-0.9.25/lib/yard/docstring_parser.rb +345 -0
  230. data/gems/yard-0.9.25/lib/yard/gem_index.rb +29 -0
  231. data/gems/yard-0.9.25/lib/yard/globals.rb +22 -0
  232. data/gems/yard-0.9.25/lib/yard/handlers/base.rb +595 -0
  233. data/gems/yard-0.9.25/lib/yard/handlers/c/alias_handler.rb +16 -0
  234. data/gems/yard-0.9.25/lib/yard/handlers/c/attribute_handler.rb +13 -0
  235. data/gems/yard-0.9.25/lib/yard/handlers/c/base.rb +164 -0
  236. data/gems/yard-0.9.25/lib/yard/handlers/c/class_handler.rb +27 -0
  237. data/gems/yard-0.9.25/lib/yard/handlers/c/constant_handler.rb +13 -0
  238. data/gems/yard-0.9.25/lib/yard/handlers/c/handler_methods.rb +212 -0
  239. data/gems/yard-0.9.25/lib/yard/handlers/c/init_handler.rb +20 -0
  240. data/gems/yard-0.9.25/lib/yard/handlers/c/method_handler.rb +45 -0
  241. data/gems/yard-0.9.25/lib/yard/handlers/c/mixin_handler.rb +21 -0
  242. data/gems/yard-0.9.25/lib/yard/handlers/c/module_handler.rb +17 -0
  243. data/gems/yard-0.9.25/lib/yard/handlers/c/override_comment_handler.rb +31 -0
  244. data/gems/yard-0.9.25/lib/yard/handlers/c/path_handler.rb +11 -0
  245. data/gems/yard-0.9.25/lib/yard/handlers/c/struct_handler.rb +13 -0
  246. data/gems/yard-0.9.25/lib/yard/handlers/c/symbol_handler.rb +8 -0
  247. data/gems/yard-0.9.25/lib/yard/handlers/common/method_handler.rb +19 -0
  248. data/gems/yard-0.9.25/lib/yard/handlers/processor.rb +200 -0
  249. data/gems/yard-0.9.25/lib/yard/handlers/ruby/alias_handler.rb +45 -0
  250. data/gems/yard-0.9.25/lib/yard/handlers/ruby/attribute_handler.rb +87 -0
  251. data/gems/yard-0.9.25/lib/yard/handlers/ruby/base.rb +165 -0
  252. data/gems/yard-0.9.25/lib/yard/handlers/ruby/class_condition_handler.rb +92 -0
  253. data/gems/yard-0.9.25/lib/yard/handlers/ruby/class_handler.rb +119 -0
  254. data/gems/yard-0.9.25/lib/yard/handlers/ruby/class_variable_handler.rb +17 -0
  255. data/gems/yard-0.9.25/lib/yard/handlers/ruby/comment_handler.rb +10 -0
  256. data/gems/yard-0.9.25/lib/yard/handlers/ruby/constant_handler.rb +55 -0
  257. data/gems/yard-0.9.25/lib/yard/handlers/ruby/decorator_handler_methods.rb +123 -0
  258. data/gems/yard-0.9.25/lib/yard/handlers/ruby/dsl_handler.rb +15 -0
  259. data/gems/yard-0.9.25/lib/yard/handlers/ruby/dsl_handler_methods.rb +96 -0
  260. data/gems/yard-0.9.25/lib/yard/handlers/ruby/exception_handler.rb +27 -0
  261. data/gems/yard-0.9.25/lib/yard/handlers/ruby/extend_handler.rb +22 -0
  262. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/alias_handler.rb +37 -0
  263. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/attribute_handler.rb +65 -0
  264. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/base.rb +245 -0
  265. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/class_condition_handler.rb +83 -0
  266. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/class_handler.rb +113 -0
  267. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/class_variable_handler.rb +15 -0
  268. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/comment_handler.rb +10 -0
  269. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/constant_handler.rb +29 -0
  270. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/dsl_handler.rb +17 -0
  271. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/exception_handler.rb +13 -0
  272. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/extend_handler.rb +21 -0
  273. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/method_handler.rb +90 -0
  274. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/mixin_handler.rb +39 -0
  275. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/module_function_handler.rb +19 -0
  276. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/module_handler.rb +12 -0
  277. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/private_class_method_handler.rb +22 -0
  278. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/private_constant_handler.rb +22 -0
  279. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/visibility_handler.rb +17 -0
  280. data/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/yield_handler.rb +29 -0
  281. data/gems/yard-0.9.25/lib/yard/handlers/ruby/method_condition_handler.rb +9 -0
  282. data/gems/yard-0.9.25/lib/yard/handlers/ruby/method_handler.rb +104 -0
  283. data/gems/yard-0.9.25/lib/yard/handlers/ruby/mixin_handler.rb +49 -0
  284. data/gems/yard-0.9.25/lib/yard/handlers/ruby/module_function_handler.rb +27 -0
  285. data/gems/yard-0.9.25/lib/yard/handlers/ruby/module_handler.rb +12 -0
  286. data/gems/yard-0.9.25/lib/yard/handlers/ruby/private_class_method_handler.rb +14 -0
  287. data/gems/yard-0.9.25/lib/yard/handlers/ruby/private_constant_handler.rb +43 -0
  288. data/gems/yard-0.9.25/lib/yard/handlers/ruby/public_class_method_handler.rb +14 -0
  289. data/gems/yard-0.9.25/lib/yard/handlers/ruby/struct_handler_methods.rb +143 -0
  290. data/gems/yard-0.9.25/lib/yard/handlers/ruby/visibility_handler.rb +22 -0
  291. data/gems/yard-0.9.25/lib/yard/handlers/ruby/yield_handler.rb +31 -0
  292. data/gems/yard-0.9.25/lib/yard/i18n/locale.rb +67 -0
  293. data/gems/yard-0.9.25/lib/yard/i18n/message.rb +57 -0
  294. data/gems/yard-0.9.25/lib/yard/i18n/messages.rb +56 -0
  295. data/gems/yard-0.9.25/lib/yard/i18n/po_parser.rb +61 -0
  296. data/gems/yard-0.9.25/lib/yard/i18n/pot_generator.rb +290 -0
  297. data/gems/yard-0.9.25/lib/yard/i18n/text.rb +173 -0
  298. data/gems/yard-0.9.25/lib/yard/logging.rb +205 -0
  299. data/gems/yard-0.9.25/lib/yard/options.rb +217 -0
  300. data/gems/yard-0.9.25/lib/yard/parser/base.rb +57 -0
  301. data/gems/yard-0.9.25/lib/yard/parser/c/c_parser.rb +235 -0
  302. data/gems/yard-0.9.25/lib/yard/parser/c/comment_parser.rb +134 -0
  303. data/gems/yard-0.9.25/lib/yard/parser/c/statement.rb +66 -0
  304. data/gems/yard-0.9.25/lib/yard/parser/ruby/ast_node.rb +551 -0
  305. data/gems/yard-0.9.25/lib/yard/parser/ruby/legacy/irb/slex.rb +276 -0
  306. data/gems/yard-0.9.25/lib/yard/parser/ruby/legacy/ruby_lex.rb +1345 -0
  307. data/gems/yard-0.9.25/lib/yard/parser/ruby/legacy/ruby_parser.rb +32 -0
  308. data/gems/yard-0.9.25/lib/yard/parser/ruby/legacy/statement.rb +68 -0
  309. data/gems/yard-0.9.25/lib/yard/parser/ruby/legacy/statement_list.rb +394 -0
  310. data/gems/yard-0.9.25/lib/yard/parser/ruby/legacy/token_list.rb +74 -0
  311. data/gems/yard-0.9.25/lib/yard/parser/ruby/ruby_parser.rb +701 -0
  312. data/gems/yard-0.9.25/lib/yard/parser/ruby/token_resolver.rb +158 -0
  313. data/gems/yard-0.9.25/lib/yard/parser/source_parser.rb +526 -0
  314. data/gems/yard-0.9.25/lib/yard/rake/yardoc_task.rb +81 -0
  315. data/gems/yard-0.9.25/lib/yard/registry.rb +439 -0
  316. data/gems/yard-0.9.25/lib/yard/registry_resolver.rb +217 -0
  317. data/gems/yard-0.9.25/lib/yard/registry_store.rb +342 -0
  318. data/gems/yard-0.9.25/lib/yard/rubygems/backports/LICENSE.txt +57 -0
  319. data/gems/yard-0.9.25/lib/yard/rubygems/backports/MIT.txt +20 -0
  320. data/gems/yard-0.9.25/lib/yard/rubygems/backports/gem.rb +10 -0
  321. data/gems/yard-0.9.25/lib/yard/rubygems/backports/source_index.rb +365 -0
  322. data/gems/yard-0.9.25/lib/yard/rubygems/backports.rb +10 -0
  323. data/gems/yard-0.9.25/lib/yard/rubygems/doc_manager.rb +90 -0
  324. data/gems/yard-0.9.25/lib/yard/rubygems/hook.rb +197 -0
  325. data/gems/yard-0.9.25/lib/yard/rubygems/specification.rb +50 -0
  326. data/gems/yard-0.9.25/lib/yard/serializers/base.rb +83 -0
  327. data/gems/yard-0.9.25/lib/yard/serializers/file_system_serializer.rb +123 -0
  328. data/gems/yard-0.9.25/lib/yard/serializers/process_serializer.rb +24 -0
  329. data/gems/yard-0.9.25/lib/yard/serializers/stdout_serializer.rb +34 -0
  330. data/gems/yard-0.9.25/lib/yard/serializers/yardoc_serializer.rb +152 -0
  331. data/gems/yard-0.9.25/lib/yard/server/adapter.rb +100 -0
  332. data/gems/yard-0.9.25/lib/yard/server/commands/base.rb +209 -0
  333. data/gems/yard-0.9.25/lib/yard/server/commands/display_file_command.rb +29 -0
  334. data/gems/yard-0.9.25/lib/yard/server/commands/display_object_command.rb +65 -0
  335. data/gems/yard-0.9.25/lib/yard/server/commands/frames_command.rb +16 -0
  336. data/gems/yard-0.9.25/lib/yard/server/commands/library_command.rb +187 -0
  337. data/gems/yard-0.9.25/lib/yard/server/commands/library_index_command.rb +28 -0
  338. data/gems/yard-0.9.25/lib/yard/server/commands/list_command.rb +25 -0
  339. data/gems/yard-0.9.25/lib/yard/server/commands/root_request_command.rb +15 -0
  340. data/gems/yard-0.9.25/lib/yard/server/commands/search_command.rb +79 -0
  341. data/gems/yard-0.9.25/lib/yard/server/commands/static_file_command.rb +23 -0
  342. data/gems/yard-0.9.25/lib/yard/server/commands/static_file_helpers.rb +61 -0
  343. data/gems/yard-0.9.25/lib/yard/server/doc_server_helper.rb +91 -0
  344. data/gems/yard-0.9.25/lib/yard/server/doc_server_serializer.rb +39 -0
  345. data/gems/yard-0.9.25/lib/yard/server/library_version.rb +277 -0
  346. data/gems/yard-0.9.25/lib/yard/server/rack_adapter.rb +89 -0
  347. data/gems/yard-0.9.25/lib/yard/server/router.rb +187 -0
  348. data/gems/yard-0.9.25/lib/yard/server/static_caching.rb +46 -0
  349. data/gems/yard-0.9.25/lib/yard/server/templates/default/fulldoc/html/css/custom.css +127 -0
  350. data/gems/yard-0.9.25/lib/yard/server/templates/default/fulldoc/html/images/processing.gif +0 -0
  351. data/gems/yard-0.9.25/lib/yard/server/templates/default/fulldoc/html/js/autocomplete.js +12 -0
  352. data/gems/yard-0.9.25/lib/yard/server/templates/default/layout/html/breadcrumb.erb +37 -0
  353. data/gems/yard-0.9.25/lib/yard/server/templates/default/layout/html/script_setup.erb +7 -0
  354. data/gems/yard-0.9.25/lib/yard/server/templates/default/layout/html/setup.rb +8 -0
  355. data/gems/yard-0.9.25/lib/yard/server/templates/default/method_details/html/permalink.erb +4 -0
  356. data/gems/yard-0.9.25/lib/yard/server/templates/default/method_details/html/setup.rb +5 -0
  357. data/gems/yard-0.9.25/lib/yard/server/templates/doc_server/library_list/html/headers.erb +8 -0
  358. data/gems/yard-0.9.25/lib/yard/server/templates/doc_server/library_list/html/library_list.erb +14 -0
  359. data/gems/yard-0.9.25/lib/yard/server/templates/doc_server/library_list/html/listing.erb +13 -0
  360. data/gems/yard-0.9.25/lib/yard/server/templates/doc_server/library_list/html/setup.rb +6 -0
  361. data/gems/yard-0.9.25/lib/yard/server/templates/doc_server/library_list/html/title.erb +2 -0
  362. data/gems/yard-0.9.25/lib/yard/server/templates/doc_server/processing/html/processing.erb +52 -0
  363. data/gems/yard-0.9.25/lib/yard/server/templates/doc_server/processing/html/setup.rb +4 -0
  364. data/gems/yard-0.9.25/lib/yard/server/templates/doc_server/search/html/search.erb +18 -0
  365. data/gems/yard-0.9.25/lib/yard/server/templates/doc_server/search/html/setup.rb +9 -0
  366. data/gems/yard-0.9.25/lib/yard/server/webrick_adapter.rb +45 -0
  367. data/gems/yard-0.9.25/lib/yard/server.rb +13 -0
  368. data/gems/yard-0.9.25/lib/yard/tags/default_factory.rb +191 -0
  369. data/gems/yard-0.9.25/lib/yard/tags/default_tag.rb +13 -0
  370. data/gems/yard-0.9.25/lib/yard/tags/directives.rb +616 -0
  371. data/gems/yard-0.9.25/lib/yard/tags/library.rb +633 -0
  372. data/gems/yard-0.9.25/lib/yard/tags/option_tag.rb +13 -0
  373. data/gems/yard-0.9.25/lib/yard/tags/overload_tag.rb +71 -0
  374. data/gems/yard-0.9.25/lib/yard/tags/ref_tag.rb +8 -0
  375. data/gems/yard-0.9.25/lib/yard/tags/ref_tag_list.rb +28 -0
  376. data/gems/yard-0.9.25/lib/yard/tags/tag.rb +71 -0
  377. data/gems/yard-0.9.25/lib/yard/tags/tag_format_error.rb +7 -0
  378. data/gems/yard-0.9.25/lib/yard/tags/types_explainer.rb +162 -0
  379. data/gems/yard-0.9.25/lib/yard/templates/engine.rb +186 -0
  380. data/gems/yard-0.9.25/lib/yard/templates/erb_cache.rb +23 -0
  381. data/gems/yard-0.9.25/lib/yard/templates/helpers/base_helper.rb +215 -0
  382. data/gems/yard-0.9.25/lib/yard/templates/helpers/filter_helper.rb +27 -0
  383. data/gems/yard-0.9.25/lib/yard/templates/helpers/html_helper.rb +670 -0
  384. data/gems/yard-0.9.25/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +78 -0
  385. data/gems/yard-0.9.25/lib/yard/templates/helpers/markup/rdoc_markdown.rb +23 -0
  386. data/gems/yard-0.9.25/lib/yard/templates/helpers/markup/rdoc_markup.rb +110 -0
  387. data/gems/yard-0.9.25/lib/yard/templates/helpers/markup_helper.rb +172 -0
  388. data/gems/yard-0.9.25/lib/yard/templates/helpers/method_helper.rb +75 -0
  389. data/gems/yard-0.9.25/lib/yard/templates/helpers/module_helper.rb +21 -0
  390. data/gems/yard-0.9.25/lib/yard/templates/helpers/text_helper.rb +112 -0
  391. data/gems/yard-0.9.25/lib/yard/templates/helpers/uml_helper.rb +47 -0
  392. data/gems/yard-0.9.25/lib/yard/templates/section.rb +105 -0
  393. data/gems/yard-0.9.25/lib/yard/templates/template.rb +418 -0
  394. data/gems/yard-0.9.25/lib/yard/templates/template_options.rb +92 -0
  395. data/gems/yard-0.9.25/lib/yard/verifier.rb +151 -0
  396. data/gems/yard-0.9.25/lib/yard/version.rb +6 -0
  397. data/gems/yard-0.9.25/lib/yard.rb +69 -0
  398. data/gems/yard-0.9.25/po/ja.po +31108 -0
  399. data/gems/yard-0.9.25/samus.json +80 -0
  400. data/gems/yard-0.9.25/tasks/update_error_map.rake +53 -0
  401. data/gems/yard-0.9.25/templates/default/class/dot/setup.rb +7 -0
  402. data/gems/yard-0.9.25/templates/default/class/dot/superklass.erb +3 -0
  403. data/gems/yard-0.9.25/templates/default/class/html/constructor_details.erb +8 -0
  404. data/gems/yard-0.9.25/templates/default/class/html/setup.rb +2 -0
  405. data/gems/yard-0.9.25/templates/default/class/html/subclasses.erb +4 -0
  406. data/gems/yard-0.9.25/templates/default/class/setup.rb +36 -0
  407. data/gems/yard-0.9.25/templates/default/class/text/setup.rb +12 -0
  408. data/gems/yard-0.9.25/templates/default/class/text/subclasses.erb +5 -0
  409. data/gems/yard-0.9.25/templates/default/constant/text/header.erb +11 -0
  410. data/gems/yard-0.9.25/templates/default/constant/text/setup.rb +4 -0
  411. data/gems/yard-0.9.25/templates/default/docstring/html/abstract.erb +4 -0
  412. data/gems/yard-0.9.25/templates/default/docstring/html/deprecated.erb +1 -0
  413. data/gems/yard-0.9.25/templates/default/docstring/html/index.erb +5 -0
  414. data/gems/yard-0.9.25/templates/default/docstring/html/note.erb +6 -0
  415. data/gems/yard-0.9.25/templates/default/docstring/html/private.erb +4 -0
  416. data/gems/yard-0.9.25/templates/default/docstring/html/returns_void.erb +1 -0
  417. data/gems/yard-0.9.25/templates/default/docstring/html/text.erb +1 -0
  418. data/gems/yard-0.9.25/templates/default/docstring/html/todo.erb +6 -0
  419. data/gems/yard-0.9.25/templates/default/docstring/setup.rb +52 -0
  420. data/gems/yard-0.9.25/templates/default/docstring/text/abstract.erb +2 -0
  421. data/gems/yard-0.9.25/templates/default/docstring/text/deprecated.erb +2 -0
  422. data/gems/yard-0.9.25/templates/default/docstring/text/index.erb +2 -0
  423. data/gems/yard-0.9.25/templates/default/docstring/text/note.erb +4 -0
  424. data/gems/yard-0.9.25/templates/default/docstring/text/private.erb +2 -0
  425. data/gems/yard-0.9.25/templates/default/docstring/text/returns_void.erb +1 -0
  426. data/gems/yard-0.9.25/templates/default/docstring/text/text.erb +1 -0
  427. data/gems/yard-0.9.25/templates/default/docstring/text/todo.erb +4 -0
  428. data/gems/yard-0.9.25/templates/default/fulldoc/html/css/common.css +1 -0
  429. data/gems/yard-0.9.25/templates/default/fulldoc/html/css/full_list.css +58 -0
  430. data/gems/yard-0.9.25/templates/default/fulldoc/html/css/style.css +496 -0
  431. data/gems/yard-0.9.25/templates/default/fulldoc/html/frames.erb +17 -0
  432. data/gems/yard-0.9.25/templates/default/fulldoc/html/full_list.erb +37 -0
  433. data/gems/yard-0.9.25/templates/default/fulldoc/html/full_list_class.erb +2 -0
  434. data/gems/yard-0.9.25/templates/default/fulldoc/html/full_list_file.erb +7 -0
  435. data/gems/yard-0.9.25/templates/default/fulldoc/html/full_list_method.erb +10 -0
  436. data/gems/yard-0.9.25/templates/default/fulldoc/html/js/app.js +314 -0
  437. data/gems/yard-0.9.25/templates/default/fulldoc/html/js/full_list.js +216 -0
  438. data/gems/yard-0.9.25/templates/default/fulldoc/html/js/jquery.js +4 -0
  439. data/gems/yard-0.9.25/templates/default/fulldoc/html/setup.rb +241 -0
  440. data/gems/yard-0.9.25/templates/default/layout/dot/header.erb +6 -0
  441. data/gems/yard-0.9.25/templates/default/layout/dot/setup.rb +15 -0
  442. data/gems/yard-0.9.25/templates/default/layout/html/breadcrumb.erb +11 -0
  443. data/gems/yard-0.9.25/templates/default/layout/html/files.erb +11 -0
  444. data/gems/yard-0.9.25/templates/default/layout/html/footer.erb +5 -0
  445. data/gems/yard-0.9.25/templates/default/layout/html/headers.erb +15 -0
  446. data/gems/yard-0.9.25/templates/default/layout/html/index.erb +2 -0
  447. data/gems/yard-0.9.25/templates/default/layout/html/layout.erb +24 -0
  448. data/gems/yard-0.9.25/templates/default/layout/html/listing.erb +4 -0
  449. data/gems/yard-0.9.25/templates/default/layout/html/objects.erb +32 -0
  450. data/gems/yard-0.9.25/templates/default/layout/html/script_setup.erb +4 -0
  451. data/gems/yard-0.9.25/templates/default/layout/html/search.erb +13 -0
  452. data/gems/yard-0.9.25/templates/default/layout/html/setup.rb +89 -0
  453. data/gems/yard-0.9.25/templates/default/method/html/header.erb +17 -0
  454. data/gems/yard-0.9.25/templates/default/method/setup.rb +4 -0
  455. data/gems/yard-0.9.25/templates/default/method/text/header.erb +1 -0
  456. data/gems/yard-0.9.25/templates/default/method_details/html/header.erb +3 -0
  457. data/gems/yard-0.9.25/templates/default/method_details/html/method_signature.erb +25 -0
  458. data/gems/yard-0.9.25/templates/default/method_details/html/source.erb +10 -0
  459. data/gems/yard-0.9.25/templates/default/method_details/setup.rb +11 -0
  460. data/gems/yard-0.9.25/templates/default/method_details/text/header.erb +10 -0
  461. data/gems/yard-0.9.25/templates/default/method_details/text/method_signature.erb +12 -0
  462. data/gems/yard-0.9.25/templates/default/method_details/text/setup.rb +11 -0
  463. data/gems/yard-0.9.25/templates/default/module/dot/child.erb +1 -0
  464. data/gems/yard-0.9.25/templates/default/module/dot/dependencies.erb +3 -0
  465. data/gems/yard-0.9.25/templates/default/module/dot/header.erb +6 -0
  466. data/gems/yard-0.9.25/templates/default/module/dot/info.erb +14 -0
  467. data/gems/yard-0.9.25/templates/default/module/dot/setup.rb +15 -0
  468. data/gems/yard-0.9.25/templates/default/module/html/attribute_details.erb +10 -0
  469. data/gems/yard-0.9.25/templates/default/module/html/attribute_summary.erb +8 -0
  470. data/gems/yard-0.9.25/templates/default/module/html/box_info.erb +43 -0
  471. data/gems/yard-0.9.25/templates/default/module/html/children.erb +8 -0
  472. data/gems/yard-0.9.25/templates/default/module/html/constant_summary.erb +17 -0
  473. data/gems/yard-0.9.25/templates/default/module/html/defines.erb +3 -0
  474. data/gems/yard-0.9.25/templates/default/module/html/header.erb +5 -0
  475. data/gems/yard-0.9.25/templates/default/module/html/inherited_attributes.erb +14 -0
  476. data/gems/yard-0.9.25/templates/default/module/html/inherited_constants.erb +8 -0
  477. data/gems/yard-0.9.25/templates/default/module/html/inherited_methods.erb +19 -0
  478. data/gems/yard-0.9.25/templates/default/module/html/item_summary.erb +40 -0
  479. data/gems/yard-0.9.25/templates/default/module/html/method_details_list.erb +9 -0
  480. data/gems/yard-0.9.25/templates/default/module/html/method_summary.erb +14 -0
  481. data/gems/yard-0.9.25/templates/default/module/html/methodmissing.erb +12 -0
  482. data/gems/yard-0.9.25/templates/default/module/html/pre_docstring.erb +1 -0
  483. data/gems/yard-0.9.25/templates/default/module/setup.rb +167 -0
  484. data/gems/yard-0.9.25/templates/default/module/text/children.erb +10 -0
  485. data/gems/yard-0.9.25/templates/default/module/text/class_meths_list.erb +8 -0
  486. data/gems/yard-0.9.25/templates/default/module/text/extends.erb +8 -0
  487. data/gems/yard-0.9.25/templates/default/module/text/header.erb +7 -0
  488. data/gems/yard-0.9.25/templates/default/module/text/includes.erb +8 -0
  489. data/gems/yard-0.9.25/templates/default/module/text/instance_meths_list.erb +8 -0
  490. data/gems/yard-0.9.25/templates/default/module/text/setup.rb +13 -0
  491. data/gems/yard-0.9.25/templates/default/onefile/html/files.erb +5 -0
  492. data/gems/yard-0.9.25/templates/default/onefile/html/headers.erb +6 -0
  493. data/gems/yard-0.9.25/templates/default/onefile/html/layout.erb +17 -0
  494. data/gems/yard-0.9.25/templates/default/onefile/html/readme.erb +3 -0
  495. data/gems/yard-0.9.25/templates/default/onefile/html/setup.rb +62 -0
  496. data/gems/yard-0.9.25/templates/default/root/dot/child.erb +3 -0
  497. data/gems/yard-0.9.25/templates/default/root/dot/setup.rb +6 -0
  498. data/gems/yard-0.9.25/templates/default/root/html/setup.rb +2 -0
  499. data/gems/yard-0.9.25/templates/default/tags/html/example.erb +11 -0
  500. data/gems/yard-0.9.25/templates/default/tags/html/index.erb +3 -0
  501. data/gems/yard-0.9.25/templates/default/tags/html/option.erb +24 -0
  502. data/gems/yard-0.9.25/templates/default/tags/html/overload.erb +14 -0
  503. data/gems/yard-0.9.25/templates/default/tags/html/see.erb +8 -0
  504. data/gems/yard-0.9.25/templates/default/tags/html/tag.erb +20 -0
  505. data/gems/yard-0.9.25/templates/default/tags/setup.rb +57 -0
  506. data/gems/yard-0.9.25/templates/default/tags/text/example.erb +12 -0
  507. data/gems/yard-0.9.25/templates/default/tags/text/index.erb +1 -0
  508. data/gems/yard-0.9.25/templates/default/tags/text/option.erb +20 -0
  509. data/gems/yard-0.9.25/templates/default/tags/text/overload.erb +19 -0
  510. data/gems/yard-0.9.25/templates/default/tags/text/see.erb +11 -0
  511. data/gems/yard-0.9.25/templates/default/tags/text/tag.erb +13 -0
  512. data/gems/yard-0.9.25/templates/guide/class/html/setup.rb +2 -0
  513. data/gems/yard-0.9.25/templates/guide/docstring/html/setup.rb +2 -0
  514. data/gems/yard-0.9.25/templates/guide/fulldoc/html/css/style.css +108 -0
  515. data/gems/yard-0.9.25/templates/guide/fulldoc/html/js/app.js +33 -0
  516. data/gems/yard-0.9.25/templates/guide/fulldoc/html/setup.rb +74 -0
  517. data/gems/yard-0.9.25/templates/guide/layout/html/layout.erb +81 -0
  518. data/gems/yard-0.9.25/templates/guide/layout/html/setup.rb +25 -0
  519. data/gems/yard-0.9.25/templates/guide/method/html/header.erb +18 -0
  520. data/gems/yard-0.9.25/templates/guide/method/html/setup.rb +22 -0
  521. data/gems/yard-0.9.25/templates/guide/module/html/header.erb +7 -0
  522. data/gems/yard-0.9.25/templates/guide/module/html/method_list.erb +5 -0
  523. data/gems/yard-0.9.25/templates/guide/module/html/setup.rb +27 -0
  524. data/gems/yard-0.9.25/templates/guide/onefile/html/files.erb +4 -0
  525. data/gems/yard-0.9.25/templates/guide/onefile/html/setup.rb +6 -0
  526. data/gems/yard-0.9.25/templates/guide/onefile/html/toc.erb +3 -0
  527. data/gems/yard-0.9.25/templates/guide/tags/html/setup.rb +9 -0
  528. data/gems/yard-0.9.25/yard.gemspec +24 -0
  529. data/kinetic_sdk.gemspec +3 -7
  530. data/lib/kinetic_sdk/core/lib/form.rb +55 -0
  531. data/lib/kinetic_sdk/core/lib/kapp.rb +52 -0
  532. data/lib/kinetic_sdk/core/lib/space.rb +51 -0
  533. data/lib/kinetic_sdk/task/lib/export.rb +22 -2
  534. data/lib/kinetic_sdk/task/lib/trees.rb +11 -0
  535. data/lib/kinetic_sdk/version.rb +1 -1
  536. data/lib/kinetic_sdk.rb +2 -22
  537. metadata +551 -229
  538. data/gems/kontena-websocket-client-0.1.1/Gemfile +0 -4
  539. data/gems/kontena-websocket-client-0.1.1/LICENSE +0 -190
  540. data/gems/kontena-websocket-client-0.1.1/README.md +0 -138
  541. data/gems/kontena-websocket-client-0.1.1/Rakefile +0 -6
  542. data/gems/kontena-websocket-client-0.1.1/benchmark/benchmark-client.rb +0 -45
  543. data/gems/kontena-websocket-client-0.1.1/benchmark/benchmark-em.rb +0 -66
  544. data/gems/kontena-websocket-client-0.1.1/benchmark/benchmark.rb +0 -161
  545. data/gems/kontena-websocket-client-0.1.1/benchmark/benchmark.sh +0 -17
  546. data/gems/kontena-websocket-client-0.1.1/benchmark/websocket-echo-server.go +0 -207
  547. data/gems/kontena-websocket-client-0.1.1/examples/websocket-echo-client.rb +0 -80
  548. data/gems/kontena-websocket-client-0.1.1/kontena-websocket-client.gemspec +0 -24
  549. data/gems/kontena-websocket-client-0.1.1/lib/kontena/websocket/client/connection.rb +0 -119
  550. data/gems/kontena-websocket-client-0.1.1/lib/kontena/websocket/client/version.rb +0 -13
  551. data/gems/kontena-websocket-client-0.1.1/lib/kontena/websocket/client.rb +0 -848
  552. data/gems/kontena-websocket-client-0.1.1/lib/kontena/websocket/error.rb +0 -81
  553. data/gems/kontena-websocket-client-0.1.1/lib/kontena/websocket/logging.rb +0 -55
  554. data/gems/kontena-websocket-client-0.1.1/lib/kontena/websocket/openssl_patch.rb +0 -10
  555. data/gems/kontena-websocket-client-0.1.1/lib/kontena-websocket-client.rb +0 -15
  556. data/gems/mime-types-3.1/Contributing.rdoc +0 -130
  557. data/gems/mime-types-3.1/History.rdoc +0 -658
  558. data/gems/mime-types-3.1/Rakefile +0 -254
  559. data/gems/mime-types-3.1/lib/mime/types/columnar.rb +0 -1
  560. data/gems/mime-types-3.1/lib/mime/types/container.rb +0 -30
  561. data/gems/mime-types-3.1/lib/mime-types.rb +0 -1
  562. data/gems/mime-types-3.1/test/minitest_helper.rb +0 -13
  563. data/gems/mime-types-3.1/test/test_mime_type.rb +0 -603
  564. data/gems/mime-types-3.1/test/test_mime_types.rb +0 -161
  565. data/gems/mime-types-3.1/test/test_mime_types_cache.rb +0 -109
  566. data/gems/mime-types-3.1/test/test_mime_types_class.rb +0 -155
  567. data/gems/mime-types-3.1/test/test_mime_types_lazy.rb +0 -43
  568. data/gems/mime-types-3.1/test/test_mime_types_loader.rb +0 -32
  569. data/gems/mime-types-data-3.2016.0521/Contributing.md +0 -157
  570. data/gems/mime-types-data-3.2016.0521/History.md +0 -351
  571. data/gems/mime-types-data-3.2016.0521/Licence.md +0 -25
  572. data/gems/mime-types-data-3.2016.0521/README.md +0 -61
  573. data/gems/mime-types-data-3.2016.0521/Rakefile +0 -80
  574. data/gems/mime-types-data-3.2016.0521/data/mime-types.json +0 -1
  575. data/gems/mime-types-data-3.2016.0521/data/mime.flags.column +0 -1964
  576. data/gems/parallel-1.12.1/lib/parallel/processor_count.rb +0 -93
  577. data/gems/parallel-1.12.1/lib/parallel/version.rb +0 -3
  578. data/gems/parallel-1.12.1/lib/parallel.rb +0 -500
  579. data/gems/ruby-progressbar-1.9.0/LICENSE.txt +0 -19
  580. data/gems/ruby-progressbar-1.9.0/README.md +0 -38
  581. data/gems/ruby-progressbar-1.9.0/Rakefile +0 -2
  582. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/base.rb +0 -183
  583. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/calculators/length.rb +0 -99
  584. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/calculators/running_average.rb +0 -9
  585. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/components/bar.rb +0 -96
  586. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/components/percentage.rb +0 -29
  587. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/components/rate.rb +0 -43
  588. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/components/time.rb +0 -107
  589. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/components/title.rb +0 -13
  590. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/components.rb +0 -5
  591. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/errors/invalid_progress_error.rb +0 -4
  592. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/format/formatter.rb +0 -27
  593. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/format/molecule.rb +0 -59
  594. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/format/string.rb +0 -36
  595. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/format.rb +0 -3
  596. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/output.rb +0 -68
  597. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/outputs/non_tty.rb +0 -47
  598. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/outputs/null.rb +0 -33
  599. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/outputs/tty.rb +0 -32
  600. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/progress.rb +0 -118
  601. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/refinements/enumerator.rb +0 -25
  602. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/refinements.rb +0 -1
  603. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/throttle.rb +0 -25
  604. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/time.rb +0 -30
  605. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/timer.rb +0 -72
  606. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar/version.rb +0 -3
  607. data/gems/ruby-progressbar-1.9.0/lib/ruby-progressbar.rb +0 -18
  608. data/gems/websocket-driver-0.6.5/CHANGELOG.md +0 -123
  609. data/gems/websocket-driver-0.6.5/LICENSE.md +0 -22
  610. data/gems/websocket-driver-0.6.5/README.md +0 -369
  611. data/gems/websocket-driver-0.6.5/examples/tcp_server.rb +0 -28
  612. data/gems/websocket-driver-0.6.5/ext/websocket-driver/Makefile +0 -264
  613. data/gems/websocket-driver-0.6.5/ext/websocket-driver/WebsocketMaskService.java +0 -55
  614. data/gems/websocket-driver-0.6.5/ext/websocket-driver/extconf.rb +0 -4
  615. data/gems/websocket-driver-0.6.5/ext/websocket-driver/websocket_mask.bundle +0 -0
  616. data/gems/websocket-driver-0.6.5/ext/websocket-driver/websocket_mask.c +0 -41
  617. data/gems/websocket-driver-0.6.5/ext/websocket-driver/websocket_mask.o +0 -0
  618. data/gems/websocket-driver-0.6.5/lib/websocket/driver/client.rb +0 -140
  619. data/gems/websocket-driver-0.6.5/lib/websocket/driver/draft75.rb +0 -102
  620. data/gems/websocket-driver-0.6.5/lib/websocket/driver/draft76.rb +0 -96
  621. data/gems/websocket-driver-0.6.5/lib/websocket/driver/event_emitter.rb +0 -54
  622. data/gems/websocket-driver-0.6.5/lib/websocket/driver/headers.rb +0 -45
  623. data/gems/websocket-driver-0.6.5/lib/websocket/driver/hybi/frame.rb +0 -20
  624. data/gems/websocket-driver-0.6.5/lib/websocket/driver/hybi/message.rb +0 -31
  625. data/gems/websocket-driver-0.6.5/lib/websocket/driver/hybi.rb +0 -406
  626. data/gems/websocket-driver-0.6.5/lib/websocket/driver/proxy.rb +0 -68
  627. data/gems/websocket-driver-0.6.5/lib/websocket/driver/server.rb +0 -80
  628. data/gems/websocket-driver-0.6.5/lib/websocket/driver/stream_reader.rb +0 -55
  629. data/gems/websocket-driver-0.6.5/lib/websocket/driver.rb +0 -199
  630. data/gems/websocket-driver-0.6.5/lib/websocket/http/headers.rb +0 -112
  631. data/gems/websocket-driver-0.6.5/lib/websocket/http/request.rb +0 -45
  632. data/gems/websocket-driver-0.6.5/lib/websocket/http/response.rb +0 -29
  633. data/gems/websocket-driver-0.6.5/lib/websocket/http.rb +0 -15
  634. data/gems/websocket-driver-0.6.5/lib/websocket/mask.rb +0 -14
  635. data/gems/websocket-driver-0.6.5/lib/websocket/websocket_mask.rb +0 -2
  636. data/gems/websocket-driver-0.6.5/lib/websocket_mask.bundle +0 -0
  637. data/gems/websocket-driver-0.6.5-java/CHANGELOG.md +0 -123
  638. data/gems/websocket-driver-0.6.5-java/README.md +0 -369
  639. data/gems/websocket-driver-0.6.5-java/examples/tcp_server.rb +0 -28
  640. data/gems/websocket-driver-0.6.5-java/ext/websocket-driver/WebsocketMaskService.java +0 -55
  641. data/gems/websocket-driver-0.6.5-java/ext/websocket-driver/extconf.rb +0 -4
  642. data/gems/websocket-driver-0.6.5-java/ext/websocket-driver/websocket_mask.c +0 -41
  643. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/client.rb +0 -140
  644. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/draft75.rb +0 -102
  645. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/draft76.rb +0 -96
  646. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/event_emitter.rb +0 -54
  647. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/headers.rb +0 -45
  648. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/hybi/frame.rb +0 -20
  649. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/hybi/message.rb +0 -31
  650. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/hybi.rb +0 -406
  651. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/proxy.rb +0 -68
  652. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/server.rb +0 -80
  653. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver/stream_reader.rb +0 -55
  654. data/gems/websocket-driver-0.6.5-java/lib/websocket/driver.rb +0 -199
  655. data/gems/websocket-driver-0.6.5-java/lib/websocket/http/headers.rb +0 -112
  656. data/gems/websocket-driver-0.6.5-java/lib/websocket/http/request.rb +0 -45
  657. data/gems/websocket-driver-0.6.5-java/lib/websocket/http/response.rb +0 -29
  658. data/gems/websocket-driver-0.6.5-java/lib/websocket/http.rb +0 -15
  659. data/gems/websocket-driver-0.6.5-java/lib/websocket/mask.rb +0 -14
  660. data/gems/websocket-driver-0.6.5-java/lib/websocket/websocket_mask.rb +0 -2
  661. data/gems/websocket-driver-0.6.5-java/lib/websocket_mask.jar +0 -0
  662. data/gems/websocket-extensions-0.1.3/CHANGELOG.md +0 -15
  663. data/gems/websocket-extensions-0.1.3/LICENSE.md +0 -20
  664. data/gems/websocket-extensions-0.1.3/README.md +0 -313
  665. data/gems/websocket-extensions-0.1.3/lib/websocket/extensions/parser.rb +0 -111
  666. data/gems/websocket-extensions-0.1.3/lib/websocket/extensions.rb +0 -181
  667. data/lib/kinetic_sdk/discussions/lib/websockets.rb +0 -96
@@ -0,0 +1,283 @@
1
+ # @title Tags Overview
2
+
3
+ # Tags Overview
4
+
5
+ Tags represent meta-data as well as behavioural data that can be added to
6
+ documentation through the `@tag` style syntax. As mentioned, there are two
7
+ basic types of tags in YARD, "meta-data tags" and "behavioural tags", the
8
+ latter is more often known as "directives". These two tag types can be
9
+ visually identified by their prefix. Meta-data tags have a `@` prefix,
10
+ while directives have a prefix of `@!` to indicate that the directive
11
+ performs some potentially mutable action on or with the docstring. The
12
+ two tag types would be used in the following way, respectively:
13
+
14
+ # @meta_data_tag some data
15
+ # @!directive_tag some data
16
+ class Foo; end
17
+
18
+ This document describes how tags can be specified, how they affect your
19
+ documentation, and how to use specific built-in tags in YARD, as well
20
+ as how to define custom tags.
21
+
22
+ ## Meta-Data Tags
23
+
24
+ Meta-data tags are useful to add arbitrary meta-data about a documented
25
+ object. These tags simply add data to objects that can be looked up later,
26
+ either programmatically, or displayed in templates. The benefit to describing
27
+ objects using meta-data tags is that your documentation can be organized
28
+ semantically. Rather than having a huge listing of text with no distinction
29
+ of what each paragraph is discussing, tags allow you to focus in on specific
30
+ elements of your documentation.
31
+
32
+ For example, describing parameters of a method can often be important to your
33
+ documentation, but should not be mixed up with the documentation that describes
34
+ what the method itself does. In this case, separating the parameter documentation
35
+ into {tag:param} tags can yield much better organized documentation, both in
36
+ source and in your output, without having to manually format the data using
37
+ standard markup.
38
+
39
+ All of this meta-data can be easily parsed by tools and used both in your templates
40
+ as well as in code checker tools. An example of how you can leverage tags
41
+ programmatically is shown in the {tag:todo} tag, which lists a small snippet of
42
+ Ruby code that can list all of your TODO items, if they are properly tagged.
43
+
44
+ Custom meta-data tags can be added either programmatically or via the YARD
45
+ command-line. This is discussed in the "[Adding Custom Tags](#Adding_Custom_Tags)"
46
+ section.
47
+
48
+ A list of built-in meta-data tags are found below in the [Tag List](#Tag_List).
49
+
50
+ ## Directives
51
+
52
+ Directives are similar to meta-data tags in the way they are specified, but they
53
+ do not add meta-data to the object directly. Instead, they affect the parsing
54
+ context and objects themselves, allowing a developer to create objects
55
+ (like methods) outright, rather than simply add text to an existing object.
56
+ Directives have a `@!` prefix to differentiate these tags from meta-data tags,
57
+ as well as to indicate that the tag may modify or create new objects when
58
+ it is called.
59
+
60
+ A list of built-in directives are found below in the [Directive List](#Directive_List).
61
+
62
+ ## Tag Syntax
63
+
64
+ Tags begin with the `@` or `@!` prefix at the start of a comment line, followed
65
+ immediately by the tag name, and then optional tag data (if the tag requires it).
66
+ Unless otherwise specified by documentation for the tag, all "description" text
67
+ is considered free-form data and can include any arbitrary textual data.
68
+
69
+ ### Multi-line Tags
70
+
71
+ Tags can span multiple lines if the subsequent lines are indented by more than
72
+ one space. The typical convention is to indent subsequent lines by 2 spaces.
73
+ In the following example, `@tagname` will have the text *"This is indented tag data"*:
74
+
75
+ # @tagname This is
76
+ # indented tag data
77
+ # but this is not
78
+
79
+ For most tags, newlines and indented data are not significant and do not impact
80
+ the result of the tag. In other words, you can decide to span a tag onto multiple
81
+ lines at any point by creating an indented block. However, some tags like
82
+ {tag:example}, {tag:overload}, {tag:!macro}, {tag:!method}, and {tag:!attribute}
83
+ rely on the first line for special information about the tag, and you cannot
84
+ split this first line up. For instance, the {tag:example} tag uses the first line
85
+ to indicate the example's title.
86
+
87
+ ### Common Tag Syntaxes
88
+
89
+ Although custom tags can be parsed in any way, the built-in tags follow a few
90
+ common syntax structures by convention in order to simplify the syntax. The
91
+ following syntaxes are available:
92
+
93
+ 1. **Freeform data** — In this case, any amount of textual data is allowed,
94
+ including no data. In some cases, no data is necessary for the tag.
95
+ 2. **Freeform data with a types specifier list** — Mostly freeform data
96
+ beginning with an *optional* types specifier list surrounded in `[brackets]`.
97
+ Note that for extensibility, other bracket types are allowed, such as `<>`,
98
+ `()` and `{}`. The contents of the list are discussed in detail below.
99
+ 3. **Freeform data with a name and types specifier list** &mdash; freeform
100
+ data beginning with an *optional* types list, as well as a name key, placed
101
+ either before or after the types list. The name key is *required*. Note that
102
+ for extensibility, the name can be placed *before* the types list, like:
103
+ `name [Types] description`. In this case, a separating space is not required
104
+ between the name and types, and you can still use any of the other brackets
105
+ that the type specifier list allows.
106
+ 4. **Freeform data with title** &mdash; freeform data where the first line cannot
107
+ be split into multiple lines. The first line must also always refer to the
108
+ "title" portion, and therefore, if there is no title, the first line must
109
+ be blank. The "title" might occasionally be listed by another name in tag
110
+ documentation, however, you can identify this syntax by the existence of
111
+ a multi-line signature with "Indented block" on the second line.
112
+
113
+ In the tag list below, the term "description" implies freeform data, `[Types]`
114
+ implies a types specifier list, "name" implies a name key, and "title" implies
115
+ the first line is a newline significant field that cannot be split into multiple
116
+ lines.
117
+
118
+ ### Types Specifier List
119
+
120
+ In some cases, a tag will allow for a "types specifier list"; this will be evident
121
+ from the use of the `[Types]` syntax in the tag signature. A types specifier list
122
+ is a comma separated list of types, most often classes or modules, but occasionally
123
+ literals. For example, the following {tag:return} tag lists a set of types returned
124
+ by a method:
125
+
126
+ # Finds an object or list of objects in the db using a query
127
+ # @return [String, Array<String>, nil] the object or objects to
128
+ # find in the database. Can be nil.
129
+ def find(query) finder_code_here end
130
+
131
+ A list of conventions for type names is specified below. Typically, however,
132
+ any Ruby literal or class/module is allowed here. Duck-types (method names
133
+ prefixed with "#") are also allowed.
134
+
135
+ Note that the type specifier list is always an optional field and can be omitted
136
+ when present in a tag signature. This is the reason why it is surrounded by
137
+ brackets. It is also a freeform list, and can contain any list of values, though
138
+ a set of conventions for how to list types is described below.
139
+
140
+ ### Type List Conventions
141
+
142
+ <p class="note">
143
+ A list of examples of common type listings and what they translate into is
144
+ available at <a href="http://yardoc.org/types">http://yardoc.org/types</a>.
145
+ </p>
146
+
147
+ Typically, a type list contains a list of classes or modules that are associated
148
+ with the tag. In some cases, however, certain special values are allowed or required
149
+ to be listed. This section discusses the syntax for specifying Ruby types inside of
150
+ type specifier lists, as well as the other non-Ruby types that are accepted by
151
+ convention in these lists.
152
+
153
+ It's important to realize that the conventions listed here may not always adequately
154
+ describe every type signature, and is not meant to be a complete syntax. This is
155
+ why the types specifier list is freeform and can contain any set of values. The
156
+ conventions defined here are only conventions, and if they do not work for your
157
+ type specifications, you can define your own appropriate conventions.
158
+
159
+ Note that a types specifier list might also be used for non-Type values. In this
160
+ case, the tag documentation will describe what values are allowed within the
161
+ type specifier list.
162
+
163
+ #### Class or Module Types
164
+
165
+ Any Ruby type is allowed as a class or module type. Such a type is simply the name
166
+ of the class or module.
167
+
168
+ Note that one extra type that is accepted by convention is the `Boolean` type,
169
+ which represents both the `TrueClass` and `FalseClass` types. This type does not
170
+ exist in Ruby, however.
171
+
172
+ #### Parametrized Types
173
+
174
+ In addition to basic types (like String or Array), YARD conventions allow for
175
+ a "generics" like syntax to specify container objects or other parametrized types.
176
+ The syntax is `Type<SubType, OtherSubType, ...>`. For instance, an Array might
177
+ contain only String objects, in which case the type specification would be
178
+ `Array<String>`. Multiple parametrized types can be listed, separated by commas.
179
+
180
+ Note that parametrized types are typically not order-dependent, in other words,
181
+ a list of parametrized types can occur in any order inside of a type. An array
182
+ specified as `Array<String, Fixnum>` can contain any amount of Strings or Fixnums,
183
+ in any order. When the order matters, use "order-dependent lists", described below.
184
+
185
+ #### Duck-Types
186
+
187
+ Duck-types are allowed in type specifier lists, and are identified by method
188
+ names beginning with the "#" prefix. Typically, duck-types are recommended
189
+ for {tag:param} tags only, though they can be used in other tags if needed.
190
+ The following example shows a method that takes a parameter of any type
191
+ that responds to the "read" method:
192
+
193
+ # Reads from any I/O object.
194
+ # @param io [#read] the input object to read from
195
+ def read(io) io.read end
196
+
197
+ #### Hashes
198
+
199
+ Hashes can be specified either via the parametrized type discussed above,
200
+ in the form `Hash<KeyType, ValueType>`, or using the hash specific syntax:
201
+ `Hash{KeyTypes=>ValueTypes}`. In the latter case, KeyTypes or ValueTypes can
202
+ also be a list of types separated by commas.
203
+
204
+ #### Order-Dependent Lists
205
+
206
+ An order dependent list is a set of types surrounded by "()" and separated by
207
+ commas. This list must contain exactly those types in exactly the order specified.
208
+ For instance, an Array containing a String, Fixnum and Hash in that order (and
209
+ having exactly those 3 elements) would be listed as: `Array<(String, Fixnum, Hash)>`.
210
+
211
+ #### Literals
212
+
213
+ Some literals are accepted by virtue of being Ruby literals, but also by YARD
214
+ conventions. Here is a non-exhaustive list of certain accepted literal values:
215
+
216
+ * `true`, `false`, `nil` &mdash; used when a method returns these explicit literal
217
+ values. Note that if your method returns both `true` or `false`, you should use
218
+ the `Boolean` conventional type instead.
219
+ * `self` &mdash; has the same meaning as Ruby's "self" keyword in the context of
220
+ parameters or return types. Recommended mostly for {tag:return} tags that are
221
+ chainable.
222
+ * `void` &mdash; indicates that the type for this tag is explicitly undefined.
223
+ Mostly used to specify {tag:return} tags that do not care about their return
224
+ value. Using a `void` return tag is recommended over no type, because it makes
225
+ the documentation more explicit about what the user should expect. YARD will
226
+ also add a note for the user if they have undefined return types, making things
227
+ clear that they should not use the return value of such a method.
228
+
229
+ <a name="reftags"></a>
230
+
231
+ ### Reference Tags
232
+
233
+ <p class="note">
234
+ Reference tag syntax applies only to meta-data tags, not directives.
235
+ </p>
236
+
237
+ If a tag's data begins with `(see OBJECT)` it is considered a "reference tag".
238
+ A reference tag literally copies the tag data by the given tag name from the
239
+ specified OBJECT. For instance, a method may copy all {tag:param} tags from
240
+ a given object using the reference tag syntax:
241
+
242
+ # @param user [String] the username for the operation
243
+ # @param host [String] the host that this user is associated with
244
+ # @param time [Time] the time that this operation took place
245
+ def clean(user, host, time = Time.now) end
246
+
247
+ # @param (see #clean)
248
+ def activate(user, host, time = Time.now) end
249
+
250
+ ## Adding Custom Tags
251
+
252
+ <p class="note">If a tag is specific to a given project, consider namespacing
253
+ it by naming it in the form <tt>projectname.tagname</tt>, ie.,
254
+ <tt>yard.tag_signature</tt>.</p>
255
+
256
+ Custom tags can be added to YARD either via the command-line or programmatically.
257
+ The programmatic method is not discussed in this document, but rather in the
258
+ {file:docs/TagsArch.md} document.
259
+
260
+ To add a custom tag via the command-line or .yardopts file, you can use the
261
+ `--*-tag` options. A few different options are available for the common tag
262
+ syntaxes described above. For example, to add a basic freeform tag, use:
263
+
264
+ !!!sh
265
+ $ yard doc --tag rest_url:"REST URL"
266
+
267
+ This will register the `@rest_url` tag for use in your documentation and display
268
+ this tag in HTML output wherever it is used with the heading "REST URL".
269
+ Note that the tag title should follow the tag name with a colon (`:`). Other
270
+ tag syntaxes exist, such as the type specifier list freeform tag
271
+ (`--type-tag`), or a named key tag with types (`--type-name-tag`).
272
+
273
+ If you want to create a tag but not display it in output (it is only for
274
+ programmatic use), add `--hide-tag tagname` after the definition:
275
+
276
+ !!!sh
277
+ $ yard doc --tag complexity:"McCabe Complexity" --hide-tag complexity
278
+
279
+ Note that you might not need a tag title if you are hiding it. The title
280
+ part can be omitted.
281
+
282
+ {yard:include_tags}
283
+
@@ -0,0 +1,123 @@
1
+ # @title Tags Architecture
2
+
3
+ # Tags Architecture
4
+
5
+ ## Programmatic API
6
+
7
+ ### Accessing Tag Information
8
+
9
+ Tag metadata is added when a {YARD::Docstring} is added to a {file:docs/CodeObjects.md code object}
10
+ using the {YARD::CodeObjects::Base#docstring=} attribute. In addition to adding
11
+ conventional comments, tags are parsed and associated with the object. The easiest
12
+ way to access tags on an object is to use the {YARD::CodeObjects::Base#tag} and `#tags`
13
+ methods, for example:
14
+
15
+ # Using the Foo class object from above
16
+ obj.tags(:tagname).first.text #=> "some data"
17
+
18
+ Because multiple tags can be stored with the same name, they are stored as a list
19
+ of tags. The `#tag` method is an alias for the first item in the list of tags.
20
+ Also note that the `#tag`, `#tags` and `#has_tag?` methods are all convenience
21
+ methods that delegate to the {YARD::Docstring} object described above.
22
+
23
+ ### Adding Custom Tags
24
+
25
+ The `@tagname` tag used in the above examples is clearly not part of the tags
26
+ that come with YARD. If such a tag would actually be part of documentation under
27
+ a default install, YARD would raise a warning that the tag does not exist. It is,
28
+ however, trivial to add this tag to be recognized by YARD.
29
+
30
+ All tags in YARD are added to the {YARD::Tags::Library tag library} which makes
31
+ use of a tag factory class to parse the data inside the tags. To simply add a
32
+ tag that stores simple text like our `@tagname` tag above, use:
33
+
34
+ YARD::Tags::Library.define_tag("A Sample Tag", :tagname)
35
+
36
+ This will now allow YARD to add the metadata from `@tagname` to the docstring.
37
+
38
+ ## Tag Factory Architecture
39
+
40
+ Recognizing a tag is one part of the process. Parsing the tag contents is the
41
+ second step. YARD has a tag architecture that allows developers to add or completely
42
+ change the way tags contents can be parsed.
43
+
44
+ The separation of registration and tag creation can be seen in the following
45
+ class diagram:
46
+
47
+ ![Tags Architecture Class Diagram](images/tags-class-diagram.png)
48
+
49
+ ### DefaultFactory
50
+
51
+ By default, YARD has a few standard syntaxes that can be parsed for tags. These
52
+ are all implemented by the {YARD::Tags::DefaultFactory} class. These syntaxes
53
+ are:
54
+
55
+ * Standard text: no parsing is done, but text is stripped of newlines and
56
+ multiple spaces.
57
+
58
+ * Raw text: does no parsing at all, no stripping of newlines or spaces. This
59
+ is best used for code snippets.
60
+
61
+ * Raw text with title: does no parsing on the text but extracts the first line
62
+ of the metadata as the "title", useful for tags such as `@example`:
63
+
64
+ # @example Inspect an element
65
+ # myobj.inspect #=> #<Object:0x123525>
66
+
67
+ * Text with types: parses a list of types at the beginning of the text. Types
68
+ are optional. The standard syntax is in the form `[type1, type2, ...]`,
69
+ for example:
70
+
71
+ # @return [String, Symbol] a description here
72
+ # @return description here with no types
73
+
74
+ * Text with types and a name: parses a list of types at the beginning of text
75
+ followed by a name and extra descriptive text. For example:
76
+
77
+ # @param [String] str the string to reverse
78
+ def reverse(str) '...' end
79
+
80
+ As mentioned above, this syntax is implemented by the `DefaultFactory` which can
81
+ be swapped out for any factory. In some cases, a developer may want to change
82
+ the type declaration syntax to be in the form:
83
+
84
+ # @tagname name <Types, here> description
85
+
86
+ This can be done by simply implementing a new factory that parses the data in
87
+ this form.
88
+
89
+ ### Implementing a Factory
90
+
91
+ Factories should implement the method `parse_tag` as well as any `parse_tag_SUFFIX`
92
+ method where SUFFIX refers to the suffix added when declaring the tag. For example,
93
+ a tag can also be declared as follows:
94
+
95
+ YARD::Tags::Library.define_tag "Parameter", :param, :with_types
96
+
97
+ In such a case, the factory will be called with method `parse_tag_with_types`. In
98
+ all cases, the method should return a new {YARD::Tags::Tag} object. Generally,
99
+ the `parse_tag` methods take 2 or 3 parameters. A simple tag can be implemented
100
+ as:
101
+
102
+ def parse_tag(tag_name, text)
103
+ Tag.new(tag_name, text)
104
+ end
105
+
106
+ The text parameter contains pre-parsed text with extra spaces and newlines removed.
107
+ If required, the method could also be declared with a third parameter containing
108
+ unmodified raw text:
109
+
110
+ def parse_tag_with_raw_text(tag_name, text, raw_text)
111
+ Tag.new(tag_name, raw_text)
112
+ end
113
+
114
+ Note that this method would be invoked for a tag declared with the `:with_raw_text`
115
+ suffix.
116
+
117
+ ### Changing the Factory
118
+
119
+ To change the factory, set the {YARD::Tags::Library.default_factory} attribute:
120
+
121
+ YARD::Tags::Library.default_factory = MyFactory
122
+
123
+ This must be done before any parsing is done, or the factory will not be used.