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
@@ -10,20 +10,20 @@
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
- - (<tt>void</tt>) <strong>m</strong>(*args)
16
-
13
+ <h3 class="signature first" id="m-instance_method">
17
14
 
18
-
19
- </p><div class="docstring">
15
+ - (<tt>void</tt>) <strong>m</strong>(*args)
16
+
17
+
18
+
19
+ </h3><div class="docstring">
20
20
  <div class="discussion">
21
21
  <p class="note returns_void">This method returns an undefined value.</p>
22
22
 
23
23
  </div>
24
24
  </div>
25
25
  <div class="tags">
26
-
26
+
27
27
  </div><table class="source_code">
28
28
  <tr>
29
29
  <td>
@@ -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">- (<tt>void</tt>) <strong>m</strong>(a) </span>
17
-
17
+
18
18
  <span class="overload">- <strong>m</strong>(b) </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
+
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">- (<tt>void</tt>) <strong>m</strong>(a) </span>
37
37
  <div class="docstring">
@@ -41,42 +41,42 @@
41
41
  </div>
42
42
  </div>
43
43
  <div class="tags">
44
-
44
+
45
45
  </div>
46
46
  </li>
47
-
48
-
47
+
48
+
49
49
  <li class="overload_item">
50
50
  <span class="signature">- <strong>m</strong>(b) </span>
51
51
  <div class="docstring">
52
52
  <div class="discussion">
53
-
53
+
54
54
 
55
55
  </div>
56
56
  </div>
57
57
  <div class="tags">
58
- <h3>Parameters:</h3>
58
+ <p class="tag_title">Parameters:</p>
59
59
  <ul class="param">
60
-
60
+
61
61
  <li>
62
-
62
+
63
63
  <span class='name'>b</span>
64
-
65
-
64
+
65
+
66
66
  <span class='type'>(<tt>String</tt>)</span>
67
-
68
-
69
-
67
+
68
+
69
+
70
70
  &mdash;
71
71
  <div class='inline'>hi</div>
72
-
72
+
73
73
  </li>
74
-
74
+
75
75
  </ul>
76
76
 
77
77
  </div>
78
78
  </li>
79
-
79
+
80
80
  </ul>
81
81
 
82
82
  </div><table class="source_code">
@@ -1,29 +1,29 @@
1
1
  <h1>Module: A
2
-
3
-
4
-
2
+
3
+
4
+
5
5
  </h1>
6
6
 
7
7
  <dl class="box">
8
-
9
-
10
-
11
-
12
-
8
+
9
+
10
+
11
+
12
+
13
13
  <dt class="r1">Includes:</dt>
14
14
  <dd class="r1">B, BaseMod</dd>
15
-
16
-
17
-
18
-
15
+
16
+
17
+
18
+
19
19
  <dt class="r2">Included in:</dt>
20
20
  <dd class="r2">TMP, TMP2</dd>
21
-
22
-
23
-
21
+
22
+
23
+
24
24
  <dt class="r1 last">Defined in:</dt>
25
25
  <dd class="r1 last">(stdin)</dd>
26
-
26
+
27
27
  </dl>
28
28
  <div class="clear"></div>
29
29
 
@@ -34,24 +34,24 @@
34
34
  </div>
35
35
  </div>
36
36
  <div class="tags">
37
-
37
+
38
38
  </div><h2>Defined Under Namespace</h2>
39
39
  <p class="children">
40
-
41
-
40
+
41
+
42
42
  <strong class="modules">Modules:</strong> Z
43
-
44
-
45
-
43
+
44
+
45
+
46
46
  <strong class="classes">Classes:</strong> Q, X, Y
47
-
48
-
47
+
48
+
49
49
  </p>
50
50
 
51
51
  <h2>Constant Summary</h2>
52
-
52
+
53
53
  <dl class="constants">
54
-
54
+
55
55
  <dt id="CONSTANT-constant" class="">CONSTANT =
56
56
  <div class="docstring">
57
57
  <div class="discussion">
@@ -61,11 +61,11 @@ and newlines.
61
61
  </div>
62
62
  </div>
63
63
  <div class="tags">
64
-
64
+
65
65
  </div>
66
66
  </dt>
67
67
  <dd><pre class="code">'value'</pre></dd>
68
-
68
+
69
69
  <dt id="cvar-classvariable" class="deprecated">@@cvar =
70
70
  <div class="docstring">
71
71
  <div class="discussion">
@@ -75,302 +75,302 @@ and newlines.
75
75
  </div>
76
76
  </div>
77
77
  <div class="tags">
78
-
78
+
79
79
  </div>
80
80
  </dt>
81
81
  <dd><pre class="code">'value'</pre></dd>
82
-
82
+
83
83
  </dl>
84
-
85
84
 
86
85
 
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
95
  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
96
96
  <ul class="summary">
97
-
97
+
98
98
  <li class="public ">
99
99
  <span class="summary_signature">
100
-
100
+
101
101
  <a title="#attr1 (instance method)">- <strong>attr1</strong> </a>
102
-
103
102
 
104
-
103
+
104
+
105
105
  </span>
106
-
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
-
115
-
116
-
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
117
  <span class="summary_desc"><div class='inline'>Returns the value of attribute attr1.</div></span>
118
-
118
+
119
119
  </li>
120
120
 
121
-
121
+
122
122
  <li class="public ">
123
123
  <span class="summary_signature">
124
-
124
+
125
125
  <a title="#attr2 (instance method)">- <strong>attr2</strong> </a>
126
-
127
126
 
128
-
127
+
128
+
129
129
  </span>
130
-
131
-
130
+
131
+
132
132
  <span class="note title readonly">readonly</span>
133
-
134
-
135
-
136
-
137
-
138
-
139
-
140
-
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
141
  <span class="summary_desc"><div class='inline'>Returns the value of attribute attr2.</div></span>
142
-
142
+
143
143
  </li>
144
144
 
145
-
145
+
146
146
  <li class="public ">
147
147
  <span class="summary_signature">
148
-
148
+
149
149
  <a title="#attr3 (instance method)">- <strong>attr3</strong> </a>
150
-
151
150
 
152
-
151
+
152
+
153
153
  </span>
154
-
155
-
156
-
157
-
158
-
159
-
160
-
161
-
162
-
163
-
164
-
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
165
  <span class="summary_desc"><div class='inline'></div></span>
166
-
166
+
167
167
  </li>
168
168
 
169
-
169
+
170
170
  <li class="public ">
171
171
  <span class="summary_signature">
172
-
172
+
173
173
  <a title="#attr4= (instance method)">- <strong>attr4</strong> </a>
174
-
175
174
 
176
-
175
+
176
+
177
177
  </span>
178
-
179
-
180
-
178
+
179
+
180
+
181
181
  <span class="note title writeonly">writeonly</span>
182
-
183
-
184
-
185
-
186
-
187
182
 
188
-
183
+
184
+
185
+
186
+
187
+
188
+
189
189
  <span class="summary_desc"><div class='inline'>Sets the attribute attr4.</div></span>
190
-
190
+
191
191
  </li>
192
192
 
193
-
193
+
194
194
  </ul>
195
195
 
196
196
 
197
197
 
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
206
  <h3 class="inherited">Attributes included from BaseMod</h3>
207
207
  <p class="inherited">#base_attr1, #base_attr2, #base_attr3</p>
208
208
 
209
209
 
210
-
210
+
211
211
  <h2>
212
212
  Class Method Summary
213
213
  <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
214
214
  </h2>
215
215
 
216
216
  <ul class="summary">
217
-
217
+
218
218
  <li class="public ">
219
219
  <span class="summary_signature">
220
-
220
+
221
221
  <a title="a (class method)">+ <strong>a</strong> </a>
222
-
223
222
 
224
-
223
+
224
+
225
225
  </span>
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
-
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
234
  <span class="summary_desc"><div class='inline'></div></span>
235
-
235
+
236
236
  </li>
237
237
 
238
-
238
+
239
239
  </ul>
240
-
240
+
241
241
  <h2>
242
242
  Instance Method Summary
243
243
  <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
244
244
  </h2>
245
245
 
246
246
  <ul class="summary">
247
-
247
+
248
248
  <li class="public ">
249
249
  <span class="summary_signature">
250
-
250
+
251
251
  <a title="#a (instance method)">- <strong>a</strong> </a>
252
-
253
252
 
254
-
253
+
254
+
255
255
  (also: #b)
256
-
256
+
257
257
  </span>
258
-
259
-
260
-
261
-
262
-
263
-
264
-
265
-
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
266
  <span class="summary_desc"><div class='inline'></div></span>
267
-
267
+
268
268
  </li>
269
269
 
270
-
270
+
271
271
  <li class="public ">
272
272
  <span class="summary_signature">
273
-
273
+
274
274
  <a title="#test_multi_overload (instance method)">- <strong>test_multi_overload</strong>(*args) </a>
275
-
276
275
 
277
-
276
+
277
+
278
278
  </span>
279
-
280
-
281
-
282
-
283
-
284
-
285
-
286
-
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
287
  <span class="summary_desc"><div class='inline'></div></span>
288
-
288
+
289
289
  </li>
290
290
 
291
-
291
+
292
292
  <li class="public ">
293
293
  <span class="summary_signature">
294
-
294
+
295
295
  <a title="#test_overload (instance method)">- <strong>test_overload</strong>(a) </a>
296
-
297
296
 
298
-
297
+
298
+
299
299
  </span>
300
-
301
-
302
-
303
-
304
-
305
-
306
-
307
-
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
308
  <span class="summary_desc"><div class='inline'>hello2.</div></span>
309
-
309
+
310
310
  </li>
311
311
 
312
-
312
+
313
313
  <li class="public ">
314
314
  <span class="summary_signature">
315
-
315
+
316
316
  <a title="#void_meth (instance method)">- <strong>void_meth</strong> </a>
317
-
318
317
 
319
-
318
+
319
+
320
320
  </span>
321
-
322
-
323
-
324
-
325
-
326
-
327
-
328
-
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
329
  <span class="summary_desc"><div class='inline'></div></span>
330
-
330
+
331
331
  </li>
332
332
 
333
-
333
+
334
334
  </ul>
335
-
336
335
 
337
336
 
338
-
339
-
340
-
341
-
342
-
343
-
344
-
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
345
  <h3 class="inherited">Methods included from B</h3>
346
346
  <p class="inherited">#c, #d</p>
347
347
 
348
-
349
-
350
-
351
-
352
-
348
+
349
+
350
+
351
+
352
+
353
353
  <div id="instance_attr_details" class="attr_details">
354
354
  <h2>Instance Attribute Details</h2>
355
-
356
-
355
+
356
+
357
357
  <span id="attr1=-instance_method"></span>
358
358
  <span id="attr1-instance_method"></span>
359
359
  <div class="method_details first">
360
- <p class="signature first" id="attr1-instance_method">
361
-
362
- - <strong>attr1</strong>
363
-
360
+ <h3 class="signature first" id="attr1-instance_method">
361
+
362
+ - <strong>attr1</strong>
363
+
364
364
 
365
-
366
- </p><div class="docstring">
365
+
366
+ </h3><div class="docstring">
367
367
  <div class="discussion">
368
368
  Returns the value of attribute attr1
369
369
 
370
370
  </div>
371
371
  </div>
372
372
  <div class="tags">
373
-
373
+
374
374
  </div><table class="source_code">
375
375
  <tr>
376
376
  <td>
@@ -391,25 +391,25 @@ end</pre>
391
391
  </tr>
392
392
  </table>
393
393
  </div>
394
-
395
-
394
+
395
+
396
396
  <span id=""></span>
397
397
  <span id="attr2-instance_method"></span>
398
398
  <div class="method_details ">
399
- <p class="signature " id="attr2-instance_method">
400
-
399
+ <h3 class="signature " id="attr2-instance_method">
400
+
401
401
  - <strong>attr2</strong> <span class="extras">(readonly)</span>
402
-
403
402
 
404
-
405
- </p><div class="docstring">
403
+
404
+
405
+ </h3><div class="docstring">
406
406
  <div class="discussion">
407
407
  Returns the value of attribute attr2
408
408
 
409
409
  </div>
410
410
  </div>
411
411
  <div class="tags">
412
-
412
+
413
413
  </div><table class="source_code">
414
414
  <tr>
415
415
  <td>
@@ -430,33 +430,33 @@ end</pre>
430
430
  </tr>
431
431
  </table>
432
432
  </div>
433
-
434
-
433
+
434
+
435
435
  <span id="attr3=-instance_method"></span>
436
436
  <span id="attr3-instance_method"></span>
437
437
  <div class="method_details ">
438
- <p class="signature " id="attr3-instance_method">
439
-
440
-
438
+ <h3 class="signature " id="attr3-instance_method">
439
+
440
+
441
441
  <span class="overload">- (<tt>String</tt>) <strong>attr3</strong> </span>
442
-
442
+
443
443
  <span class="overload">- <strong>attr3=</strong>(value) </span>
444
-
445
-
446
444
 
447
-
448
- </p><div class="docstring">
445
+
446
+
447
+
448
+ </h3><div class="docstring">
449
449
  <div class="discussion">
450
-
450
+
451
451
 
452
452
  </div>
453
453
  </div>
454
454
  <div class="tags">
455
-
456
- <h3>Overloads:</h3>
455
+
456
+ <p class="tag_title">Overloads:</p>
457
457
  <ul class="overload">
458
-
459
-
458
+
459
+
460
460
  <li class="overload_item">
461
461
  <span class="signature">- (<tt>String</tt>) <strong>attr3</strong> </span>
462
462
  <div class="docstring">
@@ -466,27 +466,27 @@ end</pre>
466
466
  </div>
467
467
  </div>
468
468
  <div class="tags">
469
- <h3>Returns:</h3>
469
+ <p class="tag_title">Returns:</p>
470
470
  <ul class="return">
471
-
471
+
472
472
  <li>
473
-
474
-
473
+
474
+
475
475
  <span class='type'>(<tt>String</tt>)</span>
476
-
477
-
478
-
476
+
477
+
478
+
479
479
  &mdash;
480
480
  <div class='inline'>a string</div>
481
-
481
+
482
482
  </li>
483
-
483
+
484
484
  </ul>
485
485
 
486
486
  </div>
487
487
  </li>
488
-
489
-
488
+
489
+
490
490
  <li class="overload_item">
491
491
  <span class="signature">- <strong>attr3=</strong>(value) </span>
492
492
  <div class="docstring">
@@ -496,28 +496,28 @@ end</pre>
496
496
  </div>
497
497
  </div>
498
498
  <div class="tags">
499
- <h3>Parameters:</h3>
499
+ <p class="tag_title">Parameters:</p>
500
500
  <ul class="param">
501
-
501
+
502
502
  <li>
503
-
503
+
504
504
  <span class='name'>value</span>
505
-
506
-
505
+
506
+
507
507
  <span class='type'>(<tt>String</tt>)</span>
508
-
509
-
510
-
508
+
509
+
510
+
511
511
  &mdash;
512
512
  <div class='inline'>sets the string</div>
513
-
513
+
514
514
  </li>
515
-
515
+
516
516
  </ul>
517
517
 
518
518
  </div>
519
519
  </li>
520
-
520
+
521
521
  </ul>
522
522
 
523
523
  </div><table class="source_code">
@@ -540,41 +540,41 @@ end</pre>
540
540
  </tr>
541
541
  </table>
542
542
  </div>
543
-
544
-
543
+
544
+
545
545
  <span id="attr4=-instance_method"></span>
546
546
  <span id=""></span>
547
547
  <div class="method_details ">
548
- <p class="signature " id="attr4=-instance_method">
549
-
548
+ <h3 class="signature " id="attr4=-instance_method">
549
+
550
550
  - <strong>attr4=</strong>(value) <span class="extras">(writeonly)</span>
551
-
552
551
 
553
-
554
- </p><div class="docstring">
552
+
553
+
554
+ </h3><div class="docstring">
555
555
  <div class="discussion">
556
556
  Sets the attribute attr4
557
557
 
558
558
  </div>
559
559
  </div>
560
560
  <div class="tags">
561
- <h3>Parameters:</h3>
561
+ <p class="tag_title">Parameters:</p>
562
562
  <ul class="param">
563
-
563
+
564
564
  <li>
565
-
565
+
566
566
  <span class='name'>value</span>
567
-
568
-
567
+
568
+
569
569
  <span class='type'></span>
570
-
571
-
572
-
570
+
571
+
572
+
573
573
  &mdash;
574
574
  <div class='inline'>the value to set the attribute attr4 to.</div>
575
-
575
+
576
576
  </li>
577
-
577
+
578
578
  </ul>
579
579
 
580
580
  </div><table class="source_code">
@@ -597,22 +597,22 @@ end</pre>
597
597
  </tr>
598
598
  </table>
599
599
  </div>
600
-
600
+
601
601
  </div>
602
602
 
603
603
 
604
604
  <div id="class_method_details" class="method_details_list">
605
605
  <h2>Class Method Details</h2>
606
-
607
-
606
+
607
+
608
608
  <div class="method_details first">
609
- <p class="signature first" id="a-class_method">
610
-
611
- + <strong>a</strong>
612
-
609
+ <h3 class="signature first" id="a-class_method">
613
610
 
614
-
615
- </p><table class="source_code">
611
+ + <strong>a</strong>
612
+
613
+
614
+
615
+ </h3><table class="source_code">
616
616
  <tr>
617
617
  <td>
618
618
  <pre class="lines">
@@ -628,25 +628,25 @@ def self.a; end</pre>
628
628
  </tr>
629
629
  </table>
630
630
  </div>
631
-
631
+
632
632
  </div>
633
633
 
634
634
  <div id="instance_method_details" class="method_details_list">
635
635
  <h2>Instance Method Details</h2>
636
-
637
-
636
+
637
+
638
638
  <div class="method_details first">
639
- <p class="signature first" id="a-instance_method">
640
-
641
- - <strong>a</strong>
642
-
639
+ <h3 class="signature first" id="a-instance_method">
640
+
641
+ - <strong>a</strong>
642
+
643
+
643
644
 
644
-
645
645
  <span class="aliases">Also known as:
646
646
  <span class="names"><span id='b-instance_method'>b</span></span>
647
647
  </span>
648
-
649
- </p><table class="source_code">
648
+
649
+ </h3><table class="source_code">
650
650
  <tr>
651
651
  <td>
652
652
  <pre class="lines">
@@ -662,26 +662,26 @@ def a; end</pre>
662
662
  </tr>
663
663
  </table>
664
664
  </div>
665
-
665
+
666
666
  <div class="method_details ">
667
- <p class="signature " id="test_multi_overload-instance_method">
668
-
669
-
667
+ <h3 class="signature " id="test_multi_overload-instance_method">
668
+
669
+
670
670
  <span class="overload">- <strong>test_multi_overload</strong>(a) </span>
671
-
671
+
672
672
  <span class="overload">- <strong>test_multi_overload</strong>(a, b) </span>
673
-
674
-
675
673
 
676
-
677
- </p><div class="docstring">
674
+
675
+
676
+
677
+ </h3><div class="docstring">
678
678
  <div class="discussion">
679
-
679
+
680
680
 
681
681
  </div>
682
682
  </div>
683
683
  <div class="tags">
684
-
684
+
685
685
  </div><table class="source_code">
686
686
  <tr>
687
687
  <td>
@@ -698,22 +698,22 @@ def test_multi_overload(*args) end</pre>
698
698
  </tr>
699
699
  </table>
700
700
  </div>
701
-
701
+
702
702
  <div class="method_details ">
703
- <p class="signature " id="test_overload-instance_method">
704
-
705
- - <strong>test_overload</strong>(a)
706
-
703
+ <h3 class="signature " id="test_overload-instance_method">
704
+
705
+ - <strong>test_overload</strong>(a)
706
+
707
707
 
708
-
709
- </p><div class="docstring">
708
+
709
+ </h3><div class="docstring">
710
710
  <div class="discussion">
711
-
711
+
712
712
 
713
713
  </div>
714
714
  </div>
715
715
  <div class="tags">
716
-
716
+
717
717
  <div class="docstring">
718
718
  <div class="discussion">
719
719
  hello2
@@ -721,23 +721,23 @@ def test_multi_overload(*args) end</pre>
721
721
  </div>
722
722
  </div>
723
723
  <div class="tags">
724
- <h3>Parameters:</h3>
724
+ <p class="tag_title">Parameters:</p>
725
725
  <ul class="param">
726
-
726
+
727
727
  <li>
728
-
728
+
729
729
  <span class='name'>a</span>
730
-
731
-
730
+
731
+
732
732
  <span class='type'>(<tt>String</tt>)</span>
733
-
734
-
735
-
733
+
734
+
735
+
736
736
  &mdash;
737
737
  <div class='inline'>hi</div>
738
-
738
+
739
739
  </li>
740
-
740
+
741
741
  </ul>
742
742
 
743
743
  </div>
@@ -758,22 +758,22 @@ def test_overload(*args) end</pre>
758
758
  </tr>
759
759
  </table>
760
760
  </div>
761
-
761
+
762
762
  <div class="method_details ">
763
- <p class="signature " id="void_meth-instance_method">
764
-
765
- - <strong>void_meth</strong>
766
-
763
+ <h3 class="signature " id="void_meth-instance_method">
764
+
765
+ - <strong>void_meth</strong>
767
766
 
768
-
769
- </p><div class="docstring">
767
+
768
+
769
+ </h3><div class="docstring">
770
770
  <div class="discussion">
771
771
  <p class="note returns_void">This method returns an undefined value.</p>
772
772
 
773
773
  </div>
774
774
  </div>
775
775
  <div class="tags">
776
-
776
+
777
777
  </div><table class="source_code">
778
778
  <tr>
779
779
  <td>
@@ -790,6 +790,6 @@ def void_meth; end</pre>
790
790
  </tr>
791
791
  </table>
792
792
  </div>
793
-
793
+
794
794
  </div>
795
795