yard 0.9.24 → 0.9.25

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 (223) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +37 -24
  3. data/CHANGELOG.md +18 -3
  4. data/README.md +96 -101
  5. data/Rakefile +2 -0
  6. data/lib/yard/cli/diff.rb +4 -1
  7. data/lib/yard/cli/server.rb +22 -13
  8. data/lib/yard/code_objects/proxy.rb +2 -1
  9. data/lib/yard/globals.rb +1 -1
  10. data/lib/yard/handlers/c/base.rb +164 -129
  11. data/lib/yard/parser/ruby/ruby_parser.rb +6 -4
  12. data/lib/yard/registry_store.rb +1 -1
  13. data/lib/yard/templates/helpers/html_helper.rb +10 -3
  14. data/lib/yard/templates/helpers/markup/rdoc_markup.rb +5 -4
  15. data/lib/yard/version.rb +1 -1
  16. data/tasks/update_error_map.rake +53 -0
  17. data/yard.gemspec +1 -1
  18. metadata +3 -207
  19. data/spec/cli/command_parser_spec.rb +0 -43
  20. data/spec/cli/command_spec.rb +0 -36
  21. data/spec/cli/config_spec.rb +0 -148
  22. data/spec/cli/diff_spec.rb +0 -254
  23. data/spec/cli/display_spec.rb +0 -30
  24. data/spec/cli/gems_spec.rb +0 -81
  25. data/spec/cli/graph_spec.rb +0 -18
  26. data/spec/cli/help_spec.rb +0 -22
  27. data/spec/cli/i18n_spec.rb +0 -107
  28. data/spec/cli/list_spec.rb +0 -8
  29. data/spec/cli/markup_types_spec.rb +0 -22
  30. data/spec/cli/server_spec.rb +0 -324
  31. data/spec/cli/stats_spec.rb +0 -96
  32. data/spec/cli/yard_on_yard_spec.rb +0 -38
  33. data/spec/cli/yardoc_spec.rb +0 -896
  34. data/spec/cli/yri_spec.rb +0 -101
  35. data/spec/code_objects/base_spec.rb +0 -485
  36. data/spec/code_objects/class_object_spec.rb +0 -226
  37. data/spec/code_objects/code_object_list_spec.rb +0 -36
  38. data/spec/code_objects/constants_spec.rb +0 -116
  39. data/spec/code_objects/extra_file_object_spec.rb +0 -161
  40. data/spec/code_objects/macro_object_spec.rb +0 -150
  41. data/spec/code_objects/method_object_spec.rb +0 -184
  42. data/spec/code_objects/module_object_spec.rb +0 -142
  43. data/spec/code_objects/namespace_mapper_spec.rb +0 -32
  44. data/spec/code_objects/namespace_object_spec.rb +0 -171
  45. data/spec/code_objects/proxy_spec.rb +0 -147
  46. data/spec/code_objects/spec_helper.rb +0 -3
  47. data/spec/config_spec.rb +0 -171
  48. data/spec/core_ext/array_spec.rb +0 -13
  49. data/spec/core_ext/file_spec.rb +0 -72
  50. data/spec/core_ext/hash_spec.rb +0 -14
  51. data/spec/core_ext/insertion_spec.rb +0 -37
  52. data/spec/core_ext/module_spec.rb +0 -9
  53. data/spec/core_ext/string_spec.rb +0 -42
  54. data/spec/core_ext/symbol_hash_spec.rb +0 -89
  55. data/spec/docstring_parser_spec.rb +0 -280
  56. data/spec/docstring_spec.rb +0 -373
  57. data/spec/handlers/alias_handler_spec.rb +0 -82
  58. data/spec/handlers/attribute_handler_spec.rb +0 -96
  59. data/spec/handlers/base_spec.rb +0 -216
  60. data/spec/handlers/c/alias_handler_spec.rb +0 -34
  61. data/spec/handlers/c/attribute_handler_spec.rb +0 -41
  62. data/spec/handlers/c/class_handler_spec.rb +0 -78
  63. data/spec/handlers/c/constant_handler_spec.rb +0 -71
  64. data/spec/handlers/c/init_handler_spec.rb +0 -48
  65. data/spec/handlers/c/method_handler_spec.rb +0 -327
  66. data/spec/handlers/c/mixin_handler_spec.rb +0 -44
  67. data/spec/handlers/c/module_handler_spec.rb +0 -71
  68. data/spec/handlers/c/override_comment_handler_spec.rb +0 -47
  69. data/spec/handlers/c/path_handler_spec.rb +0 -36
  70. data/spec/handlers/c/spec_helper.rb +0 -23
  71. data/spec/handlers/c/struct_handler_spec.rb +0 -16
  72. data/spec/handlers/class_condition_handler_spec.rb +0 -87
  73. data/spec/handlers/class_handler_spec.rb +0 -247
  74. data/spec/handlers/class_method_handler_shared_examples.rb +0 -133
  75. data/spec/handlers/class_variable_handler_spec.rb +0 -12
  76. data/spec/handlers/constant_handler_spec.rb +0 -112
  77. data/spec/handlers/decorator_handler_methods_spec.rb +0 -393
  78. data/spec/handlers/dsl_handler_spec.rb +0 -226
  79. data/spec/handlers/examples/alias_handler_001.rb.txt +0 -46
  80. data/spec/handlers/examples/attribute_handler_001.rb.txt +0 -32
  81. data/spec/handlers/examples/class_condition_handler_001.rb.txt +0 -69
  82. data/spec/handlers/examples/class_handler_001.rb.txt +0 -120
  83. data/spec/handlers/examples/class_variable_handler_001.rb.txt +0 -10
  84. data/spec/handlers/examples/constant_handler_001.rb.txt +0 -35
  85. data/spec/handlers/examples/dsl_handler_001.rb.txt +0 -156
  86. data/spec/handlers/examples/exception_handler_001.rb.txt +0 -59
  87. data/spec/handlers/examples/extend_handler_001.rb.txt +0 -19
  88. data/spec/handlers/examples/method_condition_handler_001.rb.txt +0 -10
  89. data/spec/handlers/examples/method_handler_001.rb.txt +0 -128
  90. data/spec/handlers/examples/mixin_handler_001.rb.txt +0 -40
  91. data/spec/handlers/examples/module_handler_001.rb.txt +0 -29
  92. data/spec/handlers/examples/private_constant_handler_001.rb.txt +0 -8
  93. data/spec/handlers/examples/process_handler_001.rb.txt +0 -11
  94. data/spec/handlers/examples/visibility_handler_001.rb.txt +0 -36
  95. data/spec/handlers/examples/yield_handler_001.rb.txt +0 -54
  96. data/spec/handlers/exception_handler_spec.rb +0 -49
  97. data/spec/handlers/extend_handler_spec.rb +0 -28
  98. data/spec/handlers/legacy_base_spec.rb +0 -128
  99. data/spec/handlers/method_condition_handler_spec.rb +0 -15
  100. data/spec/handlers/method_handler_spec.rb +0 -214
  101. data/spec/handlers/mixin_handler_spec.rb +0 -60
  102. data/spec/handlers/module_function_handler_spec.rb +0 -106
  103. data/spec/handlers/module_handler_spec.rb +0 -35
  104. data/spec/handlers/private_class_method_handler_spec.rb +0 -11
  105. data/spec/handlers/private_constant_handler_spec.rb +0 -25
  106. data/spec/handlers/processor_spec.rb +0 -35
  107. data/spec/handlers/public_class_method_handler_spec.rb +0 -11
  108. data/spec/handlers/ruby/base_spec.rb +0 -95
  109. data/spec/handlers/ruby/legacy/base_spec.rb +0 -84
  110. data/spec/handlers/spec_helper.rb +0 -33
  111. data/spec/handlers/visibility_handler_spec.rb +0 -44
  112. data/spec/handlers/yield_handler_spec.rb +0 -52
  113. data/spec/i18n/locale_spec.rb +0 -81
  114. data/spec/i18n/message_spec.rb +0 -52
  115. data/spec/i18n/messages_spec.rb +0 -67
  116. data/spec/i18n/pot_generator_spec.rb +0 -295
  117. data/spec/i18n/text_spec.rb +0 -184
  118. data/spec/logging_spec.rb +0 -44
  119. data/spec/options_spec.rb +0 -171
  120. data/spec/parser/base_spec.rb +0 -24
  121. data/spec/parser/c_parser_spec.rb +0 -236
  122. data/spec/parser/examples/array.c.txt +0 -6267
  123. data/spec/parser/examples/example1.rb.txt +0 -8
  124. data/spec/parser/examples/extrafile.c.txt +0 -8
  125. data/spec/parser/examples/file.c.txt +0 -28
  126. data/spec/parser/examples/multifile.c.txt +0 -22
  127. data/spec/parser/examples/namespace.cpp.txt +0 -68
  128. data/spec/parser/examples/override.c.txt +0 -424
  129. data/spec/parser/examples/parse_in_order_001.rb.txt +0 -2
  130. data/spec/parser/examples/parse_in_order_002.rb.txt +0 -2
  131. data/spec/parser/examples/tag_handler_001.rb.txt +0 -8
  132. data/spec/parser/ruby/ast_node_spec.rb +0 -33
  133. data/spec/parser/ruby/legacy/statement_list_spec.rb +0 -299
  134. data/spec/parser/ruby/legacy/token_list_spec.rb +0 -79
  135. data/spec/parser/ruby/ruby_parser_spec.rb +0 -520
  136. data/spec/parser/ruby/token_resolver_spec.rb +0 -165
  137. data/spec/parser/source_parser_spec.rb +0 -727
  138. data/spec/parser/tag_parsing_spec.rb +0 -17
  139. data/spec/rake/yardoc_task_spec.rb +0 -118
  140. data/spec/registry_resolver_spec.rb +0 -15
  141. data/spec/registry_spec.rb +0 -463
  142. data/spec/registry_store_spec.rb +0 -327
  143. data/spec/rubygems/doc_manager_spec.rb +0 -112
  144. data/spec/serializers/data/serialized_yardoc/checksums +0 -1
  145. data/spec/serializers/data/serialized_yardoc/objects/Foo.dat +0 -0
  146. data/spec/serializers/data/serialized_yardoc/objects/Foo/bar_i.dat +0 -0
  147. data/spec/serializers/data/serialized_yardoc/objects/Foo/baz_i.dat +0 -0
  148. data/spec/serializers/data/serialized_yardoc/objects/root.dat +0 -0
  149. data/spec/serializers/data/serialized_yardoc/proxy_types +0 -2
  150. data/spec/serializers/file_system_serializer_spec.rb +0 -145
  151. data/spec/serializers/spec_helper.rb +0 -2
  152. data/spec/serializers/yardoc_serializer_spec.rb +0 -90
  153. data/spec/server/adapter_spec.rb +0 -39
  154. data/spec/server/commands/base_spec.rb +0 -91
  155. data/spec/server/commands/library_command_spec.rb +0 -39
  156. data/spec/server/doc_server_helper_spec.rb +0 -72
  157. data/spec/server/doc_server_serializer_spec.rb +0 -60
  158. data/spec/server/rack_adapter_spec.rb +0 -21
  159. data/spec/server/router_spec.rb +0 -123
  160. data/spec/server/spec_helper.rb +0 -22
  161. data/spec/server/static_caching_spec.rb +0 -47
  162. data/spec/server/webrick_servlet_spec.rb +0 -20
  163. data/spec/server_spec.rb +0 -19
  164. data/spec/spec_helper.rb +0 -212
  165. data/spec/tags/default_factory_spec.rb +0 -168
  166. data/spec/tags/default_tag_spec.rb +0 -11
  167. data/spec/tags/directives_spec.rb +0 -463
  168. data/spec/tags/library_spec.rb +0 -48
  169. data/spec/tags/overload_tag_spec.rb +0 -53
  170. data/spec/tags/ref_tag_list_spec.rb +0 -53
  171. data/spec/tags/types_explainer_spec.rb +0 -203
  172. data/spec/templates/class_spec.rb +0 -45
  173. data/spec/templates/constant_spec.rb +0 -41
  174. data/spec/templates/engine_spec.rb +0 -131
  175. data/spec/templates/examples/class001.html +0 -308
  176. data/spec/templates/examples/class001.txt +0 -36
  177. data/spec/templates/examples/class002.html +0 -39
  178. data/spec/templates/examples/constant001.txt +0 -25
  179. data/spec/templates/examples/constant002.txt +0 -7
  180. data/spec/templates/examples/constant003.txt +0 -11
  181. data/spec/templates/examples/method001.html +0 -137
  182. data/spec/templates/examples/method001.txt +0 -35
  183. data/spec/templates/examples/method002.html +0 -91
  184. data/spec/templates/examples/method002.txt +0 -20
  185. data/spec/templates/examples/method003.html +0 -165
  186. data/spec/templates/examples/method003.txt +0 -45
  187. data/spec/templates/examples/method004.html +0 -48
  188. data/spec/templates/examples/method004.txt +0 -10
  189. data/spec/templates/examples/method005.html +0 -105
  190. data/spec/templates/examples/method005.txt +0 -33
  191. data/spec/templates/examples/method006.html +0 -108
  192. data/spec/templates/examples/method006.txt +0 -20
  193. data/spec/templates/examples/module001.dot +0 -33
  194. data/spec/templates/examples/module001.html +0 -833
  195. data/spec/templates/examples/module001.txt +0 -33
  196. data/spec/templates/examples/module002.html +0 -341
  197. data/spec/templates/examples/module003.html +0 -202
  198. data/spec/templates/examples/module004.html +0 -394
  199. data/spec/templates/examples/module005.html +0 -82
  200. data/spec/templates/examples/tag001.txt +0 -82
  201. data/spec/templates/helpers/base_helper_spec.rb +0 -171
  202. data/spec/templates/helpers/html_helper_spec.rb +0 -666
  203. data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb +0 -65
  204. data/spec/templates/helpers/markup/rdoc_markup_spec.rb +0 -84
  205. data/spec/templates/helpers/markup_helper_spec.rb +0 -136
  206. data/spec/templates/helpers/method_helper_spec.rb +0 -107
  207. data/spec/templates/helpers/module_helper_spec.rb +0 -35
  208. data/spec/templates/helpers/shared_signature_examples.rb +0 -126
  209. data/spec/templates/helpers/text_helper_spec.rb +0 -65
  210. data/spec/templates/markup_processor_integrations/asciidoctor_spec.rb +0 -60
  211. data/spec/templates/markup_processor_integrations/integration_spec_helper.rb +0 -50
  212. data/spec/templates/markup_processor_integrations/rdoc_markdown_spec.rb +0 -48
  213. data/spec/templates/markup_processor_integrations/rdoc_spec.rb +0 -39
  214. data/spec/templates/markup_processor_integrations/redcarpet_spec.rb +0 -64
  215. data/spec/templates/markup_processor_integrations/redcloth_spec.rb +0 -64
  216. data/spec/templates/method_spec.rb +0 -118
  217. data/spec/templates/module_spec.rb +0 -203
  218. data/spec/templates/onefile_spec.rb +0 -66
  219. data/spec/templates/section_spec.rb +0 -144
  220. data/spec/templates/spec_helper.rb +0 -76
  221. data/spec/templates/tag_spec.rb +0 -52
  222. data/spec/templates/template_spec.rb +0 -410
  223. data/spec/verifier_spec.rb +0 -106
@@ -1,45 +0,0 @@
1
- ------------------------------------------------------------- Method: #m
2
- (Defined in: (stdin))
3
-
4
- root.m(x, y) (private)
5
- root.m(x, y, z) (private)
6
- ------------------------------------------------------------------------
7
-
8
- Method comments
9
-
10
- Overloads:
11
- ----------
12
-
13
- ------------------------------------------------------------------------
14
- root.m(x, y) (private)
15
- ------------------------------------------------------------------------
16
-
17
- Overload docstring
18
-
19
- Parameters:
20
- -----------
21
-
22
- (String) x - parameter x
23
-
24
- (Boolean) y - parameter y
25
-
26
-
27
-
28
- ------------------------------------------------------------------------
29
- root.m(x, y, z) (private)
30
- ------------------------------------------------------------------------
31
-
32
-
33
- Parameters:
34
- -----------
35
-
36
- (String) x - parameter x
37
-
38
- (Boolean) y - parameter y
39
-
40
- (Boolean) z - parameter z
41
-
42
-
43
-
44
-
45
-
@@ -1,48 +0,0 @@
1
- <h1>Method: #m</h1>
2
- <div class="box_info">
3
- <dl>
4
- <dt class="">Defined in:</dt>
5
- <dd class="">
6
- (stdin)
7
- </dd>
8
- </dl>
9
- </div>
10
-
11
- <div class="method_details_list">
12
- <div id="method_details">
13
- <div class="method_details first">
14
- <h3 class="signature first" id="m-instance_method">
15
-
16
- #<strong>m</strong>(*args) &#x21d2; <tt>void</tt>
17
-
18
-
19
-
20
-
21
-
22
- </h3><div class="docstring">
23
- <div class="discussion">
24
- <p class="note returns_void">This method returns an undefined value.</p>
25
-
26
- </div>
27
- </div>
28
- <div class="tags">
29
-
30
-
31
- </div><table class="source_code">
32
- <tr>
33
- <td>
34
- <pre class="lines">
35
-
36
-
37
- 2</pre>
38
- </td>
39
- <td>
40
- <pre class="code"><span class="info file"># File '(stdin)', line 2</span>
41
-
42
- def m(*args) end</pre>
43
- </td>
44
- </tr>
45
- </table>
46
- </div>
47
- </div>
48
- </div>
@@ -1,10 +0,0 @@
1
- ------------------------------------------------------------- Method: #m
2
- (Defined in: (stdin))
3
-
4
- root.m(*args) -> void
5
- ------------------------------------------------------------------------
6
-
7
- This method returns an undefined value.
8
-
9
-
10
-
@@ -1,105 +0,0 @@
1
- <h1>Method: #m</h1>
2
- <div class="box_info">
3
- <dl>
4
- <dt class="">Defined in:</dt>
5
- <dd class="">
6
- (stdin)
7
- </dd>
8
- </dl>
9
- </div>
10
-
11
- <div class="method_details_list">
12
- <div id="method_details">
13
- <div class="method_details first">
14
- <h3 class="signature first" id="m-instance_method">
15
-
16
-
17
- <span class="overload">#<strong>m</strong>(a) &#x21d2; <tt>void</tt> </span>
18
-
19
- <span class="overload">#<strong>m</strong>(b) </span>
20
-
21
-
22
-
23
-
24
-
25
-
26
- </h3><div class="docstring">
27
- <div class="discussion">
28
-
29
-
30
- </div>
31
- </div>
32
- <div class="tags">
33
-
34
- <p class="tag_title">Overloads:</p>
35
- <ul class="overload">
36
-
37
-
38
- <li class="overload_item">
39
- <span class="signature">#<strong>m</strong>(a) &#x21d2; <tt>void</tt> </span>
40
- <div class="docstring">
41
- <div class="discussion">
42
- <p class="note returns_void">This method returns an undefined value.</p>
43
-
44
- </div>
45
- </div>
46
- <div class="tags">
47
-
48
-
49
- </div>
50
- </li>
51
-
52
-
53
- <li class="overload_item">
54
- <span class="signature">#<strong>m</strong>(b) </span>
55
- <div class="docstring">
56
- <div class="discussion">
57
-
58
-
59
- </div>
60
- </div>
61
- <div class="tags">
62
- <p class="tag_title">Parameters:</p>
63
- <ul class="param">
64
-
65
- <li>
66
-
67
- <span class='name'>b</span>
68
-
69
-
70
- <span class='type'>(<tt>String</tt>)</span>
71
-
72
-
73
-
74
- &mdash;
75
- <div class='inline'>hi</div>
76
-
77
- </li>
78
-
79
- </ul>
80
-
81
-
82
- </div>
83
- </li>
84
-
85
- </ul>
86
-
87
-
88
- </div><table class="source_code">
89
- <tr>
90
- <td>
91
- <pre class="lines">
92
-
93
-
94
- 5</pre>
95
- </td>
96
- <td>
97
- <pre class="code"><span class="info file"># File '(stdin)', line 5</span>
98
-
99
- def m(*args) end</pre>
100
- </td>
101
- </tr>
102
- </table>
103
- </div>
104
- </div>
105
- </div>
@@ -1,33 +0,0 @@
1
- ------------------------------------------------------------- Method: #m
2
- (Defined in: (stdin))
3
-
4
- root.m(a) -> void
5
- root.m(b)
6
- ------------------------------------------------------------------------
7
-
8
-
9
- Overloads:
10
- ----------
11
-
12
- ------------------------------------------------------------------------
13
- root.m(a) -> void
14
- ------------------------------------------------------------------------
15
-
16
- This method returns an undefined value.
17
-
18
-
19
-
20
- ------------------------------------------------------------------------
21
- root.m(b)
22
- ------------------------------------------------------------------------
23
-
24
-
25
- Parameters:
26
- -----------
27
-
28
- (String) b - hi
29
-
30
-
31
-
32
-
33
-
@@ -1,108 +0,0 @@
1
- <h1>Method: #m</h1>
2
- <div class="box_info">
3
- <dl>
4
- <dt class="">Defined in:</dt>
5
- <dd class="">
6
- (stdin)
7
- </dd>
8
- </dl>
9
- </div>
10
-
11
- <div class="method_details_list">
12
- <div id="method_details">
13
- <div class="method_details first">
14
- <h3 class="signature first" id="m-instance_method">
15
-
16
- #<strong>m</strong>(x, y, *args, kword1: 123, kword2:)
17
-
18
-
19
-
20
-
21
-
22
- </h3><div class="docstring">
23
- <div class="discussion">
24
-
25
-
26
- </div>
27
- </div>
28
- <div class="tags">
29
- <p class="tag_title">Parameters:</p>
30
- <ul class="param">
31
-
32
- <li>
33
-
34
- <span class='name'>x</span>
35
-
36
-
37
- <span class='type'>(<tt>String</tt>)</span>
38
-
39
-
40
-
41
- &mdash;
42
- <div class='inline'>the x argument</div>
43
-
44
- </li>
45
-
46
- <li>
47
-
48
- <span class='name'>y</span>
49
-
50
-
51
- <span class='type'>(<tt>Boolean</tt>)</span>
52
-
53
-
54
-
55
- &mdash;
56
- <div class='inline'>the y argument</div>
57
-
58
- </li>
59
-
60
- <li>
61
-
62
- <span class='name'>keyword</span>
63
-
64
-
65
- <span class='type'>(<tt>kword1</tt>)</span>
66
-
67
-
68
-
69
- &mdash;
70
- <div class='inline'>1</div>
71
-
72
- </li>
73
-
74
- <li>
75
-
76
- <span class='name'>keyword</span>
77
-
78
-
79
- <span class='type'>(<tt>kword2</tt>)</span>
80
-
81
-
82
-
83
- &mdash;
84
- <div class='inline'>2</div>
85
-
86
- </li>
87
-
88
- </ul>
89
-
90
-
91
- </div><table class="source_code">
92
- <tr>
93
- <td>
94
- <pre class="lines">
95
-
96
-
97
- 5</pre>
98
- </td>
99
- <td>
100
- <pre class="code"><span class="info file"># File '(stdin)', line 5</span>
101
-
102
- def m(x, y, *args, kword1: 123, kword2:, **) end</pre>
103
- </td>
104
- </tr>
105
- </table>
106
- </div>
107
- </div>
108
- </div>
@@ -1,20 +0,0 @@
1
- ------------------------------------------------------------- Method: #m
2
- (Defined in: (stdin))
3
-
4
- root.m(x, y, *args, kword1: 123, kword2:)
5
- ------------------------------------------------------------------------
6
-
7
-
8
- Parameters:
9
- -----------
10
-
11
- (String) x - the x argument
12
-
13
- (Boolean) y - the y argument
14
-
15
- (kword1) keyword - 1
16
-
17
- (kword2) keyword - 2
18
-
19
-
20
-
@@ -1,33 +0,0 @@
1
- A [label="{module A|+ \#attr1 [RW]\l+ \#attr2 [R]\l+ \#attr3 [RW]\l+ \#attr4 [W]\l|+ a\l+ \#a\l+ \#test_multi_overload\l+ \#test_overload\l+ \#void_meth\ \:\ void\l}" rank=sink];
2
- A_Y [label="{class Y||}" rank=sink];
3
- subgraph cluster_A_Y {
4
- label = "Y"; labelloc=b;
5
-
6
- }
7
-
8
- A_Q [label="{class Q||}" rank=sink];
9
- subgraph cluster_A_Q {
10
- label = "Q"; labelloc=b;
11
-
12
- }
13
-
14
- A_X [label="{class X||}" rank=sink];
15
- subgraph cluster_A_X {
16
- label = "X"; labelloc=b;
17
-
18
- }
19
- subgraph cluster_A {
20
- label = "A"; labelloc=b;
21
-
22
- A_Z [label="{module Z||}" rank=sink];
23
- subgraph cluster_A_Z {
24
- label = "Z"; labelloc=b;
25
-
26
- }
27
-
28
-
29
- }
30
-
31
- A -> B [style=dotted arrowType=none];
32
-
33
- A -> BaseMod [style=dotted arrowType=none];
@@ -1,833 +0,0 @@
1
- <h1>Module: A
2
-
3
-
4
-
5
- </h1>
6
- <div class="box_info">
7
-
8
-
9
-
10
-
11
-
12
-
13
- <dl>
14
- <dt>Includes:</dt>
15
- <dd>B, BaseMod</dd>
16
- </dl>
17
-
18
-
19
-
20
-
21
- <dl>
22
- <dt>Included in:</dt>
23
- <dd>TMP, TMP2</dd>
24
- </dl>
25
-
26
-
27
-
28
- <dl>
29
- <dt>Defined in:</dt>
30
- <dd>(stdin)</dd>
31
- </dl>
32
-
33
- </div>
34
-
35
- <h2>Overview</h2><div class="docstring">
36
- <div class="discussion">
37
- Comments
38
-
39
- </div>
40
- </div>
41
- <div class="tags">
42
-
43
-
44
- </div><h2>Defined Under Namespace</h2>
45
- <p class="children">
46
-
47
-
48
- <strong class="modules">Modules:</strong> Z
49
-
50
-
51
-
52
- <strong class="classes">Classes:</strong> Q, X, Y
53
-
54
-
55
- </p>
56
-
57
- <h2>
58
- Constant Summary
59
-
60
- <small><a href="#" class="constants_summary_toggle">collapse</a></small>
61
- </h2>
62
-
63
- <dl class="constants">
64
-
65
- <dt id="CONSTANT-constant" class="">CONSTANT =
66
- <div class="docstring">
67
- <div class="discussion">
68
- A long docstring for the constant. With extra text
69
- and newlines.
70
-
71
- </div>
72
- </div>
73
- <div class="tags">
74
-
75
-
76
- </div>
77
- </dt>
78
- <dd><pre class="code">&#39;value&#39;</pre></dd>
79
-
80
- <dt id="cvar-classvariable" class="deprecated">@@cvar =
81
- <div class="docstring">
82
- <div class="discussion">
83
- <div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'></div></div>
84
-
85
-
86
- </div>
87
- </div>
88
- <div class="tags">
89
-
90
-
91
- </div>
92
- </dt>
93
- <dd><pre class="code">&#39;value&#39;</pre></dd>
94
-
95
- </dl>
96
-
97
-
98
-
99
-
100
-
101
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
102
- <ul class="summary">
103
-
104
- <li class="public ">
105
- <span class="summary_signature">
106
-
107
- <a title="#attr1 (instance method)">#<strong>attr1</strong> </a>
108
-
109
-
110
-
111
- </span>
112
-
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
-
124
- <span class="summary_desc"><div class='inline'>Returns the value of attribute attr1.</div></span>
125
-
126
- </li>
127
-
128
-
129
- <li class="public ">
130
- <span class="summary_signature">
131
-
132
- <a title="#attr2 (instance method)">#<strong>attr2</strong> </a>
133
-
134
-
135
-
136
- </span>
137
-
138
-
139
-
140
-
141
- <span class="note title readonly">readonly</span>
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
- <span class="summary_desc"><div class='inline'>Returns the value of attribute attr2.</div></span>
152
-
153
- </li>
154
-
155
-
156
- <li class="public ">
157
- <span class="summary_signature">
158
-
159
- <a title="#attr3 (instance method)">#<strong>attr3</strong> </a>
160
-
161
-
162
-
163
- </span>
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
-
174
-
175
-
176
- <span class="summary_desc"><div class='inline'></div></span>
177
-
178
- </li>
179
-
180
-
181
- <li class="public ">
182
- <span class="summary_signature">
183
-
184
- <a title="#attr4= (instance method)">#<strong>attr4</strong> </a>
185
-
186
-
187
-
188
- </span>
189
-
190
-
191
-
192
-
193
-
194
- <span class="note title writeonly">writeonly</span>
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
-
203
- <span class="summary_desc"><div class='inline'>Sets the attribute attr4.</div></span>
204
-
205
- </li>
206
-
207
-
208
- </ul>
209
-
210
-
211
-
212
-
213
-
214
- <h3 class="inherited">Attributes included from BaseMod</h3>
215
- <p class="inherited">#base_attr1, #base_attr2, #base_attr3</p>
216
-
217
-
218
-
219
- <h2>
220
- Class Method Summary
221
- <small><a href="#" class="summary_toggle">collapse</a></small>
222
- </h2>
223
-
224
- <ul class="summary">
225
-
226
- <li class="public ">
227
- <span class="summary_signature">
228
-
229
- <a title="a (class method)">.<strong>a</strong> </a>
230
-
231
-
232
-
233
- </span>
234
-
235
-
236
-
237
-
238
-
239
-
240
-
241
-
242
-
243
- <span class="summary_desc"><div class='inline'></div></span>
244
-
245
- </li>
246
-
247
-
248
- </ul>
249
-
250
- <h2>
251
- Instance Method Summary
252
- <small><a href="#" class="summary_toggle">collapse</a></small>
253
- </h2>
254
-
255
- <ul class="summary">
256
-
257
- <li class="public ">
258
- <span class="summary_signature">
259
-
260
- <a title="#a (instance method)">#<strong>a</strong> </a>
261
-
262
-
263
-
264
- (also: #b)
265
-
266
- </span>
267
-
268
-
269
-
270
-
271
-
272
-
273
-
274
-
275
-
276
- <span class="summary_desc"><div class='inline'></div></span>
277
-
278
- </li>
279
-
280
-
281
- <li class="public ">
282
- <span class="summary_signature">
283
-
284
- <a title="#test_multi_overload (instance method)">#<strong>test_multi_overload</strong>(*args) </a>
285
-
286
-
287
-
288
- </span>
289
-
290
-
291
-
292
-
293
-
294
-
295
-
296
-
297
-
298
- <span class="summary_desc"><div class='inline'></div></span>
299
-
300
- </li>
301
-
302
-
303
- <li class="public ">
304
- <span class="summary_signature">
305
-
306
- <a title="#test_overload (instance method)">#<strong>test_overload</strong>(a) </a>
307
-
308
-
309
-
310
- </span>
311
-
312
-
313
-
314
-
315
-
316
-
317
-
318
-
319
-
320
- <span class="summary_desc"><div class='inline'>hello2.</div></span>
321
-
322
- </li>
323
-
324
-
325
- <li class="public ">
326
- <span class="summary_signature">
327
-
328
- <a title="#void_meth (instance method)">#<strong>void_meth</strong> </a>
329
-
330
-
331
-
332
- </span>
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
- <span class="summary_desc"><div class='inline'></div></span>
343
-
344
- </li>
345
-
346
-
347
- </ul>
348
-
349
-
350
-
351
-
352
-
353
-
354
-
355
-
356
-
357
-
358
-
359
- <h3 class="inherited">Methods included from B</h3>
360
- <p class="inherited">#c, #d</p>
361
-
362
-
363
-
364
-
365
-
366
-
367
-
368
- <div id="instance_attr_details" class="attr_details">
369
- <h2>Instance Attribute Details</h2>
370
-
371
-
372
- <span id="attr1=-instance_method"></span>
373
- <div class="method_details first">
374
- <h3 class="signature first" id="attr1-instance_method">
375
-
376
- #<strong>attr1</strong>
377
-
378
-
379
-
380
-
381
-
382
- </h3><div class="docstring">
383
- <div class="discussion">
384
- Returns the value of attribute attr1.
385
-
386
- </div>
387
- </div>
388
- <div class="tags">
389
-
390
-
391
- </div><table class="source_code">
392
- <tr>
393
- <td>
394
- <pre class="lines">
395
-
396
-
397
- 17
398
- 18
399
- 19</pre>
400
- </td>
401
- <td>
402
- <pre class="code"><span class="info file"># File '(stdin)', line 17</span>
403
-
404
- def attr1
405
- @attr1
406
- end</pre>
407
- </td>
408
- </tr>
409
- </table>
410
- </div>
411
-
412
-
413
- <span id=""></span>
414
- <div class="method_details ">
415
- <h3 class="signature " id="attr2-instance_method">
416
-
417
- #<strong>attr2</strong> <span class="extras">(readonly)</span>
418
-
419
-
420
-
421
-
422
-
423
- </h3><div class="docstring">
424
- <div class="discussion">
425
- Returns the value of attribute attr2.
426
-
427
- </div>
428
- </div>
429
- <div class="tags">
430
-
431
-
432
- </div><table class="source_code">
433
- <tr>
434
- <td>
435
- <pre class="lines">
436
-
437
-
438
- 18
439
- 19
440
- 20</pre>
441
- </td>
442
- <td>
443
- <pre class="code"><span class="info file"># File '(stdin)', line 18</span>
444
-
445
- def attr2
446
- @attr2
447
- end</pre>
448
- </td>
449
- </tr>
450
- </table>
451
- </div>
452
-
453
-
454
- <span id="attr3=-instance_method"></span>
455
- <div class="method_details ">
456
- <h3 class="signature " id="attr3-instance_method">
457
-
458
-
459
- <span class="overload">#<strong>attr3</strong> &#x21d2; <tt>String</tt> </span>
460
-
461
- <span class="overload">#<strong>attr3=</strong>(value) </span>
462
-
463
-
464
-
465
-
466
-
467
-
468
- </h3><div class="docstring">
469
- <div class="discussion">
470
-
471
-
472
- </div>
473
- </div>
474
- <div class="tags">
475
-
476
- <p class="tag_title">Overloads:</p>
477
- <ul class="overload">
478
-
479
-
480
- <li class="overload_item">
481
- <span class="signature">#<strong>attr3</strong> &#x21d2; <tt>String</tt> </span>
482
- <div class="docstring">
483
- <div class="discussion">
484
- Returns a string.
485
-
486
- </div>
487
- </div>
488
- <div class="tags">
489
-
490
- <p class="tag_title">Returns:</p>
491
- <ul class="return">
492
-
493
- <li>
494
-
495
-
496
- <span class='type'>(<tt>String</tt>)</span>
497
-
498
-
499
-
500
- &mdash;
501
- <div class='inline'>a string</div>
502
-
503
- </li>
504
-
505
- </ul>
506
-
507
- </div>
508
- </li>
509
-
510
-
511
- <li class="overload_item">
512
- <span class="signature">#<strong>attr3=</strong>(value) </span>
513
- <div class="docstring">
514
- <div class="discussion">
515
- <p class="note returns_void">This method returns an undefined value.</p>
516
-
517
- </div>
518
- </div>
519
- <div class="tags">
520
- <p class="tag_title">Parameters:</p>
521
- <ul class="param">
522
-
523
- <li>
524
-
525
- <span class='name'>value</span>
526
-
527
-
528
- <span class='type'>(<tt>String</tt>)</span>
529
-
530
-
531
-
532
- &mdash;
533
- <div class='inline'>sets the string</div>
534
-
535
- </li>
536
-
537
- </ul>
538
-
539
-
540
- </div>
541
- </li>
542
-
543
- </ul>
544
-
545
-
546
- </div><table class="source_code">
547
- <tr>
548
- <td>
549
- <pre class="lines">
550
-
551
-
552
- 25
553
- 26
554
- 27</pre>
555
- </td>
556
- <td>
557
- <pre class="code"><span class="info file"># File '(stdin)', line 25</span>
558
-
559
- def attr3
560
- @attr3
561
- end</pre>
562
- </td>
563
- </tr>
564
- </table>
565
- </div>
566
-
567
-
568
- <span id=""></span>
569
- <div class="method_details ">
570
- <h3 class="signature " id="attr4=-instance_method">
571
-
572
- #<strong>attr4=</strong>(value) <span class="extras">(writeonly)</span>
573
-
574
-
575
-
576
-
577
-
578
- </h3><div class="docstring">
579
- <div class="discussion">
580
- Sets the attribute attr4
581
-
582
- </div>
583
- </div>
584
- <div class="tags">
585
- <p class="tag_title">Parameters:</p>
586
- <ul class="param">
587
-
588
- <li>
589
-
590
- <span class='name'>value</span>
591
-
592
-
593
- <span class='type'></span>
594
-
595
-
596
-
597
- &mdash;
598
- <div class='inline'>the value to set the attribute attr4 to.</div>
599
-
600
- </li>
601
-
602
- </ul>
603
-
604
-
605
- </div><table class="source_code">
606
- <tr>
607
- <td>
608
- <pre class="lines">
609
-
610
-
611
- 27
612
- 28
613
- 29</pre>
614
- </td>
615
- <td>
616
- <pre class="code"><span class="info file"># File '(stdin)', line 27</span>
617
-
618
- def attr4=(value)
619
- @attr4 = value
620
- end</pre>
621
- </td>
622
- </tr>
623
- </table>
624
- </div>
625
-
626
- </div>
627
-
628
-
629
- <div id="class_method_details" class="method_details_list">
630
- <h2>Class Method Details</h2>
631
-
632
-
633
- <div class="method_details first">
634
- <h3 class="signature first" id="a-class_method">
635
-
636
- .<strong>a</strong>
637
-
638
-
639
-
640
-
641
-
642
- </h3><table class="source_code">
643
- <tr>
644
- <td>
645
- <pre class="lines">
646
-
647
-
648
- 29</pre>
649
- </td>
650
- <td>
651
- <pre class="code"><span class="info file"># File '(stdin)', line 29</span>
652
-
653
- def self.a; end</pre>
654
- </td>
655
- </tr>
656
- </table>
657
- </div>
658
-
659
- </div>
660
-
661
- <div id="instance_method_details" class="method_details_list">
662
- <h2>Instance Method Details</h2>
663
-
664
-
665
- <div class="method_details first">
666
- <h3 class="signature first" id="a-instance_method">
667
-
668
- #<strong>a</strong>
669
-
670
-
671
-
672
- <span class="aliases">Also known as:
673
- <span class="names"><span id='b-instance_method'>b</span></span>
674
- </span>
675
-
676
-
677
-
678
- </h3><table class="source_code">
679
- <tr>
680
- <td>
681
- <pre class="lines">
682
-
683
-
684
- 30</pre>
685
- </td>
686
- <td>
687
- <pre class="code"><span class="info file"># File '(stdin)', line 30</span>
688
-
689
- def a; end</pre>
690
- </td>
691
- </tr>
692
- </table>
693
- </div>
694
-
695
- <div class="method_details ">
696
- <h3 class="signature " id="test_multi_overload-instance_method">
697
-
698
-
699
- <span class="overload">#<strong>test_multi_overload</strong>(a) </span>
700
-
701
- <span class="overload">#<strong>test_multi_overload</strong>(a, b) </span>
702
-
703
-
704
-
705
-
706
-
707
-
708
- </h3><div class="docstring">
709
- <div class="discussion">
710
-
711
-
712
- </div>
713
- </div>
714
- <div class="tags">
715
-
716
-
717
- </div><table class="source_code">
718
- <tr>
719
- <td>
720
- <pre class="lines">
721
-
722
-
723
- 40</pre>
724
- </td>
725
- <td>
726
- <pre class="code"><span class="info file"># File '(stdin)', line 40</span>
727
-
728
- def test_multi_overload(*args) end</pre>
729
- </td>
730
- </tr>
731
- </table>
732
- </div>
733
-
734
- <div class="method_details ">
735
- <h3 class="signature " id="test_overload-instance_method">
736
-
737
- #<strong>test_overload</strong>(a)
738
-
739
-
740
-
741
-
742
-
743
- </h3><div class="docstring">
744
- <div class="discussion">
745
-
746
-
747
- </div>
748
- </div>
749
- <div class="tags">
750
-
751
- <div class="docstring">
752
- <div class="discussion">
753
- hello2
754
-
755
- </div>
756
- </div>
757
- <div class="tags">
758
- <p class="tag_title">Parameters:</p>
759
- <ul class="param">
760
-
761
- <li>
762
-
763
- <span class='name'>a</span>
764
-
765
-
766
- <span class='type'>(<tt>String</tt>)</span>
767
-
768
-
769
-
770
- &mdash;
771
- <div class='inline'>hi</div>
772
-
773
- </li>
774
-
775
- </ul>
776
-
777
-
778
- </div>
779
-
780
-
781
- </div><table class="source_code">
782
- <tr>
783
- <td>
784
- <pre class="lines">
785
-
786
-
787
- 36</pre>
788
- </td>
789
- <td>
790
- <pre class="code"><span class="info file"># File '(stdin)', line 36</span>
791
-
792
- def test_overload(*args) end</pre>
793
- </td>
794
- </tr>
795
- </table>
796
- </div>
797
-
798
- <div class="method_details ">
799
- <h3 class="signature " id="void_meth-instance_method">
800
-
801
- #<strong>void_meth</strong>
802
-
803
-
804
-
805
-
806
-
807
- </h3><div class="docstring">
808
- <div class="discussion">
809
- <p class="note returns_void">This method returns an undefined value.</p>
810
-
811
- </div>
812
- </div>
813
- <div class="tags">
814
-
815
-
816
- </div><table class="source_code">
817
- <tr>
818
- <td>
819
- <pre class="lines">
820
-
821
-
822
- 43</pre>
823
- </td>
824
- <td>
825
- <pre class="code"><span class="info file"># File '(stdin)', line 43</span>
826
-
827
- def void_meth; end</pre>
828
- </td>
829
- </tr>
830
- </table>
831
- </div>
832
-
833
- </div>