yard 0.7.5 → 0.8.0

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 (339) hide show
  1. data/.yardopts +10 -2
  2. data/ChangeLog +1263 -38
  3. data/LEGAL +5 -5
  4. data/LICENSE +1 -1
  5. data/README.md +91 -82
  6. data/Rakefile +6 -6
  7. data/benchmarks/builtins_vs_eval.rb +1 -1
  8. data/benchmarks/erb_vs_erubis.rb +4 -4
  9. data/benchmarks/generation.rb +5 -5
  10. data/benchmarks/parsing.rb +2 -2
  11. data/benchmarks/registry_store_types.rb +48 -0
  12. data/bin/yard +9 -1
  13. data/bin/yardoc +9 -1
  14. data/bin/yri +10 -2
  15. data/docs/CodeObjects.md +10 -10
  16. data/docs/GettingStarted.md +85 -83
  17. data/docs/Handlers.md +21 -21
  18. data/docs/Overview.md +7 -7
  19. data/docs/Parser.md +30 -30
  20. data/docs/Tags.md +250 -554
  21. data/docs/TagsArch.md +123 -0
  22. data/docs/Templates.md +58 -80
  23. data/docs/WhatsNew.md +378 -133
  24. data/docs/templates/default/fulldoc/html/full_list_tag.erb +7 -0
  25. data/docs/templates/default/fulldoc/html/setup.rb +6 -0
  26. data/docs/templates/default/layout/html/setup.rb +8 -0
  27. data/docs/templates/default/layout/html/tag_list.erb +11 -0
  28. data/docs/templates/default/yard_tags/html/list.erb +18 -0
  29. data/docs/templates/default/yard_tags/html/setup.rb +27 -0
  30. data/docs/templates/plugin.rb +65 -0
  31. data/lib/yard.rb +1 -10
  32. data/lib/yard/autoload.rb +75 -27
  33. data/lib/yard/cli/command.rb +5 -2
  34. data/lib/yard/cli/command_parser.rb +3 -2
  35. data/lib/yard/cli/diff.rb +1 -1
  36. data/lib/yard/cli/i18n.rb +69 -0
  37. data/lib/yard/cli/list.rb +1 -1
  38. data/lib/yard/cli/server.rb +30 -7
  39. data/lib/yard/cli/stats.rb +5 -6
  40. data/lib/yard/cli/yardoc.rb +95 -45
  41. data/lib/yard/cli/yri.rb +24 -3
  42. data/lib/yard/code_objects/base.rb +35 -4
  43. data/lib/yard/code_objects/extra_file_object.rb +1 -1
  44. data/lib/yard/code_objects/macro_object.rb +56 -99
  45. data/lib/yard/code_objects/method_object.rb +44 -6
  46. data/lib/yard/config.rb +18 -8
  47. data/lib/yard/core_ext/symbol_hash.rb +1 -1
  48. data/lib/yard/docstring.rb +45 -85
  49. data/lib/yard/docstring_parser.rb +269 -0
  50. data/lib/yard/handlers/base.rb +129 -118
  51. data/lib/yard/handlers/c/alias_handler.rb +15 -0
  52. data/lib/yard/handlers/c/attribute_handler.rb +13 -0
  53. data/lib/yard/handlers/c/base.rb +110 -0
  54. data/lib/yard/handlers/c/class_handler.rb +26 -0
  55. data/lib/yard/handlers/c/constant_handler.rb +12 -0
  56. data/lib/yard/handlers/c/handler_methods.rb +165 -0
  57. data/lib/yard/handlers/c/init_handler.rb +16 -0
  58. data/lib/yard/handlers/c/method_handler.rb +35 -0
  59. data/lib/yard/handlers/c/mixin_handler.rb +13 -0
  60. data/lib/yard/handlers/c/module_handler.rb +16 -0
  61. data/lib/yard/handlers/c/override_comment_handler.rb +22 -0
  62. data/lib/yard/handlers/c/path_handler.rb +10 -0
  63. data/lib/yard/handlers/c/struct_handler.rb +12 -0
  64. data/lib/yard/handlers/c/symbol_handler.rb +7 -0
  65. data/lib/yard/handlers/processor.rb +41 -30
  66. data/lib/yard/handlers/ruby/alias_handler.rb +0 -2
  67. data/lib/yard/handlers/ruby/attribute_handler.rb +16 -17
  68. data/lib/yard/handlers/ruby/base.rb +10 -6
  69. data/lib/yard/handlers/ruby/comment_handler.rb +9 -0
  70. data/lib/yard/handlers/ruby/dsl_handler.rb +14 -0
  71. data/lib/yard/handlers/ruby/dsl_handler_methods.rb +71 -0
  72. data/lib/yard/handlers/ruby/legacy/alias_handler.rb +0 -3
  73. data/lib/yard/handlers/ruby/legacy/attribute_handler.rb +16 -17
  74. data/lib/yard/handlers/ruby/legacy/base.rb +28 -6
  75. data/lib/yard/handlers/ruby/legacy/comment_handler.rb +9 -0
  76. data/lib/yard/handlers/ruby/legacy/dsl_handler.rb +16 -0
  77. data/lib/yard/handlers/ruby/legacy/method_handler.rb +0 -2
  78. data/lib/yard/handlers/ruby/legacy/mixin_handler.rb +1 -1
  79. data/lib/yard/handlers/ruby/legacy/module_function_handler.rb +18 -0
  80. data/lib/yard/handlers/ruby/method_handler.rb +10 -15
  81. data/lib/yard/handlers/ruby/mixin_handler.rb +1 -1
  82. data/lib/yard/handlers/ruby/module_function_handler.rb +26 -0
  83. data/lib/yard/handlers/ruby/struct_handler_methods.rb +3 -2
  84. data/lib/yard/i18n/pot_generator.rb +281 -0
  85. data/lib/yard/i18n/text.rb +72 -0
  86. data/lib/yard/logging.rb +3 -7
  87. data/lib/yard/options.rb +216 -0
  88. data/lib/yard/parser/c/c_parser.rb +225 -0
  89. data/lib/yard/parser/c/comment_parser.rb +131 -0
  90. data/lib/yard/parser/c/statement.rb +63 -0
  91. data/lib/yard/parser/ruby/ast_node.rb +91 -1
  92. data/lib/yard/parser/ruby/legacy/ruby_parser.rb +1 -0
  93. data/lib/yard/parser/ruby/legacy/statement.rb +7 -2
  94. data/lib/yard/parser/ruby/legacy/statement_list.rb +13 -22
  95. data/lib/yard/parser/ruby/ruby_parser.rb +87 -26
  96. data/lib/yard/parser/source_parser.rb +89 -88
  97. data/lib/yard/rake/yardoc_task.rb +1 -1
  98. data/lib/yard/registry.rb +21 -10
  99. data/lib/yard/registry_store.rb +48 -0
  100. data/lib/yard/serializers/file_system_serializer.rb +18 -20
  101. data/lib/yard/serializers/yardoc_serializer.rb +1 -0
  102. data/lib/yard/server/adapter.rb +2 -2
  103. data/lib/yard/server/commands/base.rb +1 -1
  104. data/lib/yard/server/commands/display_object_command.rb +13 -6
  105. data/lib/yard/server/commands/frames_command.rb +4 -21
  106. data/lib/yard/server/commands/library_command.rb +57 -11
  107. data/lib/yard/server/commands/list_command.rb +10 -34
  108. data/lib/yard/server/commands/search_command.rb +8 -2
  109. data/lib/yard/server/doc_server_helper.rb +34 -0
  110. data/lib/yard/server/rack_adapter.rb +5 -1
  111. data/lib/yard/server/router.rb +4 -10
  112. data/lib/yard/server/static_caching.rb +2 -2
  113. data/lib/yard/server/templates/default/fulldoc/html/css/custom.css +2 -2
  114. data/lib/yard/server/templates/default/fulldoc/html/js/live.js +0 -15
  115. data/lib/yard/server/templates/default/layout/html/breadcrumb.erb +3 -3
  116. data/lib/yard/server/templates/default/layout/html/script_setup.erb +8 -0
  117. data/lib/yard/server/templates/doc_server/processing/html/processing.erb +1 -1
  118. data/lib/yard/server/templates/doc_server/search/html/setup.rb +1 -1
  119. data/lib/yard/tags/default_factory.rb +31 -4
  120. data/lib/yard/tags/directives.rb +593 -0
  121. data/lib/yard/tags/library.rb +437 -35
  122. data/lib/yard/templates/engine.rb +17 -12
  123. data/lib/yard/templates/helpers/base_helper.rb +8 -2
  124. data/lib/yard/templates/helpers/html_helper.rb +57 -14
  125. data/lib/yard/templates/helpers/markup/rdoc_markup.rb +1 -1
  126. data/lib/yard/templates/helpers/markup_helper.rb +9 -9
  127. data/lib/yard/templates/helpers/text_helper.rb +2 -2
  128. data/lib/yard/templates/template.rb +42 -13
  129. data/lib/yard/templates/template_options.rb +81 -0
  130. data/spec/cli/command_parser_spec.rb +4 -4
  131. data/spec/cli/command_spec.rb +3 -3
  132. data/spec/cli/config_spec.rb +13 -13
  133. data/spec/cli/diff_spec.rb +13 -10
  134. data/spec/cli/gems_spec.rb +12 -12
  135. data/spec/cli/help_spec.rb +2 -2
  136. data/spec/cli/i18n_spec.rb +111 -0
  137. data/spec/cli/server_spec.rb +66 -18
  138. data/spec/cli/stats_spec.rb +15 -15
  139. data/spec/cli/yardoc_spec.rb +124 -97
  140. data/spec/cli/yri_spec.rb +14 -12
  141. data/spec/code_objects/base_spec.rb +104 -46
  142. data/spec/code_objects/class_object_spec.rb +33 -33
  143. data/spec/code_objects/code_object_list_spec.rb +5 -5
  144. data/spec/code_objects/constants_spec.rb +4 -3
  145. data/spec/code_objects/extra_file_object_spec.rb +19 -19
  146. data/spec/code_objects/macro_object_spec.rb +31 -37
  147. data/spec/code_objects/method_object_spec.rb +46 -23
  148. data/spec/code_objects/module_object_spec.rb +16 -16
  149. data/spec/code_objects/namespace_object_spec.rb +6 -6
  150. data/spec/code_objects/proxy_spec.rb +19 -19
  151. data/spec/config_spec.rb +33 -24
  152. data/spec/core_ext/array_spec.rb +1 -1
  153. data/spec/core_ext/file_spec.rb +8 -8
  154. data/spec/core_ext/hash_spec.rb +1 -1
  155. data/spec/core_ext/insertion_spec.rb +3 -3
  156. data/spec/core_ext/module_spec.rb +1 -1
  157. data/spec/core_ext/string_spec.rb +6 -6
  158. data/spec/core_ext/symbol_hash_spec.rb +11 -11
  159. data/spec/docstring_parser_spec.rb +207 -0
  160. data/spec/docstring_spec.rb +33 -146
  161. data/spec/handlers/alias_handler_spec.rb +14 -14
  162. data/spec/handlers/attribute_handler_spec.rb +20 -20
  163. data/spec/handlers/base_spec.rb +16 -16
  164. data/spec/handlers/c/alias_handler_spec.rb +33 -0
  165. data/spec/handlers/c/attribute_handler_spec.rb +40 -0
  166. data/spec/handlers/c/class_handler_spec.rb +64 -0
  167. data/spec/handlers/c/constant_handler_spec.rb +68 -0
  168. data/spec/handlers/c/init_handler_spec.rb +36 -0
  169. data/spec/handlers/c/method_handler_spec.rb +228 -0
  170. data/spec/handlers/c/mixin_handler_spec.rb +27 -0
  171. data/spec/handlers/c/module_handler_spec.rb +38 -0
  172. data/spec/handlers/c/override_comment_handler_spec.rb +43 -0
  173. data/spec/handlers/c/path_handler_spec.rb +35 -0
  174. data/spec/handlers/c/spec_helper.rb +11 -0
  175. data/spec/handlers/c/struct_handler_spec.rb +15 -0
  176. data/spec/handlers/class_condition_handler_spec.rb +10 -10
  177. data/spec/handlers/class_handler_spec.rb +38 -38
  178. data/spec/handlers/class_variable_handler_spec.rb +1 -1
  179. data/spec/handlers/constant_handler_spec.rb +7 -7
  180. data/spec/handlers/{macro_handler_spec.rb → dsl_handler_spec.rb} +72 -53
  181. data/spec/handlers/examples/alias_handler_001.rb.txt +5 -5
  182. data/spec/handlers/examples/class_condition_handler_001.rb.txt +9 -9
  183. data/spec/handlers/examples/class_handler_001.rb.txt +1 -1
  184. data/spec/handlers/examples/dsl_handler_001.rb.txt +110 -0
  185. data/spec/handlers/examples/exception_handler_001.rb.txt +14 -14
  186. data/spec/handlers/examples/method_condition_handler_001.rb.txt +2 -2
  187. data/spec/handlers/examples/method_handler_001.rb.txt +16 -16
  188. data/spec/handlers/examples/mixin_handler_001.rb.txt +8 -4
  189. data/spec/handlers/examples/private_constant_handler_001.rb.txt +1 -1
  190. data/spec/handlers/examples/visibility_handler_001.rb.txt +3 -3
  191. data/spec/handlers/examples/yield_handler_001.rb.txt +13 -14
  192. data/spec/handlers/exception_handler_spec.rb +9 -9
  193. data/spec/handlers/extend_handler_spec.rb +2 -2
  194. data/spec/handlers/legacy_base_spec.rb +34 -34
  195. data/spec/handlers/method_condition_handler_spec.rb +2 -2
  196. data/spec/handlers/method_handler_spec.rb +33 -33
  197. data/spec/handlers/mixin_handler_spec.rb +13 -9
  198. data/spec/handlers/module_function_handler_spec.rb +82 -0
  199. data/spec/handlers/module_handler_spec.rb +6 -6
  200. data/spec/handlers/private_constant_handler_spec.rb +3 -3
  201. data/spec/handlers/processor_spec.rb +5 -5
  202. data/spec/handlers/ruby/base_spec.rb +10 -6
  203. data/spec/handlers/ruby/legacy/base_spec.rb +11 -7
  204. data/spec/handlers/spec_helper.rb +2 -3
  205. data/spec/handlers/visibility_handler_spec.rb +6 -6
  206. data/spec/handlers/yield_handler_spec.rb +8 -8
  207. data/spec/i18n/pot_generator_spec.rb +244 -0
  208. data/spec/i18n/text_spec.rb +69 -0
  209. data/spec/options_spec.rb +160 -0
  210. data/spec/parser/base_spec.rb +3 -3
  211. data/spec/parser/c_parser_spec.rb +31 -257
  212. data/spec/parser/examples/array.c.txt +187 -187
  213. data/spec/parser/examples/extrafile.c.txt +1 -1
  214. data/spec/parser/examples/override.c.txt +1 -1
  215. data/spec/parser/ruby/ast_node_spec.rb +1 -1
  216. data/spec/parser/ruby/legacy/statement_list_spec.rb +24 -24
  217. data/spec/parser/ruby/legacy/token_list_spec.rb +7 -7
  218. data/spec/parser/ruby/ruby_parser_spec.rb +56 -34
  219. data/spec/parser/source_parser_spec.rb +125 -65
  220. data/spec/parser/tag_parsing_spec.rb +4 -4
  221. data/spec/rake/yardoc_task_spec.rb +10 -8
  222. data/spec/registry_spec.rb +65 -36
  223. data/spec/registry_store_spec.rb +90 -40
  224. data/spec/serializers/file_system_serializer_spec.rb +12 -12
  225. data/spec/serializers/yardoc_serializer_spec.rb +2 -2
  226. data/spec/server/adapter_spec.rb +3 -3
  227. data/spec/server/commands/base_spec.rb +8 -8
  228. data/spec/server/commands/library_command_spec.rb +3 -3
  229. data/spec/server/commands/static_file_command_spec.rb +7 -7
  230. data/spec/server/doc_server_helper_spec.rb +1 -1
  231. data/spec/server/doc_server_serializer_spec.rb +6 -6
  232. data/spec/server/rack_adapter_spec.rb +3 -3
  233. data/spec/server/router_spec.rb +19 -19
  234. data/spec/server/static_caching_spec.rb +4 -4
  235. data/spec/spec_helper.rb +7 -7
  236. data/spec/tags/default_factory_spec.rb +24 -16
  237. data/spec/tags/directives_spec.rb +422 -0
  238. data/spec/tags/library_spec.rb +15 -4
  239. data/spec/tags/overload_tag_spec.rb +6 -6
  240. data/spec/tags/ref_tag_list_spec.rb +8 -8
  241. data/spec/templates/class_spec.rb +7 -7
  242. data/spec/templates/constant_spec.rb +7 -7
  243. data/spec/templates/engine_spec.rb +28 -36
  244. data/spec/templates/examples/class001.html +108 -108
  245. data/spec/templates/examples/class002.html +17 -17
  246. data/spec/templates/examples/constant001.txt +1 -1
  247. data/spec/templates/examples/method001.html +45 -45
  248. data/spec/templates/examples/method002.html +25 -25
  249. data/spec/templates/examples/method003.html +60 -60
  250. data/spec/templates/examples/method004.html +7 -7
  251. data/spec/templates/examples/method005.html +28 -28
  252. data/spec/templates/examples/module001.html +321 -321
  253. data/spec/templates/examples/module001.txt +1 -1
  254. data/spec/templates/examples/module002.html +130 -130
  255. data/spec/templates/examples/module003.html +74 -74
  256. data/spec/templates/examples/module004.html +388 -0
  257. data/spec/templates/helpers/base_helper_spec.rb +32 -32
  258. data/spec/templates/helpers/html_helper_spec.rb +87 -68
  259. data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb +9 -9
  260. data/spec/templates/helpers/markup/rdoc_markup_spec.rb +16 -16
  261. data/spec/templates/helpers/markup_helper_spec.rb +31 -28
  262. data/spec/templates/helpers/method_helper_spec.rb +7 -7
  263. data/spec/templates/helpers/shared_signature_examples.rb +9 -7
  264. data/spec/templates/helpers/text_helper_spec.rb +3 -3
  265. data/spec/templates/method_spec.rb +13 -13
  266. data/spec/templates/module_spec.rb +70 -24
  267. data/spec/templates/onefile_spec.rb +32 -15
  268. data/spec/templates/section_spec.rb +23 -23
  269. data/spec/templates/spec_helper.rb +31 -1
  270. data/spec/templates/tag_spec.rb +5 -5
  271. data/spec/templates/template_spec.rb +54 -46
  272. data/spec/verifier_spec.rb +5 -5
  273. data/templates/default/class/setup.rb +2 -2
  274. data/templates/default/docstring/html/abstract.erb +1 -1
  275. data/templates/default/docstring/html/note.erb +1 -1
  276. data/templates/default/docstring/html/private.erb +1 -1
  277. data/templates/default/docstring/html/todo.erb +1 -1
  278. data/templates/default/docstring/setup.rb +2 -2
  279. data/templates/default/fulldoc/html/css/full_list.css +4 -2
  280. data/templates/default/fulldoc/html/css/style.css +50 -44
  281. data/templates/default/fulldoc/html/frames.erb +21 -6
  282. data/templates/default/fulldoc/html/full_list.erb +5 -3
  283. data/templates/default/fulldoc/html/{full_list_files.erb → full_list_file.erb} +0 -0
  284. data/templates/default/fulldoc/html/js/app.js +29 -26
  285. data/templates/default/fulldoc/html/js/full_list.js +9 -9
  286. data/templates/default/fulldoc/html/js/jquery.js +4 -16
  287. data/templates/default/fulldoc/html/setup.rb +42 -38
  288. data/templates/default/layout/dot/header.erb +1 -1
  289. data/templates/default/layout/html/breadcrumb.erb +6 -6
  290. data/templates/default/layout/html/files.erb +1 -1
  291. data/templates/default/layout/html/footer.erb +1 -1
  292. data/templates/default/layout/html/headers.erb +3 -6
  293. data/templates/default/layout/html/index.erb +1 -1
  294. data/templates/default/layout/html/layout.erb +3 -7
  295. data/templates/default/layout/html/objects.erb +1 -1
  296. data/templates/default/layout/html/script_setup.erb +5 -0
  297. data/templates/default/layout/html/search.erb +4 -1
  298. data/templates/default/layout/html/setup.rb +8 -8
  299. data/templates/default/method_details/html/method_signature.erb +10 -3
  300. data/templates/default/method_details/setup.rb +1 -0
  301. data/templates/default/module/dot/info.erb +1 -1
  302. data/templates/default/module/dot/setup.rb +2 -2
  303. data/templates/default/module/html/attribute_details.erb +1 -1
  304. data/templates/default/module/html/children.erb +1 -1
  305. data/templates/default/module/html/defines.erb +1 -1
  306. data/templates/default/module/html/inherited_methods.erb +5 -4
  307. data/templates/default/module/html/item_summary.erb +15 -5
  308. data/templates/default/module/html/method_details_list.erb +2 -2
  309. data/templates/default/module/setup.rb +25 -12
  310. data/templates/default/module/text/setup.rb +1 -1
  311. data/templates/default/onefile/html/layout.erb +1 -1
  312. data/templates/default/onefile/html/setup.rb +2 -2
  313. data/templates/default/tags/html/example.erb +4 -2
  314. data/templates/default/tags/html/option.erb +1 -1
  315. data/templates/default/tags/html/overload.erb +1 -1
  316. data/templates/default/tags/html/see.erb +1 -1
  317. data/templates/default/tags/html/tag.erb +1 -1
  318. data/templates/default/tags/setup.rb +4 -3
  319. data/templates/guide/fulldoc/html/css/style.css +8 -8
  320. data/templates/guide/fulldoc/html/js/app.js +6 -6
  321. data/templates/guide/fulldoc/html/setup.rb +12 -12
  322. data/templates/guide/layout/html/layout.erb +11 -11
  323. data/templates/guide/layout/html/setup.rb +9 -9
  324. data/templates/guide/method/html/header.erb +2 -2
  325. data/templates/guide/method/html/setup.rb +1 -1
  326. metadata +68 -18
  327. data/bin/yard-graph +0 -4
  328. data/bin/yard-server +0 -4
  329. data/docs/Glossary.md +0 -12
  330. data/lib/yard/handlers/ruby/legacy/macro_handler.rb +0 -39
  331. data/lib/yard/handlers/ruby/macro_handler.rb +0 -40
  332. data/lib/yard/handlers/ruby/macro_handler_methods.rb +0 -131
  333. data/lib/yard/parser/c_parser.rb +0 -497
  334. data/lib/yard/server/templates/default/layout/html/headers.erb +0 -16
  335. data/lib/yard/server/templates/doc_server/frames/html/frames.erb +0 -13
  336. data/lib/yard/server/templates/doc_server/frames/html/setup.rb +0 -3
  337. data/lib/yard/server/templates/doc_server/full_list/html/full_list.erb +0 -34
  338. data/lib/yard/server/templates/doc_server/full_list/html/setup.rb +0 -20
  339. data/spec/handlers/examples/macro_handler_001.rb.txt +0 -83
data/templates/guide/layout/html/layout.erb CHANGED
@@ -4,9 +4,9 @@
4
4
  <head>
5
5
  <%= erb(:headers) %>
6
6
  <script type="text/javascript" charset="utf-8">
7
- $(function() {
8
- $('.object_link').each(function() {
9
- $(this).html($(this).find('a').html())
7
+ $(function() {
8
+ $('.object_link').each(function() {
9
+ $(this).html($(this).find('a').html())
10
10
  });
11
11
  });
12
12
  $(function() {
@@ -20,11 +20,11 @@
20
20
  <body>
21
21
  <div id="top_nav">
22
22
  <div id="inner_nav">
23
- <% if options[:readme] != options[:file] && options[:title] %>
24
- <span class="title"><strong><%= options[:title] %></strong>: <%= @page_title %></span>
23
+ <% if options.readme != options.file && options.title %>
24
+ <span class="title"><strong><%= options.title %></strong>: <%= @page_title %></span>
25
25
  <small class="links">
26
- <% links = [link_file('index.html', 'top'),
27
- @prevfile ? link_file(@prevfile, 'prev') : nil,
26
+ <% links = [link_file('index.html', 'top'),
27
+ @prevfile ? link_file(@prevfile, 'prev') : nil,
28
28
  @nextfile ? link_file(@nextfile, 'next') : nil].compact %>
29
29
  (<%= links.join(", ") %>)
30
30
  </small>
@@ -35,12 +35,12 @@
35
35
  <div id="sidebar">
36
36
  <h2 class="toc">Table Of Contents</h2>
37
37
  <div id="toc"></div>
38
-
39
- <% if options[:readme] != options[:file] %>
38
+
39
+ <% if options.readme != options.file %>
40
40
  <h2>Related Topics</h2>
41
41
  <div id="links">
42
42
  <ol class="top">
43
- <% if options[:readme] %>
43
+ <% if options.readme %>
44
44
  <li><%= link_file("index.html", "Documentation Overview") %></li>
45
45
  <% end %>
46
46
  <ol>
@@ -65,7 +65,7 @@
65
65
  <ol class="top">
66
66
  <li><a href="#">Documentation Overview</a></li>
67
67
  <ol>
68
- <% options[:files].each do |file| %>
68
+ <% options.files.each do |file| %>
69
69
  <li><%= link_file(file.filename, file.title) %></li>
70
70
  <% end %>
71
71
  </ol>
data/templates/guide/layout/html/setup.rb CHANGED
@@ -2,23 +2,23 @@ include T('default/layout/html')
2
2
 
3
3
  def init
4
4
  super
5
-
6
- @topfile = options[:readme]
7
- @toptitle = options[:readme].attributes[:title] || "Documentation Overview"
8
- if @file == options[:readme]
9
- @page_title = options[:title]
5
+
6
+ @topfile = options.readme
7
+ @toptitle = options.readme.attributes[:title] || "Documentation Overview"
8
+ if @file == options.readme
9
+ @page_title = options.title
10
10
  else
11
11
  @page_title = @file.title
12
12
  end
13
13
 
14
- index = options[:files].index(@file)
14
+ index = options.files.index(@file)
15
15
  if index
16
- @prevfile = index > 0 ? (options[:files][index - 1] || options[:readme]) : nil
17
- @nextfile = options[:files][index + 1]
16
+ @prevfile = index > 0 ? (options.files[index - 1] || options.readme) : nil
17
+ @nextfile = options.files[index + 1]
18
18
  end
19
19
  end
20
20
 
21
21
  def diskfile
22
- options[:including_object] = @object
22
+ options.including_object = @object
23
23
  super
24
24
  end
data/templates/guide/method/html/header.erb CHANGED
@@ -1,5 +1,5 @@
1
1
  <div class="method_header">
2
- <% if options[:in_module] %>
2
+ <% if options.in_module %>
3
3
  <% if object.constructor? %>
4
4
  <em>self.</em><span class="path"><strong>new</strong></span><big>(</big><%= format_args(object) %><big>)</big> <%= format_block(object) %>
5
5
  <% else %>
@@ -11,7 +11,7 @@
11
11
  <% else %><big>(</big><%= format_args(object) %><big>)</big> <%= format_block(object) %><% end %>
12
12
  <% end %>
13
13
  <% else %>
14
- <em>def</em> <span class="path space"><%= options[:including_object].relative_path(object.namespace) %><big><%= object.send(:sep) %></big><strong><%= object.name %></strong></span><big>(</big><%= format_args(object) %><big>)</big> <%= format_block(object) %>
14
+ <em>def</em> <span class="path space"><%= options.including_object.relative_path(object.namespace) %><big><%= object.send(:sep) %></big><strong><%= object.name %></strong></span><big>(</big><%= format_args(object) %><big>)</big> <%= format_block(object) %>
15
15
  <% end %>
16
16
  <% if object.has_tag?(:since) && object.namespace.tag(:since) != object.tag(:since) %><span class="since">since <%= object.tag(:since).text %></span><% end %>
17
17
  </div>
data/templates/guide/method/html/setup.rb CHANGED
@@ -11,7 +11,7 @@ def format_args(object)
11
11
  !object.tags(:param).any? {|t| t.name == param[0][1..-1] }
12
12
  end
13
13
  end
14
-
14
+
15
15
  unless params.empty?
16
16
  args = params.map {|n, v| v ? "<em>#{h n}</em> = #{h v}" : "<em>" + n.to_s + "</em>" }.join(", ")
17
17
  args
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: yard
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.7.5
4
+ version: 0.8.0
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2012-01-31 00:00:00.000000000 -05:00
12
+ date: 2012-04-30 00:00:00.000000000 -04:00
13
13
  default_executable:
14
14
  dependencies: []
15
15
  description: ! " YARD is a documentation generation tool for the Ruby programming
@@ -26,7 +26,6 @@ extra_rdoc_files: []
26
26
  files:
27
27
  - docs/CodeObjects.md
28
28
  - docs/GettingStarted.md
29
- - docs/Glossary.md
30
29
  - docs/Handlers.md
31
30
  - docs/images/code-objects-class-diagram.png
32
31
  - docs/images/handlers-class-diagram.png
@@ -36,11 +35,17 @@ files:
36
35
  - docs/Overview.md
37
36
  - docs/Parser.md
38
37
  - docs/Tags.md
38
+ - docs/TagsArch.md
39
+ - docs/templates/default/fulldoc/html/full_list_tag.erb
40
+ - docs/templates/default/fulldoc/html/setup.rb
41
+ - docs/templates/default/layout/html/setup.rb
42
+ - docs/templates/default/layout/html/tag_list.erb
43
+ - docs/templates/default/yard_tags/html/list.erb
44
+ - docs/templates/default/yard_tags/html/setup.rb
45
+ - docs/templates/plugin.rb
39
46
  - docs/Templates.md
40
47
  - docs/WhatsNew.md
41
48
  - bin/yard
42
- - bin/yard-graph
43
- - bin/yard-server
44
49
  - bin/yardoc
45
50
  - bin/yri
46
51
  - lib/rubygems_plugin.rb
@@ -52,6 +57,7 @@ files:
52
57
  - lib/yard/cli/gems.rb
53
58
  - lib/yard/cli/graph.rb
54
59
  - lib/yard/cli/help.rb
60
+ - lib/yard/cli/i18n.rb
55
61
  - lib/yard/cli/list.rb
56
62
  - lib/yard/cli/server.rb
57
63
  - lib/yard/cli/stats.rb
@@ -78,8 +84,23 @@ files:
78
84
  - lib/yard/core_ext/string.rb
79
85
  - lib/yard/core_ext/symbol_hash.rb
80
86
  - lib/yard/docstring.rb
87
+ - lib/yard/docstring_parser.rb
81
88
  - lib/yard/globals.rb
82
89
  - lib/yard/handlers/base.rb
90
+ - lib/yard/handlers/c/alias_handler.rb
91
+ - lib/yard/handlers/c/attribute_handler.rb
92
+ - lib/yard/handlers/c/base.rb
93
+ - lib/yard/handlers/c/class_handler.rb
94
+ - lib/yard/handlers/c/constant_handler.rb
95
+ - lib/yard/handlers/c/handler_methods.rb
96
+ - lib/yard/handlers/c/init_handler.rb
97
+ - lib/yard/handlers/c/method_handler.rb
98
+ - lib/yard/handlers/c/mixin_handler.rb
99
+ - lib/yard/handlers/c/module_handler.rb
100
+ - lib/yard/handlers/c/override_comment_handler.rb
101
+ - lib/yard/handlers/c/path_handler.rb
102
+ - lib/yard/handlers/c/struct_handler.rb
103
+ - lib/yard/handlers/c/symbol_handler.rb
83
104
  - lib/yard/handlers/processor.rb
84
105
  - lib/yard/handlers/ruby/alias_handler.rb
85
106
  - lib/yard/handlers/ruby/attribute_handler.rb
@@ -87,7 +108,10 @@ files:
87
108
  - lib/yard/handlers/ruby/class_condition_handler.rb
88
109
  - lib/yard/handlers/ruby/class_handler.rb
89
110
  - lib/yard/handlers/ruby/class_variable_handler.rb
111
+ - lib/yard/handlers/ruby/comment_handler.rb
90
112
  - lib/yard/handlers/ruby/constant_handler.rb
113
+ - lib/yard/handlers/ruby/dsl_handler.rb
114
+ - lib/yard/handlers/ruby/dsl_handler_methods.rb
91
115
  - lib/yard/handlers/ruby/exception_handler.rb
92
116
  - lib/yard/handlers/ruby/extend_handler.rb
93
117
  - lib/yard/handlers/ruby/legacy/alias_handler.rb
@@ -96,29 +120,35 @@ files:
96
120
  - lib/yard/handlers/ruby/legacy/class_condition_handler.rb
97
121
  - lib/yard/handlers/ruby/legacy/class_handler.rb
98
122
  - lib/yard/handlers/ruby/legacy/class_variable_handler.rb
123
+ - lib/yard/handlers/ruby/legacy/comment_handler.rb
99
124
  - lib/yard/handlers/ruby/legacy/constant_handler.rb
125
+ - lib/yard/handlers/ruby/legacy/dsl_handler.rb
100
126
  - lib/yard/handlers/ruby/legacy/exception_handler.rb
101
127
  - lib/yard/handlers/ruby/legacy/extend_handler.rb
102
- - lib/yard/handlers/ruby/legacy/macro_handler.rb
103
128
  - lib/yard/handlers/ruby/legacy/method_handler.rb
104
129
  - lib/yard/handlers/ruby/legacy/mixin_handler.rb
130
+ - lib/yard/handlers/ruby/legacy/module_function_handler.rb
105
131
  - lib/yard/handlers/ruby/legacy/module_handler.rb
106
132
  - lib/yard/handlers/ruby/legacy/private_constant_handler.rb
107
133
  - lib/yard/handlers/ruby/legacy/visibility_handler.rb
108
134
  - lib/yard/handlers/ruby/legacy/yield_handler.rb
109
- - lib/yard/handlers/ruby/macro_handler.rb
110
- - lib/yard/handlers/ruby/macro_handler_methods.rb
111
135
  - lib/yard/handlers/ruby/method_condition_handler.rb
112
136
  - lib/yard/handlers/ruby/method_handler.rb
113
137
  - lib/yard/handlers/ruby/mixin_handler.rb
138
+ - lib/yard/handlers/ruby/module_function_handler.rb
114
139
  - lib/yard/handlers/ruby/module_handler.rb
115
140
  - lib/yard/handlers/ruby/private_constant_handler.rb
116
141
  - lib/yard/handlers/ruby/struct_handler_methods.rb
117
142
  - lib/yard/handlers/ruby/visibility_handler.rb
118
143
  - lib/yard/handlers/ruby/yield_handler.rb
144
+ - lib/yard/i18n/pot_generator.rb
145
+ - lib/yard/i18n/text.rb
119
146
  - lib/yard/logging.rb
147
+ - lib/yard/options.rb
120
148
  - lib/yard/parser/base.rb
121
- - lib/yard/parser/c_parser.rb
149
+ - lib/yard/parser/c/c_parser.rb
150
+ - lib/yard/parser/c/comment_parser.rb
151
+ - lib/yard/parser/c/statement.rb
122
152
  - lib/yard/parser/ruby/ast_node.rb
123
153
  - lib/yard/parser/ruby/legacy/ruby_lex.rb
124
154
  - lib/yard/parser/ruby/legacy/ruby_parser.rb
@@ -163,12 +193,8 @@ files:
163
193
  - lib/yard/server/templates/default/fulldoc/html/js/autocomplete.js
164
194
  - lib/yard/server/templates/default/fulldoc/html/js/live.js
165
195
  - lib/yard/server/templates/default/layout/html/breadcrumb.erb
166
- - lib/yard/server/templates/default/layout/html/headers.erb
196
+ - lib/yard/server/templates/default/layout/html/script_setup.erb
167
197
  - lib/yard/server/templates/default/layout/html/setup.rb
168
- - lib/yard/server/templates/doc_server/frames/html/frames.erb
169
- - lib/yard/server/templates/doc_server/frames/html/setup.rb
170
- - lib/yard/server/templates/doc_server/full_list/html/full_list.erb
171
- - lib/yard/server/templates/doc_server/full_list/html/setup.rb
172
198
  - lib/yard/server/templates/doc_server/library_list/html/contents.erb
173
199
  - lib/yard/server/templates/doc_server/library_list/html/headers.erb
174
200
  - lib/yard/server/templates/doc_server/library_list/html/library_list.erb
@@ -182,6 +208,7 @@ files:
182
208
  - lib/yard/server.rb
183
209
  - lib/yard/tags/default_factory.rb
184
210
  - lib/yard/tags/default_tag.rb
211
+ - lib/yard/tags/directives.rb
185
212
  - lib/yard/tags/library.rb
186
213
  - lib/yard/tags/option_tag.rb
187
214
  - lib/yard/tags/overload_tag.rb
@@ -203,6 +230,7 @@ files:
203
230
  - lib/yard/templates/helpers/uml_helper.rb
204
231
  - lib/yard/templates/section.rb
205
232
  - lib/yard/templates/template.rb
233
+ - lib/yard/templates/template_options.rb
206
234
  - lib/yard/verifier.rb
207
235
  - lib/yard.rb
208
236
  - spec/cli/command_parser_spec.rb
@@ -211,6 +239,7 @@ files:
211
239
  - spec/cli/diff_spec.rb
212
240
  - spec/cli/gems_spec.rb
213
241
  - spec/cli/help_spec.rb
242
+ - spec/cli/i18n_spec.rb
214
243
  - spec/cli/list_spec.rb
215
244
  - spec/cli/server_spec.rb
216
245
  - spec/cli/stats_spec.rb
@@ -235,23 +264,37 @@ files:
235
264
  - spec/core_ext/module_spec.rb
236
265
  - spec/core_ext/string_spec.rb
237
266
  - spec/core_ext/symbol_hash_spec.rb
267
+ - spec/docstring_parser_spec.rb
238
268
  - spec/docstring_spec.rb
239
269
  - spec/handlers/alias_handler_spec.rb
240
270
  - spec/handlers/attribute_handler_spec.rb
241
271
  - spec/handlers/base_spec.rb
272
+ - spec/handlers/c/alias_handler_spec.rb
273
+ - spec/handlers/c/attribute_handler_spec.rb
274
+ - spec/handlers/c/class_handler_spec.rb
275
+ - spec/handlers/c/constant_handler_spec.rb
276
+ - spec/handlers/c/init_handler_spec.rb
277
+ - spec/handlers/c/method_handler_spec.rb
278
+ - spec/handlers/c/mixin_handler_spec.rb
279
+ - spec/handlers/c/module_handler_spec.rb
280
+ - spec/handlers/c/override_comment_handler_spec.rb
281
+ - spec/handlers/c/path_handler_spec.rb
282
+ - spec/handlers/c/spec_helper.rb
283
+ - spec/handlers/c/struct_handler_spec.rb
242
284
  - spec/handlers/class_condition_handler_spec.rb
243
285
  - spec/handlers/class_handler_spec.rb
244
286
  - spec/handlers/class_variable_handler_spec.rb
245
287
  - spec/handlers/constant_handler_spec.rb
288
+ - spec/handlers/dsl_handler_spec.rb
246
289
  - spec/handlers/examples/alias_handler_001.rb.txt
247
290
  - spec/handlers/examples/attribute_handler_001.rb.txt
248
291
  - spec/handlers/examples/class_condition_handler_001.rb.txt
249
292
  - spec/handlers/examples/class_handler_001.rb.txt
250
293
  - spec/handlers/examples/class_variable_handler_001.rb.txt
251
294
  - spec/handlers/examples/constant_handler_001.rb.txt
295
+ - spec/handlers/examples/dsl_handler_001.rb.txt
252
296
  - spec/handlers/examples/exception_handler_001.rb.txt
253
297
  - spec/handlers/examples/extend_handler_001.rb.txt
254
- - spec/handlers/examples/macro_handler_001.rb.txt
255
298
  - spec/handlers/examples/method_condition_handler_001.rb.txt
256
299
  - spec/handlers/examples/method_handler_001.rb.txt
257
300
  - spec/handlers/examples/mixin_handler_001.rb.txt
@@ -263,10 +306,10 @@ files:
263
306
  - spec/handlers/exception_handler_spec.rb
264
307
  - spec/handlers/extend_handler_spec.rb
265
308
  - spec/handlers/legacy_base_spec.rb
266
- - spec/handlers/macro_handler_spec.rb
267
309
  - spec/handlers/method_condition_handler_spec.rb
268
310
  - spec/handlers/method_handler_spec.rb
269
311
  - spec/handlers/mixin_handler_spec.rb
312
+ - spec/handlers/module_function_handler_spec.rb
270
313
  - spec/handlers/module_handler_spec.rb
271
314
  - spec/handlers/private_constant_handler_spec.rb
272
315
  - spec/handlers/processor_spec.rb
@@ -275,7 +318,10 @@ files:
275
318
  - spec/handlers/spec_helper.rb
276
319
  - spec/handlers/visibility_handler_spec.rb
277
320
  - spec/handlers/yield_handler_spec.rb
321
+ - spec/i18n/pot_generator_spec.rb
322
+ - spec/i18n/text_spec.rb
278
323
  - spec/logging_spec.rb
324
+ - spec/options_spec.rb
279
325
  - spec/parser/base_spec.rb
280
326
  - spec/parser/c_parser_spec.rb
281
327
  - spec/parser/examples/array.c.txt
@@ -319,6 +365,7 @@ files:
319
365
  - spec/spec_helper.rb
320
366
  - spec/tags/default_factory_spec.rb
321
367
  - spec/tags/default_tag_spec.rb
368
+ - spec/tags/directives_spec.rb
322
369
  - spec/tags/library_spec.rb
323
370
  - spec/tags/overload_tag_spec.rb
324
371
  - spec/tags/ref_tag_list_spec.rb
@@ -346,6 +393,7 @@ files:
346
393
  - spec/templates/examples/module001.txt
347
394
  - spec/templates/examples/module002.html
348
395
  - spec/templates/examples/module003.html
396
+ - spec/templates/examples/module004.html
349
397
  - spec/templates/examples/tag001.txt
350
398
  - spec/templates/helpers/base_helper_spec.rb
351
399
  - spec/templates/helpers/html_helper_spec.rb
@@ -396,7 +444,7 @@ files:
396
444
  - templates/default/fulldoc/html/frames.erb
397
445
  - templates/default/fulldoc/html/full_list.erb
398
446
  - templates/default/fulldoc/html/full_list_class.erb
399
- - templates/default/fulldoc/html/full_list_files.erb
447
+ - templates/default/fulldoc/html/full_list_file.erb
400
448
  - templates/default/fulldoc/html/full_list_methods.erb
401
449
  - templates/default/fulldoc/html/js/app.js
402
450
  - templates/default/fulldoc/html/js/full_list.js
@@ -412,6 +460,7 @@ files:
412
460
  - templates/default/layout/html/layout.erb
413
461
  - templates/default/layout/html/listing.erb
414
462
  - templates/default/layout/html/objects.erb
463
+ - templates/default/layout/html/script_setup.erb
415
464
  - templates/default/layout/html/search.erb
416
465
  - templates/default/layout/html/setup.rb
417
466
  - templates/default/method/html/header.erb
@@ -494,6 +543,7 @@ files:
494
543
  - benchmarks/parsing.rb
495
544
  - benchmarks/pathname_vs_string.rb
496
545
  - benchmarks/rdoc_vs_yardoc.rb
546
+ - benchmarks/registry_store_types.rb
497
547
  - benchmarks/ri_vs_yri.rb
498
548
  - benchmarks/ripper_parser.rb
499
549
  - benchmarks/splat_vs_flatten.rb
@@ -528,7 +578,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
528
578
  version: '0'
529
579
  requirements: []
530
580
  rubyforge_project: yard
531
- rubygems_version: 1.3.9.3
581
+ rubygems_version: 1.3.9.4
532
582
  signing_key:
533
583
  specification_version: 3
534
584
  summary: Documentation tool for consistent and usable documentation in Ruby.
data/bin/yard-graph DELETED
@@ -1,4 +0,0 @@
1
- #!/usr/bin/env ruby
2
- require File.dirname(__FILE__) + '/../lib/yard'
3
-
4
- YARD::CLI::Graph.run(*ARGV)
data/bin/yard-server DELETED
@@ -1,4 +0,0 @@
1
- #!/usr/bin/env ruby
2
- require File.dirname(__FILE__) + '/../lib/yard'
3
-
4
- YARD::CLI::Server.run(*ARGV)
data/docs/Glossary.md DELETED
@@ -1,12 +0,0 @@
1
- # Glossary
2
-
3
- * **Code Object**: Any explicitly defined Ruby source that describes a feature
4
- of the code. By default, this refers to classes, modules, methods, constants
5
- and class variables, though it can be extended to refer to custom functionality
6
- defined by a DSL (like a spec, for instance).
7
-
8
- * **Domain Specific Language (DSL)**: In the context of Ruby, a DSL is a language
9
- optimized for a specific domain (problem) but represented using Ruby syntax.
10
-
11
- * **Docstring (Documentation String)**: Comments associated with a code object
12
- used for documentation purposes.
data/lib/yard/handlers/ruby/legacy/macro_handler.rb DELETED
@@ -1,39 +0,0 @@
1
- module YARD
2
- module Handlers
3
- module Ruby
4
- module Legacy
5
- # (see Ruby::MacroHandler)
6
- class MacroHandler < Base
7
- include CodeObjects
8
- include MacroHandlerMethods
9
- handles TkIDENTIFIER
10
- namespace_only
11
-
12
- process do
13
- globals.__attached_macros ||= {}
14
- if !globals.__attached_macros[caller_method]
15
- return if Ruby::MacroHandler::IGNORE_METHODS[caller_method]
16
- return if !statement.comments || statement.comments.empty?
17
- end
18
-
19
- comments = statement.comments ? statement.comments.join("\n") : ""
20
- @macro, @docstring = nil, Docstring.new(comments)
21
- find_or_create_macro(@docstring)
22
- return if !@macro && !statement.comments_hash_flag && @docstring.tags.size == 0
23
- @docstring = expanded_macro_or_docstring
24
- name = method_name
25
- raise UndocumentableError, "method, missing name" if name.nil? || name.empty?
26
- tmp_scope = sanitize_scope
27
- tmp_vis = sanitize_visibility
28
- object = MethodObject.new(namespace, name, tmp_scope)
29
- register(object)
30
- object.visibility = tmp_vis
31
- object.dynamic = true
32
- object.signature = method_signature
33
- create_attribute_data(object)
34
- end
35
- end
36
- end
37
- end
38
- end
39
- end