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/spec/templates/examples/class002.html CHANGED
@@ -1,34 +1,34 @@
1
- <h1>Class: D
2
-
3
-
1
+ <h1>Class: D
2
+
3
+
4
4
  </h1>
5
5
 
6
6
  <dl class="box">
7
-
7
+
8
8
  <dt class="r1">Inherits:</dt>
9
9
  <dd class="r1">
10
10
  <span class="inheritName">Object</span>
11
-
11
+
12
12
  <ul class="fullTree">
13
13
  <li>Object</li>
14
-
14
+
15
15
  <li class="next">D</li>
16
-
16
+
17
17
  </ul>
18
18
  <a href="#" class="inheritanceTree">show all</a>
19
-
19
+
20
20
  </dd>
21
-
22
-
23
-
24
-
25
-
26
-
27
-
28
-
21
+
22
+
23
+
24
+
25
+
26
+
27
+
28
+
29
29
  <dt class="r2 last">Defined in:</dt>
30
30
  <dd class="r2 last">(stdin)</dd>
31
-
31
+
32
32
  </dl>
33
33
  <div class="clear"></div>
34
34
 
data/spec/templates/examples/constant001.txt CHANGED
@@ -6,7 +6,7 @@ DEFAULT_SEARCH_PATHS = []
6
6
 
7
7
  Default search paths that should be loaded dynamically into YRI.
8
8
  These paths take precedence over all other paths
9
- ({SEARCH_PATHS_FILE} and RubyGems paths). To add a path, call:
9
+ ({SEARCH_PATHS_FILE} and RubyGems paths). To add a path, call:
10
10
 
11
11
  DEFAULT_SEARCH_PATHS.push("/path/to/.yardoc")
12
12
 
data/spec/templates/examples/method001.html CHANGED
@@ -10,17 +10,17 @@
10
10
  <div class="method_details_list">
11
11
  <div id="method_details">
12
12
  <div class="method_details first">
13
- <p class="signature first" id="m-instance_method">
14
-
13
+ <h3 class="signature first" id="m-instance_method">
14
+
15
15
  - (<tt>String</tt>) <strong>m</strong>(x) <span class="extras">(private)</span>
16
-
17
16
 
18
-
17
+
18
+
19
19
  <span class="aliases">Also known as:
20
20
  <span class="names"><span id='x-instance_method'>x</span></span>
21
21
  </span>
22
-
23
- </p><div class="docstring">
22
+
23
+ </h3><div class="docstring">
24
24
  <div class="discussion">
25
25
  <div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'>for great justice</div></div>
26
26
  Comments
@@ -28,86 +28,86 @@ Comments
28
28
  </div>
29
29
  </div>
30
30
  <div class="tags">
31
- <h3>Parameters:</h3>
31
+ <p class="tag_title">Parameters:</p>
32
32
  <ul class="param">
33
-
33
+
34
34
  <li>
35
-
35
+
36
36
  <span class='name'>x</span>
37
-
38
-
37
+
38
+
39
39
  <span class='type'>(<tt>Hash</tt>)</span>
40
-
41
-
42
-
40
+
41
+
42
+
43
43
  &mdash;
44
44
  <div class='inline'>the x argument</div>
45
-
45
+
46
46
  </li>
47
-
47
+
48
48
  </ul>
49
49
 
50
-
51
-
52
-
53
- <h3>Options Hash (<tt>x</tt>):</h3>
50
+
51
+
52
+
53
+ <p class="tag_title">Options Hash (<tt>x</tt>):</p>
54
54
  <ul class="option">
55
-
55
+
56
56
  <li>
57
57
  <span class="name">:key1</span>
58
58
  <span class="type">(<tt>String</tt>)</span>
59
59
  <span class="default">
60
-
60
+
61
61
  &mdash; default:
62
62
  <tt>default</tt>
63
-
63
+
64
64
  </span>
65
65
  &mdash; <div class='inline'>first key</div>
66
66
  </li>
67
-
67
+
68
68
  <li>
69
69
  <span class="name">:key2</span>
70
70
  <span class="type">(<tt>Symbol</tt>)</span>
71
71
  <span class="default">
72
-
72
+
73
73
  </span>
74
74
  &mdash; <div class='inline'>second key</div>
75
75
  </li>
76
-
76
+
77
77
  </ul>
78
-
79
78
 
80
- <h3>Returns:</h3>
79
+
80
+ <p class="tag_title">Returns:</p>
81
81
  <ul class="return">
82
-
82
+
83
83
  <li>
84
-
85
-
84
+
85
+
86
86
  <span class='type'>(<tt>String</tt>)</span>
87
-
88
-
89
-
87
+
88
+
89
+
90
90
  &mdash;
91
91
  <div class='inline'>the result</div>
92
-
92
+
93
93
  </li>
94
-
94
+
95
95
  </ul>
96
- <h3>Raises:</h3>
96
+ <p class="tag_title">Raises:</p>
97
97
  <ul class="raise">
98
-
98
+
99
99
  <li>
100
-
101
-
100
+
101
+
102
102
  <span class='type'>(<tt>Exception</tt>)</span>
103
-
104
-
105
-
103
+
104
+
105
+
106
106
  &mdash;
107
107
  <div class='inline'>hi!</div>
108
-
108
+
109
109
  </li>
110
-
110
+
111
111
  </ul>
112
112
 
113
113
  </div><table class="source_code">
data/spec/templates/examples/method002.html CHANGED
@@ -10,58 +10,58 @@
10
10
  <div class="method_details_list">
11
11
  <div id="method_details">
12
12
  <div class="method_details first">
13
- <p class="signature first" id="m-instance_method">
14
-
13
+ <h3 class="signature first" id="m-instance_method">
14
+
15
15
  - <strong>m</strong>(x, y) <span class="extras">(private)</span>
16
-
17
16
 
18
-
19
- </p><div class="docstring">
17
+
18
+
19
+ </h3><div class="docstring">
20
20
  <div class="discussion">
21
21
  Comments
22
22
 
23
23
  </div>
24
24
  </div>
25
25
  <div class="tags">
26
-
26
+
27
27
  <div class="docstring">
28
28
  <div class="discussion">
29
-
29
+
30
30
 
31
31
  </div>
32
32
  </div>
33
33
  <div class="tags">
34
- <h3>Parameters:</h3>
34
+ <p class="tag_title">Parameters:</p>
35
35
  <ul class="param">
36
-
36
+
37
37
  <li>
38
-
38
+
39
39
  <span class='name'>x</span>
40
-
41
-
40
+
41
+
42
42
  <span class='type'>(<tt>String</tt>)</span>
43
-
44
-
45
-
43
+
44
+
45
+
46
46
  &mdash;
47
47
  <div class='inline'>parameter x</div>
48
-
48
+
49
49
  </li>
50
-
50
+
51
51
  <li>
52
-
52
+
53
53
  <span class='name'>y</span>
54
-
55
-
54
+
55
+
56
56
  <span class='type'>(<tt>Boolean</tt>)</span>
57
-
58
-
59
-
57
+
58
+
59
+
60
60
  &mdash;
61
61
  <div class='inline'>parameter y</div>
62
-
62
+
63
63
  </li>
64
-
64
+
65
65
  </ul>
66
66
 
67
67
  </div>
data/spec/templates/examples/method003.html CHANGED
@@ -10,28 +10,28 @@
10
10
  <div class="method_details_list">
11
11
  <div id="method_details">
12
12
  <div class="method_details first">
13
- <p class="signature first" id="m-instance_method">
14
-
15
-
13
+ <h3 class="signature first" id="m-instance_method">
14
+
15
+
16
16
  <span class="overload">- <strong>m</strong>(x, y) <span class="extras">(private)</span></span>
17
-
17
+
18
18
  <span class="overload">- <strong>m</strong>(x, y, z) <span class="extras">(private)</span></span>
19
-
20
-
21
19
 
22
-
23
- </p><div class="docstring">
20
+
21
+
22
+
23
+ </h3><div class="docstring">
24
24
  <div class="discussion">
25
25
  Method comments
26
26
 
27
27
  </div>
28
28
  </div>
29
29
  <div class="tags">
30
-
31
- <h3>Overloads:</h3>
30
+
31
+ <p class="tag_title">Overloads:</p>
32
32
  <ul class="overload">
33
-
34
-
33
+
34
+
35
35
  <li class="overload_item">
36
36
  <span class="signature">- <strong>m</strong>(x, y) </span>
37
37
  <div class="docstring">
@@ -41,102 +41,102 @@
41
41
  </div>
42
42
  </div>
43
43
  <div class="tags">
44
- <h3>Parameters:</h3>
44
+ <p class="tag_title">Parameters:</p>
45
45
  <ul class="param">
46
-
46
+
47
47
  <li>
48
-
48
+
49
49
  <span class='name'>x</span>
50
-
51
-
50
+
51
+
52
52
  <span class='type'>(<tt>String</tt>)</span>
53
-
54
-
55
-
53
+
54
+
55
+
56
56
  &mdash;
57
57
  <div class='inline'>parameter x</div>
58
-
58
+
59
59
  </li>
60
-
60
+
61
61
  <li>
62
-
62
+
63
63
  <span class='name'>y</span>
64
-
65
-
64
+
65
+
66
66
  <span class='type'>(<tt>Boolean</tt>)</span>
67
-
68
-
69
-
67
+
68
+
69
+
70
70
  &mdash;
71
71
  <div class='inline'>parameter y</div>
72
-
72
+
73
73
  </li>
74
-
74
+
75
75
  </ul>
76
76
 
77
77
  </div>
78
78
  </li>
79
-
80
-
79
+
80
+
81
81
  <li class="overload_item">
82
82
  <span class="signature">- <strong>m</strong>(x, y, z) </span>
83
83
  <div class="docstring">
84
84
  <div class="discussion">
85
-
85
+
86
86
 
87
87
  </div>
88
88
  </div>
89
89
  <div class="tags">
90
- <h3>Parameters:</h3>
90
+ <p class="tag_title">Parameters:</p>
91
91
  <ul class="param">
92
-
92
+
93
93
  <li>
94
-
94
+
95
95
  <span class='name'>x</span>
96
-
97
-
96
+
97
+
98
98
  <span class='type'>(<tt>String</tt>)</span>
99
-
100
-
101
-
99
+
100
+
101
+
102
102
  &mdash;
103
103
  <div class='inline'>parameter x</div>
104
-
104
+
105
105
  </li>
106
-
106
+
107
107
  <li>
108
-
108
+
109
109
  <span class='name'>y</span>
110
-
111
-
110
+
111
+
112
112
  <span class='type'>(<tt>Boolean</tt>)</span>
113
-
114
-
115
-
113
+
114
+
115
+
116
116
  &mdash;
117
117
  <div class='inline'>parameter y</div>
118
-
118
+
119
119
  </li>
120
-
120
+
121
121
  <li>
122
-
122
+
123
123
  <span class='name'>z</span>
124
-
125
-
124
+
125
+
126
126
  <span class='type'>(<tt>Boolean</tt>)</span>
127
-
128
-
129
-
127
+
128
+
129
+
130
130
  &mdash;
131
131
  <div class='inline'>parameter z</div>
132
-
132
+
133
133
  </li>
134
-
134
+
135
135
  </ul>
136
136
 
137
137
  </div>
138
138
  </li>
139
-
139
+
140
140
  </ul>
141
141
 
142
142
  </div><table class="source_code">