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,1245 @@
1
+ # @title What's New?
2
+
3
+ # What's New in 0.8.x?
4
+
5
+ 1. **Directives (new behavioural tag syntax)** (0.8.0)
6
+ 2. **Added `--embed-mixin(s)` to embed mixins into class docs** (0.8.0)
7
+ 3. **Internationalization (I18n) support for translating docs** (0.8.0)
8
+ 4. **New C parser / handlers architecture** (0.8.0)
9
+ 5. **YARD will now warn if `@param` name not in method params** (0.8.0)
10
+ 6. **Added support for `module_function` calls in Ruby code** (0.8.0)
11
+ 7. **Greatly improved tag documentation using custom template** (0.8.0)
12
+ 8. **Tags can now contain '.' for namespacing** (0.8.0)
13
+ 9. **Added "frames" links for non-framed pages for better nav** (0.8.0)
14
+ 10. **Added Gemfile support to YARD server for local gem sets** (0.8.0)
15
+ 11. **Server now displays README on index route like static docs** (0.8.0)
16
+ 12. **Added line numbers to `yard stats --list-undoc --compact`** (0.8.0)
17
+ 13. **Single object db now default (multi-object db unsupported)** (0.8.0)
18
+ 14. **Added `--api` tag to generate documentation for API sets** (0.8.1)
19
+ 15. **Added `--non-transitive-tag` to disable transitive tag** (0.8.3)
20
+ 16. **Added `-B/--bind` to bind to a port in yard server** (0.8.4)
21
+ 17. **Added `asciidoc` markup type support** (0.8.6)
22
+ 18. **Added `yard markups` command to list available markup types** (0.8.6)
23
+ 19. **Added `yard display` command to display formatted objects** (0.8.6)
24
+ 20. **Added `--layout` to `yard display` command** (0.8.6.1)
25
+ 21. **Added `stats_options` for the rake task** (0.8.7.6)
26
+
27
+ ## Directives (new behavioural tag syntax) (0.8.0)
28
+
29
+ <p class="note">
30
+ The tags {tag:!macro}, {tag:!method}, {tag:!attribute}, {tag:!group},
31
+ {tag:!endgroup}, {tag:!scope} and {tag:!visibility} have been changed
32
+ from meta-data tags to directives. This means they should now be called
33
+ with the "@!" prefix instead of "@". Note however that for <strong>
34
+ backward compatibility</strong>, the old "@macro", "@method", etc.,
35
+ syntax for all of these tags will still work and is supported.
36
+ </p>
37
+
38
+ <p class="note">
39
+ Some <strong>backwards incompatible</strong> changes were made to {tag:!macro} syntax.
40
+ Please read this section carefully if you are using this tag.
41
+ </p>
42
+
43
+ YARD 0.8.0 adds a new tag syntax called "directives" using the `@!`
44
+ prefix. These directive tags can be used to modify parser state while
45
+ processing objects, or even create new objects on the fly. A plugin
46
+ API is available similar to tags, and directives should be registered
47
+ in the {YARD::Tags::Library} class using {YARD::Tags::Library.define_directive}.
48
+
49
+ To use a directive, simply call it the same way as any tag. Tag syntax
50
+ is documented in {file:docs/Tags.md}.
51
+
52
+ ### Notable features of directives
53
+
54
+ #### Directives do not need to be attached to object docstrings
55
+
56
+ Unlike meta-data tags which apply to created objects, directives
57
+ do not need to be attached to an object in order to be used. This
58
+ means you can have free-standing comments with directives, such as:
59
+
60
+ # @macro mymacro
61
+ # A new macro, not attached to any docstring
62
+
63
+ # ...other Ruby code here...
64
+
65
+ # Using the macro:
66
+ # @macro mymacro
67
+ def mymethod; end
68
+
69
+ You can do the same to define methods and attributes, as discussed
70
+ below.
71
+
72
+ #### `@!method` and `@!attribute` directives improved
73
+
74
+ The method and attribute directives can now be used to create multiple
75
+ objects in a single docstring. Previously a `@method` or `@attribute`
76
+ tag would only create one method per docstring. In 0.8.0, you could
77
+ attach multiple methods to the same block of Ruby source, such as:
78
+
79
+ # @!method foo(a, b, c)
80
+ # @!method bar(x, y, z)
81
+ # Docstring for code
82
+ some_ruby_source
83
+
84
+ The above creates #foo and #bar and the source listing for both will
85
+ be `some_ruby_source` with "Docstring for code" as the docstring.
86
+
87
+ The attribute directive can take advantage of this functionality as well.
88
+ Note that these directives also do not need to be attached to a line of
89
+ code to be recognized; they can be in free-standing comments if the
90
+ methods are defined dynamically and not associated with any code.
91
+
92
+ #### New `@!parse` directive to parse Ruby code
93
+
94
+ A new {tag:!parse} directive was added that allows a developer to have
95
+ YARD parse code that might not necessarily be parseable in its original
96
+ form. This is useful when using `instance_eval` and other dynamic
97
+ meta-programming techniques to define methods or perform functionality.
98
+ For instance, a common case of the "self.included" callback in module
99
+ to extend a module on a class might be in the form:
100
+
101
+ def self.included(mod)
102
+ mod.extend(self)
103
+ end
104
+
105
+ Unfortunately, this does not get picked up by YARD, but on the original
106
+ class, we can add:
107
+
108
+ class MyClass
109
+ # @!parse extend TheDynamicModule
110
+ include TheDynamicModule
111
+ end
112
+
113
+ YARD will then parse the code `extend TheDynamicModule` as if
114
+ it were in the source file.
115
+
116
+ You can also use this technique to register regular methods as
117
+ attributes, if you did not define them with `attr_*` methods:
118
+
119
+ def foo; @foo end
120
+ def foo=(v) @foo = v end
121
+
122
+ # Register them as methods:
123
+ # @!parse attr_accessor :foo
124
+
125
+ ### Backward incompatible changes to `@!macro` directive
126
+
127
+ Unfortunately, in order to create the new directives architecture,
128
+ some previously supported syntax in `@macro` tags are no longer supported.
129
+ Specifically, macros can no longer expand text on an entire docstring.
130
+ Instead, macros only expand the data that is indented inside of the tag
131
+ text.
132
+
133
+ This syntax is **no longer supported**:
134
+
135
+ # @macro mymacro
136
+ # Expanding text $1 $2 $3
137
+ property :a, :b, :c
138
+
139
+ In 0.7.0 to 0.7.5, the above would have created a method with the docstring
140
+ "Expanding text a b c". This will not work in 0.8.0. Instead, you must
141
+ indent all the macro expansion data so that it is part of the `@macro`
142
+ tag as follows:
143
+
144
+ # @!macro mymacro
145
+ # Expanding text $1 $2 $3
146
+ property :a, :b, :c
147
+
148
+ Note that we also use the recommended `@!macro` syntax, though `@macro`
149
+ is still supported.
150
+
151
+ ## Added `--embed-mixin(s)` to embed mixins into class docs (0.8.0)
152
+
153
+ Methods from mixins can now be embedded directly into the documentation
154
+ output for a class by using `--embed-mixin ModuleName`, or `--embed-mixins`
155
+ for all mixins. This enables a documentation writer to refactor methods
156
+ into modules without worrying about them showing up in separate files
157
+ in generated documentation. When mixin methods are embedded, they
158
+ show up in both the original module page and the pages of the classes
159
+ they are mixed into. A note is added to the method signature telling the
160
+ user where the method comes from.
161
+
162
+ The `--embed-mixin` command-line option can also take wildcard values
163
+ in order to match specific namespaces. For instance, you can embed
164
+ only mixins inside of a "Foo::Bar" namespace by doing:
165
+
166
+ !!!sh
167
+ $ yard doc --embed-mixin "Foo::Bar::*"
168
+
169
+ ## Internationalization (I18n) support for translating docs
170
+
171
+ YARD now ships with the beginnings of internationalization support
172
+ for translating documentation into multiple languages. The
173
+ `yard i18n` command now allows you to generate ".pot" and ultimately
174
+ ".po" files for translation with [gettext](http://www.gnu.org/software/gettext).
175
+
176
+ Note that this tool is a small step in the larger transition for
177
+ proper I18n support in YARD. We still have to add proper gettext
178
+ support to our templates for proper generation in multiple languages,
179
+ but this tool allows you to get started in translating your
180
+ documents. Improved I18n support will come throughout the 0.8.x series.
181
+
182
+ ## New C parser / handlers architecture (0.8.0)
183
+
184
+ The C parser was completely rewritten to take advantage of YARD's
185
+ parser and handler architecture. This means more YARD will be more robust
186
+ when parsing failures occur, tags and directives will now work consistently
187
+ across Ruby and CRuby files ({tag:!group} will now work, for instance),
188
+ and developers can now write custom handlers that target CRuby source files.
189
+
190
+ ## YARD will now warn if `@param` name not in method params (0.8.0)
191
+
192
+ YARD will now give you a warning if you use a `@param` tag in your
193
+ source but give an invalid parameter name. This should catch a lot of
194
+ common documentation errors and help keep your documentation consistent.
195
+
196
+ ## Added support for `module_function` calls in Ruby code (0.8.0)
197
+
198
+ The `module_function` command in Ruby is now supported in Ruby files.
199
+ It defines two separate methods, one class and one instance method,
200
+ both having the exact same docstring, and marks the instance method
201
+ as private.
202
+
203
+ ## Greatly improved tag documentation using custom template (0.8.0)
204
+
205
+ We have completely revamped the {docs/Tags.md} to include documentation
206
+ for each meta-data tag and directive with at least one useful example
207
+ for each one. This was done using template customization and extension
208
+ available within YARD.
209
+
210
+ ## Tags can now contain '.' for namespacing (0.8.0)
211
+
212
+ Prior to 0.8.0, tags could only contain alphanumeric characters and
213
+ underscore. YARD now allows the '.' character in tag names, and it
214
+ is now recommended for namespacing project-specific custom tags.
215
+ YARD has its own set of custom tags that are namespaced in this
216
+ way (using the "yard.tagname" namespace). The namespace recommendation
217
+ is to use "projectname.tagname", or "projectname.component.tagname".
218
+
219
+ ## Added "frames" links for non-framed pages for better nav (0.8.0)
220
+
221
+ Frames navigation has always had a "(no frames)" link to get rid
222
+ of the frameset. YARD 0.8.0 introduces a "(frames)" link on non-framed
223
+ pages to reverse this, allowing you to navigate between framed and
224
+ frameless pages seamlessly.
225
+
226
+ ## Added Gemfile support to YARD server for local gem sets (0.8.0)
227
+
228
+ The `yard server` command now supports `--gemfile` to serve gems
229
+ from a Gemfile.lock, instead of all system-wide gems.
230
+
231
+ ## Server now displays README on index route like static docs (0.8.0)
232
+
233
+ The `yard server` command will now behave like static docs regarding
234
+ the index action for a project, listing the README file if present
235
+ before displaying the alphabetic index. Note that the route for
236
+ the alphabetic index page has now moved to the explicit '/index' action.
237
+
238
+ ## Added line numbers to `yard stats --list-undoc --compact` (0.8.0)
239
+
240
+ Line numbers are now listed in the compact listing of undocumented objects
241
+ so that they can be more easily located in the files.
242
+
243
+ ## Single object db now default (multi-object db unsupported) (0.8.0)
244
+
245
+ YARD previously would split the .yardoc db into multiple marshal files
246
+ for load-time performance reasons if it grew past a specific number of
247
+ objects. This check is now disabled, and YARD will never automatically
248
+ switch to a multi-object DB. YARD will now always use the single object
249
+ db unless explicitly set with `--no-single-db`. If YARD is taking a
250
+ long time to load your .yardoc database, you can try using this
251
+ option to split your database into multiple files, but note that this
252
+ can cause problems with certain codebases (specifically, if you
253
+ have class methods using the same name as a module/class).
254
+
255
+ ## Added `--api` tag to generate documentation for API sets (0.8.1)
256
+
257
+ You can now use `yardoc --api APINAME` to generate documentation only
258
+ for objects with the `@api APINAME` tag (or any parent namespace objects,
259
+ since this tag is transitive). Multiple `--api` switches may be used to
260
+ generate documentation for multiple APIs together. The following generates
261
+ documentation for both the "public" and "developer" APIs, also including
262
+ any objects with undefined API (via `--no-api`):
263
+
264
+ $ yard doc --api public --api developer --no-api
265
+
266
+ Note that if you use `--api`, you must ensure that you also add `@api`
267
+ tags to your namespace objects (modules and classes), not just your methods.
268
+ If you do not want to do this, you can also include all objects with *no*
269
+ `@api` tag by using `--no-api` as shown above.
270
+
271
+ Remember that applying an `@api` tag to a class or module will apply it
272
+ to all children that do not have this tag already defined, so you can
273
+ declare an entire class public by applying it to the class itself. Note
274
+ also that these tags can be overridden by child elements if the tag is
275
+ re-applied to the individual object.
276
+
277
+ This feature is a simplified version of the more powerful `--query`
278
+ switch. The query to display the same API documentation as the
279
+ above example would be:
280
+
281
+ $ yard doc --query '!@api || @api.text =~ /^(public|private)$/'
282
+
283
+ But note that `--query` does not work when YARD is in "safe mode"
284
+ due to security concerns, whereas `--api` works in either mode.
285
+ This enables `--api` to function on remote documentation sites like
286
+ [rubydoc.info](http://rubydoc.info).
287
+
288
+ ## Added `--non-transitive-tag` to disable transitive tag (0.8.3)
289
+
290
+ You can now use `--non-transitive-tag` to disable transitivity on
291
+ tags that are defined as transitive by default. For instance, in
292
+ some cases you might not want the @api tag to apply to all methods
293
+ when you define it on a class. Only the class itself has a specific
294
+ @api tag. To do this, you can mark @api as non-transitive with:
295
+
296
+ $ yard doc --non-transitive-tag api --api some_api
297
+
298
+ Which will avoid classifying treating @api as a transitive tag
299
+ when parsing modules and classes.
300
+
301
+ ## Added `-B/--bind` to bind to a port in yard server (0.8.4)
302
+
303
+ You can now bind the `yard server` command to a given local port
304
+ with `yard server -B PORT` or `yard server --bind PORT`.
305
+
306
+ ## Added `asciidoc` markup type support (0.8.6)
307
+
308
+ Support for the AsciiDoc markup type is now introduced using the `asciidoc`
309
+ markup type (`yard doc -m asciidoc`). Requires the
310
+ [asciidoctor](http://rubygems.org/gems/asciidoctor) RubyGem library to be
311
+ installed before running YARD.
312
+
313
+ ## Added `yard markups` command to list available markup types (0.8.6)
314
+
315
+ You can now list all available markup types and their respective providers by
316
+ typing `yard markups`. This list also includes the file extensions used to
317
+ auto-identify markup types for extra files and READMEs. To use a markup in
318
+ the list, call `yard doc` with `-m MARKUP_TYPE`. To select a specific markup
319
+ provider library, pass the `-M PROVIDER_NAME` option.
320
+
321
+ ## Added `yard display` command to display formatted objects (0.8.6)
322
+
323
+ <p class="note">This feature requires the .yardoc registry to have already been
324
+ generated. To generate the registry, run <code>yard doc -n</code>.
325
+ </p>
326
+
327
+ You can now display a single object (or a list of objects) in the YARD registry
328
+ using the `yard display OBJECT ...` command. For example, to display the
329
+ `YARD::CodeObjects` module as text (the way it is displayed in `yri`), type:
330
+
331
+ $ yard display YARD::CodeObjects
332
+
333
+ You can also format individual objects as HTML. For example, you can format
334
+ the above object as HTML and pipe the contents into a file readable by a
335
+ web browser:
336
+
337
+ $ yard display -f html YARD::CodeObjects > codeobjects.html
338
+
339
+ Custom templating options from `yard doc` can also be used, see
340
+ `yard display --help` for more options.
341
+
342
+ ## Added `--layout` to `yard display` command (0.8.6.1)
343
+
344
+ The `yard display` command now accepts `--layout` to wrap content in a layout
345
+ template. Currently the `layout` and `onefile` layout templates are supported,
346
+ though any template can be used. If no parameter is specified, the layout will
347
+ default to the `layout` template. Example usage:
348
+
349
+ $ yard display --layout onefile -f html YARD::CodeObjects > codeobjects.html
350
+
351
+ The above generates a `codeobjects.html` file that is self-contained with
352
+ CSS stylesheets and JavaScript code. This is similar to calling
353
+ `yard doc --one-file` with only the YARD::CodeObjects object in the registry.
354
+
355
+ Note that even though this uses the onefile template, the README file will not
356
+ be auto-included the way it is with the `yard doc` command. To include the
357
+ README text at the top of the onefile template, pass the --readme switch:
358
+
359
+ $ yard display --layout onefile -f html --readme README.md OBJECT > out.html
360
+
361
+ # What's New in 0.7.x?
362
+
363
+ 1. **Macro support and detection of DSL methods** (0.7.0)
364
+ 2. **Inherited attributes now show in HTML output** (0.7.0)
365
+ 3. **The 'app' directory is now parsed by default** (0.7.0)
366
+ 4. **Added support for metadata (@title, @markup) in extra files/readmes** (0.7.0)
367
+ 5. **Added `yard list` command (alias for `yardoc --list`)** (0.7.0)
368
+ 6. **Added Git support in `yard diff`** (0.7.0)
369
+ 7. **Added `{include:file:FILENAME}` syntax** (0.7.0)
370
+ 8. **Added `{render:OBJECT}` syntax to embed object docs in extra files** (0.7.0)
371
+ 9. **Added improved templates API for custom CSS/JS/menus** (0.7.0)
372
+ 10. **Added Ruby markup type (`-m ruby`)** (0.7.0)
373
+ 11. **Added state tracking variables to Parser/Handler architecture** (0.7.0)
374
+ 12. **Added before/after callbacks to SourceParser** (0.7.0)
375
+ 13. **Can now use `--yardopts FILE` to specify a custom yardopts file** (0.7.0)
376
+ 14. **Added new `-t guide` template for guide based docs** (0.7.0)
377
+ 15. **Github Flavoured Markdown now works out-of-box** (0.7.4)
378
+ 16. **Added `-m textile_strict` and `-m pre` markup types** (0.7.4)
379
+ 17. **Reorganized markup types 'text' and 'none'** (0.7.4)
380
+ 18. **Add support for `rb_define_alias`** (0.7.4)
381
+
382
+ ## Macro support and detection of DSL methods (0.7.0)
383
+
384
+ YARD will now automatically detect class level method calls, similar to the
385
+ way it knows what an `attr_accessor` is. By simply adding documentation to
386
+ your class level declarations, YARD can automatically detect them as methods
387
+ or attributes in your class. Consider DataMapper's "property" declaration:
388
+
389
+ class Post
390
+ # @attribute
391
+ # @return [String] the title of the post
392
+ property :title, String
393
+ end
394
+
395
+ The above declaration would be created as the `Post#title`. The optional
396
+ `@attribute` tag tells YARD that the property is an "attribute", and not just
397
+ a regular method.
398
+
399
+ In addition to basic DSL method detection, YARD also supports macros to create
400
+ docstrings that can be copies to other objects; these macros can also be
401
+ "attached" to class level methods to create implicit documentation for macros.
402
+
403
+ Macros and DSL method detection are discussed in much more detail in the
404
+ {file:docs/GettingStarted.md}, so you should read about them there if you're
405
+ interested in this feature.
406
+
407
+ ## Inherited attributes now show in HTML output (0.7.0)
408
+
409
+ Inherited attributes will now show up in HTML documentation using the default
410
+ template in the same manner that inherited methods do.
411
+
412
+ ## The 'app' directory is now parsed by default (0.7.0)
413
+
414
+ YARD tries to follow the "It Just Works" attitude in writing developer tools,
415
+ and therefore has added `app/**/*.rb` to the default list of globs that it
416
+ searches for code in. You no longer need to create a `.yardopts` just to
417
+ list your app directory when documenting your code on rubydoc.info.
418
+ We should have done this a while ago! And don't worry, YARD still checks
419
+ lib and ext by default, too.
420
+
421
+ ## Added support for metadata (@title, @markup) in extra files/readmes (0.7.0)
422
+
423
+ Extra files (READMEs, ChangeLogs, LICENSE files, and other guides) now support
424
+ metadata tags, just like docstrings in code comments. By adding @tag values
425
+ to the top of a file (no whitespace preceding it) inside of a `# comment` line,
426
+ YARD will detect and parse these tags and store it for later usage.
427
+
428
+ Tags can contain arbitrary data as well as arbitrary tag names, however the
429
+ tag names @title and @markup are reserved to specify the document title and
430
+ markup format respectively. The title will be used in the file list menu,
431
+ index page, as well as any linking of the file via the `{file:Filename}`
432
+ syntax. An example of a document with metadata would be:
433
+
434
+ # @title The Best Project Ever!
435
+ # @markup rdoc
436
+ # @author Foo Bar (custom tag, does not display in templates)
437
+
438
+ = This Project Rules
439
+
440
+ == Contents
441
+
442
+ ...
443
+
444
+ Note that previous versions of YARD recommended specifying the markup of an
445
+ extra file with the `#!markup` shebang, but the `@markup` metadata tag is now
446
+ the "best practice" for specifying the markup format of an extra file.
447
+
448
+ ## Added `yard list` command (alias for `yardoc --list`) (0.7.0)
449
+
450
+ The `yardoc --list` command is used to list objects that are parsed from
451
+ a codebase. This can be used to grep methods/classes in a codebase from the
452
+ command line. `yard list` now calls `yardoc --list` as a convenience command.
453
+
454
+ Note that the `yardoc --list` command may eventually be replaced by a more
455
+ feature-filled `yard list` command, so `yard list` should be used instead of
456
+ `yardoc --list` when possible.
457
+
458
+ ## Added Git support in `yard diff` (0.7.0)
459
+
460
+ The `yard diff` command can now perform object diffing on git repositories.
461
+ Provide the `--git` switch to `yard diff` with 2 commit/branches like so:
462
+
463
+ $ yard diff --git HEAD~5 HEAD
464
+ Added objects:
465
+
466
+ YARD::Parser::SourceParser#contents
467
+ YARD::Parser::SourceParser#globals
468
+ ...
469
+
470
+ ## Added `{include:file:FILENAME}` syntax (0.7.0)
471
+
472
+ You can now use the `{include:file:FILENAME}` syntax to embed the contents
473
+ of an extra file marked up in its markup format. This syntax supports embedding
474
+ Ruby source files and performing syntax highlighting on the code.
475
+
476
+ ## Added `{render:OBJECT}` syntax to embed object docs in extra files (0.7.0)
477
+
478
+ You can now use the `{render:Object}` syntax to embed the documentation
479
+ rendering of an entire object (method, class, module) inside of an extra file.
480
+ This is useful when writing non-API based guides that might require listing
481
+ a few helper methods or classes. The {file:docs/GettingStarted.md} discussed
482
+ this syntax in more detail (with example usage).
483
+
484
+ ## Added improved templates API for custom CSS/JS/menus (0.7.0)
485
+
486
+ Plugin & template developers can now more easily insert custom stylesheet
487
+ or JavaScript files in their customized templates, thanks to an abstraction
488
+ of the template API. This is documented in the {docs/Templates.md} document.
489
+ In addition to custom CSS/JS, developers can also create custom menu tabs
490
+ in both the framed and non framed version of the default theme.
491
+
492
+ ## Added Ruby markup type (`-m ruby`) (0.7.0)
493
+
494
+ The Ruby markup type (`-m ruby`) will now use syntax highlighting for all
495
+ formatting. This is probably not useful as a global switch, but can be used
496
+ on individual extra files using the metadata markup specification discussed
497
+ above.
498
+
499
+ ## Added state tracking variables to Parser/Handler architecture (0.7.0)
500
+
501
+ The parser and handler architecture now contain state variables
502
+ {YARD::Handlers::Base#extra_state} and {YARD::Handlers::Processor#globals}
503
+ to share data across handlers and the entire processing phase. `#extra_state`
504
+ provided a place to store per-file data, while `#globals` gives the developer
505
+ access to inter-file state when parsing multiple files at once.
506
+
507
+ ## Added before/after callbacks to SourceParser (0.7.0)
508
+
509
+ The {YARD::Parser::SourceParser} class can now register callbacks to execute
510
+ code before and after parsing of file globs, as well as before and after
511
+ parsing of individual files. This allows plugin developers to perform
512
+ setup/teardown (and set global state or update the {YARD::Registry}).
513
+
514
+ See the documentation for the following methods:
515
+
516
+ * {YARD::Parser::SourceParser.before_parse_list}
517
+ * {YARD::Parser::SourceParser.after_parse_list}
518
+ * {YARD::Parser::SourceParser.before_parse_file}
519
+ * {YARD::Parser::SourceParser.after_parse_file}
520
+
521
+ ## Can now use `--yardopts FILE` to specify a custom yardopts file (0.7.0)
522
+
523
+ The `yardoc` command now supports `--yardopts FILE` to specify custom .yardopts
524
+ options files. This is useful if you have multiple documentation sets, such
525
+ as a guide documentation set and an API documentation set.
526
+
527
+ ## Added new `-t guide` template for guide based docs (0.7.0)
528
+
529
+ You can now write guide style documentation using a new 'guide' template that
530
+ only generates documentation for extra files. You would use it in the form:
531
+
532
+ yardoc -t guide - README GettingStarted FAQ TroubleShooting LICENSE
533
+
534
+ This creates the sections for the readme, a getting started, frequently asked
535
+ questions, trouble shooting and license page.
536
+
537
+ If you need to refer to class / method documentation, you can embed API documentation
538
+ using the `{render:Object}` tag discussed above.
539
+
540
+ ## Github Flavoured Markdown now works out-of-box (0.7.4)
541
+
542
+ Due to the growing popularity of Github-Flavoured-Markdown (GFM), YARD now uses
543
+ the Redcarpet library as the default Markdown formatting library with GFM fenced
544
+ code blocks enabled. This means that you can use fenced code blocks inside of
545
+ Markdown files with redcarpet installed without any extra code. Previously, users
546
+ who wanted GFM in their Markdown would have to specify `-m markdown -M redcarpet`,
547
+ but this is now the default behaviour for YARD.
548
+
549
+ Note that you can still specify language types in code blocks without GFM in YARD
550
+ by using the "!!!lang" prefix syntax. For example (plain means no markup):
551
+
552
+ !!!plain
553
+ !!!plain
554
+ Some code
555
+ block here.
556
+
557
+ The GFM version would be:
558
+
559
+ !!!plain
560
+ ```plain
561
+ Some code
562
+ block here.
563
+ ```
564
+
565
+ ## Added `-m textile_strict` and `-m pre` markup types (0.7.4)
566
+
567
+ A new "textile_strict" markup type was added which behaves exactly like "textile"
568
+ except it enables hard breaks, so newlines behave as line breaks in the HTML
569
+ (using `<br>` tags). This option is added for users who want the classic textile
570
+ behaviour.
571
+
572
+ ## Reorganized markup types 'text' and 'none' (0.7.4)
573
+
574
+ Due to the new pre markup type, the behaviour for text and none were slightly
575
+ reorganized to be more intuitive. The following behaviours now represent these
576
+ markup types:
577
+
578
+ * pre: Used to wrap text inside `<pre>` tags
579
+ * text: No formatting except for hard breaks (`<br>`) on newlines
580
+ * none: No formatting at all.
581
+
582
+ In all cases, HTML is escaped from input. If you want no HTML escaping, use the
583
+ html markup type.
584
+
585
+ ## Add support for `rb_define_alias` (0.7.4)
586
+
587
+ CRuby code can now make use of the `rb_define_alias` function. Documentation
588
+ for aliases is not supported, however.
589
+
590
+ # What's New in 0.6.x?
591
+
592
+ 1. **Local documentation server for RubyGems or projects (`yard server`)** (0.6.0)
593
+ 2. **Groups support for method listing** (0.6.0)
594
+ 3. **Single file template (`--one-file`) support** (0.6.0)
595
+ 4. **`yard` CLI executable with pluggable commands** (0.6.0)
596
+ 5. **`yard diff` command to object-diff two versions of a project** (0.6.0)
597
+ 6. **Added `--asset` option to `yardoc`** (0.6.0)
598
+ 7. **New template API** (0.6.0)
599
+ 8. **HTML template now adds inline Table of Contents for extra files pages** (0.6.0)
600
+ 9. **Removed `--incremental` in favour of `--use-cache`** (0.6.0)
601
+ 10. **Ad-hoc tag registration via `yardoc` CLI (`--tag`, etc.)** (0.6.0)
602
+ 11. **Added `--transitive-tags` to register transitive tags** (0.6.0)
603
+ 12. **`yardoc` now displays RDoc-like statistics (`--no-stats` to hide)** (0.6.0)
604
+ 13. **`yri` now works on constants** (0.6.0)
605
+ 14. **Plugins are no longer auto-loaded (added `--plugin` switch)** (0.6.2)
606
+ 15. **Added `YARD::Config` API and `~/.yard/config` configuration file** (0.6.2)
607
+ 16. **Added `yard config` command to view/edit configuration** (0.6.2)
608
+ 17. **Added `yard server -t` template path switch** (0.6.2)
609
+ 18. **Added `YARD::Server.register_static_path` for static server assets** (0.6.2)
610
+ 19. **YARD::Registry is now thread local** (0.6.5)
611
+ 20. **Support for ripper gem in Ruby 1.8.7** (0.6.5)
612
+
613
+ ## Local documentation server for RubyGems or projects (`yard server`) (0.6.0)
614
+
615
+ The new `yard server` command spawns a documentation server that can serve
616
+ either documentation for a local project or installed RubyGems. The server
617
+ will host (by default) on http://localhost:8808.
618
+
619
+ To serve documentation for the active project (in the current directory):
620
+
621
+ $ yard server
622
+
623
+ The server can also run in "incremental" mode for local projects. In this
624
+ situation, any modified sources will immediately be updated at each request,
625
+ ensuring that the server always serve the code exactly as it is on disk.
626
+ Documenting your code in this fashion essentially gives you an efficient a
627
+ live preview without running a separate command everytime you make a change.
628
+ To serve documentation for the active project in incremental mode:
629
+
630
+ $ yard server --reload
631
+
632
+ <span class="note">Note that in incremental mode, objects or method groupings
633
+ cannot be removed. If you have removed objects or modified groupings, you
634
+ will need to flush the cache by deleting `.yardoc` and (optionally)
635
+ restarting the server.</span>
636
+
637
+ The documentation server can also serve documentation for all installed gems
638
+ on your system, similar to `gem server`, but using YARD's functionality and
639
+ templates. To serve documentation for installed gems:
640
+
641
+ $ yard server --gems
642
+
643
+ <span class="note">Documentation for the gem need not be previously generated
644
+ at install-time. If documentation for the gem has not been generated, YARD
645
+ will do this for you on-the-fly. It is therefore possible to speed up your
646
+ gem installs by using `gem install GEMNAME --no-rdoc` without repercussion.
647
+ You can also add this switch to your `~/.gemrc` file so that you don't need
648
+ to re-type it each time. See [this link](http://stackoverflow.com/questions/1789376/how-do-i-make-no-ri-no-rdoc-the-default-for-gem-install)
649
+ for exact instructions.</span>
650
+
651
+ ## Groups support for method listing (0.6.0)
652
+
653
+ You can now organize methods in a class/module into logical separated groups.
654
+ These groups apply lexically and are listed in the order they are defined.
655
+ For instance, to define a group:
656
+
657
+ # @group Rendering an Object
658
+
659
+ # Documentation here
660
+ def foo; end
661
+
662
+ # Extra documentation...
663
+ def bar; end
664
+
665
+ # @group Another Group
666
+
667
+ def aaa; end
668
+
669
+ <span class="note">Note that these `@group` and `@endgroup` declarations are
670
+ not "tags" and should always be separated with at least 1 line of whitespace
671
+ from any other documentation or code.</span>
672
+
673
+ In the above example, "Rendering an Object" will be listed with "foo" and
674
+ "bar" above "Another Group", even though "aaa" comes before the two other
675
+ methods, alphabetically. To end a group, use `@endgroup`. It is not necessary
676
+ to end a group to start a new one, only if there is an object following the
677
+ group that should not belong in any group.
678
+
679
+ # @group Group 1
680
+
681
+ def foo; end
682
+
683
+ # @endgroup
684
+
685
+ # This method should not be listed in any group
686
+ def bar; end
687
+
688
+ ## Single file template (`--one-file`) support (0.6.0)
689
+
690
+ `yardoc` now has the `--one-file` option to generate a single-file template
691
+ for small scripts and libraries. In this case, any comments at the top of
692
+ the script file will be recognized as a README.
693
+
694
+ ## `yard` CLI executable with pluggable commands (0.6.0)
695
+
696
+ <span class="note">The `yardoc` and `yri` commands are not deprecated and can
697
+ continue to be used. They are shortcuts for `yard doc` and `yard ri`
698
+ respectively. However, `yard-graph` has been removed.</span>
699
+
700
+ YARD now has a `yard` executable which combines all pre-existing and new
701
+ commands into a single pluggable command that is both easier to remember and
702
+ access. To get a list of commands, type `yard --help`.
703
+
704
+ If you are a plugin developer, you can create your own `yard` command by first
705
+ subclassing the {YARD::CLI::Command} class and then registering this class
706
+ with the {YARD::CLI::CommandParser.commands} list. For instance:
707
+
708
+ YARD::CLI::CommandParser.commands[:my_command] = MyCommandClass
709
+
710
+ The above line will enable the user to execute `yard my_command [options]`.
711
+
712
+ ## `yard diff` command to object-diff two versions of a project (0.6.0)
713
+
714
+ One of the built-in commands that comes with the new `yard` executable is the
715
+ ability to do object-oriented diffing across multiple versions of the same
716
+ project, either by 2 versions of a gem, or 2 working copies. Just like
717
+ regular diffing tells you which lines have been added/removed in a file,
718
+ object diffing allows you to see what classes/methods/modules have been
719
+ added/removed between versions of a codebase.
720
+
721
+ For an overview of how to use `yard diff`, see [YARD Object Oriented Diffing](http://gnuu.org/2010/06/26/yard-object-oriented-diffing/).
722
+
723
+ ## `yard stats` to display statistics and undocumented objects (0.6.0)
724
+
725
+ YARD now outputs the following statistics when `yard stats` is run:
726
+
727
+ Files: 125
728
+ Modules: 35 ( 4 undocumented)
729
+ Classes: 139 ( 29 undocumented)
730
+ Constants: 53 ( 20 undocumented)
731
+ Methods: 602 ( 70 undocumented)
732
+ 85.16% documented
733
+
734
+ Note that these statistics are based on what you have set to show in your
735
+ documentation. If you use `@private` tags and/or do not display
736
+ private/protected methods in your documentation, these will not show up as
737
+ undocumented. Therefore this metric is contextual.
738
+
739
+ You can also specifically list all undocumented objects (and their file
740
+ locations) with the `--list-undoc` option.
741
+
742
+ ## Added `--asset` option to `yardoc` (0.6.0)
743
+
744
+ The `yardoc` command can now take the `--asset` option to copy over
745
+ files/directories (recursively) to the output path after generating
746
+ documentation. The format of the argument is "from:to" where from is the
747
+ source path and to is the destination. For instance, YARD uses the following
748
+ syntax in the `.yardopts` file to copy over image assets from the
749
+ 'docs/images' directory into the 'images' directory after generating HTML:
750
+
751
+ --asset docs/images:images
752
+
753
+ ## New template API (0.6.0)
754
+
755
+ The new template API allows for easier insertion of sections within an
756
+ inherited template. You should no longer need to insert by index, an
757
+ error-prone process that could break when a template is updated. Instead of:
758
+
759
+ sections.last.place(:my_section).before(:another_section)
760
+
761
+ use:
762
+
763
+ sections.place(:my_section).before_any(:another_section)
764
+
765
+ You can see more in the {file:docs/Templates.md#Inserting_and_Traversing_Sections}
766
+ document.
767
+
768
+ ## HTML template now adds inline Table of Contents for extra files pages (0.6.0)
769
+
770
+ A table of contents is now generated dynamically using JavaScript for extra
771
+ file pages (such as README's, or this document). It is generated based off the
772
+ headers (h1,h2,... tags) used in the document, and can be floated to the
773
+ right or listed inline on the page.
774
+
775
+ ## Ad-hoc tag registration via `yardoc` CLI (`--tag`, etc.) (0.6.0)
776
+
777
+ Simple meta-data tags can now be added at the command-line and registered to
778
+ display in templates in a number of pre-defined ways. For instance, to create
779
+ a freeform text tag, use the following:
780
+
781
+ --tag my_tag_name:"My Tag Title"
782
+
783
+ You can also create a "typed" tag (similar to `@return`), a typed named tag
784
+ (similar to `@param`) as well as various combinations. The full list of
785
+ options are listed in `yardoc --help` under the "Tag Options" section.
786
+
787
+ If you wish to create a tag to store data but do not wish to show this data
788
+ in the templates, use the `--hide-tag` option to hide it from generated output:
789
+
790
+ --hide-tag my_tag_name
791
+
792
+ ## Added `--transitive-tags` to register transitive tags (0.6.0)
793
+
794
+ Transitive tags are tags that apply to all descendants of a namespace (class
795
+ or module) when documented on that namespace. For instance, the `@since` tag
796
+ is a transitive tag. Applying `@since` to a class will automatically apply
797
+ `@since` to all methods in the class. Creating a `@since` tag directly on a
798
+ method will override the inherited value.
799
+
800
+ You can specify transitive tags on the command-line by using this option. Note
801
+ that the tags must already exist (built-in or created with the `--tag` option)
802
+ to be specified as transitive. If you wish to do this programmatically, see
803
+ the {YARD::Tags::Library.transitive_tags} attribute.
804
+
805
+ ## `yardoc` now displays RDoc-like statistics (`--no-stats` to hide) (0.6.0)
806
+
807
+ As seen in the `yard stats` feature overview, `yardoc` displays RDoc-like
808
+ statistics when it is run. The output is equivalent to typing `yard stats`.
809
+ To hide this output when yardoc is run, use `--no-stats`.
810
+
811
+ ## `yri` now works on constants (0.6.0)
812
+
813
+ Templates have now been added for text view of constants, which displays any
814
+ documentation and the constant value.
815
+
816
+ ## Plugins are no longer auto-loaded (added `--plugin` switch) (0.6.2)
817
+
818
+ This is a backwards-incompatible change that disables plugins from automatically
819
+ loading when YARD starts up. From now on, you should manually declare which
820
+ plugins your project is using by adding `--plugin PLUGINNAME` to a `.yardopts`
821
+ file in the root of your project. You can also re-enable autoloaded plugins
822
+ by setting `load_plugins` to true in your configuration file (`yard config load_plugins true`,
823
+ see next item). You can also set `autoload_plugins` to a list of plugins
824
+ to be automatically loaded on start.
825
+
826
+ If you are a YARD plugin author, please make sure to inform your users of these
827
+ changes.
828
+
829
+ Note that `--plugin` switches passed on the commandline (not via `.yardopts`)
830
+ are parsed before commands are loaded, and therefore can add in new CLI commands.
831
+
832
+ ## Added `YARD::Config` API and `~/.yard/config` configuration file (0.6.2)
833
+
834
+ There is a new global configuration API that can be accessed programmatically
835
+ and set via the `~/.yard/config` file. The file is encoded as a YAML file,
836
+ and looks like:
837
+
838
+ :load_plugins: false
839
+ :ignored_plugins:
840
+ - my_plugin
841
+ - my_other_plugin
842
+ :autoload_plugins:
843
+ - my_autoload_plugin
844
+ :safe_mode: false
845
+
846
+ You can also set configuration options via the command-line (see next item).
847
+
848
+ ## Added `yard config` command to view/edit configuration (0.6.2)
849
+
850
+ A new `yard config` command was created to view or edit the configuration
851
+ file via the commandline.
852
+
853
+ * To view the current configuration use `yard config --list`.
854
+ * To view a specific item use `yard config ITEMNAME`
855
+ * To modify an item value use `yard config ITEMNAME VALUE`
856
+
857
+ ## Added `yard server -t` template path switch (0.6.2)
858
+
859
+ The `yard server` command now accepts `-t` or `--template-path` to register
860
+ a new template path for template customization.
861
+
862
+ ## Added `YARD::Server.register_static_path` for static server assets (0.6.2)
863
+
864
+ The server now supports a command to register static asset paths. If you are
865
+ extending the YARD::Server modules, make sure to register your asset paths
866
+ through this method.
867
+
868
+ ## YARD::Registry is now thread local (0.6.5)
869
+
870
+ Creating a new thread will now implicitly load a new Registry that can be used
871
+ to parse and process new code objects independently of the other threads. Note
872
+ that this means you can no longer use the Registry across threads; you must
873
+ either access the threadlocal object directly, or synchronize threads to do
874
+ the processing in the initial registry's thread.
875
+
876
+ ## Support for ripper gem in Ruby 1.8.7 (0.6.5)
877
+
878
+ YARD now supports the Ruby 1.8.7 port of the `ripper` gem to improve parsing
879
+ of source, both in terms of performance and functionality. When the `ripper`
880
+ gem is available, YARD will use the "new-style" handlers. You can take advantage
881
+ of this functionality by performing a `gem install ripper`.
882
+
883
+
884
+ What's New in 0.5.x?
885
+ ====================
886
+
887
+ 1. **Support for documenting native Ruby C code** (0.5.0)
888
+ 2. **Incremental parsing and output generation with `yardoc -c`** (0.5.0, 0.5.3)
889
+ 2. **Improved `yri` support to perform lookups on installed Gems** (0.5.0)
890
+ 3. **Added `yardoc --default-return` and `yardoc --hide-void-return`** (0.5.0)
891
+ 4. **Multiple syntax highlighting language support** (0.5.0)
892
+ 5. **New .yardoc format** (0.5.0)
893
+ 6. **Support for yard-doc-* gem packages as hosted .yardoc dbs** (0.5.1)
894
+ 7. **Support for extra search paths in `yri`** (0.5.1)
895
+ 8. **Generating HTML docs now adds frames view** (0.5.3)
896
+ 9. **Tree view for class list** (0.5.3)
897
+ 10. **Ability to specify markup format of extra files** (0.5.3)
898
+ 11. **Keyboard shortcuts for default HTML template** (0.5.4)
899
+
900
+ Support for documenting native Ruby C code (0.5.0)
901
+ --------------------------------------------------
902
+
903
+ It is now possible to document native Ruby extensions with YARD with a new
904
+ C parser mostly borrowed from RDoc. This enables the ability to document
905
+ Ruby's core and stdlibs which will be hosted on http://yardoc.org/docs. In
906
+ addition, the .yardoc dump for the Ruby-core classes will become available
907
+ as an installable gem for yri support (see #3).
908
+
909
+ Incremental parsing and output generation with `yardoc -c` (0.5.0, 0.5.3)
910
+ -------------------------------------------------------------------------
911
+
912
+ <p class="note">Note: in 0.5.3 and above you must use <tt>--incremental</tt>
913
+ to incrementally generate HTML, otherwise only parsing will be done
914
+ incrementally but HTML will be generated with all objects. <tt>--incremental</tt>
915
+ implies <tt>-c</tt>, so no need to specify them both.</p>
916
+
917
+ YARD now compares file checksums before parsing when using `yardoc -c`
918
+ (aka `yardoc --use-cache`) to do incremental parsing of only the files that
919
+ have changed. HTML (or other output format) generation will also only be
920
+ done on the objects that were parsed from changed files (\*). This makes doing
921
+ a documentation development cycle much faster for quick HTML previews. Just
922
+ remember that when using incremental output generation, the index will not
923
+ be rebuilt and inter-file links might not hook up right, so it is best to
924
+ perform a full rebuild at the end of such previews.
925
+
926
+ (\*) Only for versions prior to 0.5.3. For 0.5.3+, use `--incremental` for
927
+ incremental HTML output.
928
+
929
+ Improved `yri` support to perform lookups on installed Gems (0.5.0)
930
+ -------------------------------------------------------------------
931
+
932
+ The `yri` executable can now perform lookups on gems that have been parsed
933
+ by yard. Therefore, to use this command you must first parse all gems with
934
+ YARD. To parse all gems, use the following command:
935
+
936
+ $ sudo yardoc --build-gems
937
+
938
+ The above command builds a .yardoc file for all installed gems in the
939
+ respective gem directory. If you do not have write access to the gem path,
940
+ YARD will write the yardoc file to `~/.yard/gem_index/NAME-VERSION.yardoc`.
941
+
942
+ Note: you can also use `--re-build-gems` to force re-parsing of all gems.
943
+
944
+ You can now do lookups with yri:
945
+
946
+ $ yri JSON
947
+
948
+ All lookups are cached to `~/.yard/yri_cache` for quicker lookups the second
949
+ time onward.
950
+
951
+ Added `yardoc --default-return` and `yardoc --hide-void-return` (0.5.0)
952
+ -----------------------------------------------------------------------
953
+
954
+ YARD defaults to displaying (Object) as the default return type of any
955
+ method that has not declared a @return tag. To customize the default
956
+ return type, you can specify:
957
+
958
+ $ yardoc --default-return 'MyDefaultType'
959
+
960
+ You can also use the empty string to list no return type.
961
+
962
+ In addition, you can use --hide-void-return to ignore any method that
963
+ defines itself as a void type by: `@return [void]`
964
+
965
+ Multiple syntax highlighting language support (0.5.0)
966
+ -----------------------------------------------------
967
+
968
+ YARD now supports the ability to specify a language type for code blocks in
969
+ docstrings. Although no actual highlighting support is added for any language
970
+ but Ruby, you can add your own support by writing your own helper method:
971
+
972
+ # Where LANGNAME is the language:
973
+ def html_syntax_highlight_LANGNAME(source)
974
+ # return highlighted HTML
975
+ end
976
+
977
+ To use this language in code blocks, prefix the block with `!!!LANGNAME`:
978
+
979
+ !!!plain
980
+ !!!python
981
+ def python_code(self):
982
+ return self
983
+
984
+ By the same token. you can now use `!!!plain` to ignore highlighting for
985
+ a specific code block.
986
+
987
+ New .yardoc format (0.5.0)
988
+ --------------------------
989
+
990
+ To make the above yri support possible, the .yardoc format was redesigned
991
+ to be a directory instead of a file. YARD can still load old .yardoc files,
992
+ but they will be automatically upgraded if re-saved. The new .yardoc format
993
+ does have a larger memory footprint, but this will hopefully be optimized
994
+ downward.
995
+
996
+ Support for yard-doc-* gem packages as hosted .yardoc dbs (0.5.1)
997
+ -----------------------------------------------------------------
998
+
999
+ You can now install special YARD plugin gems titled yard-doc-NAME to get
1000
+ packaged a .yardoc database. This will enable yri lookups or building docs
1001
+ for the gem without the code.
1002
+
1003
+ One main use for this is the `yard-doc-core` package, which enabled yri
1004
+ support for Ruby core classes (stdlib coming soon as `yard-doc-stdlib`).
1005
+ To install it, simply:
1006
+
1007
+ $ sudo gem install yard-doc-core
1008
+ # now you can use:
1009
+ $ yri String
1010
+
1011
+ This will by default install the 1.9.1 core library. To install a library
1012
+ for a specific version of Ruby, use the `--version` switch on gem:
1013
+
1014
+ $ sudo gem install --version '= 1.8.6' yard-doc-core
1015
+
1016
+ Support for extra search paths in `yri` (0.5.1)
1017
+ -----------------------------------------------
1018
+
1019
+ You can now add custom paths to non-gem .yardoc files
1020
+ by adding them as newline separated paths in `~/.yard/yri_search_paths`.
1021
+
1022
+ Generating HTML docs now adds frames view (0.5.3)
1023
+ -------------------------------------------------
1024
+
1025
+ `yardoc` will now create a `frames.html` file when generating HTML documents
1026
+ which allows the user to view documentation inside frames, for those users who
1027
+ still find frames beneficial.
1028
+
1029
+ Tree view for class list (0.5.3)
1030
+ --------------------------------
1031
+
1032
+ The class list now displays as an expandable tree view to better organized an
1033
+ otherwise cluttered namespace. If you properly namespace your less important
1034
+ classes (like Rails timezone classes), they will not take up space in the
1035
+ class list unless the user looks for them.
1036
+
1037
+ Ability to specify markup format of extra files (0.5.3)
1038
+ -------------------------------------------------------
1039
+
1040
+ You can now specify the markup format of an extra file (like README) at the
1041
+ top of the file with a shebang-like line:
1042
+
1043
+ #!textile
1044
+ contents here
1045
+
1046
+ The above file contents will be rendered with a textile markup engine
1047
+ (eg. RedCloth).
1048
+
1049
+ Keyboard shortcuts for default HTML template (0.5.4)
1050
+ ----------------------------------------------------
1051
+
1052
+ You can now access the "Class List", "Method List" and "File List" with the
1053
+ 'c', 'm' and 'f' keyboard shortcuts in the default HTML template, allowing
1054
+ for keyboard-only navigation around YARD documentation.
1055
+
1056
+ API for registering custom parsers (0.5.6)
1057
+ ------------------------------------------
1058
+
1059
+ You can now register parsers for custom source languages by calling the
1060
+ following method:
1061
+
1062
+ SourceParser.register_parser_type(:java, MyJavaParser, 'java')
1063
+
1064
+ The parser class MyJavaParser should be a subclass of {YARD::Parser::Base},
1065
+ and the last argument is a set of extensions (string, array or regexp). You
1066
+ can read more about registering parsers at the {YARD::Parser::SourceParser}
1067
+ class documentation.
1068
+
1069
+
1070
+ What's New in 0.4.x?
1071
+ ====================
1072
+
1073
+ 1. **New templating engine and templates**
1074
+ 2. **yardoc `--query` argument**
1075
+ 3. **Greatly expanded API documentation**
1076
+ 4. **New plugin support**
1077
+ 5. **New tags (@abstract, @private)**
1078
+ 6. **Default rake task is now `rake yard`**
1079
+
1080
+ New templating engine and templates
1081
+ -----------------------------------
1082
+
1083
+ The templates were redesigned, most notably removing the ugly frameset, adding
1084
+ search to the class/method lists, simplifying the layout and making things
1085
+ generally prettier. You should also notice that more tags are now visible in
1086
+ the templates such as @todo, the new @abstract and @note tags and some others
1087
+ that existed but were previously omitted from the generated documentation.
1088
+
1089
+ There is also a new templating engine (based on the tadpole templating library)
1090
+ to allow for much more user customization. You can read about it in
1091
+ {file:docs/Templates.md}.
1092
+
1093
+ yardoc `--query` argument
1094
+ -------------------------
1095
+
1096
+ The yardoc command-line tool now supports queries to select which classes,
1097
+ modules or methods to include in documentation based on their data or meta-data.
1098
+ For instance, you can now generate documentation for your "public" API only by
1099
+ adding "@api public" to each of your public API methods/classes and using
1100
+ the following argument:
1101
+
1102
+ --query '@api.text == "public"'
1103
+
1104
+ More information on queries is in the {file:README.md}.
1105
+
1106
+ Greatly expanded API documentation
1107
+ ----------------------------------
1108
+
1109
+ Last release focused on many how-to and architecture documents to explain
1110
+ the design of YARD, but many of the actual API classes/methods were still
1111
+ left undocumented. This release marks a focus on getting YARD's own documentation
1112
+ up to par so that it can serve as an official reference on the recommended
1113
+ conventions to use when documenting code.
1114
+
1115
+ New plugin support
1116
+ ------------------
1117
+
1118
+ YARD now supports loading of plugins via RubyGems. Any gem named `yard-*` or
1119
+ `yard_*` will now be loaded when YARD starts up. Note that the '-' separator
1120
+ is the recommended naming scheme.
1121
+
1122
+ To ignore plugins, add the gem names to `~/.yard/ignored_plugins` on separate
1123
+ lines (or separated by whitespace).
1124
+
1125
+ New tags (@abstract, @private)
1126
+ ------------------------------
1127
+
1128
+ Two new tags were added to the list of builtin meta-tags in YARD. `@abstract`
1129
+ marks a class/module/method as abstract while `@private` marks an object
1130
+ as "private". The latter tag is used in situations where an object is public
1131
+ due to Ruby's own visibility limitations (constants, classes and modules
1132
+ can never be private) but not actually part of your public API. You should
1133
+ use this tag sparingly, as it is not meant to be an equivalent to RDoc's
1134
+ `:nodoc:` tag. Remember, YARD recommends documenting private objects too.
1135
+ This tag exists so that you can create a query (`--query !@private`) to
1136
+ ignore all of these private objects in your documentation. You can also
1137
+ use the new `--no-private` switch, which is a shortcut to the aforementioned
1138
+ query. You can read more about the new tags in the {file:docs/GettingStarted.md}
1139
+ guide.
1140
+
1141
+ Default rake task is now `rake yard`
1142
+ ------------------------------------
1143
+
1144
+ Not a big change, but anyone using the default "rake yardoc" task should
1145
+ update their scripts:
1146
+
1147
+ [http://github.com/lsegal/yard/commit/ad38a68dd73898b06bd5d0a1912b7d815878fae0](http://github.com/lsegal/yard/commit/ad38a68dd73898b06bd5d0a1912b7d815878fae0)
1148
+
1149
+
1150
+ What's New in 0.2.3.x?
1151
+ ======================
1152
+
1153
+ 1. **Full Ruby 1.9 support**
1154
+ 2. **New parser code and handler API for 1.9**
1155
+ 3. **A new `@overload` tag**
1156
+ 4. **Better documentation**
1157
+ 5. **Template changes and bug fixes**
1158
+
1159
+ Full Ruby 1.9 support
1160
+ ---------------------
1161
+
1162
+ YARD's development actually focuses primarily on 1.9 from the get-go, so it is
1163
+ not an afterthought. All features are first implemented for compatibility with
1164
+ 1.9, but of course all functionality is also tested in 1.8.x. YARD 0.2.2 was
1165
+ mostly compatible with 1.9, but the new release improves and extends in certain
1166
+ areas where compatibility was lacking. The new release should be fully functional
1167
+ in Ruby 1.9.
1168
+
1169
+ New parser code and handler API for 1.9
1170
+ ---------------------------------------
1171
+
1172
+ Using Ruby 1.9 also gives YARD the advantage of using the new `ripper` library
1173
+ which was added to stdlib. The ripper parser is Ruby's official answer to
1174
+ projects like ParseTree and ruby2ruby. Ripper allows access to the AST as it
1175
+ is parsed by the Ruby compiler. This has some large benefits over alternative
1176
+ projects:
1177
+
1178
+ 1. It is officially supported and maintained by the Ruby core team.
1179
+ 2. The AST is generated directly from the exact same code that drives the
1180
+ compiler, meaning anything that compiles is guaranteed to generate the
1181
+ equivalent AST.
1182
+ 3. It needs no hacks, gems or extra libs and works out of the box in 1.9.
1183
+ 4. It's *fast*.
1184
+
1185
+ Having the AST means that developers looking to extend YARD have much better
1186
+ access to the parsed code than in previous versions. The only caveat is that
1187
+ this library is not back-compatible to 1.8.x. Because of this, there are
1188
+ subtle changes to the handler extension API that developers use to extend YARD.
1189
+ Namely, there is now a standard API for 1.9 and a "legacy" API that can run in
1190
+ both 1.8.x and 1.9 if needed. A developer can still use the legacy API to write
1191
+ handlers that are compatible for both 1.8.x and 1.9 in one shot, or decide to
1192
+ implement the handler using both APIs. Realize that the benefit of using the new
1193
+ API means 1.9 users will get a 2.5x parsing speed increase over running the legacy
1194
+ handlers (this is *in addition to* the ~1.8x speed increase of using YARV over MRI).
1195
+
1196
+ A new `@overload` tag
1197
+ ---------------------
1198
+
1199
+ The new `@overload` tag enables users to document methods that take multiple
1200
+ parameters depending on context. This is basically equivalent to RDoc's call-seq,
1201
+ but with a name that is more akin to the OOP concept of method overloading
1202
+ that is actually being employed. Here's an example:
1203
+
1204
+ # @overload def to_html(html, autolink = true)
1205
+ # This docstring describes the specific overload only.
1206
+ # @param [String] html the HTML
1207
+ # @param [Boolean] autolink whether or not to atuomatically link
1208
+ # URL references
1209
+ # @overload def to_html(html, opts = {})
1210
+ # @param [String] html the HTML
1211
+ # @param [Hash] opts any attributes to add to the root HTML node
1212
+ def to_html(*args)
1213
+ # split args depending on context
1214
+ end
1215
+
1216
+ As you can see each overload takes its own nested tags (including a docstring)
1217
+ as if it were its own method. This allows "virtual" overloading behaviour at
1218
+ the API level to make Ruby look like overload-aware languages without caring
1219
+ about the implementation details required to add the behaviour.
1220
+
1221
+ It is still recommended practice, however, to stay away from overloading when
1222
+ possible and document the types of each method's real parameters. This allows
1223
+ toolkits making use of YARD to get accurate type information for your methods,
1224
+ for instance, allowing IDE autocompletion. There are, of course, situations
1225
+ where overload just makes more sense.
1226
+
1227
+ Better documentation
1228
+ --------------------
1229
+
1230
+ The first few iterations of YARD were very much a proof of concept. Few people
1231
+ were paying attention and it was really just pieced together to see what was
1232
+ feasible. Now that YARD is gaining interest, there are many developers that
1233
+ want to take advantage of its extensibility support to do some really cool stuff.
1234
+ Considerable time was spent for this release documenting, at a high level, what
1235
+ YARD can do and how it can be done. Expect this documentation to be extended and
1236
+ improved in future releases.
1237
+
1238
+ Template changes and bug fixes
1239
+ ------------------------------
1240
+
1241
+ Of course no new release would be complete without fixing the old broken code.
1242
+ Some tags existed but were not present in generated documentation. The templates
1243
+ were mostly fixed to add the major omitted tags. In addition to template adjustments,
1244
+ many parsing bugs were ironed out to make YARD much more stable with existing projects
1245
+ (Rails, HAML, Sinatra, Ramaze, etc.).