yard 0.9.1 → 0.9.2

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 (569) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +0 -0
  3. data/CHANGELOG.md +11 -0
  4. data/LEGAL +0 -0
  5. data/LICENSE +0 -0
  6. data/README.md +0 -0
  7. data/Rakefile +0 -0
  8. data/benchmarks/builtins_vs_eval.rb +0 -0
  9. data/benchmarks/concat_vs_join.rb +0 -0
  10. data/benchmarks/erb_vs_erubis.rb +0 -0
  11. data/benchmarks/format_args.rb +0 -0
  12. data/benchmarks/generation.rb +0 -0
  13. data/benchmarks/marshal_vs_dbm.rb +0 -0
  14. data/benchmarks/parsing.rb +0 -0
  15. data/benchmarks/pathname_vs_string.rb +0 -0
  16. data/benchmarks/rdoc_vs_yardoc.rb +0 -0
  17. data/benchmarks/registry_store_types.rb +0 -0
  18. data/benchmarks/ri_vs_yri.rb +0 -0
  19. data/benchmarks/ripper_parser.rb +0 -0
  20. data/benchmarks/splat_vs_flatten.rb +0 -0
  21. data/benchmarks/template_erb.rb +0 -0
  22. data/benchmarks/template_format.rb +0 -0
  23. data/benchmarks/template_profile.rb +0 -0
  24. data/benchmarks/yri_cache.rb +0 -0
  25. data/bin/yard +0 -0
  26. data/bin/yardoc +0 -0
  27. data/bin/yri +0 -0
  28. data/docs/CodeObjects.md +0 -0
  29. data/docs/GettingStarted.md +0 -0
  30. data/docs/Handlers.md +0 -0
  31. data/docs/Overview.md +0 -0
  32. data/docs/Parser.md +0 -0
  33. data/docs/Tags.md +0 -0
  34. data/docs/TagsArch.md +0 -0
  35. data/docs/Templates.md +0 -0
  36. data/docs/WhatsNew.md +0 -0
  37. data/docs/images/code-objects-class-diagram.png +0 -0
  38. data/docs/images/handlers-class-diagram.png +0 -0
  39. data/docs/images/overview-class-diagram.png +0 -0
  40. data/docs/images/parser-class-diagram.png +0 -0
  41. data/docs/images/tags-class-diagram.png +0 -0
  42. data/docs/templates/default/fulldoc/html/full_list_tag.erb +0 -0
  43. data/docs/templates/default/fulldoc/html/setup.rb +0 -0
  44. data/docs/templates/default/layout/html/setup.rb +0 -0
  45. data/docs/templates/default/layout/html/tag_list.erb +0 -0
  46. data/docs/templates/default/yard_tags/html/list.erb +0 -0
  47. data/docs/templates/default/yard_tags/html/setup.rb +0 -0
  48. data/docs/templates/plugin.rb +0 -0
  49. data/lib/rubygems_plugin.rb +0 -0
  50. data/lib/yard.rb +0 -0
  51. data/lib/yard/autoload.rb +0 -0
  52. data/lib/yard/cli/command.rb +0 -0
  53. data/lib/yard/cli/command_parser.rb +0 -0
  54. data/lib/yard/cli/config.rb +62 -1
  55. data/lib/yard/cli/diff.rb +0 -0
  56. data/lib/yard/cli/display.rb +0 -0
  57. data/lib/yard/cli/gems.rb +0 -0
  58. data/lib/yard/cli/graph.rb +0 -0
  59. data/lib/yard/cli/help.rb +0 -0
  60. data/lib/yard/cli/i18n.rb +0 -0
  61. data/lib/yard/cli/list.rb +0 -0
  62. data/lib/yard/cli/markup_types.rb +0 -0
  63. data/lib/yard/cli/server.rb +0 -0
  64. data/lib/yard/cli/stats.rb +0 -0
  65. data/lib/yard/cli/yardoc.rb +4 -0
  66. data/lib/yard/cli/yardopts_command.rb +0 -0
  67. data/lib/yard/cli/yri.rb +0 -0
  68. data/lib/yard/code_objects/base.rb +0 -0
  69. data/lib/yard/code_objects/class_object.rb +0 -0
  70. data/lib/yard/code_objects/class_variable_object.rb +0 -0
  71. data/lib/yard/code_objects/constant_object.rb +0 -0
  72. data/lib/yard/code_objects/extended_method_object.rb +0 -0
  73. data/lib/yard/code_objects/extra_file_object.rb +0 -0
  74. data/lib/yard/code_objects/macro_object.rb +0 -0
  75. data/lib/yard/code_objects/method_object.rb +0 -0
  76. data/lib/yard/code_objects/module_object.rb +0 -0
  77. data/lib/yard/code_objects/namespace_mapper.rb +0 -0
  78. data/lib/yard/code_objects/namespace_object.rb +0 -0
  79. data/lib/yard/code_objects/proxy.rb +0 -0
  80. data/lib/yard/code_objects/root_object.rb +0 -0
  81. data/lib/yard/config.rb +2 -2
  82. data/lib/yard/core_ext/array.rb +0 -0
  83. data/lib/yard/core_ext/file.rb +0 -0
  84. data/lib/yard/core_ext/hash.rb +0 -0
  85. data/lib/yard/core_ext/insertion.rb +0 -0
  86. data/lib/yard/core_ext/module.rb +0 -0
  87. data/lib/yard/core_ext/string.rb +0 -0
  88. data/lib/yard/core_ext/symbol_hash.rb +0 -0
  89. data/lib/yard/docstring.rb +0 -0
  90. data/lib/yard/docstring_parser.rb +1 -1
  91. data/lib/yard/globals.rb +0 -0
  92. data/lib/yard/handlers/base.rb +0 -0
  93. data/lib/yard/handlers/c/alias_handler.rb +0 -0
  94. data/lib/yard/handlers/c/attribute_handler.rb +0 -0
  95. data/lib/yard/handlers/c/base.rb +0 -0
  96. data/lib/yard/handlers/c/class_handler.rb +0 -0
  97. data/lib/yard/handlers/c/constant_handler.rb +0 -0
  98. data/lib/yard/handlers/c/handler_methods.rb +0 -0
  99. data/lib/yard/handlers/c/init_handler.rb +0 -0
  100. data/lib/yard/handlers/c/method_handler.rb +0 -0
  101. data/lib/yard/handlers/c/mixin_handler.rb +0 -0
  102. data/lib/yard/handlers/c/module_handler.rb +0 -0
  103. data/lib/yard/handlers/c/override_comment_handler.rb +0 -0
  104. data/lib/yard/handlers/c/path_handler.rb +0 -0
  105. data/lib/yard/handlers/c/struct_handler.rb +0 -0
  106. data/lib/yard/handlers/c/symbol_handler.rb +0 -0
  107. data/lib/yard/handlers/processor.rb +0 -0
  108. data/lib/yard/handlers/ruby/alias_handler.rb +0 -0
  109. data/lib/yard/handlers/ruby/attribute_handler.rb +0 -0
  110. data/lib/yard/handlers/ruby/base.rb +0 -0
  111. data/lib/yard/handlers/ruby/class_condition_handler.rb +0 -0
  112. data/lib/yard/handlers/ruby/class_handler.rb +0 -0
  113. data/lib/yard/handlers/ruby/class_variable_handler.rb +0 -0
  114. data/lib/yard/handlers/ruby/comment_handler.rb +0 -0
  115. data/lib/yard/handlers/ruby/constant_handler.rb +0 -0
  116. data/lib/yard/handlers/ruby/decorator_handler_methods.rb +0 -0
  117. data/lib/yard/handlers/ruby/dsl_handler.rb +0 -0
  118. data/lib/yard/handlers/ruby/dsl_handler_methods.rb +0 -0
  119. data/lib/yard/handlers/ruby/exception_handler.rb +0 -0
  120. data/lib/yard/handlers/ruby/extend_handler.rb +0 -0
  121. data/lib/yard/handlers/ruby/legacy/alias_handler.rb +0 -0
  122. data/lib/yard/handlers/ruby/legacy/attribute_handler.rb +0 -0
  123. data/lib/yard/handlers/ruby/legacy/base.rb +0 -0
  124. data/lib/yard/handlers/ruby/legacy/class_condition_handler.rb +0 -0
  125. data/lib/yard/handlers/ruby/legacy/class_handler.rb +0 -0
  126. data/lib/yard/handlers/ruby/legacy/class_variable_handler.rb +0 -0
  127. data/lib/yard/handlers/ruby/legacy/comment_handler.rb +0 -0
  128. data/lib/yard/handlers/ruby/legacy/constant_handler.rb +0 -0
  129. data/lib/yard/handlers/ruby/legacy/dsl_handler.rb +0 -0
  130. data/lib/yard/handlers/ruby/legacy/exception_handler.rb +0 -0
  131. data/lib/yard/handlers/ruby/legacy/extend_handler.rb +0 -0
  132. data/lib/yard/handlers/ruby/legacy/method_handler.rb +0 -0
  133. data/lib/yard/handlers/ruby/legacy/mixin_handler.rb +0 -0
  134. data/lib/yard/handlers/ruby/legacy/module_function_handler.rb +0 -0
  135. data/lib/yard/handlers/ruby/legacy/module_handler.rb +0 -0
  136. data/lib/yard/handlers/ruby/legacy/private_class_method_handler.rb +0 -0
  137. data/lib/yard/handlers/ruby/legacy/private_constant_handler.rb +0 -0
  138. data/lib/yard/handlers/ruby/legacy/visibility_handler.rb +0 -0
  139. data/lib/yard/handlers/ruby/legacy/yield_handler.rb +0 -0
  140. data/lib/yard/handlers/ruby/method_condition_handler.rb +0 -0
  141. data/lib/yard/handlers/ruby/method_handler.rb +0 -0
  142. data/lib/yard/handlers/ruby/mixin_handler.rb +0 -0
  143. data/lib/yard/handlers/ruby/module_function_handler.rb +0 -0
  144. data/lib/yard/handlers/ruby/module_handler.rb +0 -0
  145. data/lib/yard/handlers/ruby/private_class_method_handler.rb +0 -0
  146. data/lib/yard/handlers/ruby/private_constant_handler.rb +2 -1
  147. data/lib/yard/handlers/ruby/public_class_method_handler.rb +0 -0
  148. data/lib/yard/handlers/ruby/struct_handler_methods.rb +0 -0
  149. data/lib/yard/handlers/ruby/visibility_handler.rb +0 -0
  150. data/lib/yard/handlers/ruby/yield_handler.rb +0 -0
  151. data/lib/yard/i18n/locale.rb +0 -0
  152. data/lib/yard/i18n/message.rb +0 -0
  153. data/lib/yard/i18n/messages.rb +0 -0
  154. data/lib/yard/i18n/po_parser.rb +0 -0
  155. data/lib/yard/i18n/pot_generator.rb +0 -0
  156. data/lib/yard/i18n/text.rb +0 -0
  157. data/lib/yard/logging.rb +0 -0
  158. data/lib/yard/options.rb +0 -0
  159. data/lib/yard/parser/base.rb +0 -0
  160. data/lib/yard/parser/c/c_parser.rb +0 -0
  161. data/lib/yard/parser/c/comment_parser.rb +0 -0
  162. data/lib/yard/parser/c/statement.rb +0 -0
  163. data/lib/yard/parser/ruby/ast_node.rb +0 -0
  164. data/lib/yard/parser/ruby/legacy/ruby_lex.rb +0 -0
  165. data/lib/yard/parser/ruby/legacy/ruby_parser.rb +0 -0
  166. data/lib/yard/parser/ruby/legacy/statement.rb +0 -0
  167. data/lib/yard/parser/ruby/legacy/statement_list.rb +0 -0
  168. data/lib/yard/parser/ruby/legacy/token_list.rb +0 -0
  169. data/lib/yard/parser/ruby/ruby_parser.rb +0 -0
  170. data/lib/yard/parser/source_parser.rb +0 -0
  171. data/lib/yard/rake/yardoc_task.rb +0 -0
  172. data/lib/yard/registry.rb +22 -15
  173. data/lib/yard/registry_resolver.rb +2 -1
  174. data/lib/yard/registry_store.rb +0 -0
  175. data/lib/yard/rubygems/backports.rb +0 -0
  176. data/lib/yard/rubygems/backports/LICENSE.txt +0 -0
  177. data/lib/yard/rubygems/backports/MIT.txt +0 -0
  178. data/lib/yard/rubygems/backports/gem.rb +0 -0
  179. data/lib/yard/rubygems/backports/source_index.rb +0 -0
  180. data/lib/yard/rubygems/doc_manager.rb +0 -0
  181. data/lib/yard/rubygems/hook.rb +12 -3
  182. data/lib/yard/rubygems/specification.rb +0 -0
  183. data/lib/yard/serializers/base.rb +0 -0
  184. data/lib/yard/serializers/file_system_serializer.rb +0 -0
  185. data/lib/yard/serializers/process_serializer.rb +0 -0
  186. data/lib/yard/serializers/stdout_serializer.rb +0 -0
  187. data/lib/yard/serializers/yardoc_serializer.rb +0 -0
  188. data/lib/yard/server.rb +0 -0
  189. data/lib/yard/server/adapter.rb +0 -0
  190. data/lib/yard/server/commands/base.rb +0 -0
  191. data/lib/yard/server/commands/display_file_command.rb +0 -0
  192. data/lib/yard/server/commands/display_object_command.rb +0 -0
  193. data/lib/yard/server/commands/frames_command.rb +0 -0
  194. data/lib/yard/server/commands/library_command.rb +0 -0
  195. data/lib/yard/server/commands/library_index_command.rb +0 -0
  196. data/lib/yard/server/commands/list_command.rb +0 -0
  197. data/lib/yard/server/commands/root_request_command.rb +0 -0
  198. data/lib/yard/server/commands/search_command.rb +0 -0
  199. data/lib/yard/server/commands/static_file_command.rb +0 -0
  200. data/lib/yard/server/doc_server_helper.rb +0 -0
  201. data/lib/yard/server/doc_server_serializer.rb +0 -0
  202. data/lib/yard/server/library_version.rb +0 -0
  203. data/lib/yard/server/rack_adapter.rb +0 -0
  204. data/lib/yard/server/router.rb +0 -0
  205. data/lib/yard/server/static_caching.rb +0 -0
  206. data/lib/yard/server/templates/default/fulldoc/html/css/custom.css +0 -0
  207. data/lib/yard/server/templates/default/fulldoc/html/images/processing.gif +0 -0
  208. data/lib/yard/server/templates/default/fulldoc/html/js/autocomplete.js +0 -0
  209. data/lib/yard/server/templates/default/layout/html/breadcrumb.erb +0 -0
  210. data/lib/yard/server/templates/default/layout/html/script_setup.erb +0 -0
  211. data/lib/yard/server/templates/default/layout/html/setup.rb +0 -0
  212. data/lib/yard/server/templates/default/method_details/html/permalink.erb +0 -0
  213. data/lib/yard/server/templates/default/method_details/html/setup.rb +0 -0
  214. data/lib/yard/server/templates/doc_server/library_list/html/contents.erb +0 -0
  215. data/lib/yard/server/templates/doc_server/library_list/html/headers.erb +0 -0
  216. data/lib/yard/server/templates/doc_server/library_list/html/library_list.erb +0 -0
  217. data/lib/yard/server/templates/doc_server/library_list/html/setup.rb +0 -0
  218. data/lib/yard/server/templates/doc_server/library_list/html/title.erb +0 -0
  219. data/lib/yard/server/templates/doc_server/processing/html/processing.erb +0 -0
  220. data/lib/yard/server/templates/doc_server/processing/html/setup.rb +0 -0
  221. data/lib/yard/server/templates/doc_server/search/html/search.erb +0 -0
  222. data/lib/yard/server/templates/doc_server/search/html/setup.rb +0 -0
  223. data/lib/yard/server/webrick_adapter.rb +0 -0
  224. data/lib/yard/tags/default_factory.rb +0 -0
  225. data/lib/yard/tags/default_tag.rb +0 -0
  226. data/lib/yard/tags/directives.rb +0 -0
  227. data/lib/yard/tags/library.rb +0 -0
  228. data/lib/yard/tags/option_tag.rb +0 -0
  229. data/lib/yard/tags/overload_tag.rb +0 -0
  230. data/lib/yard/tags/ref_tag.rb +0 -0
  231. data/lib/yard/tags/ref_tag_list.rb +0 -0
  232. data/lib/yard/tags/tag.rb +0 -0
  233. data/lib/yard/tags/tag_format_error.rb +0 -0
  234. data/lib/yard/templates/engine.rb +0 -0
  235. data/lib/yard/templates/erb_cache.rb +0 -0
  236. data/lib/yard/templates/helpers/base_helper.rb +0 -0
  237. data/lib/yard/templates/helpers/filter_helper.rb +0 -0
  238. data/lib/yard/templates/helpers/html_helper.rb +0 -0
  239. data/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +0 -0
  240. data/lib/yard/templates/helpers/markup/rdoc_markdown.rb +0 -0
  241. data/lib/yard/templates/helpers/markup/rdoc_markup.rb +0 -0
  242. data/lib/yard/templates/helpers/markup_helper.rb +0 -0
  243. data/lib/yard/templates/helpers/method_helper.rb +0 -0
  244. data/lib/yard/templates/helpers/module_helper.rb +0 -0
  245. data/lib/yard/templates/helpers/text_helper.rb +0 -0
  246. data/lib/yard/templates/helpers/uml_helper.rb +0 -0
  247. data/lib/yard/templates/section.rb +0 -0
  248. data/lib/yard/templates/template.rb +0 -0
  249. data/lib/yard/templates/template_options.rb +0 -0
  250. data/lib/yard/verifier.rb +0 -0
  251. data/lib/yard/version.rb +1 -1
  252. data/spec/cli/command_parser_spec.rb +0 -0
  253. data/spec/cli/command_spec.rb +0 -0
  254. data/spec/cli/config_spec.rb +57 -0
  255. data/spec/cli/diff_spec.rb +0 -0
  256. data/spec/cli/display_spec.rb +0 -0
  257. data/spec/cli/gems_spec.rb +0 -0
  258. data/spec/cli/graph_spec.rb +0 -0
  259. data/spec/cli/help_spec.rb +0 -0
  260. data/spec/cli/i18n_spec.rb +0 -0
  261. data/spec/cli/list_spec.rb +0 -0
  262. data/spec/cli/markup_types_spec.rb +0 -0
  263. data/spec/cli/server_spec.rb +0 -0
  264. data/spec/cli/stats_spec.rb +0 -0
  265. data/spec/cli/yardoc_spec.rb +8 -0
  266. data/spec/cli/yri_spec.rb +0 -0
  267. data/spec/code_objects/base_spec.rb +0 -0
  268. data/spec/code_objects/class_object_spec.rb +0 -0
  269. data/spec/code_objects/code_object_list_spec.rb +0 -0
  270. data/spec/code_objects/constants_spec.rb +0 -0
  271. data/spec/code_objects/extra_file_object_spec.rb +0 -0
  272. data/spec/code_objects/macro_object_spec.rb +0 -0
  273. data/spec/code_objects/method_object_spec.rb +0 -0
  274. data/spec/code_objects/module_object_spec.rb +0 -0
  275. data/spec/code_objects/namespace_object_spec.rb +0 -0
  276. data/spec/code_objects/proxy_spec.rb +0 -0
  277. data/spec/code_objects/spec_helper.rb +0 -0
  278. data/spec/config_spec.rb +0 -0
  279. data/spec/core_ext/array_spec.rb +0 -0
  280. data/spec/core_ext/file_spec.rb +0 -0
  281. data/spec/core_ext/hash_spec.rb +0 -0
  282. data/spec/core_ext/insertion_spec.rb +0 -0
  283. data/spec/core_ext/module_spec.rb +0 -0
  284. data/spec/core_ext/string_spec.rb +0 -0
  285. data/spec/core_ext/symbol_hash_spec.rb +0 -0
  286. data/spec/docstring_parser_spec.rb +0 -0
  287. data/spec/docstring_spec.rb +0 -0
  288. data/spec/handlers/alias_handler_spec.rb +0 -0
  289. data/spec/handlers/attribute_handler_spec.rb +0 -0
  290. data/spec/handlers/base_spec.rb +0 -0
  291. data/spec/handlers/c/alias_handler_spec.rb +0 -0
  292. data/spec/handlers/c/attribute_handler_spec.rb +0 -0
  293. data/spec/handlers/c/class_handler_spec.rb +0 -0
  294. data/spec/handlers/c/constant_handler_spec.rb +0 -0
  295. data/spec/handlers/c/init_handler_spec.rb +0 -0
  296. data/spec/handlers/c/method_handler_spec.rb +0 -0
  297. data/spec/handlers/c/mixin_handler_spec.rb +0 -0
  298. data/spec/handlers/c/module_handler_spec.rb +0 -0
  299. data/spec/handlers/c/override_comment_handler_spec.rb +0 -0
  300. data/spec/handlers/c/path_handler_spec.rb +0 -0
  301. data/spec/handlers/c/spec_helper.rb +0 -0
  302. data/spec/handlers/c/struct_handler_spec.rb +0 -0
  303. data/spec/handlers/class_condition_handler_spec.rb +0 -0
  304. data/spec/handlers/class_handler_spec.rb +0 -0
  305. data/spec/handlers/class_method_handler_shared_examples.rb +0 -0
  306. data/spec/handlers/class_variable_handler_spec.rb +0 -0
  307. data/spec/handlers/constant_handler_spec.rb +0 -0
  308. data/spec/handlers/decorator_handler_methods_spec.rb +0 -0
  309. data/spec/handlers/dsl_handler_spec.rb +0 -0
  310. data/spec/handlers/examples/alias_handler_001.rb.txt +0 -0
  311. data/spec/handlers/examples/attribute_handler_001.rb.txt +0 -0
  312. data/spec/handlers/examples/class_condition_handler_001.rb.txt +0 -0
  313. data/spec/handlers/examples/class_handler_001.rb.txt +0 -0
  314. data/spec/handlers/examples/class_variable_handler_001.rb.txt +0 -0
  315. data/spec/handlers/examples/constant_handler_001.rb.txt +0 -0
  316. data/spec/handlers/examples/dsl_handler_001.rb.txt +0 -0
  317. data/spec/handlers/examples/exception_handler_001.rb.txt +0 -0
  318. data/spec/handlers/examples/extend_handler_001.rb.txt +0 -0
  319. data/spec/handlers/examples/method_condition_handler_001.rb.txt +0 -0
  320. data/spec/handlers/examples/method_handler_001.rb.txt +0 -0
  321. data/spec/handlers/examples/mixin_handler_001.rb.txt +0 -0
  322. data/spec/handlers/examples/module_handler_001.rb.txt +0 -0
  323. data/spec/handlers/examples/private_constant_handler_001.rb.txt +0 -0
  324. data/spec/handlers/examples/process_handler_001.rb.txt +0 -0
  325. data/spec/handlers/examples/visibility_handler_001.rb.txt +0 -0
  326. data/spec/handlers/examples/yield_handler_001.rb.txt +0 -0
  327. data/spec/handlers/exception_handler_spec.rb +0 -0
  328. data/spec/handlers/extend_handler_spec.rb +0 -0
  329. data/spec/handlers/legacy_base_spec.rb +0 -0
  330. data/spec/handlers/method_condition_handler_spec.rb +0 -0
  331. data/spec/handlers/method_handler_spec.rb +0 -0
  332. data/spec/handlers/mixin_handler_spec.rb +0 -0
  333. data/spec/handlers/module_function_handler_spec.rb +0 -0
  334. data/spec/handlers/module_handler_spec.rb +0 -0
  335. data/spec/handlers/private_class_method_handler_spec.rb +0 -0
  336. data/spec/handlers/private_constant_handler_spec.rb +0 -0
  337. data/spec/handlers/processor_spec.rb +0 -0
  338. data/spec/handlers/public_class_method_handler_spec.rb +0 -0
  339. data/spec/handlers/ruby/base_spec.rb +0 -0
  340. data/spec/handlers/ruby/legacy/base_spec.rb +0 -0
  341. data/spec/handlers/spec_helper.rb +0 -0
  342. data/spec/handlers/visibility_handler_spec.rb +0 -0
  343. data/spec/handlers/yield_handler_spec.rb +0 -0
  344. data/spec/i18n/locale_spec.rb +0 -0
  345. data/spec/i18n/message_spec.rb +0 -0
  346. data/spec/i18n/messages_spec.rb +0 -0
  347. data/spec/i18n/pot_generator_spec.rb +0 -0
  348. data/spec/i18n/text_spec.rb +0 -0
  349. data/spec/logging_spec.rb +0 -0
  350. data/spec/options_spec.rb +0 -0
  351. data/spec/parser/base_spec.rb +0 -0
  352. data/spec/parser/c_parser_spec.rb +0 -0
  353. data/spec/parser/examples/array.c.txt +0 -0
  354. data/spec/parser/examples/example1.rb.txt +0 -0
  355. data/spec/parser/examples/extrafile.c.txt +0 -0
  356. data/spec/parser/examples/multifile.c.txt +0 -0
  357. data/spec/parser/examples/override.c.txt +0 -0
  358. data/spec/parser/examples/parse_in_order_001.rb.txt +0 -0
  359. data/spec/parser/examples/parse_in_order_002.rb.txt +0 -0
  360. data/spec/parser/examples/tag_handler_001.rb.txt +0 -0
  361. data/spec/parser/ruby/ast_node_spec.rb +0 -0
  362. data/spec/parser/ruby/legacy/statement_list_spec.rb +0 -0
  363. data/spec/parser/ruby/legacy/token_list_spec.rb +0 -0
  364. data/spec/parser/ruby/ruby_parser_spec.rb +0 -0
  365. data/spec/parser/source_parser_spec.rb +0 -0
  366. data/spec/parser/tag_parsing_spec.rb +0 -0
  367. data/spec/rake/yardoc_task_spec.rb +0 -0
  368. data/spec/registry_spec.rb +5 -0
  369. data/spec/registry_store_spec.rb +0 -0
  370. data/spec/rubygems/doc_manager_spec.rb +0 -0
  371. data/spec/serializers/data/serialized_yardoc/checksums +0 -0
  372. data/spec/serializers/data/serialized_yardoc/objects/Foo.dat +0 -0
  373. data/spec/serializers/data/serialized_yardoc/objects/Foo/bar_i.dat +0 -0
  374. data/spec/serializers/data/serialized_yardoc/objects/Foo/baz_i.dat +0 -0
  375. data/spec/serializers/data/serialized_yardoc/objects/root.dat +0 -0
  376. data/spec/serializers/data/serialized_yardoc/proxy_types +0 -0
  377. data/spec/serializers/file_system_serializer_spec.rb +0 -0
  378. data/spec/serializers/spec_helper.rb +0 -0
  379. data/spec/serializers/yardoc_serializer_spec.rb +0 -0
  380. data/spec/server/adapter_spec.rb +0 -0
  381. data/spec/server/commands/base_spec.rb +0 -0
  382. data/spec/server/commands/library_command_spec.rb +0 -0
  383. data/spec/server/doc_server_helper_spec.rb +0 -0
  384. data/spec/server/doc_server_serializer_spec.rb +0 -0
  385. data/spec/server/rack_adapter_spec.rb +0 -0
  386. data/spec/server/router_spec.rb +0 -0
  387. data/spec/server/spec_helper.rb +0 -0
  388. data/spec/server/static_caching_spec.rb +0 -0
  389. data/spec/server/webrick_servlet_spec.rb +0 -0
  390. data/spec/server_spec.rb +0 -0
  391. data/spec/spec_helper.rb +0 -0
  392. data/spec/tags/default_factory_spec.rb +0 -0
  393. data/spec/tags/default_tag_spec.rb +0 -0
  394. data/spec/tags/directives_spec.rb +0 -0
  395. data/spec/tags/library_spec.rb +0 -0
  396. data/spec/tags/overload_tag_spec.rb +0 -0
  397. data/spec/tags/ref_tag_list_spec.rb +0 -0
  398. data/spec/templates/class_spec.rb +0 -0
  399. data/spec/templates/constant_spec.rb +0 -0
  400. data/spec/templates/engine_spec.rb +0 -0
  401. data/spec/templates/examples/class001.html +0 -0
  402. data/spec/templates/examples/class001.txt +0 -0
  403. data/spec/templates/examples/class002.html +0 -0
  404. data/spec/templates/examples/constant001.txt +0 -0
  405. data/spec/templates/examples/constant002.txt +0 -0
  406. data/spec/templates/examples/constant003.txt +0 -0
  407. data/spec/templates/examples/method001.html +0 -0
  408. data/spec/templates/examples/method001.txt +0 -0
  409. data/spec/templates/examples/method002.html +0 -0
  410. data/spec/templates/examples/method002.txt +0 -0
  411. data/spec/templates/examples/method003.html +0 -0
  412. data/spec/templates/examples/method003.txt +0 -0
  413. data/spec/templates/examples/method004.html +0 -0
  414. data/spec/templates/examples/method004.txt +0 -0
  415. data/spec/templates/examples/method005.html +0 -0
  416. data/spec/templates/examples/method005.txt +0 -0
  417. data/spec/templates/examples/module001.dot +0 -0
  418. data/spec/templates/examples/module001.html +0 -0
  419. data/spec/templates/examples/module001.txt +0 -0
  420. data/spec/templates/examples/module002.html +0 -0
  421. data/spec/templates/examples/module003.html +0 -0
  422. data/spec/templates/examples/module004.html +0 -0
  423. data/spec/templates/examples/tag001.txt +0 -0
  424. data/spec/templates/helpers/base_helper_spec.rb +0 -0
  425. data/spec/templates/helpers/html_helper_spec.rb +0 -0
  426. data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb +0 -0
  427. data/spec/templates/helpers/markup/rdoc_markup_spec.rb +0 -0
  428. data/spec/templates/helpers/markup_helper_spec.rb +0 -0
  429. data/spec/templates/helpers/method_helper_spec.rb +0 -0
  430. data/spec/templates/helpers/module_helper_spec.rb +0 -0
  431. data/spec/templates/helpers/shared_signature_examples.rb +0 -0
  432. data/spec/templates/helpers/text_helper_spec.rb +0 -0
  433. data/spec/templates/method_spec.rb +0 -0
  434. data/spec/templates/module_spec.rb +0 -0
  435. data/spec/templates/onefile_spec.rb +0 -0
  436. data/spec/templates/section_spec.rb +0 -0
  437. data/spec/templates/spec_helper.rb +0 -0
  438. data/spec/templates/tag_spec.rb +0 -0
  439. data/spec/templates/template_spec.rb +0 -0
  440. data/spec/verifier_spec.rb +0 -0
  441. data/templates/default/class/dot/setup.rb +0 -0
  442. data/templates/default/class/dot/superklass.erb +0 -0
  443. data/templates/default/class/html/constructor_details.erb +0 -0
  444. data/templates/default/class/html/setup.rb +0 -0
  445. data/templates/default/class/html/subclasses.erb +0 -0
  446. data/templates/default/class/setup.rb +0 -0
  447. data/templates/default/class/text/setup.rb +0 -0
  448. data/templates/default/class/text/subclasses.erb +0 -0
  449. data/templates/default/constant/text/header.erb +0 -0
  450. data/templates/default/constant/text/setup.rb +0 -0
  451. data/templates/default/docstring/html/abstract.erb +0 -0
  452. data/templates/default/docstring/html/deprecated.erb +0 -0
  453. data/templates/default/docstring/html/index.erb +0 -0
  454. data/templates/default/docstring/html/note.erb +0 -0
  455. data/templates/default/docstring/html/private.erb +0 -0
  456. data/templates/default/docstring/html/returns_void.erb +0 -0
  457. data/templates/default/docstring/html/text.erb +0 -0
  458. data/templates/default/docstring/html/todo.erb +0 -0
  459. data/templates/default/docstring/setup.rb +0 -0
  460. data/templates/default/docstring/text/abstract.erb +0 -0
  461. data/templates/default/docstring/text/deprecated.erb +0 -0
  462. data/templates/default/docstring/text/index.erb +0 -0
  463. data/templates/default/docstring/text/note.erb +0 -0
  464. data/templates/default/docstring/text/private.erb +0 -0
  465. data/templates/default/docstring/text/returns_void.erb +0 -0
  466. data/templates/default/docstring/text/text.erb +0 -0
  467. data/templates/default/docstring/text/todo.erb +0 -0
  468. data/templates/default/fulldoc/html/css/common.css +0 -0
  469. data/templates/default/fulldoc/html/css/full_list.css +0 -0
  470. data/templates/default/fulldoc/html/css/style.css +1 -1
  471. data/templates/default/fulldoc/html/frames.erb +0 -0
  472. data/templates/default/fulldoc/html/full_list.erb +0 -0
  473. data/templates/default/fulldoc/html/full_list_class.erb +0 -0
  474. data/templates/default/fulldoc/html/full_list_file.erb +0 -0
  475. data/templates/default/fulldoc/html/full_list_method.erb +0 -0
  476. data/templates/default/fulldoc/html/js/app.js +0 -0
  477. data/templates/default/fulldoc/html/js/full_list.js +0 -0
  478. data/templates/default/fulldoc/html/js/jquery.js +0 -0
  479. data/templates/default/fulldoc/html/setup.rb +0 -0
  480. data/templates/default/layout/dot/header.erb +0 -0
  481. data/templates/default/layout/dot/setup.rb +0 -0
  482. data/templates/default/layout/html/breadcrumb.erb +0 -0
  483. data/templates/default/layout/html/files.erb +0 -0
  484. data/templates/default/layout/html/footer.erb +0 -0
  485. data/templates/default/layout/html/headers.erb +0 -0
  486. data/templates/default/layout/html/index.erb +0 -0
  487. data/templates/default/layout/html/layout.erb +0 -0
  488. data/templates/default/layout/html/listing.erb +0 -0
  489. data/templates/default/layout/html/objects.erb +0 -0
  490. data/templates/default/layout/html/script_setup.erb +0 -0
  491. data/templates/default/layout/html/search.erb +0 -0
  492. data/templates/default/layout/html/setup.rb +0 -0
  493. data/templates/default/method/html/header.erb +0 -0
  494. data/templates/default/method/setup.rb +0 -0
  495. data/templates/default/method/text/header.erb +0 -0
  496. data/templates/default/method_details/html/header.erb +0 -0
  497. data/templates/default/method_details/html/method_signature.erb +0 -0
  498. data/templates/default/method_details/html/source.erb +0 -0
  499. data/templates/default/method_details/setup.rb +0 -0
  500. data/templates/default/method_details/text/header.erb +0 -0
  501. data/templates/default/method_details/text/method_signature.erb +0 -0
  502. data/templates/default/method_details/text/setup.rb +0 -0
  503. data/templates/default/module/dot/child.erb +0 -0
  504. data/templates/default/module/dot/dependencies.erb +0 -0
  505. data/templates/default/module/dot/header.erb +0 -0
  506. data/templates/default/module/dot/info.erb +0 -0
  507. data/templates/default/module/dot/setup.rb +0 -0
  508. data/templates/default/module/html/attribute_details.erb +0 -0
  509. data/templates/default/module/html/attribute_summary.erb +0 -0
  510. data/templates/default/module/html/box_info.erb +0 -0
  511. data/templates/default/module/html/children.erb +0 -0
  512. data/templates/default/module/html/constant_summary.erb +0 -0
  513. data/templates/default/module/html/defines.erb +0 -0
  514. data/templates/default/module/html/header.erb +0 -0
  515. data/templates/default/module/html/inherited_attributes.erb +0 -0
  516. data/templates/default/module/html/inherited_constants.erb +0 -0
  517. data/templates/default/module/html/inherited_methods.erb +0 -0
  518. data/templates/default/module/html/item_summary.erb +0 -0
  519. data/templates/default/module/html/method_details_list.erb +0 -0
  520. data/templates/default/module/html/method_summary.erb +0 -0
  521. data/templates/default/module/html/methodmissing.erb +0 -0
  522. data/templates/default/module/html/pre_docstring.erb +0 -0
  523. data/templates/default/module/setup.rb +0 -0
  524. data/templates/default/module/text/children.erb +0 -0
  525. data/templates/default/module/text/class_meths_list.erb +0 -0
  526. data/templates/default/module/text/extends.erb +0 -0
  527. data/templates/default/module/text/header.erb +0 -0
  528. data/templates/default/module/text/includes.erb +0 -0
  529. data/templates/default/module/text/instance_meths_list.erb +0 -0
  530. data/templates/default/module/text/setup.rb +0 -0
  531. data/templates/default/onefile/html/files.erb +0 -0
  532. data/templates/default/onefile/html/headers.erb +0 -0
  533. data/templates/default/onefile/html/layout.erb +0 -0
  534. data/templates/default/onefile/html/readme.erb +0 -0
  535. data/templates/default/onefile/html/setup.rb +0 -0
  536. data/templates/default/root/dot/child.erb +0 -0
  537. data/templates/default/root/dot/setup.rb +0 -0
  538. data/templates/default/root/html/setup.rb +0 -0
  539. data/templates/default/tags/html/example.erb +0 -0
  540. data/templates/default/tags/html/index.erb +0 -0
  541. data/templates/default/tags/html/option.erb +0 -0
  542. data/templates/default/tags/html/overload.erb +0 -0
  543. data/templates/default/tags/html/see.erb +0 -0
  544. data/templates/default/tags/html/tag.erb +0 -0
  545. data/templates/default/tags/setup.rb +0 -0
  546. data/templates/default/tags/text/example.erb +0 -0
  547. data/templates/default/tags/text/index.erb +0 -0
  548. data/templates/default/tags/text/option.erb +0 -0
  549. data/templates/default/tags/text/overload.erb +0 -0
  550. data/templates/default/tags/text/see.erb +0 -0
  551. data/templates/default/tags/text/tag.erb +0 -0
  552. data/templates/guide/class/html/setup.rb +0 -0
  553. data/templates/guide/docstring/html/setup.rb +0 -0
  554. data/templates/guide/fulldoc/html/css/style.css +0 -0
  555. data/templates/guide/fulldoc/html/js/app.js +0 -0
  556. data/templates/guide/fulldoc/html/setup.rb +0 -0
  557. data/templates/guide/layout/html/layout.erb +0 -0
  558. data/templates/guide/layout/html/setup.rb +0 -0
  559. data/templates/guide/method/html/header.erb +0 -0
  560. data/templates/guide/method/html/setup.rb +0 -0
  561. data/templates/guide/module/html/header.erb +0 -0
  562. data/templates/guide/module/html/method_list.erb +0 -0
  563. data/templates/guide/module/html/setup.rb +0 -0
  564. data/templates/guide/onefile/html/files.erb +0 -0
  565. data/templates/guide/onefile/html/setup.rb +0 -0
  566. data/templates/guide/onefile/html/toc.erb +0 -0
  567. data/templates/guide/tags/html/setup.rb +0 -0
  568. data/yard.gemspec +19 -1
  569. metadata +21 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: ec4f1f12885dba0ad0385e0a1f7bd460275291cd
4
- data.tar.gz: 2281f497dc0fa185ccc79d8eb5a374bdae40bee2
3
+ metadata.gz: 874e67d17c94b6c8537e39ec998abbe94f5c5ffc
4
+ data.tar.gz: 245011fea4112256d31eab954d5d8a6a54f4f156
5
5
  SHA512:
6
- metadata.gz: 81280e2f91643f20e5fda61e118b97b5cb8868ca9eca7b15ff9572d9a65552df404961f7ad2af281e84937a3a6e67367f72d2746eb2add634e06f62cef126676
7
- data.tar.gz: 4ab74c0f9d79622761098afcc0dd349308500d5593f9ea75414f211207b6798c3475aed0d8936eb4e317df76d6981f5b8499bf1e90ae41d180dc8405335aa829
6
+ metadata.gz: f25ccfa7b086f9cb61830a0d66955b077cefe76cd9ff9b6e0a9dc93d81d573343ba094c9e3eac9204da94f68d26c80991e6a973ec47caa7403482da8c811a0b7
7
+ data.tar.gz: ced2f2fbe04e8af5afe4878ccd1f40f39928271d44c2c4d5b9878b4b57e1cc2665635f89e4b74ed484a5ff78b8a9d1eea0b5d50a9b0ecc29cbb0f6b1d036d01d
data/.yardopts CHANGED
File without changes
@@ -1,3 +1,14 @@
1
+ # 0.9.2 - July 19th, 2016
2
+
3
+ - Added `yard config --gem-install-[yri|yard]` commands which auto-configure
4
+ your `~/.gemrc` file to run yri/yard instead of ri/rdoc on a `gem install`.
5
+ - Added support for gemspec metadata key `"yard.run"`, which can be either
6
+ `"yard"` or `"yri"` to run the respective commands on a `gem install`.
7
+ - Added `yard doc --no-progress` to hide the progress bar.
8
+ - Fix resolution error for compound proxy namespaces.
9
+ - YRI will now search across all gem versions (latest first) for the .yardoc
10
+ database.
11
+
1
12
  # 0.9.1 - July 18th, 2016
2
13
 
3
14
  - Added "Attributes" section to `yard stats`.
data/LEGAL CHANGED
File without changes
data/LICENSE CHANGED
File without changes
data/README.md CHANGED
File without changes
data/Rakefile CHANGED
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
data/bin/yard CHANGED
File without changes
data/bin/yardoc CHANGED
File without changes
data/bin/yri CHANGED
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
@@ -18,6 +18,10 @@ module YARD
18
18
  # @return [Boolean] whether to append values to existing key
19
19
  attr_accessor :append
20
20
 
21
+ # @return [String, nil] command to use when configuring ~/.gemrc file.
22
+ # If the string is nil, configuration should not occur.
23
+ attr_accessor :gem_install_cmd
24
+
21
25
  def initialize
22
26
  super
23
27
  self.key = nil
@@ -25,6 +29,7 @@ module YARD
25
29
  self.reset = false
26
30
  self.append = false
27
31
  self.as_list = false
32
+ self.gem_install_cmd = nil
28
33
  end
29
34
 
30
35
  def description
@@ -33,7 +38,9 @@ module YARD
33
38
 
34
39
  def run(*args)
35
40
  optparse(*args)
36
- if key
41
+ if gem_install_cmd
42
+ configure_gemrc
43
+ elsif key
37
44
  if reset || values.size > 0
38
45
  modify_item
39
46
  else
@@ -46,6 +53,27 @@ module YARD
46
53
 
47
54
  private
48
55
 
56
+ def configure_gemrc
57
+ return unless gem_install_cmd
58
+
59
+ require 'rubygems'
60
+
61
+ ['install', :install, 'gem', :gem].find do |cmd|
62
+ conf = Gem.configuration[cmd] || ""
63
+ next if conf.empty? && cmd != :gem
64
+
65
+ conf = conf.split(/\s+/)
66
+ conf.delete_if {|c| c =~ /^--(no-)?document\b/ } # scrub doc args
67
+ conf |= ["--document=#{gem_install_cmd}"]
68
+ conf = conf.join(' ')
69
+
70
+ Gem.configuration[cmd] = conf
71
+ Gem.configuration.write
72
+ log.puts "Updated #{Gem.configuration.path || '~/.gemrc'}: '#{cmd}: #{conf}'"
73
+ true
74
+ end
75
+ end
76
+
49
77
  def modify_item
50
78
  if reset
51
79
  log.debug "Resetting #{key}"
@@ -104,6 +132,28 @@ module YARD
104
132
  opts.separator ""
105
133
  opts.separator "Note that `true` and `false` are reserved words."
106
134
  opts.separator ""
135
+ opts.separator "---------------------------------------------------------"
136
+ opts.separator ""
137
+ opts.separator "Configuring RubyGems support:"
138
+ opts.separator ""
139
+ opts.separator "YARD can automatically generate the YRI index or HTML"
140
+ opts.separator "documentation in a `gem install` by adding the following"
141
+ opts.separator "to your ~/.gemrc file:"
142
+ opts.separator ""
143
+ opts.separator " gem: \"--document=yri\""
144
+ opts.separator ""
145
+ opts.separator "Note: you can add 'yard' to also generate HTML docs."
146
+ opts.separator " You can also add 'ri' to continue generating RDoc."
147
+ opts.separator ""
148
+ opts.separator "You can also run the following command to configure this"
149
+ opts.separator "behavior automatically:"
150
+ opts.separator ""
151
+ opts.separator " $ yard config --gem-install-yri"
152
+ opts.separator ""
153
+ opts.separator "Add --gem-install-yard to also generate HTML."
154
+ opts.separator ""
155
+ opts.separator "---------------------------------------------------------"
156
+ opts.separator ""
107
157
  opts.separator "General options:"
108
158
 
109
159
  opts.on('-l', '--list', 'List current configuration') do
@@ -123,6 +173,17 @@ module YARD
123
173
  self.as_list = true
124
174
  end
125
175
 
176
+ opts.separator ""
177
+ opts.separator "Add RubyGems install hook:"
178
+
179
+ opts.on('--gem-install-yri', 'Configures ~/.gemrc to run yri on a gem install') do
180
+ self.gem_install_cmd = 'yri' if gem_install_cmd != 'yard'
181
+ end
182
+
183
+ opts.on('--gem-install-yard', 'Configures ~/.gemrc to run yard on a gem install') do
184
+ self.gem_install_cmd = 'yard'
185
+ end
186
+
126
187
  common_options(opts)
127
188
  parse_options(opts, args)
128
189
  args = [] if list
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
@@ -700,6 +700,10 @@ module YARD
700
700
  self.statistics = false
701
701
  end
702
702
 
703
+ opts.on('--no-progress', 'Don\'t show progress bar') do
704
+ log.show_progress = false
705
+ end
706
+
703
707
  opts.on('--locale LOCALE',
704
708
  'The locale for generated documentation.',
705
709
  ' (defaults to en)') do |locale|
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
@@ -191,7 +191,7 @@ module YARD
191
191
  options[:autoload_plugins].each {|name| load_plugin(name) }
192
192
  end
193
193
 
194
- # Load plugins from {#arguments}
194
+ # Load plugins from {arguments}
195
195
  def self.load_commandline_plugins
196
196
  with_yardopts do
197
197
  arguments.each_with_index do |arg, i|
@@ -201,7 +201,7 @@ module YARD
201
201
  end
202
202
  end
203
203
 
204
- # Check for command-line safe_mode switch in {#arguments}
204
+ # Check for command-line safe_mode switch in {arguments}
205
205
  def self.load_commandline_safemode
206
206
  with_yardopts do
207
207
  arguments.each_with_index do |arg, i|
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
@@ -268,7 +268,7 @@ module YARD
268
268
 
269
269
  # @!group Parser Callback Methods
270
270
 
271
- # Calls the {Directive#after_parse} callback on all the
271
+ # Calls the {Tags::Directive#after_parse} callback on all the
272
272
  # created directives.
273
273
  def call_directives_after_parse
274
274
  directives.each do |dir|
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes