yard 0.9.23 → 0.9.27

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 (257) hide show
  1. checksums.yaml +4 -4
  2. data/.dockerignore +0 -0
  3. data/.gitattributes +4 -0
  4. data/.github/FUNDING.yml +3 -0
  5. data/.github/ISSUE_TEMPLATE.md +6 -6
  6. data/.github/PULL_REQUEST_TEMPLATE.md +5 -5
  7. data/.github/workflows/ci.yml +30 -0
  8. data/.github/workflows/gem.yml +19 -0
  9. data/.gitignore +0 -0
  10. data/.rspec +0 -0
  11. data/.rubocop.yml +37 -24
  12. data/.yardopts +0 -0
  13. data/.yardopts_guide +0 -0
  14. data/.yardopts_i18n +0 -0
  15. data/CHANGELOG.md +50 -4
  16. data/CONTRIBUTING.md +2 -2
  17. data/Gemfile +5 -3
  18. data/README.md +97 -102
  19. data/Rakefile +2 -3
  20. data/lib/yard/cli/diff.rb +4 -1
  21. data/lib/yard/cli/server.rb +22 -13
  22. data/lib/yard/cli/stats.rb +2 -0
  23. data/lib/yard/cli/yardoc.rb +2 -1
  24. data/lib/yard/code_objects/method_object.rb +1 -1
  25. data/lib/yard/code_objects/namespace_mapper.rb +30 -3
  26. data/lib/yard/code_objects/proxy.rb +2 -1
  27. data/lib/yard/globals.rb +1 -1
  28. data/lib/yard/handlers/c/base.rb +35 -0
  29. data/lib/yard/handlers/ruby/method_handler.rb +1 -1
  30. data/lib/yard/handlers/ruby/mixin_handler.rb +7 -2
  31. data/lib/yard/handlers/ruby/module_function_handler.rb +15 -3
  32. data/lib/yard/parser/ruby/ast_node.rb +2 -2
  33. data/lib/yard/parser/ruby/ruby_parser.rb +7 -5
  34. data/lib/yard/parser/ruby/token_resolver.rb +3 -1
  35. data/lib/yard/parser/source_parser.rb +1 -1
  36. data/lib/yard/registry_resolver.rb +10 -24
  37. data/lib/yard/registry_store.rb +1 -1
  38. data/lib/yard/serializers/yardoc_serializer.rb +1 -1
  39. data/lib/yard/server/commands/base.rb +2 -2
  40. data/lib/yard/server/commands/library_command.rb +1 -1
  41. data/lib/yard/tags/directives.rb +10 -1
  42. data/lib/yard/templates/helpers/html_helper.rb +15 -5
  43. data/lib/yard/templates/helpers/markup/rdoc_markup.rb +5 -4
  44. data/lib/yard/templates/helpers/markup_helper.rb +2 -1
  45. data/lib/yard/templates/section.rb +1 -3
  46. data/lib/yard/version.rb +1 -1
  47. data/lib/yard.rb +3 -0
  48. data/samus.json +15 -46
  49. data/tasks/prepare_tag.rake +45 -0
  50. data/tasks/update_error_map.rake +53 -0
  51. data/templates/default/fulldoc/html/css/style.css +1 -0
  52. data/yard.gemspec +3 -2
  53. metadata +23 -207
  54. data/.travis.yml +0 -52
  55. data/spec/cli/command_parser_spec.rb +0 -43
  56. data/spec/cli/command_spec.rb +0 -36
  57. data/spec/cli/config_spec.rb +0 -148
  58. data/spec/cli/diff_spec.rb +0 -254
  59. data/spec/cli/display_spec.rb +0 -30
  60. data/spec/cli/gems_spec.rb +0 -81
  61. data/spec/cli/graph_spec.rb +0 -18
  62. data/spec/cli/help_spec.rb +0 -22
  63. data/spec/cli/i18n_spec.rb +0 -107
  64. data/spec/cli/list_spec.rb +0 -8
  65. data/spec/cli/markup_types_spec.rb +0 -22
  66. data/spec/cli/server_spec.rb +0 -324
  67. data/spec/cli/stats_spec.rb +0 -96
  68. data/spec/cli/yard_on_yard_spec.rb +0 -38
  69. data/spec/cli/yardoc_spec.rb +0 -896
  70. data/spec/cli/yri_spec.rb +0 -101
  71. data/spec/code_objects/base_spec.rb +0 -485
  72. data/spec/code_objects/class_object_spec.rb +0 -226
  73. data/spec/code_objects/code_object_list_spec.rb +0 -36
  74. data/spec/code_objects/constants_spec.rb +0 -116
  75. data/spec/code_objects/extra_file_object_spec.rb +0 -161
  76. data/spec/code_objects/macro_object_spec.rb +0 -150
  77. data/spec/code_objects/method_object_spec.rb +0 -184
  78. data/spec/code_objects/module_object_spec.rb +0 -142
  79. data/spec/code_objects/namespace_object_spec.rb +0 -171
  80. data/spec/code_objects/proxy_spec.rb +0 -147
  81. data/spec/code_objects/spec_helper.rb +0 -3
  82. data/spec/config_spec.rb +0 -171
  83. data/spec/core_ext/array_spec.rb +0 -13
  84. data/spec/core_ext/file_spec.rb +0 -72
  85. data/spec/core_ext/hash_spec.rb +0 -14
  86. data/spec/core_ext/insertion_spec.rb +0 -37
  87. data/spec/core_ext/module_spec.rb +0 -9
  88. data/spec/core_ext/string_spec.rb +0 -42
  89. data/spec/core_ext/symbol_hash_spec.rb +0 -89
  90. data/spec/docstring_parser_spec.rb +0 -280
  91. data/spec/docstring_spec.rb +0 -373
  92. data/spec/handlers/alias_handler_spec.rb +0 -82
  93. data/spec/handlers/attribute_handler_spec.rb +0 -96
  94. data/spec/handlers/base_spec.rb +0 -216
  95. data/spec/handlers/c/alias_handler_spec.rb +0 -34
  96. data/spec/handlers/c/attribute_handler_spec.rb +0 -41
  97. data/spec/handlers/c/class_handler_spec.rb +0 -78
  98. data/spec/handlers/c/constant_handler_spec.rb +0 -71
  99. data/spec/handlers/c/init_handler_spec.rb +0 -48
  100. data/spec/handlers/c/method_handler_spec.rb +0 -327
  101. data/spec/handlers/c/mixin_handler_spec.rb +0 -44
  102. data/spec/handlers/c/module_handler_spec.rb +0 -71
  103. data/spec/handlers/c/override_comment_handler_spec.rb +0 -47
  104. data/spec/handlers/c/path_handler_spec.rb +0 -36
  105. data/spec/handlers/c/spec_helper.rb +0 -23
  106. data/spec/handlers/c/struct_handler_spec.rb +0 -16
  107. data/spec/handlers/class_condition_handler_spec.rb +0 -87
  108. data/spec/handlers/class_handler_spec.rb +0 -247
  109. data/spec/handlers/class_method_handler_shared_examples.rb +0 -133
  110. data/spec/handlers/class_variable_handler_spec.rb +0 -12
  111. data/spec/handlers/constant_handler_spec.rb +0 -112
  112. data/spec/handlers/decorator_handler_methods_spec.rb +0 -393
  113. data/spec/handlers/dsl_handler_spec.rb +0 -226
  114. data/spec/handlers/examples/alias_handler_001.rb.txt +0 -46
  115. data/spec/handlers/examples/attribute_handler_001.rb.txt +0 -32
  116. data/spec/handlers/examples/class_condition_handler_001.rb.txt +0 -69
  117. data/spec/handlers/examples/class_handler_001.rb.txt +0 -120
  118. data/spec/handlers/examples/class_variable_handler_001.rb.txt +0 -10
  119. data/spec/handlers/examples/constant_handler_001.rb.txt +0 -35
  120. data/spec/handlers/examples/dsl_handler_001.rb.txt +0 -156
  121. data/spec/handlers/examples/exception_handler_001.rb.txt +0 -59
  122. data/spec/handlers/examples/extend_handler_001.rb.txt +0 -19
  123. data/spec/handlers/examples/method_condition_handler_001.rb.txt +0 -10
  124. data/spec/handlers/examples/method_handler_001.rb.txt +0 -128
  125. data/spec/handlers/examples/mixin_handler_001.rb.txt +0 -40
  126. data/spec/handlers/examples/module_handler_001.rb.txt +0 -29
  127. data/spec/handlers/examples/private_constant_handler_001.rb.txt +0 -8
  128. data/spec/handlers/examples/process_handler_001.rb.txt +0 -11
  129. data/spec/handlers/examples/visibility_handler_001.rb.txt +0 -36
  130. data/spec/handlers/examples/yield_handler_001.rb.txt +0 -54
  131. data/spec/handlers/exception_handler_spec.rb +0 -49
  132. data/spec/handlers/extend_handler_spec.rb +0 -28
  133. data/spec/handlers/legacy_base_spec.rb +0 -128
  134. data/spec/handlers/method_condition_handler_spec.rb +0 -15
  135. data/spec/handlers/method_handler_spec.rb +0 -214
  136. data/spec/handlers/mixin_handler_spec.rb +0 -60
  137. data/spec/handlers/module_function_handler_spec.rb +0 -106
  138. data/spec/handlers/module_handler_spec.rb +0 -35
  139. data/spec/handlers/private_class_method_handler_spec.rb +0 -11
  140. data/spec/handlers/private_constant_handler_spec.rb +0 -25
  141. data/spec/handlers/processor_spec.rb +0 -35
  142. data/spec/handlers/public_class_method_handler_spec.rb +0 -11
  143. data/spec/handlers/ruby/base_spec.rb +0 -95
  144. data/spec/handlers/ruby/legacy/base_spec.rb +0 -84
  145. data/spec/handlers/spec_helper.rb +0 -33
  146. data/spec/handlers/visibility_handler_spec.rb +0 -44
  147. data/spec/handlers/yield_handler_spec.rb +0 -52
  148. data/spec/i18n/locale_spec.rb +0 -81
  149. data/spec/i18n/message_spec.rb +0 -52
  150. data/spec/i18n/messages_spec.rb +0 -67
  151. data/spec/i18n/pot_generator_spec.rb +0 -295
  152. data/spec/i18n/text_spec.rb +0 -184
  153. data/spec/logging_spec.rb +0 -44
  154. data/spec/options_spec.rb +0 -171
  155. data/spec/parser/base_spec.rb +0 -24
  156. data/spec/parser/c_parser_spec.rb +0 -236
  157. data/spec/parser/examples/array.c.txt +0 -6267
  158. data/spec/parser/examples/example1.rb.txt +0 -8
  159. data/spec/parser/examples/extrafile.c.txt +0 -8
  160. data/spec/parser/examples/file.c.txt +0 -28
  161. data/spec/parser/examples/multifile.c.txt +0 -22
  162. data/spec/parser/examples/namespace.cpp.txt +0 -68
  163. data/spec/parser/examples/override.c.txt +0 -424
  164. data/spec/parser/examples/parse_in_order_001.rb.txt +0 -2
  165. data/spec/parser/examples/parse_in_order_002.rb.txt +0 -2
  166. data/spec/parser/examples/tag_handler_001.rb.txt +0 -8
  167. data/spec/parser/ruby/ast_node_spec.rb +0 -33
  168. data/spec/parser/ruby/legacy/statement_list_spec.rb +0 -299
  169. data/spec/parser/ruby/legacy/token_list_spec.rb +0 -79
  170. data/spec/parser/ruby/ruby_parser_spec.rb +0 -508
  171. data/spec/parser/ruby/token_resolver_spec.rb +0 -165
  172. data/spec/parser/source_parser_spec.rb +0 -727
  173. data/spec/parser/tag_parsing_spec.rb +0 -17
  174. data/spec/rake/yardoc_task_spec.rb +0 -118
  175. data/spec/registry_spec.rb +0 -463
  176. data/spec/registry_store_spec.rb +0 -327
  177. data/spec/rubygems/doc_manager_spec.rb +0 -112
  178. data/spec/serializers/data/serialized_yardoc/checksums +0 -1
  179. data/spec/serializers/data/serialized_yardoc/objects/Foo/bar_i.dat +0 -0
  180. data/spec/serializers/data/serialized_yardoc/objects/Foo/baz_i.dat +0 -0
  181. data/spec/serializers/data/serialized_yardoc/objects/Foo.dat +0 -0
  182. data/spec/serializers/data/serialized_yardoc/objects/root.dat +0 -0
  183. data/spec/serializers/data/serialized_yardoc/proxy_types +0 -2
  184. data/spec/serializers/file_system_serializer_spec.rb +0 -145
  185. data/spec/serializers/spec_helper.rb +0 -2
  186. data/spec/serializers/yardoc_serializer_spec.rb +0 -78
  187. data/spec/server/adapter_spec.rb +0 -39
  188. data/spec/server/commands/base_spec.rb +0 -91
  189. data/spec/server/commands/library_command_spec.rb +0 -39
  190. data/spec/server/doc_server_helper_spec.rb +0 -72
  191. data/spec/server/doc_server_serializer_spec.rb +0 -60
  192. data/spec/server/rack_adapter_spec.rb +0 -21
  193. data/spec/server/router_spec.rb +0 -123
  194. data/spec/server/spec_helper.rb +0 -22
  195. data/spec/server/static_caching_spec.rb +0 -47
  196. data/spec/server/webrick_servlet_spec.rb +0 -20
  197. data/spec/server_spec.rb +0 -19
  198. data/spec/spec_helper.rb +0 -212
  199. data/spec/tags/default_factory_spec.rb +0 -168
  200. data/spec/tags/default_tag_spec.rb +0 -11
  201. data/spec/tags/directives_spec.rb +0 -463
  202. data/spec/tags/library_spec.rb +0 -48
  203. data/spec/tags/overload_tag_spec.rb +0 -53
  204. data/spec/tags/ref_tag_list_spec.rb +0 -53
  205. data/spec/tags/types_explainer_spec.rb +0 -203
  206. data/spec/templates/class_spec.rb +0 -45
  207. data/spec/templates/constant_spec.rb +0 -41
  208. data/spec/templates/engine_spec.rb +0 -131
  209. data/spec/templates/examples/class001.html +0 -308
  210. data/spec/templates/examples/class001.txt +0 -36
  211. data/spec/templates/examples/class002.html +0 -39
  212. data/spec/templates/examples/constant001.txt +0 -25
  213. data/spec/templates/examples/constant002.txt +0 -7
  214. data/spec/templates/examples/constant003.txt +0 -11
  215. data/spec/templates/examples/method001.html +0 -137
  216. data/spec/templates/examples/method001.txt +0 -35
  217. data/spec/templates/examples/method002.html +0 -91
  218. data/spec/templates/examples/method002.txt +0 -20
  219. data/spec/templates/examples/method003.html +0 -165
  220. data/spec/templates/examples/method003.txt +0 -45
  221. data/spec/templates/examples/method004.html +0 -48
  222. data/spec/templates/examples/method004.txt +0 -10
  223. data/spec/templates/examples/method005.html +0 -105
  224. data/spec/templates/examples/method005.txt +0 -33
  225. data/spec/templates/examples/method006.html +0 -108
  226. data/spec/templates/examples/method006.txt +0 -20
  227. data/spec/templates/examples/module001.dot +0 -33
  228. data/spec/templates/examples/module001.html +0 -833
  229. data/spec/templates/examples/module001.txt +0 -33
  230. data/spec/templates/examples/module002.html +0 -341
  231. data/spec/templates/examples/module003.html +0 -202
  232. data/spec/templates/examples/module004.html +0 -394
  233. data/spec/templates/examples/module005.html +0 -82
  234. data/spec/templates/examples/tag001.txt +0 -82
  235. data/spec/templates/helpers/base_helper_spec.rb +0 -171
  236. data/spec/templates/helpers/html_helper_spec.rb +0 -687
  237. data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb +0 -65
  238. data/spec/templates/helpers/markup/rdoc_markup_spec.rb +0 -84
  239. data/spec/templates/helpers/markup_helper_spec.rb +0 -136
  240. data/spec/templates/helpers/method_helper_spec.rb +0 -107
  241. data/spec/templates/helpers/module_helper_spec.rb +0 -35
  242. data/spec/templates/helpers/shared_signature_examples.rb +0 -126
  243. data/spec/templates/helpers/text_helper_spec.rb +0 -65
  244. data/spec/templates/markup_processor_integrations/asciidoctor_spec.rb +0 -60
  245. data/spec/templates/markup_processor_integrations/integration_spec_helper.rb +0 -46
  246. data/spec/templates/markup_processor_integrations/rdoc_markdown_spec.rb +0 -59
  247. data/spec/templates/markup_processor_integrations/rdoc_spec.rb +0 -39
  248. data/spec/templates/markup_processor_integrations/redcarpet_spec.rb +0 -59
  249. data/spec/templates/markup_processor_integrations/redcloth_spec.rb +0 -48
  250. data/spec/templates/method_spec.rb +0 -118
  251. data/spec/templates/module_spec.rb +0 -203
  252. data/spec/templates/onefile_spec.rb +0 -66
  253. data/spec/templates/section_spec.rb +0 -144
  254. data/spec/templates/spec_helper.rb +0 -76
  255. data/spec/templates/tag_spec.rb +0 -52
  256. data/spec/templates/template_spec.rb +0 -410
  257. data/spec/verifier_spec.rb +0 -106
data/spec/templates/examples/method003.html DELETED
@@ -1,165 +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>(x, y) <span class="extras">(private)</span></span>
18
-
19
- <span class="overload">#<strong>m</strong>(x, y, z) <span class="extras">(private)</span></span>
20
-
21
-
22
-
23
-
24
-
25
-
26
- </h3><div class="docstring">
27
- <div class="discussion">
28
- Method comments
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>(x, y) </span>
40
- <div class="docstring">
41
- <div class="discussion">
42
- Overload docstring
43
-
44
- </div>
45
- </div>
46
- <div class="tags">
47
- <p class="tag_title">Parameters:</p>
48
- <ul class="param">
49
-
50
- <li>
51
-
52
- <span class='name'>x</span>
53
-
54
-
55
- <span class='type'>(<tt>String</tt>)</span>
56
-
57
-
58
-
59
- &mdash;
60
- <div class='inline'>parameter x</div>
61
-
62
- </li>
63
-
64
- <li>
65
-
66
- <span class='name'>y</span>
67
-
68
-
69
- <span class='type'>(<tt>Boolean</tt>)</span>
70
-
71
-
72
-
73
- &mdash;
74
- <div class='inline'>parameter y</div>
75
-
76
- </li>
77
-
78
- </ul>
79
-
80
-
81
- </div>
82
- </li>
83
-
84
-
85
- <li class="overload_item">
86
- <span class="signature">#<strong>m</strong>(x, y, z) </span>
87
- <div class="docstring">
88
- <div class="discussion">
89
-
90
-
91
- </div>
92
- </div>
93
- <div class="tags">
94
- <p class="tag_title">Parameters:</p>
95
- <ul class="param">
96
-
97
- <li>
98
-
99
- <span class='name'>x</span>
100
-
101
-
102
- <span class='type'>(<tt>String</tt>)</span>
103
-
104
-
105
-
106
- &mdash;
107
- <div class='inline'>parameter x</div>
108
-
109
- </li>
110
-
111
- <li>
112
-
113
- <span class='name'>y</span>
114
-
115
-
116
- <span class='type'>(<tt>Boolean</tt>)</span>
117
-
118
-
119
-
120
- &mdash;
121
- <div class='inline'>parameter y</div>
122
-
123
- </li>
124
-
125
- <li>
126
-
127
- <span class='name'>z</span>
128
-
129
-
130
- <span class='type'>(<tt>Boolean</tt>)</span>
131
-
132
-
133
-
134
- &mdash;
135
- <div class='inline'>parameter z</div>
136
-
137
- </li>
138
-
139
- </ul>
140
-
141
-
142
- </div>
143
- </li>
144
-
145
- </ul>
146
-
147
-
148
- </div><table class="source_code">
149
- <tr>
150
- <td>
151
- <pre class="lines">
152
-
153
-
154
- 11</pre>
155
- </td>
156
- <td>
157
- <pre class="code"><span class="info file"># File '(stdin)', line 11</span>
158
-
159
- def m(*args) end</pre>
160
- </td>
161
- </tr>
162
- </table>
163
- </div>
164
- </div>
165
- </div>
data/spec/templates/examples/method003.txt DELETED
@@ -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
-
data/spec/templates/examples/method004.html DELETED
@@ -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>
data/spec/templates/examples/method004.txt DELETED
@@ -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
-
data/spec/templates/examples/method005.html DELETED
@@ -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>
data/spec/templates/examples/method005.txt DELETED
@@ -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
-
data/spec/templates/examples/method006.html DELETED
@@ -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>
data/spec/templates/examples/method006.txt DELETED
@@ -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
-
data/spec/templates/examples/module001.dot DELETED
@@ -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];