yard 0.9.16 → 0.9.17

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of yard might be problematic. Click here for more details.

Files changed (566) hide show
  1. checksums.yaml +5 -5
  2. data/.yardopts +26 -26
  3. data/CHANGELOG.md +728 -728
  4. data/LEGAL +66 -66
  5. data/LICENSE +22 -22
  6. data/README.md +328 -328
  7. data/Rakefile +53 -47
  8. data/benchmarks/builtins_vs_eval.rb +24 -24
  9. data/benchmarks/concat_vs_join.rb +13 -13
  10. data/benchmarks/erb_vs_erubis.rb +54 -54
  11. data/benchmarks/format_args.rb +47 -47
  12. data/benchmarks/generation.rb +38 -38
  13. data/benchmarks/marshal_vs_dbm.rb +64 -64
  14. data/benchmarks/parsing.rb +46 -46
  15. data/benchmarks/pathname_vs_string.rb +50 -50
  16. data/benchmarks/rdoc_vs_yardoc.rb +11 -11
  17. data/benchmarks/registry_store_types.rb +49 -49
  18. data/benchmarks/ri_vs_yri.rb +19 -19
  19. data/benchmarks/ripper_parser.rb +13 -13
  20. data/benchmarks/splat_vs_flatten.rb +13 -13
  21. data/benchmarks/template_erb.rb +23 -23
  22. data/benchmarks/template_format.rb +7 -7
  23. data/benchmarks/template_profile.rb +18 -18
  24. data/benchmarks/yri_cache.rb +20 -20
  25. data/bin/yard +13 -13
  26. data/bin/yardoc +13 -13
  27. data/bin/yri +13 -13
  28. data/docs/CodeObjects.md +115 -115
  29. data/docs/GettingStarted.md +679 -679
  30. data/docs/Handlers.md +152 -152
  31. data/docs/Overview.md +61 -61
  32. data/docs/Parser.md +191 -191
  33. data/docs/Tags.md +283 -283
  34. data/docs/TagsArch.md +123 -123
  35. data/docs/Templates.md +496 -496
  36. data/docs/WhatsNew.md +1245 -1245
  37. data/docs/templates/default/fulldoc/html/full_list_tag.erb +8 -8
  38. data/docs/templates/default/fulldoc/html/setup.rb +6 -6
  39. data/docs/templates/default/layout/html/setup.rb +9 -9
  40. data/docs/templates/default/layout/html/tag_list.erb +11 -11
  41. data/docs/templates/default/yard_tags/html/list.erb +18 -18
  42. data/docs/templates/default/yard_tags/html/setup.rb +26 -26
  43. data/docs/templates/plugin.rb +70 -70
  44. data/lib/rubygems_plugin.rb +9 -9
  45. data/lib/yard.rb +69 -69
  46. data/lib/yard/autoload.rb +303 -303
  47. data/lib/yard/cli/command.rb +85 -85
  48. data/lib/yard/cli/command_parser.rb +93 -93
  49. data/lib/yard/cli/config.rb +198 -198
  50. data/lib/yard/cli/diff.rb +270 -270
  51. data/lib/yard/cli/display.rb +69 -69
  52. data/lib/yard/cli/gems.rb +84 -84
  53. data/lib/yard/cli/graph.rb +125 -125
  54. data/lib/yard/cli/help.rb +20 -20
  55. data/lib/yard/cli/i18n.rb +70 -70
  56. data/lib/yard/cli/list.rb +23 -23
  57. data/lib/yard/cli/markup_types.rb +32 -32
  58. data/lib/yard/cli/server.rb +257 -257
  59. data/lib/yard/cli/stats.rb +231 -231
  60. data/lib/yard/cli/yardoc.rb +788 -788
  61. data/lib/yard/cli/yardopts_command.rb +110 -110
  62. data/lib/yard/cli/yri.rb +215 -215
  63. data/lib/yard/code_objects/base.rb +615 -610
  64. data/lib/yard/code_objects/class_object.rb +146 -146
  65. data/lib/yard/code_objects/class_variable_object.rb +11 -11
  66. data/lib/yard/code_objects/constant_object.rb +16 -16
  67. data/lib/yard/code_objects/extended_method_object.rb +24 -24
  68. data/lib/yard/code_objects/extra_file_object.rb +131 -131
  69. data/lib/yard/code_objects/macro_object.rb +172 -172
  70. data/lib/yard/code_objects/method_object.rb +196 -196
  71. data/lib/yard/code_objects/module_object.rb +21 -21
  72. data/lib/yard/code_objects/namespace_mapper.rb +114 -114
  73. data/lib/yard/code_objects/namespace_object.rb +200 -200
  74. data/lib/yard/code_objects/proxy.rb +240 -240
  75. data/lib/yard/code_objects/root_object.rb +19 -19
  76. data/lib/yard/config.rb +270 -270
  77. data/lib/yard/core_ext/array.rb +16 -16
  78. data/lib/yard/core_ext/file.rb +69 -69
  79. data/lib/yard/core_ext/hash.rb +16 -16
  80. data/lib/yard/core_ext/insertion.rb +63 -63
  81. data/lib/yard/core_ext/module.rb +20 -20
  82. data/lib/yard/core_ext/string.rb +68 -68
  83. data/lib/yard/core_ext/symbol_hash.rb +75 -75
  84. data/lib/yard/docstring.rb +386 -378
  85. data/lib/yard/docstring_parser.rb +345 -345
  86. data/lib/yard/gem_index.rb +29 -29
  87. data/lib/yard/globals.rb +22 -22
  88. data/lib/yard/handlers/base.rb +595 -595
  89. data/lib/yard/handlers/c/alias_handler.rb +16 -16
  90. data/lib/yard/handlers/c/attribute_handler.rb +13 -13
  91. data/lib/yard/handlers/c/base.rb +129 -129
  92. data/lib/yard/handlers/c/class_handler.rb +27 -27
  93. data/lib/yard/handlers/c/constant_handler.rb +13 -13
  94. data/lib/yard/handlers/c/handler_methods.rb +211 -211
  95. data/lib/yard/handlers/c/init_handler.rb +20 -20
  96. data/lib/yard/handlers/c/method_handler.rb +45 -36
  97. data/lib/yard/handlers/c/mixin_handler.rb +21 -21
  98. data/lib/yard/handlers/c/module_handler.rb +17 -17
  99. data/lib/yard/handlers/c/override_comment_handler.rb +31 -31
  100. data/lib/yard/handlers/c/path_handler.rb +11 -11
  101. data/lib/yard/handlers/c/struct_handler.rb +13 -13
  102. data/lib/yard/handlers/c/symbol_handler.rb +8 -8
  103. data/lib/yard/handlers/processor.rb +200 -200
  104. data/lib/yard/handlers/ruby/alias_handler.rb +44 -44
  105. data/lib/yard/handlers/ruby/attribute_handler.rb +87 -87
  106. data/lib/yard/handlers/ruby/base.rb +165 -165
  107. data/lib/yard/handlers/ruby/class_condition_handler.rb +92 -92
  108. data/lib/yard/handlers/ruby/class_handler.rb +119 -119
  109. data/lib/yard/handlers/ruby/class_variable_handler.rb +17 -17
  110. data/lib/yard/handlers/ruby/comment_handler.rb +10 -10
  111. data/lib/yard/handlers/ruby/constant_handler.rb +59 -59
  112. data/lib/yard/handlers/ruby/decorator_handler_methods.rb +123 -123
  113. data/lib/yard/handlers/ruby/dsl_handler.rb +15 -15
  114. data/lib/yard/handlers/ruby/dsl_handler_methods.rb +96 -95
  115. data/lib/yard/handlers/ruby/exception_handler.rb +27 -27
  116. data/lib/yard/handlers/ruby/extend_handler.rb +22 -22
  117. data/lib/yard/handlers/ruby/legacy/alias_handler.rb +37 -37
  118. data/lib/yard/handlers/ruby/legacy/attribute_handler.rb +65 -65
  119. data/lib/yard/handlers/ruby/legacy/base.rb +245 -245
  120. data/lib/yard/handlers/ruby/legacy/class_condition_handler.rb +83 -83
  121. data/lib/yard/handlers/ruby/legacy/class_handler.rb +113 -113
  122. data/lib/yard/handlers/ruby/legacy/class_variable_handler.rb +15 -15
  123. data/lib/yard/handlers/ruby/legacy/comment_handler.rb +10 -10
  124. data/lib/yard/handlers/ruby/legacy/constant_handler.rb +29 -29
  125. data/lib/yard/handlers/ruby/legacy/dsl_handler.rb +17 -17
  126. data/lib/yard/handlers/ruby/legacy/exception_handler.rb +13 -13
  127. data/lib/yard/handlers/ruby/legacy/extend_handler.rb +21 -21
  128. data/lib/yard/handlers/ruby/legacy/method_handler.rb +90 -90
  129. data/lib/yard/handlers/ruby/legacy/mixin_handler.rb +39 -39
  130. data/lib/yard/handlers/ruby/legacy/module_function_handler.rb +19 -19
  131. data/lib/yard/handlers/ruby/legacy/module_handler.rb +12 -12
  132. data/lib/yard/handlers/ruby/legacy/private_class_method_handler.rb +22 -22
  133. data/lib/yard/handlers/ruby/legacy/private_constant_handler.rb +22 -22
  134. data/lib/yard/handlers/ruby/legacy/visibility_handler.rb +17 -17
  135. data/lib/yard/handlers/ruby/legacy/yield_handler.rb +29 -29
  136. data/lib/yard/handlers/ruby/method_condition_handler.rb +9 -9
  137. data/lib/yard/handlers/ruby/method_handler.rb +118 -118
  138. data/lib/yard/handlers/ruby/mixin_handler.rb +37 -37
  139. data/lib/yard/handlers/ruby/module_function_handler.rb +27 -27
  140. data/lib/yard/handlers/ruby/module_handler.rb +12 -12
  141. data/lib/yard/handlers/ruby/private_class_method_handler.rb +14 -14
  142. data/lib/yard/handlers/ruby/private_constant_handler.rb +43 -43
  143. data/lib/yard/handlers/ruby/public_class_method_handler.rb +14 -14
  144. data/lib/yard/handlers/ruby/struct_handler_methods.rb +143 -143
  145. data/lib/yard/handlers/ruby/visibility_handler.rb +22 -22
  146. data/lib/yard/handlers/ruby/yield_handler.rb +31 -31
  147. data/lib/yard/i18n/locale.rb +67 -67
  148. data/lib/yard/i18n/message.rb +57 -57
  149. data/lib/yard/i18n/messages.rb +56 -56
  150. data/lib/yard/i18n/po_parser.rb +61 -61
  151. data/lib/yard/i18n/pot_generator.rb +290 -290
  152. data/lib/yard/i18n/text.rb +173 -173
  153. data/lib/yard/logging.rb +205 -205
  154. data/lib/yard/options.rb +217 -217
  155. data/lib/yard/parser/base.rb +57 -57
  156. data/lib/yard/parser/c/c_parser.rb +235 -235
  157. data/lib/yard/parser/c/comment_parser.rb +134 -134
  158. data/lib/yard/parser/c/statement.rb +64 -64
  159. data/lib/yard/parser/ruby/ast_node.rb +540 -540
  160. data/lib/yard/parser/ruby/legacy/ruby_lex.rb +1354 -1354
  161. data/lib/yard/parser/ruby/legacy/ruby_parser.rb +32 -32
  162. data/lib/yard/parser/ruby/legacy/statement.rb +66 -66
  163. data/lib/yard/parser/ruby/legacy/statement_list.rb +394 -394
  164. data/lib/yard/parser/ruby/legacy/token_list.rb +74 -74
  165. data/lib/yard/parser/ruby/ruby_parser.rb +687 -687
  166. data/lib/yard/parser/ruby/token_resolver.rb +156 -156
  167. data/lib/yard/parser/source_parser.rb +526 -526
  168. data/lib/yard/rake/yardoc_task.rb +81 -81
  169. data/lib/yard/registry.rb +439 -439
  170. data/lib/yard/registry_resolver.rb +189 -189
  171. data/lib/yard/registry_store.rb +337 -337
  172. data/lib/yard/rubygems/backports.rb +10 -10
  173. data/lib/yard/rubygems/backports/LICENSE.txt +57 -57
  174. data/lib/yard/rubygems/backports/MIT.txt +20 -20
  175. data/lib/yard/rubygems/backports/gem.rb +10 -10
  176. data/lib/yard/rubygems/backports/source_index.rb +365 -365
  177. data/lib/yard/rubygems/doc_manager.rb +90 -90
  178. data/lib/yard/rubygems/hook.rb +197 -197
  179. data/lib/yard/rubygems/specification.rb +50 -50
  180. data/lib/yard/serializers/base.rb +83 -83
  181. data/lib/yard/serializers/file_system_serializer.rb +123 -123
  182. data/lib/yard/serializers/process_serializer.rb +24 -24
  183. data/lib/yard/serializers/stdout_serializer.rb +34 -34
  184. data/lib/yard/serializers/yardoc_serializer.rb +152 -152
  185. data/lib/yard/server.rb +13 -13
  186. data/lib/yard/server/adapter.rb +100 -100
  187. data/lib/yard/server/commands/base.rb +209 -209
  188. data/lib/yard/server/commands/display_file_command.rb +29 -29
  189. data/lib/yard/server/commands/display_object_command.rb +65 -65
  190. data/lib/yard/server/commands/frames_command.rb +16 -16
  191. data/lib/yard/server/commands/library_command.rb +187 -187
  192. data/lib/yard/server/commands/library_index_command.rb +28 -28
  193. data/lib/yard/server/commands/list_command.rb +25 -25
  194. data/lib/yard/server/commands/root_request_command.rb +15 -15
  195. data/lib/yard/server/commands/search_command.rb +79 -79
  196. data/lib/yard/server/commands/static_file_command.rb +23 -23
  197. data/lib/yard/server/commands/static_file_helpers.rb +62 -62
  198. data/lib/yard/server/doc_server_helper.rb +91 -91
  199. data/lib/yard/server/doc_server_serializer.rb +39 -39
  200. data/lib/yard/server/library_version.rb +277 -277
  201. data/lib/yard/server/rack_adapter.rb +89 -89
  202. data/lib/yard/server/router.rb +187 -187
  203. data/lib/yard/server/static_caching.rb +46 -46
  204. data/lib/yard/server/templates/default/fulldoc/html/css/custom.css +127 -127
  205. data/lib/yard/server/templates/default/fulldoc/html/js/autocomplete.js +11 -11
  206. data/lib/yard/server/templates/default/layout/html/breadcrumb.erb +37 -37
  207. data/lib/yard/server/templates/default/layout/html/script_setup.erb +7 -7
  208. data/lib/yard/server/templates/default/layout/html/setup.rb +8 -8
  209. data/lib/yard/server/templates/default/method_details/html/permalink.erb +4 -4
  210. data/lib/yard/server/templates/default/method_details/html/setup.rb +5 -5
  211. data/lib/yard/server/templates/doc_server/library_list/html/headers.erb +8 -8
  212. data/lib/yard/server/templates/doc_server/library_list/html/library_list.erb +14 -14
  213. data/lib/yard/server/templates/doc_server/library_list/html/listing.erb +13 -13
  214. data/lib/yard/server/templates/doc_server/library_list/html/setup.rb +6 -6
  215. data/lib/yard/server/templates/doc_server/library_list/html/title.erb +2 -2
  216. data/lib/yard/server/templates/doc_server/processing/html/processing.erb +52 -52
  217. data/lib/yard/server/templates/doc_server/processing/html/setup.rb +4 -4
  218. data/lib/yard/server/templates/doc_server/search/html/search.erb +18 -18
  219. data/lib/yard/server/templates/doc_server/search/html/setup.rb +9 -9
  220. data/lib/yard/server/webrick_adapter.rb +45 -45
  221. data/lib/yard/tags/default_factory.rb +191 -191
  222. data/lib/yard/tags/default_tag.rb +13 -13
  223. data/lib/yard/tags/directives.rb +616 -616
  224. data/lib/yard/tags/library.rb +633 -633
  225. data/lib/yard/tags/option_tag.rb +13 -13
  226. data/lib/yard/tags/overload_tag.rb +71 -71
  227. data/lib/yard/tags/ref_tag.rb +8 -8
  228. data/lib/yard/tags/ref_tag_list.rb +28 -28
  229. data/lib/yard/tags/tag.rb +71 -71
  230. data/lib/yard/tags/tag_format_error.rb +7 -7
  231. data/lib/yard/tags/types_explainer.rb +162 -162
  232. data/lib/yard/templates/engine.rb +186 -186
  233. data/lib/yard/templates/erb_cache.rb +23 -23
  234. data/lib/yard/templates/helpers/base_helper.rb +215 -215
  235. data/lib/yard/templates/helpers/filter_helper.rb +27 -27
  236. data/lib/yard/templates/helpers/html_helper.rb +646 -642
  237. data/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +78 -78
  238. data/lib/yard/templates/helpers/markup/rdoc_markdown.rb +23 -23
  239. data/lib/yard/templates/helpers/markup/rdoc_markup.rb +109 -109
  240. data/lib/yard/templates/helpers/markup_helper.rb +172 -172
  241. data/lib/yard/templates/helpers/method_helper.rb +75 -75
  242. data/lib/yard/templates/helpers/module_helper.rb +21 -21
  243. data/lib/yard/templates/helpers/text_helper.rb +112 -112
  244. data/lib/yard/templates/helpers/uml_helper.rb +47 -47
  245. data/lib/yard/templates/section.rb +105 -105
  246. data/lib/yard/templates/template.rb +418 -418
  247. data/lib/yard/templates/template_options.rb +92 -92
  248. data/lib/yard/verifier.rb +151 -151
  249. data/lib/yard/version.rb +3 -1
  250. data/spec/cli/command_parser_spec.rb +43 -43
  251. data/spec/cli/command_spec.rb +36 -36
  252. data/spec/cli/config_spec.rb +148 -148
  253. data/spec/cli/diff_spec.rb +254 -254
  254. data/spec/cli/display_spec.rb +30 -30
  255. data/spec/cli/gems_spec.rb +81 -81
  256. data/spec/cli/graph_spec.rb +18 -18
  257. data/spec/cli/help_spec.rb +22 -22
  258. data/spec/cli/i18n_spec.rb +107 -107
  259. data/spec/cli/list_spec.rb +8 -8
  260. data/spec/cli/markup_types_spec.rb +22 -22
  261. data/spec/cli/server_spec.rb +324 -324
  262. data/spec/cli/stats_spec.rb +96 -96
  263. data/spec/cli/yard_on_yard_spec.rb +38 -38
  264. data/spec/cli/yardoc_spec.rb +862 -849
  265. data/spec/cli/yri_spec.rb +101 -101
  266. data/spec/code_objects/base_spec.rb +470 -460
  267. data/spec/code_objects/class_object_spec.rb +226 -226
  268. data/spec/code_objects/code_object_list_spec.rb +36 -36
  269. data/spec/code_objects/constants_spec.rb +116 -116
  270. data/spec/code_objects/extra_file_object_spec.rb +160 -160
  271. data/spec/code_objects/macro_object_spec.rb +150 -150
  272. data/spec/code_objects/method_object_spec.rb +184 -184
  273. data/spec/code_objects/module_object_spec.rb +142 -142
  274. data/spec/code_objects/namespace_object_spec.rb +171 -171
  275. data/spec/code_objects/proxy_spec.rb +141 -141
  276. data/spec/code_objects/spec_helper.rb +3 -3
  277. data/spec/config_spec.rb +171 -171
  278. data/spec/core_ext/array_spec.rb +13 -13
  279. data/spec/core_ext/file_spec.rb +72 -72
  280. data/spec/core_ext/hash_spec.rb +14 -14
  281. data/spec/core_ext/insertion_spec.rb +37 -37
  282. data/spec/core_ext/module_spec.rb +15 -15
  283. data/spec/core_ext/string_spec.rb +42 -42
  284. data/spec/core_ext/symbol_hash_spec.rb +89 -89
  285. data/spec/docstring_parser_spec.rb +280 -262
  286. data/spec/docstring_spec.rb +373 -364
  287. data/spec/examples.txt +1875 -1871
  288. data/spec/handlers/alias_handler_spec.rb +82 -82
  289. data/spec/handlers/attribute_handler_spec.rb +96 -96
  290. data/spec/handlers/base_spec.rb +216 -216
  291. data/spec/handlers/c/alias_handler_spec.rb +34 -34
  292. data/spec/handlers/c/attribute_handler_spec.rb +41 -41
  293. data/spec/handlers/c/class_handler_spec.rb +78 -78
  294. data/spec/handlers/c/constant_handler_spec.rb +71 -71
  295. data/spec/handlers/c/init_handler_spec.rb +48 -48
  296. data/spec/handlers/c/method_handler_spec.rb +325 -325
  297. data/spec/handlers/c/mixin_handler_spec.rb +44 -44
  298. data/spec/handlers/c/module_handler_spec.rb +71 -71
  299. data/spec/handlers/c/override_comment_handler_spec.rb +47 -47
  300. data/spec/handlers/c/path_handler_spec.rb +36 -36
  301. data/spec/handlers/c/spec_helper.rb +23 -23
  302. data/spec/handlers/c/struct_handler_spec.rb +16 -16
  303. data/spec/handlers/class_condition_handler_spec.rb +87 -87
  304. data/spec/handlers/class_handler_spec.rb +247 -247
  305. data/spec/handlers/class_method_handler_shared_examples.rb +133 -133
  306. data/spec/handlers/class_variable_handler_spec.rb +12 -12
  307. data/spec/handlers/constant_handler_spec.rb +112 -112
  308. data/spec/handlers/decorator_handler_methods_spec.rb +393 -393
  309. data/spec/handlers/dsl_handler_spec.rb +219 -219
  310. data/spec/handlers/examples/alias_handler_001.rb.txt +45 -45
  311. data/spec/handlers/examples/attribute_handler_001.rb.txt +31 -31
  312. data/spec/handlers/examples/class_condition_handler_001.rb.txt +68 -68
  313. data/spec/handlers/examples/class_handler_001.rb.txt +120 -120
  314. data/spec/handlers/examples/class_variable_handler_001.rb.txt +9 -9
  315. data/spec/handlers/examples/constant_handler_001.rb.txt +35 -35
  316. data/spec/handlers/examples/dsl_handler_001.rb.txt +154 -154
  317. data/spec/handlers/examples/exception_handler_001.rb.txt +58 -58
  318. data/spec/handlers/examples/extend_handler_001.rb.txt +15 -15
  319. data/spec/handlers/examples/method_condition_handler_001.rb.txt +9 -9
  320. data/spec/handlers/examples/method_handler_001.rb.txt +128 -128
  321. data/spec/handlers/examples/mixin_handler_001.rb.txt +37 -37
  322. data/spec/handlers/examples/module_handler_001.rb.txt +29 -29
  323. data/spec/handlers/examples/private_constant_handler_001.rb.txt +8 -8
  324. data/spec/handlers/examples/process_handler_001.rb.txt +11 -11
  325. data/spec/handlers/examples/visibility_handler_001.rb.txt +35 -35
  326. data/spec/handlers/examples/yield_handler_001.rb.txt +54 -54
  327. data/spec/handlers/exception_handler_spec.rb +49 -49
  328. data/spec/handlers/extend_handler_spec.rb +24 -24
  329. data/spec/handlers/legacy_base_spec.rb +128 -128
  330. data/spec/handlers/method_condition_handler_spec.rb +15 -15
  331. data/spec/handlers/method_handler_spec.rb +190 -190
  332. data/spec/handlers/mixin_handler_spec.rb +56 -56
  333. data/spec/handlers/module_function_handler_spec.rb +106 -106
  334. data/spec/handlers/module_handler_spec.rb +35 -35
  335. data/spec/handlers/private_class_method_handler_spec.rb +11 -11
  336. data/spec/handlers/private_constant_handler_spec.rb +25 -25
  337. data/spec/handlers/processor_spec.rb +35 -35
  338. data/spec/handlers/public_class_method_handler_spec.rb +11 -11
  339. data/spec/handlers/ruby/base_spec.rb +95 -95
  340. data/spec/handlers/ruby/legacy/base_spec.rb +84 -84
  341. data/spec/handlers/spec_helper.rb +33 -33
  342. data/spec/handlers/visibility_handler_spec.rb +44 -44
  343. data/spec/handlers/yield_handler_spec.rb +52 -52
  344. data/spec/i18n/locale_spec.rb +81 -81
  345. data/spec/i18n/message_spec.rb +52 -52
  346. data/spec/i18n/messages_spec.rb +67 -67
  347. data/spec/i18n/pot_generator_spec.rb +295 -295
  348. data/spec/i18n/text_spec.rb +184 -184
  349. data/spec/logging_spec.rb +44 -44
  350. data/spec/options_spec.rb +171 -171
  351. data/spec/parser/base_spec.rb +24 -24
  352. data/spec/parser/c_parser_spec.rb +236 -223
  353. data/spec/parser/examples/array.c.txt +6267 -6267
  354. data/spec/parser/examples/example1.rb.txt +7 -7
  355. data/spec/parser/examples/extrafile.c.txt +8 -8
  356. data/spec/parser/examples/file.c.txt +28 -0
  357. data/spec/parser/examples/multifile.c.txt +22 -22
  358. data/spec/parser/examples/namespace.cpp.txt +68 -68
  359. data/spec/parser/examples/override.c.txt +424 -424
  360. data/spec/parser/examples/parse_in_order_001.rb.txt +2 -2
  361. data/spec/parser/examples/parse_in_order_002.rb.txt +1 -1
  362. data/spec/parser/examples/tag_handler_001.rb.txt +7 -7
  363. data/spec/parser/ruby/ast_node_spec.rb +33 -33
  364. data/spec/parser/ruby/legacy/statement_list_spec.rb +299 -299
  365. data/spec/parser/ruby/legacy/token_list_spec.rb +79 -79
  366. data/spec/parser/ruby/ruby_parser_spec.rb +508 -508
  367. data/spec/parser/ruby/token_resolver_spec.rb +165 -165
  368. data/spec/parser/source_parser_spec.rb +727 -727
  369. data/spec/parser/tag_parsing_spec.rb +17 -17
  370. data/spec/rake/yardoc_task_spec.rb +118 -118
  371. data/spec/registry_spec.rb +463 -463
  372. data/spec/registry_store_spec.rb +316 -316
  373. data/spec/rubygems/doc_manager_spec.rb +112 -112
  374. data/spec/serializers/data/serialized_yardoc/checksums +1 -1
  375. data/spec/serializers/file_system_serializer_spec.rb +145 -145
  376. data/spec/serializers/spec_helper.rb +2 -2
  377. data/spec/serializers/yardoc_serializer_spec.rb +78 -78
  378. data/spec/server/adapter_spec.rb +39 -39
  379. data/spec/server/commands/base_spec.rb +91 -91
  380. data/spec/server/commands/library_command_spec.rb +39 -39
  381. data/spec/server/doc_server_helper_spec.rb +72 -72
  382. data/spec/server/doc_server_serializer_spec.rb +60 -60
  383. data/spec/server/rack_adapter_spec.rb +21 -21
  384. data/spec/server/router_spec.rb +123 -123
  385. data/spec/server/spec_helper.rb +22 -22
  386. data/spec/server/static_caching_spec.rb +47 -47
  387. data/spec/server/webrick_servlet_spec.rb +20 -20
  388. data/spec/server_spec.rb +19 -19
  389. data/spec/spec_helper.rb +212 -212
  390. data/spec/tags/default_factory_spec.rb +168 -168
  391. data/spec/tags/default_tag_spec.rb +11 -11
  392. data/spec/tags/directives_spec.rb +463 -463
  393. data/spec/tags/library_spec.rb +48 -48
  394. data/spec/tags/overload_tag_spec.rb +53 -53
  395. data/spec/tags/ref_tag_list_spec.rb +53 -53
  396. data/spec/tags/types_explainer_spec.rb +203 -203
  397. data/spec/templates/class_spec.rb +45 -45
  398. data/spec/templates/constant_spec.rb +41 -41
  399. data/spec/templates/engine_spec.rb +131 -131
  400. data/spec/templates/examples/class001.html +308 -308
  401. data/spec/templates/examples/class001.txt +36 -36
  402. data/spec/templates/examples/class002.html +39 -39
  403. data/spec/templates/examples/constant001.txt +24 -24
  404. data/spec/templates/examples/constant002.txt +6 -6
  405. data/spec/templates/examples/constant003.txt +10 -10
  406. data/spec/templates/examples/method001.html +137 -137
  407. data/spec/templates/examples/method001.txt +35 -35
  408. data/spec/templates/examples/method002.html +91 -91
  409. data/spec/templates/examples/method002.txt +20 -20
  410. data/spec/templates/examples/method003.html +165 -165
  411. data/spec/templates/examples/method003.txt +45 -45
  412. data/spec/templates/examples/method004.html +48 -48
  413. data/spec/templates/examples/method004.txt +10 -10
  414. data/spec/templates/examples/method005.html +105 -105
  415. data/spec/templates/examples/method005.txt +33 -33
  416. data/spec/templates/examples/method006.html +107 -107
  417. data/spec/templates/examples/method006.txt +20 -20
  418. data/spec/templates/examples/module001.dot +33 -33
  419. data/spec/templates/examples/module001.html +833 -833
  420. data/spec/templates/examples/module001.txt +33 -33
  421. data/spec/templates/examples/module002.html +341 -341
  422. data/spec/templates/examples/module003.html +202 -202
  423. data/spec/templates/examples/module004.html +394 -394
  424. data/spec/templates/examples/module005.html +81 -81
  425. data/spec/templates/examples/tag001.txt +82 -82
  426. data/spec/templates/helpers/base_helper_spec.rb +171 -171
  427. data/spec/templates/helpers/html_helper_spec.rb +668 -653
  428. data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb +65 -65
  429. data/spec/templates/helpers/markup/rdoc_markup_spec.rb +84 -84
  430. data/spec/templates/helpers/markup_helper_spec.rb +136 -136
  431. data/spec/templates/helpers/method_helper_spec.rb +107 -107
  432. data/spec/templates/helpers/module_helper_spec.rb +35 -35
  433. data/spec/templates/helpers/shared_signature_examples.rb +126 -126
  434. data/spec/templates/helpers/text_helper_spec.rb +65 -65
  435. data/spec/templates/method_spec.rb +118 -118
  436. data/spec/templates/module_spec.rb +203 -203
  437. data/spec/templates/onefile_spec.rb +66 -66
  438. data/spec/templates/section_spec.rb +144 -144
  439. data/spec/templates/spec_helper.rb +76 -76
  440. data/spec/templates/tag_spec.rb +52 -52
  441. data/spec/templates/template_spec.rb +410 -410
  442. data/spec/verifier_spec.rb +106 -106
  443. data/templates/default/class/dot/setup.rb +7 -7
  444. data/templates/default/class/dot/superklass.erb +2 -2
  445. data/templates/default/class/html/constructor_details.erb +8 -8
  446. data/templates/default/class/html/setup.rb +2 -2
  447. data/templates/default/class/html/subclasses.erb +4 -4
  448. data/templates/default/class/setup.rb +36 -36
  449. data/templates/default/class/text/setup.rb +12 -12
  450. data/templates/default/class/text/subclasses.erb +5 -5
  451. data/templates/default/constant/text/header.erb +11 -11
  452. data/templates/default/constant/text/setup.rb +4 -4
  453. data/templates/default/docstring/html/abstract.erb +4 -4
  454. data/templates/default/docstring/html/deprecated.erb +1 -1
  455. data/templates/default/docstring/html/index.erb +5 -5
  456. data/templates/default/docstring/html/note.erb +6 -6
  457. data/templates/default/docstring/html/private.erb +4 -4
  458. data/templates/default/docstring/html/text.erb +1 -1
  459. data/templates/default/docstring/html/todo.erb +6 -6
  460. data/templates/default/docstring/setup.rb +52 -52
  461. data/templates/default/docstring/text/abstract.erb +2 -2
  462. data/templates/default/docstring/text/deprecated.erb +2 -2
  463. data/templates/default/docstring/text/index.erb +2 -2
  464. data/templates/default/docstring/text/note.erb +3 -3
  465. data/templates/default/docstring/text/private.erb +2 -2
  466. data/templates/default/docstring/text/text.erb +1 -1
  467. data/templates/default/docstring/text/todo.erb +3 -3
  468. data/templates/default/fulldoc/html/css/full_list.css +58 -58
  469. data/templates/default/fulldoc/html/css/style.css +496 -496
  470. data/templates/default/fulldoc/html/frames.erb +17 -17
  471. data/templates/default/fulldoc/html/full_list.erb +37 -37
  472. data/templates/default/fulldoc/html/full_list_class.erb +2 -2
  473. data/templates/default/fulldoc/html/full_list_file.erb +7 -7
  474. data/templates/default/fulldoc/html/full_list_method.erb +10 -10
  475. data/templates/default/fulldoc/html/js/app.js +292 -292
  476. data/templates/default/fulldoc/html/js/full_list.js +216 -216
  477. data/templates/default/fulldoc/html/js/jquery.js +3 -3
  478. data/templates/default/fulldoc/html/setup.rb +241 -241
  479. data/templates/default/layout/dot/header.erb +5 -5
  480. data/templates/default/layout/dot/setup.rb +15 -15
  481. data/templates/default/layout/html/breadcrumb.erb +11 -11
  482. data/templates/default/layout/html/files.erb +11 -11
  483. data/templates/default/layout/html/footer.erb +5 -5
  484. data/templates/default/layout/html/headers.erb +15 -15
  485. data/templates/default/layout/html/index.erb +2 -2
  486. data/templates/default/layout/html/layout.erb +23 -23
  487. data/templates/default/layout/html/listing.erb +4 -4
  488. data/templates/default/layout/html/objects.erb +32 -32
  489. data/templates/default/layout/html/script_setup.erb +4 -4
  490. data/templates/default/layout/html/search.erb +12 -12
  491. data/templates/default/layout/html/setup.rb +89 -89
  492. data/templates/default/method/html/header.erb +16 -16
  493. data/templates/default/method/setup.rb +4 -4
  494. data/templates/default/method_details/html/header.erb +2 -2
  495. data/templates/default/method_details/html/method_signature.erb +24 -24
  496. data/templates/default/method_details/html/source.erb +9 -9
  497. data/templates/default/method_details/setup.rb +11 -11
  498. data/templates/default/method_details/text/header.erb +10 -10
  499. data/templates/default/method_details/text/method_signature.erb +12 -12
  500. data/templates/default/method_details/text/setup.rb +11 -11
  501. data/templates/default/module/dot/child.erb +1 -1
  502. data/templates/default/module/dot/dependencies.erb +2 -2
  503. data/templates/default/module/dot/header.erb +6 -6
  504. data/templates/default/module/dot/info.erb +13 -13
  505. data/templates/default/module/dot/setup.rb +15 -15
  506. data/templates/default/module/html/attribute_details.erb +10 -10
  507. data/templates/default/module/html/attribute_summary.erb +8 -8
  508. data/templates/default/module/html/box_info.erb +43 -43
  509. data/templates/default/module/html/children.erb +8 -8
  510. data/templates/default/module/html/constant_summary.erb +17 -17
  511. data/templates/default/module/html/defines.erb +2 -2
  512. data/templates/default/module/html/header.erb +5 -5
  513. data/templates/default/module/html/inherited_attributes.erb +14 -14
  514. data/templates/default/module/html/inherited_constants.erb +8 -8
  515. data/templates/default/module/html/inherited_methods.erb +18 -18
  516. data/templates/default/module/html/item_summary.erb +40 -40
  517. data/templates/default/module/html/method_details_list.erb +9 -9
  518. data/templates/default/module/html/method_summary.erb +13 -13
  519. data/templates/default/module/html/methodmissing.erb +12 -12
  520. data/templates/default/module/setup.rb +167 -167
  521. data/templates/default/module/text/children.erb +9 -9
  522. data/templates/default/module/text/class_meths_list.erb +7 -7
  523. data/templates/default/module/text/extends.erb +7 -7
  524. data/templates/default/module/text/header.erb +7 -7
  525. data/templates/default/module/text/includes.erb +7 -7
  526. data/templates/default/module/text/instance_meths_list.erb +7 -7
  527. data/templates/default/module/text/setup.rb +13 -13
  528. data/templates/default/onefile/html/files.erb +4 -4
  529. data/templates/default/onefile/html/headers.erb +6 -6
  530. data/templates/default/onefile/html/layout.erb +17 -17
  531. data/templates/default/onefile/html/readme.erb +2 -2
  532. data/templates/default/onefile/html/setup.rb +62 -62
  533. data/templates/default/root/dot/child.erb +2 -2
  534. data/templates/default/root/dot/setup.rb +6 -6
  535. data/templates/default/root/html/setup.rb +2 -2
  536. data/templates/default/tags/html/example.erb +10 -10
  537. data/templates/default/tags/html/index.erb +2 -2
  538. data/templates/default/tags/html/option.erb +24 -24
  539. data/templates/default/tags/html/overload.erb +13 -13
  540. data/templates/default/tags/html/see.erb +7 -7
  541. data/templates/default/tags/html/tag.erb +20 -20
  542. data/templates/default/tags/setup.rb +57 -57
  543. data/templates/default/tags/text/example.erb +12 -12
  544. data/templates/default/tags/text/index.erb +1 -1
  545. data/templates/default/tags/text/option.erb +20 -20
  546. data/templates/default/tags/text/overload.erb +19 -19
  547. data/templates/default/tags/text/see.erb +11 -11
  548. data/templates/default/tags/text/tag.erb +13 -13
  549. data/templates/guide/class/html/setup.rb +2 -2
  550. data/templates/guide/docstring/html/setup.rb +2 -2
  551. data/templates/guide/fulldoc/html/css/style.css +108 -108
  552. data/templates/guide/fulldoc/html/js/app.js +33 -33
  553. data/templates/guide/fulldoc/html/setup.rb +74 -74
  554. data/templates/guide/layout/html/layout.erb +81 -81
  555. data/templates/guide/layout/html/setup.rb +25 -25
  556. data/templates/guide/method/html/header.erb +17 -17
  557. data/templates/guide/method/html/setup.rb +22 -22
  558. data/templates/guide/module/html/header.erb +6 -6
  559. data/templates/guide/module/html/method_list.erb +4 -4
  560. data/templates/guide/module/html/setup.rb +27 -27
  561. data/templates/guide/onefile/html/files.erb +4 -4
  562. data/templates/guide/onefile/html/setup.rb +6 -6
  563. data/templates/guide/onefile/html/toc.erb +3 -3
  564. data/templates/guide/tags/html/setup.rb +9 -9
  565. data/yard.gemspec +43 -43
  566. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 60bd85d004be2eaeed43646cc7211142cea13298
4
- data.tar.gz: aa523a2062c7d8929699dc08466fec4d76183628
2
+ SHA256:
3
+ metadata.gz: b3c208e14412a59e509f41ecc0ae1d3e77c1248c93c88289bc9a075c37716d3a
4
+ data.tar.gz: aabcd348e912cc67bea522532e9ac96c72c3027a160491052485b290c8c75878
5
5
  SHA512:
6
- metadata.gz: 9dfcc5ebef57766151261684c04838f2fa59f5711033dd71d0f163aefee347df3ae6af07f3c0f749f9baa09a880859373576a1b6c328cbd7b9143cf8c366b1ba
7
- data.tar.gz: fb836be48722eba0098e3dabad576cd64eb061aaa74477a1051bdb9ba85711092f649246f96871802ed679bd10a09e0a5cd3119e72b96da5291794b753ea7fde
6
+ metadata.gz: 121526a473724d9c3e253ef47660e8612851ffb8b7cea42a8e713c3f68e968a19b511fbb8eb139103933e962c300e6b87d9ec9505c9a6e9b240769493d95a0e2
7
+ data.tar.gz: 7b5cff989144d7acc6c359bf07cb4e52df9c3489ff26b078060d7979b7efb2dd920c5ebdd3d1fddc97c81c9d3a5a37d101d632fcee42b118cf16525223af28c0
data/.yardopts CHANGED
@@ -1,26 +1,26 @@
1
- --protected
2
- --no-private
3
- --embed-mixin ClassMethods
4
- --exclude /server/templates/
5
- --exclude /yard/rubygems/
6
- --asset docs/images:images
7
- --tag yard.signature:"YARD Tag Signature"
8
- --type-name-tag yard.tag:"YARD Tag"
9
- --type-name-tag yard.directive:"YARD Directive"
10
- --hide-tag yard.tag
11
- --hide-tag yard.directive
12
- --hide-tag yard.signature
13
- --load ./docs/templates/plugin.rb
14
- -
15
- CHANGELOG.md
16
- docs/WhatsNew.md
17
- docs/GettingStarted.md
18
- docs/Tags.md
19
- docs/Overview.md
20
- docs/CodeObjects.md
21
- docs/Parser.md
22
- docs/Handlers.md
23
- docs/TagsArch.md
24
- docs/Templates.md
25
- LICENSE
26
- LEGAL
1
+ --protected
2
+ --no-private
3
+ --embed-mixin ClassMethods
4
+ --exclude /server/templates/
5
+ --exclude /yard/rubygems/
6
+ --asset docs/images:images
7
+ --tag yard.signature:"YARD Tag Signature"
8
+ --type-name-tag yard.tag:"YARD Tag"
9
+ --type-name-tag yard.directive:"YARD Directive"
10
+ --hide-tag yard.tag
11
+ --hide-tag yard.directive
12
+ --hide-tag yard.signature
13
+ --load ./docs/templates/plugin.rb
14
+ -
15
+ CHANGELOG.md
16
+ docs/WhatsNew.md
17
+ docs/GettingStarted.md
18
+ docs/Tags.md
19
+ docs/Overview.md
20
+ docs/CodeObjects.md
21
+ docs/Parser.md
22
+ docs/Handlers.md
23
+ docs/TagsArch.md
24
+ docs/Templates.md
25
+ LICENSE
26
+ LEGAL
@@ -1,728 +1,728 @@
1
- # master
2
-
3
- # [0.9.16] - August 11th, 2018
4
-
5
- [0.9.16]: https://github.com/lsegal/yard/compare/v0.9.15...v0.9.16
6
-
7
- - Documentation fixes (#1175, #1178).
8
- - Fixed stack overflow issue when parsing extremely large lists (#1176).
9
-
10
- # [0.9.15] - July 17th, 2018
11
-
12
- [0.9.15]: https://github.com/lsegal/yard/compare/v0.9.14...v0.9.15
13
-
14
- - Fixed security issue in parsing of Ruby code that could allow for arbitrary
15
- execution. Credit to Nelson Elhage <nelhage@nelhage.com> for discovering this
16
- issue.
17
-
18
- # [0.9.14] - June 2nd, 2018
19
-
20
- [0.9.14]: https://github.com/lsegal/yard/compare/v0.9.13...v0.9.14
21
-
22
- - Fixed a regression in symbol parsing (#1170).
23
-
24
- # [0.9.13] - May 28th, 2018
25
-
26
- [0.9.13]: https://github.com/lsegal/yard/compare/v0.9.12...v0.9.13
27
-
28
- - Added support for grouped constants via `@!group` directive (#1056).
29
- - Added support for quoted symbols (#1168).
30
- - Added support for i18n in tag text (#1169).
31
- - Fixed HTML rendering of inline code blocks (#1152).
32
- - Fixed rendering of anchor URLs in rendered HTML (#1154).
33
-
34
- # [0.9.12] - November 26th, 2017
35
-
36
- [0.9.12]: https://github.com/lsegal/yard/compare/v0.9.11...v0.9.12
37
-
38
- - Be more explicit about lack of support for absolute paths in extra files
39
- specified by `yard doc` command.
40
-
41
- # [0.9.11] - November 23rd, 2017
42
-
43
- [0.9.11]: https://github.com/lsegal/yard/compare/v0.9.10...v0.9.11
44
-
45
- - Fixed security issue in `--readme` that allowed for arbitrary file reads on
46
- disk. Credit to ztz <ztz@ztz.me> for discovering this issue.
47
- - Improved styling for inline code blocks (#1142).
48
-
49
- # [0.9.10] - November 18th, 2017
50
-
51
- [0.9.10]: https://github.com/lsegal/yard/compare/v0.9.9...v0.9.10
52
-
53
- - Added `--fail-on-warning` option for `yard doc` which exits with a non-zero
54
- code if there are any warnings (#1093).
55
- - Added support for parsing inside `Struct.new` blocks (#1099).
56
- - Added support new ripper AST tokens (#1104, #1124).
57
- - Fixed an issue where `@see (obj)` reference tags would fail (#1111)
58
- - Fix sorting in `yard stats` (#1123).
59
-
60
- # [0.9.9] - April 23rd, 2017
61
-
62
- [0.9.9]: https://github.com/lsegal/yard/compare/v0.9.8...v0.9.9
63
-
64
- - Added `gem uninstall` hooks to remove YARD documentation files. (#1083)
65
- - Added support for C++ namespaces. (#809)
66
- - Fixed issue where loading a .html page via an anchor would not scroll to
67
- the anchor section. (#1082)
68
- - Hide some Ruby warnings.
69
- - Improve progress indicator icons in terminal.
70
-
71
- # [0.9.8] - January 13th, 2017
72
-
73
- [0.9.8]: https://github.com/lsegal/yard/compare/v0.9.7...v0.9.8
74
-
75
- - Fixed installed gems not being correctly found in `yard server` and by plugins.
76
- - Fixed tokenization of `%w(...)` array syntax.
77
-
78
- # [0.9.7] - January 9th, 2017
79
-
80
- [0.9.7]: https://github.com/lsegal/yard/compare/v0.9.6...v0.9.7
81
-
82
- - Fixed resolution of absolute object paths with ambiguous names. (#1029)
83
-
84
- # [0.9.6] - January 7th, 2017
85
-
86
- [0.9.6]: https://github.com/lsegal/yard/compare/v0.9.5...v0.9.6
87
-
88
- - Removed official support for Ruby 1.x (1.8/1.9). YARD can still be installed
89
- in these versions, but support is not guaranteed. Simple bug fixes may still
90
- be considered via pull request only. Issues without code will be automatically
91
- closed.
92
- - Added {YARD::Tags::Tag#explain_types} returning a plain English summary
93
- of the type specification of a given tag. Also adds {YARD::Tags::TypesExplainer}
94
- as an implementation class for the method.
95
- - Added support for automatic linking of constants and method calls of
96
- Ruby syntax highlighted source code in generated HTML. Also adds the
97
- {YARD::Parser::Ruby::TokenResolver} implementation class to iterate over
98
- tokenized code with extra resolved object information.
99
- - Added support for compound constant assignments (`A::B::C = true`).
100
- - Added `LibraryVersion#yardoc_file_for_SOURCE` callback method for sources with
101
- a pre-determined yardoc file location. Implement this method instead of
102
- manually setting `library.yardoc_file = ...` in your load method (you can
103
- still assign the attribute manually).
104
- - Use RubyGems 2.x+ API to query gems when available instead of using backport.
105
- - Various bug fixes
106
-
107
- # [0.9.5] - July 22nd, 2016
108
-
109
- [0.9.5]: https://github.com/lsegal/yard/compare/v0.9.4...v0.9.5
110
-
111
- - `yard doc` will now generate `.yardoc/processing` and `.yardoc/complete` files
112
- to allow other tools to properly detect when YARD is in the middle of parsing
113
- source files, and when it has completed writing the database.
114
- - Added support for on-demand generation of LibraryVersion objects using the
115
- `:disk` source type. LibraryVersion objects pointing to a .yardoc database
116
- directory will now auto-generate if there is a `source_path` attached.
117
- - Added warning for macros attached to non-method objects.
118
- - Fixed a few more parsing errors.
119
-
120
- # [0.9.4] - July 21st, 2016
121
-
122
- [0.9.4]: https://github.com/lsegal/yard/compare/v0.9.3...v0.9.4
123
-
124
- - Minor Ruby file parsing and CSS bug fixes.
125
-
126
- # [0.9.3] - July 20th, 2016
127
-
128
- [0.9.3]: https://github.com/lsegal/yard/compare/v0.9.2...v0.9.3
129
-
130
- - Added support for {YARD::Server::RackAdapter} to be mounted under prefix URIs.
131
- - Fixed regression in `yard server -g` that caused static file assets on index
132
- page to return 404 errors.
133
- - Fixed regression in `yard server -g` index page that disabled scrolling and
134
- caused other HTML rendering glitches.
135
-
136
- # [0.9.2] - July 19th, 2016
137
-
138
- [0.9.2]: https://github.com/lsegal/yard/compare/v0.9.1...v0.9.2
139
-
140
- - Added `yard config --gem-install-[yri|yard]` commands which auto-configure
141
- your `~/.gemrc` file to run yri/yard instead of ri/rdoc on a `gem install`.
142
- - Added support for gemspec metadata key `"yard.run"`, which can be either
143
- `"yard"` or `"yri"` to run the respective commands on a `gem install`.
144
- - Added `yard doc --no-progress` to hide the progress bar.
145
- - Fix resolution error for compound proxy namespaces.
146
- - YRI will now search across all gem versions (latest first) for the .yardoc
147
- database.
148
-
149
- # [0.9.1] - July 18th, 2016
150
-
151
- [0.9.1]: https://github.com/lsegal/yard/compare/v0.9.0...v0.9.1
152
-
153
- - Added "Attributes" section to `yard stats`.
154
- - Added support for RubyGems 2.x `--document=yri,yard` flags. You can now run
155
- YARD documentation generation against installed gems by running:
156
- `gem install mygem --document=yard,yri`.
157
- - Added `/static/*` routing for library-specific routing. This enables static
158
- template files to be served on a per-library basis instead of globally shared
159
- across the `yard server`.
160
- - Added support for inlining of `{include:*}` syntax. Using this syntax in
161
- the middle of a docstring paragraph will no longer create a separate paragraph
162
- for the included text.
163
- - Added support for resolving `{}` syntax in text templates, specifically for
164
- use in `{include:*}` syntax.
165
- - Improved object resolution logic in `{Foo::Bar}` syntax and {YARD::Registry.resolve}.
166
- New resolution logic should now more accurately support resolving compound paths
167
- across namespaces and through the inheritance tree (as Ruby does).
168
- - The `frozen_string_literal: true` comment line in Ruby source files will now be
169
- excluded from docstrings.
170
- - Added a workaround for https://bugs.ruby-lang.org/issues/11485
171
- - Fixed an issue where type using a docstring reference on an `@!attribute` macro
172
- would be incorrectly parsed as a type specifier. This change updates the tag
173
- parser to disallow newlines between the tag name and opening bracket of the
174
- type specification.
175
- - Fixed an issue where `--embed-mixins` would improperly embed methods from
176
- inherited classes instead of modules.
177
- - Fixed various parsing errors and YARD exceptions.
178
- - Added a warning for modules or classes being redefined as constants.
179
- - Reverted stripping of HTML in {YARD::Docstring#summary}.
180
- - Added optimization to remove initial docstring parse on newly created code objects.
181
- - {YARD::CodeObjects::Base#format} now passes the :type parameter to templates.
182
- - Hide methods with filtered namespaces in Method Listing.
183
-
184
- # [0.9.0] - July 4th, 2016
185
-
186
- [0.9.0]: https://github.com/lsegal/yard/compare/v0.8.7.6...v0.9.0
187
-
188
- Special thanks to Alex Dowad, MSP-Greg, and Alex McLain for their extended
189
- contributions to this version.
190
-
191
- - (Breaking Change): Replaced default template with an updated "frameless" version.
192
- This change may affect backward compatibility if custom templates made modifications
193
- to `default/fulldoc/html`, specifically the index or navigation lists.
194
- - Added support for Ruby 2.1+ decorator style method declaration syntax. YARD now
195
- supports:
196
- private def foo(x, y) end
197
- - Metadata headers in extra files can now be escaped from rendering by enclosing them
198
- in HTML comment blocks (`<!--\n @metadata here... \n-->`). Ensure that the opening
199
- comment tag is alone on the first line of the file to use this functionality.
200
- - Improved parsing of various CRuby coding styles.
201
- - Fixed issue with binary image assets when using `yard server`.
202
- - Fixed deprecation warnings from Rake 10.x.
203
- - Tests updated for RSpec 3.
204
-
205
- # [0.8.7.6] - October 26, 2014
206
-
207
- [0.8.7.6]: https://github.com/lsegal/yard/compare/v0.8.7.5...v0.8.7.6
208
-
209
- - Support using `@option` tag on keyword arg splat parameter. (#729)
210
- - Add `.stats_options` for `YardocTask`. (#800, #801)
211
-
212
- # [0.8.7.5] - October 26, 2014
213
-
214
- [0.8.7.5]: https://github.com/lsegal/yard/compare/v0.8.7.4...v0.8.7.5
215
-
216
- - Fix linking of methods in top level namespace in method listing. (#776)
217
- - Support using C macros in function declarations. (#810)
218
- - YARD will no longer group comment blocks starting on the same column if they
219
- are preceded by code. (#798)
220
- - Handle anonymous lambda calls in toplevel scope. (#774)
221
- - Support I18n in `@overload` tags. (#794)
222
- - Support `yard stats` for objects with no file property. (#792)
223
- - Support for named arguments in Ruby >= 2.1. (#785)
224
- - Exclude README backup files from YARD generation. (#790)
225
- - Turned on the lax spacing option in Redcarpet to comply with the
226
- Markdown standard.
227
- - Escape HTML in YARD server search placeholder template.
228
- - Fix issue with `private_class_method` support. (#760, #767)
229
- - Enable tables support by default in Redcarpet Markdown provider. (#765)
230
-
231
- # 0.8.7.4 - March 22, 2014
232
-
233
- [0.8.7.4]: https://github.com/lsegal/yard/compare/v0.8.7.3...v0.8.7.4
234
-
235
- - Mark C methods as explicit but also remove explicit check in stats. (#727)
236
- - Report unresolved parent namespaces as undocumentable errors instead. (#753)
237
- - No longer ignore overridden methods from documentation check in stats (#719)
238
- - Fix JRuby throwing exception when remove_method called on non-existent method. (#732)
239
- - Add basic support for `private_class_method` (#747)
240
- - Ensure namespace is always set when parent module is not found. (#753)
241
- - Set overflow as auto on table of contents.
242
- - Report 100% documented if nothing is undocumented. (#754)
243
- - Added support for RubyGems 2.0.0+. (#742)
244
- - Allow users to enter their own YARD RakeTask name. (#705)
245
- - Fixed a typo that was causing Windows detection to always fail. (#715)
246
- - Add debug information when loading a plugin fails. (#711)
247
-
248
- # [0.8.7.3] - November 1, 2013
249
-
250
- [0.8.7.3]: https://github.com/lsegal/yard/compare/v0.8.7.2...v0.8.7.3
251
-
252
- - Handle Unicode method/class/file names in server URL encoding (lsegal/rubydoc.info#69).
253
- - Style keyword style hashes with same symbol color in code highlighting (#707).
254
- - Fix broken JS when visiting docs in file:// scheme (#706).
255
- - Add support for new AsciiDoc file extensions (#704).
256
- - Fix issues where non-Ruby code blocks would not display in Ruby 2 (#702).
257
- - Add support for extra Ruby 2 symbol types in Ripper (#701).
258
- - Ensure config directory exists before saving config file (#700).
259
-
260
- # [0.8.7.2] - September 18, 2013
261
-
262
- [0.8.7.2]: https://github.com/lsegal/yard/compare/v0.8.7.1...v0.8.7.2
263
-
264
- - Disallow absolute URLs when using frame anchor support.
265
- - Support casted functions in CRuby method declarations (#697)
266
-
267
- # [0.8.7.1] - September 11, 2013
268
-
269
- [0.8.7.1]: https://github.com/lsegal/yard/compare/v0.8.7...v0.8.7.1
270
-
271
- - Fix potential XSS issue with frame anchor support.
272
- - Add support for gettext 3.x gem.
273
-
274
- # [0.8.7] - July 26, 2013
275
-
276
- [0.8.7]: https://github.com/lsegal/yard/compare/v0.8.6.2...v0.8.7
277
-
278
- - Added `--hide-api API` option to hide objects with a given `@api` tag (#685).
279
- - Added "Returns ...." prefix to summary when a lone @return tag is used.
280
- - Fixed issue that caused ref tags to be added to a docstring twice (#678).
281
- - Fixed formatting issue in docstring summaries (#686)
282
-
283
- # [0.8.6.2] - June 27, 2013
284
-
285
- [0.8.6.2]: https://github.com/lsegal/yard/compare/v0.8.6.1...v0.8.6.2
286
-
287
- - Fixed issue where `yard graph` was not displaying methods
288
-
289
- # [0.8.6.1] - April 14, 2013
290
-
291
- [0.8.6.1]: https://github.com/lsegal/yard/compare/v0.8.6...v0.8.6.1
292
-
293
- - Fixed broken links in File menu on default HTML template
294
- - Added --layout switch to `yard display` to wrap output in layout template.
295
- - See {file:docs/WhatsNew.md} for more information on added features.
296
-
297
- # [0.8.6] - April 13, 2013
298
-
299
- [0.8.6]: https://github.com/lsegal/yard/compare/v0.8.5.2...v0.8.6
300
-
301
- - Various fixes and improved Ruby 2.x compatibility support
302
- - Added support for `asciidoc` markup type
303
- - Added `yard markups` command to list available markup types
304
- - Added `yard display` command to display and format an individual object
305
- - See {file:docs/WhatsNew.md} for more information on added features.
306
-
307
- # [0.8.5.2] - February 26, 2013
308
-
309
- [0.8.5.2]: https://github.com/lsegal/yard/compare/v0.8.5.1...v0.8.5.2
310
-
311
- - Support new keyword argument syntax in method signatures (Ruby 2.x)
312
-
313
- # [0.8.5.1] - February 25, 2013
314
-
315
- [0.8.5.1]: https://github.com/lsegal/yard/compare/v0.8.5...v0.8.5.1
316
-
317
- - Fix `yard diff` of gem files with RubyGems 2.x
318
-
319
- # [0.8.5] - February 24, 2013
320
-
321
- [0.8.5]: https://github.com/lsegal/yard/compare/v0.8.4.1...v0.8.5
322
-
323
- - Basic support for Ruby 2.0 (fix compat issues in RDoc 4.0, RubyGems 2.0)
324
- - Add CSS styling for tables in default HTML template
325
-
326
- # [0.8.4.1] - February 5, 2013
327
-
328
- [0.8.4.1]: https://github.com/lsegal/yard/compare/v0.8.4...v0.8.4.1
329
-
330
- - Fix regression that broke loading of existing yardoc dbs (#648)
331
-
332
- # [0.8.4] - February 4, 2013
333
-
334
- [0.8.4]: https://github.com/lsegal/yard/compare/v0.8.3...v0.8.4
335
-
336
- - Add `-B/--bind` switch to yard server (#593, #608)
337
- - Add CodeObjects::Base#title for plugins to customize how object
338
- links display (#646)
339
- - Disable linking objects filtered out by verifiers (#645)
340
- - Allow macro expansion on class methods (#632)
341
- - Expand newly attached macro on first DSL method call (#631)
342
- - Disable RubyGems plugin in Ruby 2.0 (#627)
343
- - Fix line range for class/module node bodies (#626)
344
- - Search extended modules for attached DSL macros (#553)
345
-
346
- # [0.8.3] - October 14, 2012
347
-
348
- [0.8.3]: https://github.com/lsegal/yard/compare/v0.8.2.1...v0.8.3
349
-
350
- - Add `--non-transitive-tag` to disable tag transitivity (#571)
351
- - Support --db inside .yardopts for graph/server commands (#583, #586)
352
- - Fix handling for =begin/=end docstrings (#577, #578)
353
- - Parser only sorts file lists when a glob is provided (#572)
354
- - Fix formatting in `{include:Object#method}` syntax (#569)
355
- - Fix @option tag inside of module functions (#563)
356
- - Fix to `--api` and `--no-api` support (#559)
357
- - Fix class nesting issues when path starts with "::" (#552)
358
-
359
- # [0.8.2.1] - June 9, 2012
360
-
361
- [0.8.2.1]: https://github.com/lsegal/yard/compare/v0.8.2...v0.8.2.1
362
-
363
- - Fix a set of regressions in yard server search and dynamic generation
364
-
365
- # [0.8.2] - June 7, 2012
366
-
367
- [0.8.2]: https://github.com/lsegal/yard/compare/v0.8.1...v0.8.2
368
-
369
- - Added progress style output in tty terminals
370
- - Embedded mixins should ignore methods defined on module (#539)
371
- - Fixed permalinks for embedded mixins in `yard server` (#540)
372
- - Improve parsing in CRuby code (#543)
373
- - Ensure Registry.resolve picks module when parsing mixins (#545)
374
- - Fixed regression that caused various commands to not show output (#548)
375
- - Respect current visibility when parsing class conditions (#551)
376
-
377
- # [0.8.1] - May 2, 2012
378
-
379
- [0.8.1]: https://github.com/lsegal/yard/compare/v0.8.0...v0.8.1
380
-
381
- - Added `--[no-]api` switch to generate docs for API sets (see {file:docs/WhatsNew.md} for details) (#532)
382
- - The `yard list` command now uses cache by default (#533)
383
- - Fix `yardoc` generating incorrectly named method list file (#528)
384
- - Fix HTML output occasionally showing trailing mdash on options list (#522)
385
-
386
- # [0.8.0] - April 30, 2012
387
-
388
- [0.8.0]: https://github.com/lsegal/yard/compare/v0.7.5...v0.8.0
389
-
390
- - See {file:docs/WhatsNew.md} for a list of added features
391
- - Over 20 bug fixes:
392
- - Properly filter hidden setter/getter attributes (#394)
393
- - Fix test failures in Linux environments (#397, #472, #473, #512, #513)
394
- - Fix attribute inheritance and @private (#432)
395
- - Fix attribute parsing (#435)
396
- - Allow aliases for attributes (#436)
397
- - Fix namespace fetching in `handle_alias()` (#437)
398
- - Fix overwritten attributes marked as inherited (#442)
399
- - Fix documenting constants defined from C code with `rb_define_const()` (#443)
400
- - Do not escape snippets twice (#445)
401
- - Ajax method/class search should not fire when a non-printable character is pressed (#446)
402
- - Fix yard server crashing when RDoc is not installed (#456)
403
- - Fix tags ignored when `(see #foo)` is used (#457)
404
- - Fix three "Returns" for two `@overload` tags (#458)
405
- - Do not auto-detect DSL methods as method objects if parameter name is not a valid method name (#464)
406
- - Fix attaching of macros to Object (#465)
407
- - Fix handling of `%w()` source in `[]/[]=` parsed context. (#461, pull in #468)
408
- - Don't add default `@return` if `@overload` has `@return`. (#458, pull in #469)
409
- - Don't discard tags by (see ...). (#457, pull in #470)
410
- - Fix constants listed as inherited when overwritten (#474)
411
- - Fix `yardoc --asset` behaving differently on first and subsequent calls. (#477)
412
- - `!!!lang` code blocks should set the lang in `<pre>`'s class. (#478, #479)
413
- - Fix "File List" search tab error. (#502)
414
- - Fix search bar not redirecting to method page. (#509)
415
- - Fix server returning exception message bodies as String (#518)
416
-
417
- # [0.7.5] - January 31, 2012
418
-
419
- [0.7.5]: https://github.com/lsegal/yard/compare/v0.7.4...v0.7.5
420
-
421
- - Various minor bug fixes
422
-
423
- # [0.7.4] - December 2, 2011
424
-
425
- [0.7.4]: https://github.com/lsegal/yard/compare/v0.7.3...v0.7.4
426
-
427
- - Redcarpet is now the default Markdown formatting library. GFM now works out-of-box (#404)
428
- - Fix server side searching for elements that are marked private (#420)
429
- - Add 'textile_strict' and 'pre' markup types, reorganize text and none (#416)
430
- - Improve encoding line detection (#415)
431
- - Add support for `rb_define_alias` in CRuby code (#413)
432
- - Fix rendering of some keywords in source view (#410)
433
- - Add support for RDoc 3.10+ (#406, #407)
434
- - Fix typewriter text being processed in code blocks (#403)
435
- - Improve support for has_rdoc in RubyGems 1.8.x (#401)
436
- - See the {file:docs/WhatsNew.md} document for details on added features
437
-
438
- # [0.7.3] - October 15, 2011
439
-
440
- [0.7.3]: https://github.com/lsegal/yard/compare/v0.7.2...v0.7.3
441
-
442
- - Improve support for parsing under Ruby 1.9.2p290 and 1.9.3 (#365, #370)
443
- - Add support for SWIG generated CRuby code (#369)
444
- - Add support for `rb_define_attr` calls in CRuby code (#362)
445
- - Handle file pointers in CRuby code (#358)
446
-
447
- # [0.7.2] - June 14, 2011
448
-
449
- [0.7.2]: https://github.com/lsegal/yard/compare/v0.7.1...v0.7.2
450
-
451
- - Fix `yard --help` not showing proper output
452
- - YARD now expands path to `.yardoc` file in daemon mode for server (#328)
453
- - Fix `@overload` tag linking to wrong method (#330)
454
- - Fix incorrect return type when using `@macro` (#334)
455
- - YARD now requires 'thread' to support RubyGems 1.7+ (#338)
456
- - Fix bug in constant documentation when using `%w()` (#348)
457
- - Fix YARD style URL links when using autolinking markdown (#353)
458
-
459
- # [0.7.1] - May 18, 2011
460
-
461
- [0.7.1]: https://github.com/lsegal/yard/compare/v0.7.0...v0.7.1
462
-
463
- - Fixes a bug in `yard server` not displaying class list properly.
464
-
465
- # [0.7.0] - May 17, 2011
466
-
467
- [0.7.0]: https://github.com/lsegal/yard/compare/v0.6.8...v0.7.0
468
-
469
- - See the {file:docs/WhatsNew.md} document for details on added features
470
- - Make sure that Docstring#line_range is filled when possible (#243)
471
- - Set #verifier in YardocTask (#282)
472
- - Parse BOM in UTF-8 files (#288)
473
- - Fix instance attributes not showing up in method list (#302)
474
- - Fix rendering of %w() literals in constants (#306)
475
- - Ignore keyboard shortcuts when an input is active (#312)
476
- - And more...
477
-
478
- # [0.6.8] - April 14, 2011
479
-
480
- [0.6.8]: https://github.com/lsegal/yard/compare/v0.6.7...v0.6.8
481
-
482
- - Fix regression in RDoc 1.x markup loading
483
- - Fix regression in loading of markup libraries for `yard server`
484
-
485
- # [0.6.7] - April 6, 2011
486
-
487
- [0.6.7]: https://github.com/lsegal/yard/compare/v0.6.6...v0.6.7
488
-
489
- - Fix has_rdoc gem specification issue with new RubyGems plugin API (oops!)
490
-
491
- # [0.6.6] - April 6, 2011
492
-
493
- [0.6.6]: https://github.com/lsegal/yard/compare/v0.6.5...v0.6.6
494
-
495
- - Fix error message when RDoc is not present (#270)
496
- - Add markup type 'none' to perform basic HTML translation (fallback when RDoc is not present)
497
- - Add support for RubyGems 1.7.x (#272)
498
- - Fix rendering of `{url description}` syntax when description contains newline
499
-
500
- # [0.6.5] - March 13, 2011
501
-
502
- [0.6.5]: https://github.com/lsegal/yard/compare/v0.6.4...v0.6.5
503
-
504
- - Support `ripper` gem in Ruby 1.8.7
505
- - Upgrade jQuery to 1.5.1
506
- - Fix handling of alias statements with quoted symbols (#262)
507
- - Add CSS styles (#260)
508
- - Unhandled exception in YARD::Handlers::Ruby::MixinHandler indexing documentation for eventmachine (#248)
509
- - Splice any alias references on method re-definitions into separate methods (#247)
510
- - Fix "yard graph" (#245)
511
- - Don't process ++ typewriter text inside of HTML attributes (#244)
512
- - Prioritize loading of Kramdown before Maruku (#241)
513
- - Skip shebang encoding in docstrings (#238)
514
- - Fix truncation of references in @deprecated (#232)
515
- - Show @api private note when no other tags are present (#231)
516
- - Detect docstrings starting with "##" as `Docstring#hash_flag` (#230)
517
- - Remove trailing whitespace from freeform tags (#229)
518
- - Fix line through for deprecated methods (#225)
519
- - Mistake in Tags.md (#223)
520
- - Improve database storage by being more efficient with filesystem usage (#222)
521
- - Make Registry thread local (#221)
522
- - Support `private_constant` class method for 1.9.3 (#219)
523
- - Do not assume RDoc is installed (#214)
524
-
525
- # [0.6.4] - December 21, 2010
526
-
527
- [0.6.4]: https://github.com/lsegal/yard/compare/v0.6.3...v0.6.4
528
-
529
- - Fix yri tool crashing with new Config class (gh-217)
530
- - Fix support for ::TopLevelConstants (gh-216)
531
- - YARD's test suite is now RSpec2 compatible (gh-215)
532
- - Improved documentation for YARD::Server features (gh-207)
533
- - Fix displaying of collaped method summary lists (gh-204)
534
- - Fix automatic loading of markup providers (gh-206)
535
- - Fix keyboard shortcuts for Chrome (gh-203)
536
- - Disallow `extend self` inside of a class (gh-202)
537
- - Constants now recognized in C extensions (gh-201)
538
-
539
- # [0.6.3] - November 21, 2010
540
-
541
- [0.6.3]: https://github.com/lsegal/yard/compare/v0.6.2...v0.6.3
542
-
543
- - Fixed regression that caused `yardoc --markup` to silently exit
544
-
545
- # [0.6.2] - November 15, 2010
546
-
547
- [0.6.2]: https://github.com/lsegal/yard/compare/v0.6.1...v0.6.2
548
-
549
- - **Plugins no longer automatically load, use `--plugin` to load a plugin**
550
- - Added YARD::Config and ~/.yard/config YAML configuration file
551
- - Added `yard config` command to view/edit YARD configuration file
552
- - Fixes for YARD in 1.8.6 (gh-178)
553
- - Various HTML template adjustments and fixes (gh-198,199,200)
554
- - Improved `yard server -m` multi-project stability (gh-193)
555
- - Fixed handling of `yardoc --no-private` with missing class definitions (gh-197)
556
- - Added support for constants defined in C extensions (gh-177)
557
- - Added support for Structs defined as "Klass = Struct.new(...)" (gh-187)
558
- - Improved parsing support for third-party gems (gh-174,180)
559
- - Improved support for JRuby 1.6.4+. YARD now passes all specs in JRuby (gh-185)
560
- - Improved YARD documentation (gh-172,191,196)
561
-
562
- # [0.6.1] - September 06, 2010
563
-
564
- [0.6.1]: https://github.com/lsegal/yard/compare/v0.6.0...v0.6.1
565
-
566
- - Fixed TOC showing on top of class/method list in no-frames view
567
- - A message now displays when running `yard server` with Rack/Mongrel installed
568
- - Improved performance of JS inline search for large class/method lists
569
- - Improved link titles for relative object links
570
- - Removed `String#camelcase` and `String#underscore` for better Rails compat.
571
- - Fixed support for loading .yardoc files under Windows
572
- - Fixed inheritance tree arrows not displaying in certain environments
573
-
574
- # [0.6.0] - August 29, 2010
575
-
576
- [0.6.0]: https://github.com/lsegal/yard/compare/v0.5.8...v0.6.0
577
-
578
- - Added dynamic local documentation server
579
- - Added @group/@endgroup declarations to organize methods into groups
580
- - Added `yard` executable to serve as main CLI tool with pluggable commands
581
- - Added `--asset` switch to `yardoc` to copy files/dirs to output dir
582
- - Added ability to register/manipulate tags via CLI (`--tag`, etc.)
583
- - Added `yard diff` command
584
- - Added statistics to `yardoc` output (and `yard stats` command)
585
- - Added Javascript generated Table of Contents to file pages
586
- - Updated various APIs
587
- - Removed `yard-graph` executable
588
- - See more changes in the {file:docs/WhatsNew.md what's new document}
589
-
590
- # [0.5.8] - June 22, 2010
591
-
592
- [0.5.8]: https://github.com/lsegal/yard/compare/v0.5.7...v0.5.8
593
-
594
- - Merge fix from 0.6 branch for --no-private visibility checking
595
-
596
- # [0.5.7] - June 21, 2010
597
-
598
- [0.5.7]: https://github.com/lsegal/yard/compare/v0.5.6...v0.5.7
599
-
600
- - Fixed visibility flag parsing in `yardoc`
601
- - Updated Parser Architecture documentation with new SourceParser API
602
- - Improved Registry documentation for new load commands
603
- - Fix loading of .yardoc file as cache (and preserving aliases)
604
- - Fix "lib" directory missing when running YARD on installed gems
605
-
606
- # [0.5.6] - June 12, 2010
607
-
608
- [0.5.6]: https://github.com/lsegal/yard/compare/v0.5.5...v0.5.6
609
-
610
- - Bug fixes for RubyGems plugin, `has_rdoc=false` should now work
611
- - New API for registering custom parsers. See {file:docs/WhatsNew.md}
612
-
613
- # [0.5.5] - May 22, 2010
614
-
615
- [0.5.5]: https://github.com/lsegal/yard/compare/v0.5.4...v0.5.5
616
-
617
- - Various bug fixes
618
-
619
- # [0.5.4] - March 22, 2010
620
-
621
- [0.5.4]: https://github.com/lsegal/yard/compare/v0.5.3...v0.5.4
622
-
623
- - See {file:docs/WhatsNew.md what's new document} for changes
624
-
625
- # [0.5.3] - January 11, 2010
626
-
627
- [0.5.3]: https://github.com/lsegal/yard/compare/v0.5.2...v0.5.3
628
-
629
- - See {file:docs/WhatsNew.md what's new document} for changes
630
-
631
- # [0.5.2] - December 16, 2009
632
-
633
- [0.5.2]: https://github.com/lsegal/yard/compare/v0.5.1...v0.5.2
634
-
635
- - See {file:docs/WhatsNew.md what's new document} for changes
636
-
637
- # [0.5.1] - December 15, 2009
638
-
639
- [0.5.1]: https://github.com/lsegal/yard/compare/v0.5.0...v0.5.1
640
-
641
- - See {file:docs/WhatsNew.md what's new document} for changes
642
-
643
- # [0.5.0] - December 13, 2009
644
-
645
- [0.5.0]: https://github.com/lsegal/yard/compare/v0.4.0...v0.5.0
646
-
647
- - See {file:docs/WhatsNew.md what's new document} for changes
648
-
649
- # [0.4.0] - November 15, 2009
650
-
651
- [0.4.0]: https://github.com/lsegal/yard/compare/v0.2.3.5...v0.4.0
652
-
653
- - Added new templating engine based on [tadpole](http://github.com/lsegal/tadpole)
654
- - Added YARD queries (`--query` CLI argument to yardoc)
655
- - Greatly expanded YARD documentation
656
- - Added plugin support
657
- - New `@abstract` and `@private` tags
658
- - Changed default rake task to `rake yard`
659
- - Read about changes in {file:docs/WhatsNew.md}
660
-
661
- # [0.2.3.5] - August 13, 2009
662
-
663
- [0.2.3.5]: https://github.com/lsegal/yard/compare/v0.2.3.4...v0.2.3.5
664
-
665
- - Minor bug fixes.
666
-
667
- # [0.2.3.4] - August 07, 2009
668
-
669
- [0.2.3.4]: https://github.com/lsegal/yard/compare/v0.2.3.3...v0.2.3.4
670
-
671
- - Minor bug fixes.
672
-
673
- # [0.2.3.3] - July 26, 2009
674
-
675
- [0.2.3.3]: https://github.com/lsegal/yard/compare/v0.2.3.2...v0.2.3.3
676
-
677
- - Minor bug fixes.
678
-
679
- # [0.2.3.2] - July 06, 2009
680
-
681
- [0.2.3.2]: https://github.com/lsegal/yard/compare/v0.2.3.1...v0.2.3.2
682
-
683
- - Fix Textile hard-break issues
684
- - Add description for @see tag to use as link title in HTML docs.
685
- - Add --title CLI option to specify a title for HTML doc files.
686
- - Add custom.css file that can be overridden with various custom
687
- styelsheet declarations. To use this, simply add `default/fulldoc/html/custom.css`
688
- inside your code directory and use the `-t` template directory yardoc CLI
689
- option to point to that template directory (the dir holding 'default').
690
- - Add support in `yardoc` CLI to specify extra files (formerly --files)
691
- by appending "- extra files here" after regular source files. Example:
692
-
693
- yardoc --private lib/**/*.rb - FAQ LICENSE
694
-
695
- # [0.2.3.1] - June 13, 2009
696
-
697
- [0.2.3.1]: https://github.com/lsegal/yard/compare/v0.2.3...v0.2.3.1
698
-
699
- - Add a RubyGems 1.3.2+ plugin to generate YARD documentation instead of
700
- RDoc. To take advantage of this plugin, set `has_rdoc = 'yard'` in your
701
- .gemspec file.
702
-
703
- # [0.2.3] - June 07, 2009
704
-
705
- [0.2.3]: https://github.com/lsegal/yard/compare/v0.2.2...v0.2.3
706
-
707
- - See the {file:docs/WhatsNew.md} file for a list of important new features.
708
-
709
- # [0.2.2] - Jun 16, 2008
710
-
711
- [0.2.2]: https://github.com/lsegal/yard/compare/v0.2.1...v0.2.2
712
-
713
- - This is the largest changset since yard's conception and involves a complete
714
- overhaul of the parser and API to make it more robust and far easier to
715
- extend and use for the developer.
716
-
717
- # [0.2.1] - February 20, 2008
718
-
719
- [0.2.1]: https://github.com/lsegal/yard/compare/v0.1a...v0.2.1
720
-
721
- - See the {file:docs/WhatsNew.md} file for a list of important new features.
722
-
723
- # 0.1a - February 24, 2007
724
-
725
- - Released 0.1a experimental version for testing. The goal here is
726
- to get people testing YARD on their code because there are too many possible
727
- code styles to fit into a sane amount of test cases. It also demonstrates the
728
- power of YARD and what to expect from the syntax (Yardoc style meta tags).
1
+ # master
2
+
3
+ # [0.9.16] - August 11th, 2018
4
+
5
+ [0.9.16]: https://github.com/lsegal/yard/compare/v0.9.15...v0.9.16
6
+
7
+ - Documentation fixes (#1175, #1178).
8
+ - Fixed stack overflow issue when parsing extremely large lists (#1176).
9
+
10
+ # [0.9.15] - July 17th, 2018
11
+
12
+ [0.9.15]: https://github.com/lsegal/yard/compare/v0.9.14...v0.9.15
13
+
14
+ - Fixed security issue in parsing of Ruby code that could allow for arbitrary
15
+ execution. Credit to Nelson Elhage <nelhage@nelhage.com> for discovering this
16
+ issue.
17
+
18
+ # [0.9.14] - June 2nd, 2018
19
+
20
+ [0.9.14]: https://github.com/lsegal/yard/compare/v0.9.13...v0.9.14
21
+
22
+ - Fixed a regression in symbol parsing (#1170).
23
+
24
+ # [0.9.13] - May 28th, 2018
25
+
26
+ [0.9.13]: https://github.com/lsegal/yard/compare/v0.9.12...v0.9.13
27
+
28
+ - Added support for grouped constants via `@!group` directive (#1056).
29
+ - Added support for quoted symbols (#1168).
30
+ - Added support for i18n in tag text (#1169).
31
+ - Fixed HTML rendering of inline code blocks (#1152).
32
+ - Fixed rendering of anchor URLs in rendered HTML (#1154).
33
+
34
+ # [0.9.12] - November 26th, 2017
35
+
36
+ [0.9.12]: https://github.com/lsegal/yard/compare/v0.9.11...v0.9.12
37
+
38
+ - Be more explicit about lack of support for absolute paths in extra files
39
+ specified by `yard doc` command.
40
+
41
+ # [0.9.11] - November 23rd, 2017
42
+
43
+ [0.9.11]: https://github.com/lsegal/yard/compare/v0.9.10...v0.9.11
44
+
45
+ - Fixed security issue in `--readme` that allowed for arbitrary file reads on
46
+ disk. Credit to ztz <ztz@ztz.me> for discovering this issue.
47
+ - Improved styling for inline code blocks (#1142).
48
+
49
+ # [0.9.10] - November 18th, 2017
50
+
51
+ [0.9.10]: https://github.com/lsegal/yard/compare/v0.9.9...v0.9.10
52
+
53
+ - Added `--fail-on-warning` option for `yard doc` which exits with a non-zero
54
+ code if there are any warnings (#1093).
55
+ - Added support for parsing inside `Struct.new` blocks (#1099).
56
+ - Added support new ripper AST tokens (#1104, #1124).
57
+ - Fixed an issue where `@see (obj)` reference tags would fail (#1111)
58
+ - Fix sorting in `yard stats` (#1123).
59
+
60
+ # [0.9.9] - April 23rd, 2017
61
+
62
+ [0.9.9]: https://github.com/lsegal/yard/compare/v0.9.8...v0.9.9
63
+
64
+ - Added `gem uninstall` hooks to remove YARD documentation files. (#1083)
65
+ - Added support for C++ namespaces. (#809)
66
+ - Fixed issue where loading a .html page via an anchor would not scroll to
67
+ the anchor section. (#1082)
68
+ - Hide some Ruby warnings.
69
+ - Improve progress indicator icons in terminal.
70
+
71
+ # [0.9.8] - January 13th, 2017
72
+
73
+ [0.9.8]: https://github.com/lsegal/yard/compare/v0.9.7...v0.9.8
74
+
75
+ - Fixed installed gems not being correctly found in `yard server` and by plugins.
76
+ - Fixed tokenization of `%w(...)` array syntax.
77
+
78
+ # [0.9.7] - January 9th, 2017
79
+
80
+ [0.9.7]: https://github.com/lsegal/yard/compare/v0.9.6...v0.9.7
81
+
82
+ - Fixed resolution of absolute object paths with ambiguous names. (#1029)
83
+
84
+ # [0.9.6] - January 7th, 2017
85
+
86
+ [0.9.6]: https://github.com/lsegal/yard/compare/v0.9.5...v0.9.6
87
+
88
+ - Removed official support for Ruby 1.x (1.8/1.9). YARD can still be installed
89
+ in these versions, but support is not guaranteed. Simple bug fixes may still
90
+ be considered via pull request only. Issues without code will be automatically
91
+ closed.
92
+ - Added {YARD::Tags::Tag#explain_types} returning a plain English summary
93
+ of the type specification of a given tag. Also adds {YARD::Tags::TypesExplainer}
94
+ as an implementation class for the method.
95
+ - Added support for automatic linking of constants and method calls of
96
+ Ruby syntax highlighted source code in generated HTML. Also adds the
97
+ {YARD::Parser::Ruby::TokenResolver} implementation class to iterate over
98
+ tokenized code with extra resolved object information.
99
+ - Added support for compound constant assignments (`A::B::C = true`).
100
+ - Added `LibraryVersion#yardoc_file_for_SOURCE` callback method for sources with
101
+ a pre-determined yardoc file location. Implement this method instead of
102
+ manually setting `library.yardoc_file = ...` in your load method (you can
103
+ still assign the attribute manually).
104
+ - Use RubyGems 2.x+ API to query gems when available instead of using backport.
105
+ - Various bug fixes
106
+
107
+ # [0.9.5] - July 22nd, 2016
108
+
109
+ [0.9.5]: https://github.com/lsegal/yard/compare/v0.9.4...v0.9.5
110
+
111
+ - `yard doc` will now generate `.yardoc/processing` and `.yardoc/complete` files
112
+ to allow other tools to properly detect when YARD is in the middle of parsing
113
+ source files, and when it has completed writing the database.
114
+ - Added support for on-demand generation of LibraryVersion objects using the
115
+ `:disk` source type. LibraryVersion objects pointing to a .yardoc database
116
+ directory will now auto-generate if there is a `source_path` attached.
117
+ - Added warning for macros attached to non-method objects.
118
+ - Fixed a few more parsing errors.
119
+
120
+ # [0.9.4] - July 21st, 2016
121
+
122
+ [0.9.4]: https://github.com/lsegal/yard/compare/v0.9.3...v0.9.4
123
+
124
+ - Minor Ruby file parsing and CSS bug fixes.
125
+
126
+ # [0.9.3] - July 20th, 2016
127
+
128
+ [0.9.3]: https://github.com/lsegal/yard/compare/v0.9.2...v0.9.3
129
+
130
+ - Added support for {YARD::Server::RackAdapter} to be mounted under prefix URIs.
131
+ - Fixed regression in `yard server -g` that caused static file assets on index
132
+ page to return 404 errors.
133
+ - Fixed regression in `yard server -g` index page that disabled scrolling and
134
+ caused other HTML rendering glitches.
135
+
136
+ # [0.9.2] - July 19th, 2016
137
+
138
+ [0.9.2]: https://github.com/lsegal/yard/compare/v0.9.1...v0.9.2
139
+
140
+ - Added `yard config --gem-install-[yri|yard]` commands which auto-configure
141
+ your `~/.gemrc` file to run yri/yard instead of ri/rdoc on a `gem install`.
142
+ - Added support for gemspec metadata key `"yard.run"`, which can be either
143
+ `"yard"` or `"yri"` to run the respective commands on a `gem install`.
144
+ - Added `yard doc --no-progress` to hide the progress bar.
145
+ - Fix resolution error for compound proxy namespaces.
146
+ - YRI will now search across all gem versions (latest first) for the .yardoc
147
+ database.
148
+
149
+ # [0.9.1] - July 18th, 2016
150
+
151
+ [0.9.1]: https://github.com/lsegal/yard/compare/v0.9.0...v0.9.1
152
+
153
+ - Added "Attributes" section to `yard stats`.
154
+ - Added support for RubyGems 2.x `--document=yri,yard` flags. You can now run
155
+ YARD documentation generation against installed gems by running:
156
+ `gem install mygem --document=yard,yri`.
157
+ - Added `/static/*` routing for library-specific routing. This enables static
158
+ template files to be served on a per-library basis instead of globally shared
159
+ across the `yard server`.
160
+ - Added support for inlining of `{include:*}` syntax. Using this syntax in
161
+ the middle of a docstring paragraph will no longer create a separate paragraph
162
+ for the included text.
163
+ - Added support for resolving `{}` syntax in text templates, specifically for
164
+ use in `{include:*}` syntax.
165
+ - Improved object resolution logic in `{Foo::Bar}` syntax and {YARD::Registry.resolve}.
166
+ New resolution logic should now more accurately support resolving compound paths
167
+ across namespaces and through the inheritance tree (as Ruby does).
168
+ - The `frozen_string_literal: true` comment line in Ruby source files will now be
169
+ excluded from docstrings.
170
+ - Added a workaround for https://bugs.ruby-lang.org/issues/11485
171
+ - Fixed an issue where type using a docstring reference on an `@!attribute` macro
172
+ would be incorrectly parsed as a type specifier. This change updates the tag
173
+ parser to disallow newlines between the tag name and opening bracket of the
174
+ type specification.
175
+ - Fixed an issue where `--embed-mixins` would improperly embed methods from
176
+ inherited classes instead of modules.
177
+ - Fixed various parsing errors and YARD exceptions.
178
+ - Added a warning for modules or classes being redefined as constants.
179
+ - Reverted stripping of HTML in {YARD::Docstring#summary}.
180
+ - Added optimization to remove initial docstring parse on newly created code objects.
181
+ - {YARD::CodeObjects::Base#format} now passes the :type parameter to templates.
182
+ - Hide methods with filtered namespaces in Method Listing.
183
+
184
+ # [0.9.0] - July 4th, 2016
185
+
186
+ [0.9.0]: https://github.com/lsegal/yard/compare/v0.8.7.6...v0.9.0
187
+
188
+ Special thanks to Alex Dowad, MSP-Greg, and Alex McLain for their extended
189
+ contributions to this version.
190
+
191
+ - (Breaking Change): Replaced default template with an updated "frameless" version.
192
+ This change may affect backward compatibility if custom templates made modifications
193
+ to `default/fulldoc/html`, specifically the index or navigation lists.
194
+ - Added support for Ruby 2.1+ decorator style method declaration syntax. YARD now
195
+ supports:
196
+ private def foo(x, y) end
197
+ - Metadata headers in extra files can now be escaped from rendering by enclosing them
198
+ in HTML comment blocks (`<!--\n @metadata here... \n-->`). Ensure that the opening
199
+ comment tag is alone on the first line of the file to use this functionality.
200
+ - Improved parsing of various CRuby coding styles.
201
+ - Fixed issue with binary image assets when using `yard server`.
202
+ - Fixed deprecation warnings from Rake 10.x.
203
+ - Tests updated for RSpec 3.
204
+
205
+ # [0.8.7.6] - October 26, 2014
206
+
207
+ [0.8.7.6]: https://github.com/lsegal/yard/compare/v0.8.7.5...v0.8.7.6
208
+
209
+ - Support using `@option` tag on keyword arg splat parameter. (#729)
210
+ - Add `.stats_options` for `YardocTask`. (#800, #801)
211
+
212
+ # [0.8.7.5] - October 26, 2014
213
+
214
+ [0.8.7.5]: https://github.com/lsegal/yard/compare/v0.8.7.4...v0.8.7.5
215
+
216
+ - Fix linking of methods in top level namespace in method listing. (#776)
217
+ - Support using C macros in function declarations. (#810)
218
+ - YARD will no longer group comment blocks starting on the same column if they
219
+ are preceded by code. (#798)
220
+ - Handle anonymous lambda calls in toplevel scope. (#774)
221
+ - Support I18n in `@overload` tags. (#794)
222
+ - Support `yard stats` for objects with no file property. (#792)
223
+ - Support for named arguments in Ruby >= 2.1. (#785)
224
+ - Exclude README backup files from YARD generation. (#790)
225
+ - Turned on the lax spacing option in Redcarpet to comply with the
226
+ Markdown standard.
227
+ - Escape HTML in YARD server search placeholder template.
228
+ - Fix issue with `private_class_method` support. (#760, #767)
229
+ - Enable tables support by default in Redcarpet Markdown provider. (#765)
230
+
231
+ # 0.8.7.4 - March 22, 2014
232
+
233
+ [0.8.7.4]: https://github.com/lsegal/yard/compare/v0.8.7.3...v0.8.7.4
234
+
235
+ - Mark C methods as explicit but also remove explicit check in stats. (#727)
236
+ - Report unresolved parent namespaces as undocumentable errors instead. (#753)
237
+ - No longer ignore overridden methods from documentation check in stats (#719)
238
+ - Fix JRuby throwing exception when remove_method called on non-existent method. (#732)
239
+ - Add basic support for `private_class_method` (#747)
240
+ - Ensure namespace is always set when parent module is not found. (#753)
241
+ - Set overflow as auto on table of contents.
242
+ - Report 100% documented if nothing is undocumented. (#754)
243
+ - Added support for RubyGems 2.0.0+. (#742)
244
+ - Allow users to enter their own YARD RakeTask name. (#705)
245
+ - Fixed a typo that was causing Windows detection to always fail. (#715)
246
+ - Add debug information when loading a plugin fails. (#711)
247
+
248
+ # [0.8.7.3] - November 1, 2013
249
+
250
+ [0.8.7.3]: https://github.com/lsegal/yard/compare/v0.8.7.2...v0.8.7.3
251
+
252
+ - Handle Unicode method/class/file names in server URL encoding (lsegal/rubydoc.info#69).
253
+ - Style keyword style hashes with same symbol color in code highlighting (#707).
254
+ - Fix broken JS when visiting docs in file:// scheme (#706).
255
+ - Add support for new AsciiDoc file extensions (#704).
256
+ - Fix issues where non-Ruby code blocks would not display in Ruby 2 (#702).
257
+ - Add support for extra Ruby 2 symbol types in Ripper (#701).
258
+ - Ensure config directory exists before saving config file (#700).
259
+
260
+ # [0.8.7.2] - September 18, 2013
261
+
262
+ [0.8.7.2]: https://github.com/lsegal/yard/compare/v0.8.7.1...v0.8.7.2
263
+
264
+ - Disallow absolute URLs when using frame anchor support.
265
+ - Support casted functions in CRuby method declarations (#697)
266
+
267
+ # [0.8.7.1] - September 11, 2013
268
+
269
+ [0.8.7.1]: https://github.com/lsegal/yard/compare/v0.8.7...v0.8.7.1
270
+
271
+ - Fix potential XSS issue with frame anchor support.
272
+ - Add support for gettext 3.x gem.
273
+
274
+ # [0.8.7] - July 26, 2013
275
+
276
+ [0.8.7]: https://github.com/lsegal/yard/compare/v0.8.6.2...v0.8.7
277
+
278
+ - Added `--hide-api API` option to hide objects with a given `@api` tag (#685).
279
+ - Added "Returns ...." prefix to summary when a lone @return tag is used.
280
+ - Fixed issue that caused ref tags to be added to a docstring twice (#678).
281
+ - Fixed formatting issue in docstring summaries (#686)
282
+
283
+ # [0.8.6.2] - June 27, 2013
284
+
285
+ [0.8.6.2]: https://github.com/lsegal/yard/compare/v0.8.6.1...v0.8.6.2
286
+
287
+ - Fixed issue where `yard graph` was not displaying methods
288
+
289
+ # [0.8.6.1] - April 14, 2013
290
+
291
+ [0.8.6.1]: https://github.com/lsegal/yard/compare/v0.8.6...v0.8.6.1
292
+
293
+ - Fixed broken links in File menu on default HTML template
294
+ - Added --layout switch to `yard display` to wrap output in layout template.
295
+ - See {file:docs/WhatsNew.md} for more information on added features.
296
+
297
+ # [0.8.6] - April 13, 2013
298
+
299
+ [0.8.6]: https://github.com/lsegal/yard/compare/v0.8.5.2...v0.8.6
300
+
301
+ - Various fixes and improved Ruby 2.x compatibility support
302
+ - Added support for `asciidoc` markup type
303
+ - Added `yard markups` command to list available markup types
304
+ - Added `yard display` command to display and format an individual object
305
+ - See {file:docs/WhatsNew.md} for more information on added features.
306
+
307
+ # [0.8.5.2] - February 26, 2013
308
+
309
+ [0.8.5.2]: https://github.com/lsegal/yard/compare/v0.8.5.1...v0.8.5.2
310
+
311
+ - Support new keyword argument syntax in method signatures (Ruby 2.x)
312
+
313
+ # [0.8.5.1] - February 25, 2013
314
+
315
+ [0.8.5.1]: https://github.com/lsegal/yard/compare/v0.8.5...v0.8.5.1
316
+
317
+ - Fix `yard diff` of gem files with RubyGems 2.x
318
+
319
+ # [0.8.5] - February 24, 2013
320
+
321
+ [0.8.5]: https://github.com/lsegal/yard/compare/v0.8.4.1...v0.8.5
322
+
323
+ - Basic support for Ruby 2.0 (fix compat issues in RDoc 4.0, RubyGems 2.0)
324
+ - Add CSS styling for tables in default HTML template
325
+
326
+ # [0.8.4.1] - February 5, 2013
327
+
328
+ [0.8.4.1]: https://github.com/lsegal/yard/compare/v0.8.4...v0.8.4.1
329
+
330
+ - Fix regression that broke loading of existing yardoc dbs (#648)
331
+
332
+ # [0.8.4] - February 4, 2013
333
+
334
+ [0.8.4]: https://github.com/lsegal/yard/compare/v0.8.3...v0.8.4
335
+
336
+ - Add `-B/--bind` switch to yard server (#593, #608)
337
+ - Add CodeObjects::Base#title for plugins to customize how object
338
+ links display (#646)
339
+ - Disable linking objects filtered out by verifiers (#645)
340
+ - Allow macro expansion on class methods (#632)
341
+ - Expand newly attached macro on first DSL method call (#631)
342
+ - Disable RubyGems plugin in Ruby 2.0 (#627)
343
+ - Fix line range for class/module node bodies (#626)
344
+ - Search extended modules for attached DSL macros (#553)
345
+
346
+ # [0.8.3] - October 14, 2012
347
+
348
+ [0.8.3]: https://github.com/lsegal/yard/compare/v0.8.2.1...v0.8.3
349
+
350
+ - Add `--non-transitive-tag` to disable tag transitivity (#571)
351
+ - Support --db inside .yardopts for graph/server commands (#583, #586)
352
+ - Fix handling for =begin/=end docstrings (#577, #578)
353
+ - Parser only sorts file lists when a glob is provided (#572)
354
+ - Fix formatting in `{include:Object#method}` syntax (#569)
355
+ - Fix @option tag inside of module functions (#563)
356
+ - Fix to `--api` and `--no-api` support (#559)
357
+ - Fix class nesting issues when path starts with "::" (#552)
358
+
359
+ # [0.8.2.1] - June 9, 2012
360
+
361
+ [0.8.2.1]: https://github.com/lsegal/yard/compare/v0.8.2...v0.8.2.1
362
+
363
+ - Fix a set of regressions in yard server search and dynamic generation
364
+
365
+ # [0.8.2] - June 7, 2012
366
+
367
+ [0.8.2]: https://github.com/lsegal/yard/compare/v0.8.1...v0.8.2
368
+
369
+ - Added progress style output in tty terminals
370
+ - Embedded mixins should ignore methods defined on module (#539)
371
+ - Fixed permalinks for embedded mixins in `yard server` (#540)
372
+ - Improve parsing in CRuby code (#543)
373
+ - Ensure Registry.resolve picks module when parsing mixins (#545)
374
+ - Fixed regression that caused various commands to not show output (#548)
375
+ - Respect current visibility when parsing class conditions (#551)
376
+
377
+ # [0.8.1] - May 2, 2012
378
+
379
+ [0.8.1]: https://github.com/lsegal/yard/compare/v0.8.0...v0.8.1
380
+
381
+ - Added `--[no-]api` switch to generate docs for API sets (see {file:docs/WhatsNew.md} for details) (#532)
382
+ - The `yard list` command now uses cache by default (#533)
383
+ - Fix `yardoc` generating incorrectly named method list file (#528)
384
+ - Fix HTML output occasionally showing trailing mdash on options list (#522)
385
+
386
+ # [0.8.0] - April 30, 2012
387
+
388
+ [0.8.0]: https://github.com/lsegal/yard/compare/v0.7.5...v0.8.0
389
+
390
+ - See {file:docs/WhatsNew.md} for a list of added features
391
+ - Over 20 bug fixes:
392
+ - Properly filter hidden setter/getter attributes (#394)
393
+ - Fix test failures in Linux environments (#397, #472, #473, #512, #513)
394
+ - Fix attribute inheritance and @private (#432)
395
+ - Fix attribute parsing (#435)
396
+ - Allow aliases for attributes (#436)
397
+ - Fix namespace fetching in `handle_alias()` (#437)
398
+ - Fix overwritten attributes marked as inherited (#442)
399
+ - Fix documenting constants defined from C code with `rb_define_const()` (#443)
400
+ - Do not escape snippets twice (#445)
401
+ - Ajax method/class search should not fire when a non-printable character is pressed (#446)
402
+ - Fix yard server crashing when RDoc is not installed (#456)
403
+ - Fix tags ignored when `(see #foo)` is used (#457)
404
+ - Fix three "Returns" for two `@overload` tags (#458)
405
+ - Do not auto-detect DSL methods as method objects if parameter name is not a valid method name (#464)
406
+ - Fix attaching of macros to Object (#465)
407
+ - Fix handling of `%w()` source in `[]/[]=` parsed context. (#461, pull in #468)
408
+ - Don't add default `@return` if `@overload` has `@return`. (#458, pull in #469)
409
+ - Don't discard tags by (see ...). (#457, pull in #470)
410
+ - Fix constants listed as inherited when overwritten (#474)
411
+ - Fix `yardoc --asset` behaving differently on first and subsequent calls. (#477)
412
+ - `!!!lang` code blocks should set the lang in `<pre>`'s class. (#478, #479)
413
+ - Fix "File List" search tab error. (#502)
414
+ - Fix search bar not redirecting to method page. (#509)
415
+ - Fix server returning exception message bodies as String (#518)
416
+
417
+ # [0.7.5] - January 31, 2012
418
+
419
+ [0.7.5]: https://github.com/lsegal/yard/compare/v0.7.4...v0.7.5
420
+
421
+ - Various minor bug fixes
422
+
423
+ # [0.7.4] - December 2, 2011
424
+
425
+ [0.7.4]: https://github.com/lsegal/yard/compare/v0.7.3...v0.7.4
426
+
427
+ - Redcarpet is now the default Markdown formatting library. GFM now works out-of-box (#404)
428
+ - Fix server side searching for elements that are marked private (#420)
429
+ - Add 'textile_strict' and 'pre' markup types, reorganize text and none (#416)
430
+ - Improve encoding line detection (#415)
431
+ - Add support for `rb_define_alias` in CRuby code (#413)
432
+ - Fix rendering of some keywords in source view (#410)
433
+ - Add support for RDoc 3.10+ (#406, #407)
434
+ - Fix typewriter text being processed in code blocks (#403)
435
+ - Improve support for has_rdoc in RubyGems 1.8.x (#401)
436
+ - See the {file:docs/WhatsNew.md} document for details on added features
437
+
438
+ # [0.7.3] - October 15, 2011
439
+
440
+ [0.7.3]: https://github.com/lsegal/yard/compare/v0.7.2...v0.7.3
441
+
442
+ - Improve support for parsing under Ruby 1.9.2p290 and 1.9.3 (#365, #370)
443
+ - Add support for SWIG generated CRuby code (#369)
444
+ - Add support for `rb_define_attr` calls in CRuby code (#362)
445
+ - Handle file pointers in CRuby code (#358)
446
+
447
+ # [0.7.2] - June 14, 2011
448
+
449
+ [0.7.2]: https://github.com/lsegal/yard/compare/v0.7.1...v0.7.2
450
+
451
+ - Fix `yard --help` not showing proper output
452
+ - YARD now expands path to `.yardoc` file in daemon mode for server (#328)
453
+ - Fix `@overload` tag linking to wrong method (#330)
454
+ - Fix incorrect return type when using `@macro` (#334)
455
+ - YARD now requires 'thread' to support RubyGems 1.7+ (#338)
456
+ - Fix bug in constant documentation when using `%w()` (#348)
457
+ - Fix YARD style URL links when using autolinking markdown (#353)
458
+
459
+ # [0.7.1] - May 18, 2011
460
+
461
+ [0.7.1]: https://github.com/lsegal/yard/compare/v0.7.0...v0.7.1
462
+
463
+ - Fixes a bug in `yard server` not displaying class list properly.
464
+
465
+ # [0.7.0] - May 17, 2011
466
+
467
+ [0.7.0]: https://github.com/lsegal/yard/compare/v0.6.8...v0.7.0
468
+
469
+ - See the {file:docs/WhatsNew.md} document for details on added features
470
+ - Make sure that Docstring#line_range is filled when possible (#243)
471
+ - Set #verifier in YardocTask (#282)
472
+ - Parse BOM in UTF-8 files (#288)
473
+ - Fix instance attributes not showing up in method list (#302)
474
+ - Fix rendering of %w() literals in constants (#306)
475
+ - Ignore keyboard shortcuts when an input is active (#312)
476
+ - And more...
477
+
478
+ # [0.6.8] - April 14, 2011
479
+
480
+ [0.6.8]: https://github.com/lsegal/yard/compare/v0.6.7...v0.6.8
481
+
482
+ - Fix regression in RDoc 1.x markup loading
483
+ - Fix regression in loading of markup libraries for `yard server`
484
+
485
+ # [0.6.7] - April 6, 2011
486
+
487
+ [0.6.7]: https://github.com/lsegal/yard/compare/v0.6.6...v0.6.7
488
+
489
+ - Fix has_rdoc gem specification issue with new RubyGems plugin API (oops!)
490
+
491
+ # [0.6.6] - April 6, 2011
492
+
493
+ [0.6.6]: https://github.com/lsegal/yard/compare/v0.6.5...v0.6.6
494
+
495
+ - Fix error message when RDoc is not present (#270)
496
+ - Add markup type 'none' to perform basic HTML translation (fallback when RDoc is not present)
497
+ - Add support for RubyGems 1.7.x (#272)
498
+ - Fix rendering of `{url description}` syntax when description contains newline
499
+
500
+ # [0.6.5] - March 13, 2011
501
+
502
+ [0.6.5]: https://github.com/lsegal/yard/compare/v0.6.4...v0.6.5
503
+
504
+ - Support `ripper` gem in Ruby 1.8.7
505
+ - Upgrade jQuery to 1.5.1
506
+ - Fix handling of alias statements with quoted symbols (#262)
507
+ - Add CSS styles (#260)
508
+ - Unhandled exception in YARD::Handlers::Ruby::MixinHandler indexing documentation for eventmachine (#248)
509
+ - Splice any alias references on method re-definitions into separate methods (#247)
510
+ - Fix "yard graph" (#245)
511
+ - Don't process ++ typewriter text inside of HTML attributes (#244)
512
+ - Prioritize loading of Kramdown before Maruku (#241)
513
+ - Skip shebang encoding in docstrings (#238)
514
+ - Fix truncation of references in @deprecated (#232)
515
+ - Show @api private note when no other tags are present (#231)
516
+ - Detect docstrings starting with "##" as `Docstring#hash_flag` (#230)
517
+ - Remove trailing whitespace from freeform tags (#229)
518
+ - Fix line through for deprecated methods (#225)
519
+ - Mistake in Tags.md (#223)
520
+ - Improve database storage by being more efficient with filesystem usage (#222)
521
+ - Make Registry thread local (#221)
522
+ - Support `private_constant` class method for 1.9.3 (#219)
523
+ - Do not assume RDoc is installed (#214)
524
+
525
+ # [0.6.4] - December 21, 2010
526
+
527
+ [0.6.4]: https://github.com/lsegal/yard/compare/v0.6.3...v0.6.4
528
+
529
+ - Fix yri tool crashing with new Config class (gh-217)
530
+ - Fix support for ::TopLevelConstants (gh-216)
531
+ - YARD's test suite is now RSpec2 compatible (gh-215)
532
+ - Improved documentation for YARD::Server features (gh-207)
533
+ - Fix displaying of collaped method summary lists (gh-204)
534
+ - Fix automatic loading of markup providers (gh-206)
535
+ - Fix keyboard shortcuts for Chrome (gh-203)
536
+ - Disallow `extend self` inside of a class (gh-202)
537
+ - Constants now recognized in C extensions (gh-201)
538
+
539
+ # [0.6.3] - November 21, 2010
540
+
541
+ [0.6.3]: https://github.com/lsegal/yard/compare/v0.6.2...v0.6.3
542
+
543
+ - Fixed regression that caused `yardoc --markup` to silently exit
544
+
545
+ # [0.6.2] - November 15, 2010
546
+
547
+ [0.6.2]: https://github.com/lsegal/yard/compare/v0.6.1...v0.6.2
548
+
549
+ - **Plugins no longer automatically load, use `--plugin` to load a plugin**
550
+ - Added YARD::Config and ~/.yard/config YAML configuration file
551
+ - Added `yard config` command to view/edit YARD configuration file
552
+ - Fixes for YARD in 1.8.6 (gh-178)
553
+ - Various HTML template adjustments and fixes (gh-198,199,200)
554
+ - Improved `yard server -m` multi-project stability (gh-193)
555
+ - Fixed handling of `yardoc --no-private` with missing class definitions (gh-197)
556
+ - Added support for constants defined in C extensions (gh-177)
557
+ - Added support for Structs defined as "Klass = Struct.new(...)" (gh-187)
558
+ - Improved parsing support for third-party gems (gh-174,180)
559
+ - Improved support for JRuby 1.6.4+. YARD now passes all specs in JRuby (gh-185)
560
+ - Improved YARD documentation (gh-172,191,196)
561
+
562
+ # [0.6.1] - September 06, 2010
563
+
564
+ [0.6.1]: https://github.com/lsegal/yard/compare/v0.6.0...v0.6.1
565
+
566
+ - Fixed TOC showing on top of class/method list in no-frames view
567
+ - A message now displays when running `yard server` with Rack/Mongrel installed
568
+ - Improved performance of JS inline search for large class/method lists
569
+ - Improved link titles for relative object links
570
+ - Removed `String#camelcase` and `String#underscore` for better Rails compat.
571
+ - Fixed support for loading .yardoc files under Windows
572
+ - Fixed inheritance tree arrows not displaying in certain environments
573
+
574
+ # [0.6.0] - August 29, 2010
575
+
576
+ [0.6.0]: https://github.com/lsegal/yard/compare/v0.5.8...v0.6.0
577
+
578
+ - Added dynamic local documentation server
579
+ - Added @group/@endgroup declarations to organize methods into groups
580
+ - Added `yard` executable to serve as main CLI tool with pluggable commands
581
+ - Added `--asset` switch to `yardoc` to copy files/dirs to output dir
582
+ - Added ability to register/manipulate tags via CLI (`--tag`, etc.)
583
+ - Added `yard diff` command
584
+ - Added statistics to `yardoc` output (and `yard stats` command)
585
+ - Added Javascript generated Table of Contents to file pages
586
+ - Updated various APIs
587
+ - Removed `yard-graph` executable
588
+ - See more changes in the {file:docs/WhatsNew.md what's new document}
589
+
590
+ # [0.5.8] - June 22, 2010
591
+
592
+ [0.5.8]: https://github.com/lsegal/yard/compare/v0.5.7...v0.5.8
593
+
594
+ - Merge fix from 0.6 branch for --no-private visibility checking
595
+
596
+ # [0.5.7] - June 21, 2010
597
+
598
+ [0.5.7]: https://github.com/lsegal/yard/compare/v0.5.6...v0.5.7
599
+
600
+ - Fixed visibility flag parsing in `yardoc`
601
+ - Updated Parser Architecture documentation with new SourceParser API
602
+ - Improved Registry documentation for new load commands
603
+ - Fix loading of .yardoc file as cache (and preserving aliases)
604
+ - Fix "lib" directory missing when running YARD on installed gems
605
+
606
+ # [0.5.6] - June 12, 2010
607
+
608
+ [0.5.6]: https://github.com/lsegal/yard/compare/v0.5.5...v0.5.6
609
+
610
+ - Bug fixes for RubyGems plugin, `has_rdoc=false` should now work
611
+ - New API for registering custom parsers. See {file:docs/WhatsNew.md}
612
+
613
+ # [0.5.5] - May 22, 2010
614
+
615
+ [0.5.5]: https://github.com/lsegal/yard/compare/v0.5.4...v0.5.5
616
+
617
+ - Various bug fixes
618
+
619
+ # [0.5.4] - March 22, 2010
620
+
621
+ [0.5.4]: https://github.com/lsegal/yard/compare/v0.5.3...v0.5.4
622
+
623
+ - See {file:docs/WhatsNew.md what's new document} for changes
624
+
625
+ # [0.5.3] - January 11, 2010
626
+
627
+ [0.5.3]: https://github.com/lsegal/yard/compare/v0.5.2...v0.5.3
628
+
629
+ - See {file:docs/WhatsNew.md what's new document} for changes
630
+
631
+ # [0.5.2] - December 16, 2009
632
+
633
+ [0.5.2]: https://github.com/lsegal/yard/compare/v0.5.1...v0.5.2
634
+
635
+ - See {file:docs/WhatsNew.md what's new document} for changes
636
+
637
+ # [0.5.1] - December 15, 2009
638
+
639
+ [0.5.1]: https://github.com/lsegal/yard/compare/v0.5.0...v0.5.1
640
+
641
+ - See {file:docs/WhatsNew.md what's new document} for changes
642
+
643
+ # [0.5.0] - December 13, 2009
644
+
645
+ [0.5.0]: https://github.com/lsegal/yard/compare/v0.4.0...v0.5.0
646
+
647
+ - See {file:docs/WhatsNew.md what's new document} for changes
648
+
649
+ # [0.4.0] - November 15, 2009
650
+
651
+ [0.4.0]: https://github.com/lsegal/yard/compare/v0.2.3.5...v0.4.0
652
+
653
+ - Added new templating engine based on [tadpole](http://github.com/lsegal/tadpole)
654
+ - Added YARD queries (`--query` CLI argument to yardoc)
655
+ - Greatly expanded YARD documentation
656
+ - Added plugin support
657
+ - New `@abstract` and `@private` tags
658
+ - Changed default rake task to `rake yard`
659
+ - Read about changes in {file:docs/WhatsNew.md}
660
+
661
+ # [0.2.3.5] - August 13, 2009
662
+
663
+ [0.2.3.5]: https://github.com/lsegal/yard/compare/v0.2.3.4...v0.2.3.5
664
+
665
+ - Minor bug fixes.
666
+
667
+ # [0.2.3.4] - August 07, 2009
668
+
669
+ [0.2.3.4]: https://github.com/lsegal/yard/compare/v0.2.3.3...v0.2.3.4
670
+
671
+ - Minor bug fixes.
672
+
673
+ # [0.2.3.3] - July 26, 2009
674
+
675
+ [0.2.3.3]: https://github.com/lsegal/yard/compare/v0.2.3.2...v0.2.3.3
676
+
677
+ - Minor bug fixes.
678
+
679
+ # [0.2.3.2] - July 06, 2009
680
+
681
+ [0.2.3.2]: https://github.com/lsegal/yard/compare/v0.2.3.1...v0.2.3.2
682
+
683
+ - Fix Textile hard-break issues
684
+ - Add description for @see tag to use as link title in HTML docs.
685
+ - Add --title CLI option to specify a title for HTML doc files.
686
+ - Add custom.css file that can be overridden with various custom
687
+ styelsheet declarations. To use this, simply add `default/fulldoc/html/custom.css`
688
+ inside your code directory and use the `-t` template directory yardoc CLI
689
+ option to point to that template directory (the dir holding 'default').
690
+ - Add support in `yardoc` CLI to specify extra files (formerly --files)
691
+ by appending "- extra files here" after regular source files. Example:
692
+
693
+ yardoc --private lib/**/*.rb - FAQ LICENSE
694
+
695
+ # [0.2.3.1] - June 13, 2009
696
+
697
+ [0.2.3.1]: https://github.com/lsegal/yard/compare/v0.2.3...v0.2.3.1
698
+
699
+ - Add a RubyGems 1.3.2+ plugin to generate YARD documentation instead of
700
+ RDoc. To take advantage of this plugin, set `has_rdoc = 'yard'` in your
701
+ .gemspec file.
702
+
703
+ # [0.2.3] - June 07, 2009
704
+
705
+ [0.2.3]: https://github.com/lsegal/yard/compare/v0.2.2...v0.2.3
706
+
707
+ - See the {file:docs/WhatsNew.md} file for a list of important new features.
708
+
709
+ # [0.2.2] - Jun 16, 2008
710
+
711
+ [0.2.2]: https://github.com/lsegal/yard/compare/v0.2.1...v0.2.2
712
+
713
+ - This is the largest changset since yard's conception and involves a complete
714
+ overhaul of the parser and API to make it more robust and far easier to
715
+ extend and use for the developer.
716
+
717
+ # [0.2.1] - February 20, 2008
718
+
719
+ [0.2.1]: https://github.com/lsegal/yard/compare/v0.1a...v0.2.1
720
+
721
+ - See the {file:docs/WhatsNew.md} file for a list of important new features.
722
+
723
+ # 0.1a - February 24, 2007
724
+
725
+ - Released 0.1a experimental version for testing. The goal here is
726
+ to get people testing YARD on their code because there are too many possible
727
+ code styles to fit into a sane amount of test cases. It also demonstrates the
728
+ power of YARD and what to expect from the syntax (Yardoc style meta tags).