yard 0.8.7.6 → 0.9.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -1
- data/LICENSE +2 -2
- data/README.md +2 -2
- data/Rakefile +1 -1
- data/bin/yard +0 -0
- data/bin/yardoc +0 -0
- data/bin/yri +0 -0
- data/docs/GettingStarted.md +88 -6
- data/docs/images/handlers-class-diagram.png +0 -0
- data/docs/images/overview-class-diagram.png +0 -0
- data/docs/images/parser-class-diagram.png +0 -0
- data/docs/templates/default/fulldoc/html/full_list_tag.erb +6 -4
- data/lib/yard/autoload.rb +3 -0
- data/lib/yard/cli/yardoc.rb +1 -1
- data/lib/yard/code_objects/base.rb +4 -1
- data/lib/yard/code_objects/extra_file_object.rb +3 -1
- data/lib/yard/code_objects/proxy.rb +2 -2
- data/lib/yard/docstring.rb +11 -6
- data/lib/yard/handlers/base.rb +1 -2
- data/lib/yard/handlers/c/base.rb +19 -0
- data/lib/yard/handlers/c/handler_methods.rb +42 -8
- data/lib/yard/handlers/c/init_handler.rb +1 -1
- data/lib/yard/handlers/c/method_handler.rb +3 -3
- data/lib/yard/handlers/ruby/decorator_handler_methods.rb +132 -0
- data/lib/yard/handlers/ruby/legacy/private_class_method_handler.rb +1 -1
- data/lib/yard/handlers/ruby/private_class_method_handler.rb +6 -39
- data/lib/yard/handlers/ruby/private_constant_handler.rb +36 -30
- data/lib/yard/handlers/ruby/public_class_method_handler.rb +13 -0
- data/lib/yard/handlers/ruby/struct_handler_methods.rb +1 -0
- data/lib/yard/handlers/ruby/visibility_handler.rb +5 -8
- data/lib/yard/logging.rb +1 -0
- data/lib/yard/parser/ruby/ruby_parser.rb +2 -2
- data/lib/yard/parser/source_parser.rb +6 -6
- data/lib/yard/rake/yardoc_task.rb +2 -2
- data/lib/yard/serializers/file_system_serializer.rb +33 -1
- data/lib/yard/server/commands/display_file_command.rb +8 -3
- data/lib/yard/server/commands/display_object_command.rb +7 -3
- data/lib/yard/server/doc_server_helper.rb +2 -8
- data/lib/yard/server/doc_server_serializer.rb +2 -4
- data/lib/yard/server/router.rb +1 -1
- data/lib/yard/server/templates/default/fulldoc/html/css/custom.css +57 -8
- data/lib/yard/server/templates/default/layout/html/breadcrumb.erb +2 -10
- data/lib/yard/server/templates/default/layout/html/script_setup.erb +1 -2
- data/lib/yard/server/templates/default/method_details/html/permalink.erb +3 -3
- data/lib/yard/server/templates/doc_server/processing/html/processing.erb +4 -4
- data/lib/yard/tags/directives.rb +1 -0
- data/lib/yard/tags/library.rb +9 -7
- data/lib/yard/tags/overload_tag.rb +4 -1
- data/lib/yard/templates/helpers/html_helper.rb +4 -3
- data/lib/yard/templates/template_options.rb +3 -0
- data/lib/yard/version.rb +1 -1
- data/spec/cli/command_parser_spec.rb +14 -14
- data/spec/cli/command_spec.rb +11 -11
- data/spec/cli/config_spec.rb +32 -32
- data/spec/cli/diff_spec.rb +86 -90
- data/spec/cli/display_spec.rb +6 -6
- data/spec/cli/gems_spec.rb +28 -28
- data/spec/cli/graph_spec.rb +8 -8
- data/spec/cli/help_spec.rb +8 -8
- data/spec/cli/i18n_spec.rb +33 -37
- data/spec/cli/list_spec.rb +2 -2
- data/spec/cli/markup_types_spec.rb +3 -3
- data/spec/cli/server_spec.rb +74 -88
- data/spec/cli/stats_spec.rb +14 -14
- data/spec/cli/yardoc_spec.rb +316 -321
- data/spec/cli/yri_spec.rb +45 -45
- data/spec/code_objects/base_spec.rb +174 -173
- data/spec/code_objects/class_object_spec.rb +65 -65
- data/spec/code_objects/code_object_list_spec.rb +13 -11
- data/spec/code_objects/constants_spec.rb +68 -58
- data/spec/code_objects/extra_file_object_spec.rb +71 -59
- data/spec/code_objects/macro_object_spec.rb +64 -64
- data/spec/code_objects/method_object_spec.rb +80 -72
- data/spec/code_objects/module_object_spec.rb +47 -47
- data/spec/code_objects/namespace_object_spec.rb +51 -51
- data/spec/code_objects/proxy_spec.rb +54 -54
- data/spec/config_spec.rb +104 -104
- data/spec/core_ext/array_spec.rb +5 -5
- data/spec/core_ext/file_spec.rb +33 -33
- data/spec/core_ext/hash_spec.rb +5 -5
- data/spec/core_ext/insertion_spec.rb +18 -18
- data/spec/core_ext/module_spec.rb +6 -6
- data/spec/core_ext/string_spec.rb +17 -17
- data/spec/core_ext/symbol_hash_spec.rb +42 -39
- data/spec/docstring_parser_spec.rb +65 -65
- data/spec/docstring_spec.rb +137 -130
- data/spec/handlers/alias_handler_spec.rb +39 -39
- data/spec/handlers/attribute_handler_spec.rb +35 -35
- data/spec/handlers/base_spec.rb +60 -51
- data/spec/handlers/c/alias_handler_spec.rb +6 -6
- data/spec/handlers/c/attribute_handler_spec.rb +12 -12
- data/spec/handlers/c/class_handler_spec.rb +35 -22
- data/spec/handlers/c/constant_handler_spec.rb +24 -22
- data/spec/handlers/c/init_handler_spec.rb +10 -10
- data/spec/handlers/c/method_handler_spec.rb +150 -65
- data/spec/handlers/c/mixin_handler_spec.rb +5 -5
- data/spec/handlers/c/module_handler_spec.rb +27 -15
- data/spec/handlers/c/override_comment_handler_spec.rb +14 -14
- data/spec/handlers/c/path_handler_spec.rb +8 -8
- data/spec/handlers/c/spec_helper.rb +10 -0
- data/spec/handlers/c/struct_handler_spec.rb +3 -3
- data/spec/handlers/class_condition_handler_spec.rb +18 -18
- data/spec/handlers/class_handler_spec.rb +97 -97
- data/spec/handlers/class_method_handler_shared_examples.rb +132 -0
- data/spec/handlers/class_variable_handler_spec.rb +3 -3
- data/spec/handlers/constant_handler_spec.rb +32 -29
- data/spec/handlers/decorator_handler_methods_spec.rb +405 -0
- data/spec/handlers/dsl_handler_spec.rb +108 -109
- data/spec/handlers/examples/constant_handler_001.rb.txt +4 -1
- data/spec/handlers/examples/visibility_handler_001.rb.txt +4 -0
- data/spec/handlers/exception_handler_spec.rb +23 -23
- data/spec/handlers/extend_handler_spec.rb +9 -9
- data/spec/handlers/legacy_base_spec.rb +60 -60
- data/spec/handlers/method_condition_handler_spec.rb +5 -5
- data/spec/handlers/method_handler_spec.rb +92 -92
- data/spec/handlers/mixin_handler_spec.rb +25 -25
- data/spec/handlers/module_function_handler_spec.rb +24 -24
- data/spec/handlers/module_handler_spec.rb +15 -15
- data/spec/handlers/private_class_method_handler_spec.rb +4 -48
- data/spec/handlers/private_constant_handler_spec.rb +8 -8
- data/spec/handlers/processor_spec.rb +12 -12
- data/spec/handlers/public_class_method_handler_spec.rb +10 -0
- data/spec/handlers/ruby/base_spec.rb +16 -16
- data/spec/handlers/ruby/legacy/base_spec.rb +20 -18
- data/spec/handlers/spec_helper.rb +1 -1
- data/spec/handlers/visibility_handler_spec.rb +25 -21
- data/spec/handlers/yield_handler_spec.rb +28 -28
- data/spec/i18n/locale_spec.rb +16 -16
- data/spec/i18n/message_spec.rb +8 -8
- data/spec/i18n/messages_spec.rb +14 -14
- data/spec/i18n/pot_generator_spec.rb +32 -32
- data/spec/i18n/text_spec.rb +22 -22
- data/spec/logging_spec.rb +12 -12
- data/spec/options_spec.rb +56 -56
- data/spec/parser/base_spec.rb +9 -9
- data/spec/parser/c_parser_spec.rb +50 -50
- data/spec/parser/ruby/ast_node_spec.rb +7 -7
- data/spec/parser/ruby/legacy/statement_list_spec.rb +106 -106
- data/spec/parser/ruby/legacy/token_list_spec.rb +27 -27
- data/spec/parser/ruby/ruby_parser_spec.rb +123 -113
- data/spec/parser/source_parser_spec.rb +224 -224
- data/spec/parser/tag_parsing_spec.rb +6 -7
- data/spec/rake/yardoc_task_spec.rb +38 -48
- data/spec/registry_spec.rb +143 -143
- data/spec/registry_store_spec.rb +165 -165
- data/spec/rubygems/doc_manager_spec.rb +38 -38
- data/spec/serializers/file_system_serializer_spec.rb +53 -33
- data/spec/serializers/yardoc_serializer_spec.rb +15 -15
- data/spec/server/adapter_spec.rb +15 -15
- data/spec/server/commands/base_spec.rb +29 -29
- data/spec/server/commands/library_command_spec.rb +12 -12
- data/spec/server/commands/static_file_command_spec.rb +28 -28
- data/spec/server/doc_server_helper_spec.rb +8 -8
- data/spec/server/doc_server_serializer_spec.rb +23 -18
- data/spec/server/rack_adapter_spec.rb +6 -6
- data/spec/server/router_spec.rb +39 -39
- data/spec/server/static_caching_spec.rb +16 -16
- data/spec/server/webrick_servlet_spec.rb +6 -7
- data/spec/server_spec.rb +3 -3
- data/spec/spec_helper.rb +11 -2
- data/spec/tags/default_factory_spec.rb +64 -64
- data/spec/tags/default_tag_spec.rb +5 -5
- data/spec/tags/directives_spec.rb +121 -121
- data/spec/tags/library_spec.rb +14 -14
- data/spec/tags/overload_tag_spec.rb +24 -24
- data/spec/tags/ref_tag_list_spec.rb +12 -12
- data/spec/templates/class_spec.rb +3 -3
- data/spec/templates/constant_spec.rb +4 -4
- data/spec/templates/engine_spec.rb +47 -48
- data/spec/templates/examples/class001.html +129 -101
- data/spec/templates/examples/class002.html +31 -27
- data/spec/templates/examples/method001.html +54 -47
- data/spec/templates/examples/method002.html +33 -28
- data/spec/templates/examples/method003.html +70 -64
- data/spec/templates/examples/method004.html +13 -9
- data/spec/templates/examples/method005.html +38 -32
- data/spec/templates/examples/module001.html +343 -339
- data/spec/templates/examples/module002.html +147 -124
- data/spec/templates/examples/module003.html +94 -81
- data/spec/templates/examples/module004.html +40 -33
- data/spec/templates/helpers/base_helper_spec.rb +91 -95
- data/spec/templates/helpers/html_helper_spec.rb +276 -279
- data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb +16 -15
- data/spec/templates/helpers/markup/rdoc_markup_spec.rb +27 -34
- data/spec/templates/helpers/markup_helper_spec.rb +57 -57
- data/spec/templates/helpers/method_helper_spec.rb +20 -20
- data/spec/templates/helpers/shared_signature_examples.rb +33 -31
- data/spec/templates/helpers/text_helper_spec.rb +6 -6
- data/spec/templates/method_spec.rb +7 -7
- data/spec/templates/module_spec.rb +7 -7
- data/spec/templates/onefile_spec.rb +7 -7
- data/spec/templates/section_spec.rb +66 -69
- data/spec/templates/spec_helper.rb +1 -1
- data/spec/templates/tag_spec.rb +5 -5
- data/spec/templates/template_spec.rb +158 -158
- data/spec/verifier_spec.rb +52 -52
- data/templates/default/fulldoc/html/css/full_list.css +32 -31
- data/templates/default/fulldoc/html/css/style.css +212 -77
- data/templates/default/fulldoc/html/frames.erb +6 -15
- data/templates/default/fulldoc/html/full_list.erb +14 -21
- data/templates/default/fulldoc/html/full_list_class.erb +1 -1
- data/templates/default/fulldoc/html/full_list_file.erb +6 -4
- data/templates/default/fulldoc/html/full_list_method.erb +8 -6
- data/templates/default/fulldoc/html/js/app.js +100 -76
- data/templates/default/fulldoc/html/js/full_list.js +170 -135
- data/templates/default/fulldoc/html/setup.rb +50 -7
- data/templates/default/layout/html/breadcrumb.erb +0 -2
- data/templates/default/layout/html/headers.erb +2 -1
- data/templates/default/layout/html/layout.erb +16 -10
- data/templates/default/layout/html/script_setup.erb +1 -2
- data/templates/default/layout/html/search.erb +7 -2
- data/templates/default/layout/html/setup.rb +16 -0
- data/templates/default/method/html/header.erb +7 -6
- data/templates/default/module/html/attribute_summary.erb +1 -1
- data/templates/default/module/html/box_info.erb +24 -18
- data/templates/default/module/html/constant_summary.erb +9 -11
- data/templates/default/module/html/item_summary.erb +1 -1
- data/templates/default/module/html/method_summary.erb +1 -1
- data/templates/guide/fulldoc/html/setup.rb +1 -1
- data/yard.gemspec +1 -2
- metadata +10 -7
- data/spec/handlers/examples/private_class_method_handler_001.rb.txt +0 -9
- data/spec/handlers/examples/private_class_method_handler_002.rb.txt +0 -18
- data/spec/handlers/examples/private_class_method_handler_003.rb.txt +0 -11
@@ -1,21 +1,24 @@
|
|
1
1
|
<h1>Method: #m</h1>
|
2
|
-
<
|
3
|
-
<
|
4
|
-
|
2
|
+
<div class="box_info">
|
3
|
+
<dl>
|
4
|
+
<dt class="">Defined in:</dt>
|
5
|
+
<dd class="">
|
5
6
|
(stdin)
|
6
|
-
|
7
|
-
</dl>
|
8
|
-
|
7
|
+
</dd>
|
8
|
+
</dl>
|
9
|
+
</div>
|
9
10
|
|
10
11
|
<div class="method_details_list">
|
11
12
|
<div id="method_details">
|
12
13
|
<div class="method_details first">
|
13
14
|
<h3 class="signature first" id="m-instance_method">
|
15
|
+
|
16
|
+
#<strong>m</strong>(*args) ⇒ <tt>void</tt>
|
17
|
+
|
14
18
|
|
15
|
-
|
16
|
-
|
17
|
-
|
19
|
+
|
18
20
|
|
21
|
+
|
19
22
|
</h3><div class="docstring">
|
20
23
|
<div class="discussion">
|
21
24
|
<p class="note returns_void">This method returns an undefined value.</p>
|
@@ -23,6 +26,7 @@
|
|
23
26
|
</div>
|
24
27
|
</div>
|
25
28
|
<div class="tags">
|
29
|
+
|
26
30
|
|
27
31
|
</div><table class="source_code">
|
28
32
|
<tr>
|
@@ -1,39 +1,42 @@
|
|
1
1
|
<h1>Method: #m</h1>
|
2
|
-
<
|
3
|
-
<
|
4
|
-
|
2
|
+
<div class="box_info">
|
3
|
+
<dl>
|
4
|
+
<dt class="">Defined in:</dt>
|
5
|
+
<dd class="">
|
5
6
|
(stdin)
|
6
|
-
|
7
|
-
</dl>
|
8
|
-
|
7
|
+
</dd>
|
8
|
+
</dl>
|
9
|
+
</div>
|
9
10
|
|
10
11
|
<div class="method_details_list">
|
11
12
|
<div id="method_details">
|
12
13
|
<div class="method_details first">
|
13
14
|
<h3 class="signature first" id="m-instance_method">
|
15
|
+
|
16
|
+
|
17
|
+
<span class="overload">#<strong>m</strong>(a) ⇒ <tt>void</tt> </span>
|
18
|
+
|
19
|
+
<span class="overload">#<strong>m</strong>(b) </span>
|
20
|
+
|
21
|
+
|
14
22
|
|
23
|
+
|
15
24
|
|
16
|
-
|
17
|
-
|
18
|
-
<span class="overload">- <strong>m</strong>(b) </span>
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
25
|
+
|
23
26
|
</h3><div class="docstring">
|
24
27
|
<div class="discussion">
|
25
|
-
|
28
|
+
|
26
29
|
|
27
30
|
</div>
|
28
31
|
</div>
|
29
32
|
<div class="tags">
|
30
|
-
|
33
|
+
|
31
34
|
<p class="tag_title">Overloads:</p>
|
32
35
|
<ul class="overload">
|
33
|
-
|
34
|
-
|
36
|
+
|
37
|
+
|
35
38
|
<li class="overload_item">
|
36
|
-
<span class="signature"
|
39
|
+
<span class="signature">#<strong>m</strong>(a) ⇒ <tt>void</tt> </span>
|
37
40
|
<div class="docstring">
|
38
41
|
<div class="discussion">
|
39
42
|
<p class="note returns_void">This method returns an undefined value.</p>
|
@@ -41,44 +44,47 @@
|
|
41
44
|
</div>
|
42
45
|
</div>
|
43
46
|
<div class="tags">
|
47
|
+
|
44
48
|
|
45
49
|
</div>
|
46
50
|
</li>
|
47
|
-
|
48
|
-
|
51
|
+
|
52
|
+
|
49
53
|
<li class="overload_item">
|
50
|
-
<span class="signature"
|
54
|
+
<span class="signature">#<strong>m</strong>(b) </span>
|
51
55
|
<div class="docstring">
|
52
56
|
<div class="discussion">
|
53
|
-
|
57
|
+
|
54
58
|
|
55
59
|
</div>
|
56
60
|
</div>
|
57
61
|
<div class="tags">
|
58
62
|
<p class="tag_title">Parameters:</p>
|
59
63
|
<ul class="param">
|
60
|
-
|
64
|
+
|
61
65
|
<li>
|
62
|
-
|
66
|
+
|
63
67
|
<span class='name'>b</span>
|
64
|
-
|
65
|
-
|
68
|
+
|
69
|
+
|
66
70
|
<span class='type'>(<tt>String</tt>)</span>
|
67
|
-
|
68
|
-
|
69
|
-
|
71
|
+
|
72
|
+
|
73
|
+
|
70
74
|
—
|
71
75
|
<div class='inline'>hi</div>
|
72
|
-
|
76
|
+
|
73
77
|
</li>
|
74
|
-
|
78
|
+
|
75
79
|
</ul>
|
76
80
|
|
81
|
+
|
77
82
|
</div>
|
78
83
|
</li>
|
79
|
-
|
84
|
+
|
80
85
|
</ul>
|
81
86
|
|
87
|
+
|
82
88
|
</div><table class="source_code">
|
83
89
|
<tr>
|
84
90
|
<td>
|
@@ -1,31 +1,36 @@
|
|
1
1
|
<h1>Module: A
|
2
|
-
|
3
|
-
|
4
|
-
|
2
|
+
|
3
|
+
|
4
|
+
|
5
5
|
</h1>
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
<
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
<
|
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>
|
29
34
|
|
30
35
|
<h2>Overview</h2><div class="docstring">
|
31
36
|
<div class="discussion">
|
@@ -34,25 +39,25 @@
|
|
34
39
|
</div>
|
35
40
|
</div>
|
36
41
|
<div class="tags">
|
37
|
-
|
42
|
+
|
38
43
|
|
39
44
|
</div><h2>Defined Under Namespace</h2>
|
40
45
|
<p class="children">
|
41
|
-
|
42
|
-
|
46
|
+
|
47
|
+
|
43
48
|
<strong class="modules">Modules:</strong> Z
|
44
|
-
|
45
|
-
|
46
|
-
|
49
|
+
|
50
|
+
|
51
|
+
|
47
52
|
<strong class="classes">Classes:</strong> Q, X, Y
|
48
|
-
|
49
|
-
|
53
|
+
|
54
|
+
|
50
55
|
</p>
|
51
56
|
|
52
57
|
<h2>Constant Summary</h2>
|
53
|
-
|
58
|
+
|
54
59
|
<dl class="constants">
|
55
|
-
|
60
|
+
|
56
61
|
<dt id="CONSTANT-constant" class="">CONSTANT =
|
57
62
|
<div class="docstring">
|
58
63
|
<div class="discussion">
|
@@ -62,12 +67,12 @@ and newlines.
|
|
62
67
|
</div>
|
63
68
|
</div>
|
64
69
|
<div class="tags">
|
65
|
-
|
70
|
+
|
66
71
|
|
67
72
|
</div>
|
68
73
|
</dt>
|
69
74
|
<dd><pre class="code">'value'</pre></dd>
|
70
|
-
|
75
|
+
|
71
76
|
<dt id="cvar-classvariable" class="deprecated">@@cvar =
|
72
77
|
<div class="docstring">
|
73
78
|
<div class="discussion">
|
@@ -77,299 +82,299 @@ and newlines.
|
|
77
82
|
</div>
|
78
83
|
</div>
|
79
84
|
<div class="tags">
|
80
|
-
|
85
|
+
|
81
86
|
|
82
87
|
</div>
|
83
88
|
</dt>
|
84
89
|
<dd><pre class="code">'value'</pre></dd>
|
85
|
-
|
90
|
+
|
86
91
|
</dl>
|
92
|
+
|
87
93
|
|
88
94
|
|
89
95
|
|
90
96
|
|
91
|
-
|
92
|
-
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
97
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
93
98
|
<ul class="summary">
|
94
|
-
|
99
|
+
|
95
100
|
<li class="public ">
|
96
101
|
<span class="summary_signature">
|
102
|
+
|
103
|
+
<a title="#attr1 (instance method)">#<strong>attr1</strong> </a>
|
104
|
+
|
97
105
|
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
106
|
+
|
102
107
|
</span>
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
108
|
+
|
109
|
+
|
110
|
+
|
111
|
+
|
112
|
+
|
113
|
+
|
114
|
+
|
115
|
+
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
|
115
120
|
<span class="summary_desc"><div class='inline'>Returns the value of attribute attr1.</div></span>
|
116
|
-
|
121
|
+
|
117
122
|
</li>
|
118
123
|
|
119
|
-
|
124
|
+
|
120
125
|
<li class="public ">
|
121
126
|
<span class="summary_signature">
|
127
|
+
|
128
|
+
<a title="#attr2 (instance method)">#<strong>attr2</strong> </a>
|
129
|
+
|
122
130
|
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
131
|
+
|
127
132
|
</span>
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
|
132
137
|
<span class="note title readonly">readonly</span>
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
142
147
|
<span class="summary_desc"><div class='inline'>Returns the value of attribute attr2.</div></span>
|
143
|
-
|
148
|
+
|
144
149
|
</li>
|
145
150
|
|
146
|
-
|
151
|
+
|
147
152
|
<li class="public ">
|
148
153
|
<span class="summary_signature">
|
154
|
+
|
155
|
+
<a title="#attr3 (instance method)">#<strong>attr3</strong> </a>
|
156
|
+
|
149
157
|
|
150
|
-
|
151
|
-
|
152
|
-
|
153
|
-
|
158
|
+
|
154
159
|
</span>
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
167
172
|
<span class="summary_desc"><div class='inline'></div></span>
|
168
|
-
|
173
|
+
|
169
174
|
</li>
|
170
175
|
|
171
|
-
|
176
|
+
|
172
177
|
<li class="public ">
|
173
178
|
<span class="summary_signature">
|
179
|
+
|
180
|
+
<a title="#attr4= (instance method)">#<strong>attr4</strong> </a>
|
181
|
+
|
174
182
|
|
175
|
-
|
176
|
-
|
177
|
-
|
178
|
-
|
183
|
+
|
179
184
|
</span>
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
+
|
186
|
+
|
187
|
+
|
188
|
+
|
189
|
+
|
185
190
|
<span class="note title writeonly">writeonly</span>
|
186
|
-
|
187
|
-
|
188
|
-
|
189
|
-
|
190
|
-
|
191
|
-
|
192
|
-
|
193
|
-
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
|
194
199
|
<span class="summary_desc"><div class='inline'>Sets the attribute attr4.</div></span>
|
195
|
-
|
200
|
+
|
196
201
|
</li>
|
197
202
|
|
198
|
-
|
203
|
+
|
199
204
|
</ul>
|
200
205
|
|
201
206
|
|
202
207
|
|
203
|
-
|
204
|
-
|
208
|
+
|
209
|
+
|
205
210
|
<h3 class="inherited">Attributes included from BaseMod</h3>
|
206
211
|
<p class="inherited">#base_attr1, #base_attr2, #base_attr3</p>
|
207
212
|
|
208
213
|
|
209
|
-
|
214
|
+
|
210
215
|
<h2>
|
211
216
|
Class Method Summary
|
212
|
-
<small
|
217
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
213
218
|
</h2>
|
214
219
|
|
215
220
|
<ul class="summary">
|
216
|
-
|
221
|
+
|
217
222
|
<li class="public ">
|
218
223
|
<span class="summary_signature">
|
224
|
+
|
225
|
+
<a title="a (class method)">.<strong>a</strong> </a>
|
226
|
+
|
219
227
|
|
220
|
-
|
221
|
-
|
222
|
-
|
223
|
-
|
228
|
+
|
224
229
|
</span>
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
230
|
+
|
231
|
+
|
232
|
+
|
233
|
+
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
|
234
239
|
<span class="summary_desc"><div class='inline'></div></span>
|
235
|
-
|
240
|
+
|
236
241
|
</li>
|
237
242
|
|
238
|
-
|
243
|
+
|
239
244
|
</ul>
|
240
|
-
|
245
|
+
|
241
246
|
<h2>
|
242
247
|
Instance Method Summary
|
243
|
-
<small
|
248
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
244
249
|
</h2>
|
245
250
|
|
246
251
|
<ul class="summary">
|
247
|
-
|
252
|
+
|
248
253
|
<li class="public ">
|
249
254
|
<span class="summary_signature">
|
255
|
+
|
256
|
+
<a title="#a (instance method)">#<strong>a</strong> </a>
|
257
|
+
|
250
258
|
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
|
259
|
+
|
255
260
|
(also: #b)
|
256
|
-
|
261
|
+
|
257
262
|
</span>
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
267
272
|
<span class="summary_desc"><div class='inline'></div></span>
|
268
|
-
|
273
|
+
|
269
274
|
</li>
|
270
275
|
|
271
|
-
|
276
|
+
|
272
277
|
<li class="public ">
|
273
278
|
<span class="summary_signature">
|
279
|
+
|
280
|
+
<a title="#test_multi_overload (instance method)">#<strong>test_multi_overload</strong>(*args) </a>
|
281
|
+
|
274
282
|
|
275
|
-
|
276
|
-
|
277
|
-
|
278
|
-
|
283
|
+
|
279
284
|
</span>
|
280
|
-
|
281
|
-
|
282
|
-
|
283
|
-
|
284
|
-
|
285
|
-
|
286
|
-
|
287
|
-
|
288
|
-
|
285
|
+
|
286
|
+
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
|
293
|
+
|
289
294
|
<span class="summary_desc"><div class='inline'></div></span>
|
290
|
-
|
295
|
+
|
291
296
|
</li>
|
292
297
|
|
293
|
-
|
298
|
+
|
294
299
|
<li class="public ">
|
295
300
|
<span class="summary_signature">
|
301
|
+
|
302
|
+
<a title="#test_overload (instance method)">#<strong>test_overload</strong>(a) </a>
|
303
|
+
|
296
304
|
|
297
|
-
|
298
|
-
|
299
|
-
|
300
|
-
|
305
|
+
|
301
306
|
</span>
|
302
|
-
|
303
|
-
|
304
|
-
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
|
310
|
-
|
307
|
+
|
308
|
+
|
309
|
+
|
310
|
+
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
|
315
|
+
|
311
316
|
<span class="summary_desc"><div class='inline'>hello2.</div></span>
|
312
|
-
|
317
|
+
|
313
318
|
</li>
|
314
319
|
|
315
|
-
|
320
|
+
|
316
321
|
<li class="public ">
|
317
322
|
<span class="summary_signature">
|
323
|
+
|
324
|
+
<a title="#void_meth (instance method)">#<strong>void_meth</strong> </a>
|
325
|
+
|
318
326
|
|
319
|
-
|
320
|
-
|
321
|
-
|
322
|
-
|
327
|
+
|
323
328
|
</span>
|
324
|
-
|
325
|
-
|
326
|
-
|
327
|
-
|
328
|
-
|
329
|
-
|
330
|
-
|
331
|
-
|
332
|
-
|
329
|
+
|
330
|
+
|
331
|
+
|
332
|
+
|
333
|
+
|
334
|
+
|
335
|
+
|
336
|
+
|
337
|
+
|
333
338
|
<span class="summary_desc"><div class='inline'></div></span>
|
334
|
-
|
339
|
+
|
335
340
|
</li>
|
336
341
|
|
337
|
-
|
342
|
+
|
338
343
|
</ul>
|
344
|
+
|
339
345
|
|
340
346
|
|
341
|
-
|
342
|
-
|
343
|
-
|
344
|
-
|
345
|
-
|
346
|
-
|
347
|
-
|
348
|
-
|
349
|
-
|
347
|
+
|
348
|
+
|
349
|
+
|
350
|
+
|
351
|
+
|
352
|
+
|
353
|
+
|
354
|
+
|
350
355
|
<h3 class="inherited">Methods included from B</h3>
|
351
356
|
<p class="inherited">#c, #d</p>
|
352
357
|
|
353
|
-
|
354
|
-
|
355
|
-
|
356
|
-
|
357
|
-
|
358
|
-
|
358
|
+
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
|
363
|
+
|
359
364
|
<div id="instance_attr_details" class="attr_details">
|
360
365
|
<h2>Instance Attribute Details</h2>
|
361
|
-
|
362
|
-
|
366
|
+
|
367
|
+
|
363
368
|
<span id="attr1=-instance_method"></span>
|
364
369
|
<div class="method_details first">
|
365
370
|
<h3 class="signature first" id="attr1-instance_method">
|
371
|
+
|
372
|
+
#<strong>attr1</strong>
|
373
|
+
|
366
374
|
|
367
|
-
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
375
|
+
|
372
376
|
|
377
|
+
|
373
378
|
</h3><div class="docstring">
|
374
379
|
<div class="discussion">
|
375
380
|
Returns the value of attribute attr1
|
@@ -377,7 +382,7 @@ and newlines.
|
|
377
382
|
</div>
|
378
383
|
</div>
|
379
384
|
<div class="tags">
|
380
|
-
|
385
|
+
|
381
386
|
|
382
387
|
</div><table class="source_code">
|
383
388
|
<tr>
|
@@ -399,18 +404,18 @@ end</pre>
|
|
399
404
|
</tr>
|
400
405
|
</table>
|
401
406
|
</div>
|
402
|
-
|
403
|
-
|
407
|
+
|
408
|
+
|
404
409
|
<span id=""></span>
|
405
410
|
<div class="method_details ">
|
406
411
|
<h3 class="signature " id="attr2-instance_method">
|
412
|
+
|
413
|
+
#<strong>attr2</strong> <span class="extras">(readonly)</span>
|
414
|
+
|
407
415
|
|
408
|
-
|
409
|
-
|
410
|
-
|
411
|
-
|
412
|
-
|
416
|
+
|
413
417
|
|
418
|
+
|
414
419
|
</h3><div class="docstring">
|
415
420
|
<div class="discussion">
|
416
421
|
Returns the value of attribute attr2
|
@@ -418,7 +423,7 @@ end</pre>
|
|
418
423
|
</div>
|
419
424
|
</div>
|
420
425
|
<div class="tags">
|
421
|
-
|
426
|
+
|
422
427
|
|
423
428
|
</div><table class="source_code">
|
424
429
|
<tr>
|
@@ -440,36 +445,36 @@ end</pre>
|
|
440
445
|
</tr>
|
441
446
|
</table>
|
442
447
|
</div>
|
443
|
-
|
444
|
-
|
448
|
+
|
449
|
+
|
445
450
|
<span id="attr3=-instance_method"></span>
|
446
451
|
<div class="method_details ">
|
447
452
|
<h3 class="signature " id="attr3-instance_method">
|
453
|
+
|
454
|
+
|
455
|
+
<span class="overload">#<strong>attr3</strong> ⇒ <tt>String</tt> </span>
|
456
|
+
|
457
|
+
<span class="overload">#<strong>attr3=</strong>(value) </span>
|
458
|
+
|
459
|
+
|
448
460
|
|
461
|
+
|
449
462
|
|
450
|
-
|
451
|
-
|
452
|
-
<span class="overload">- <strong>attr3=</strong>(value) </span>
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
|
458
|
-
|
463
|
+
|
459
464
|
</h3><div class="docstring">
|
460
465
|
<div class="discussion">
|
461
|
-
|
466
|
+
|
462
467
|
|
463
468
|
</div>
|
464
469
|
</div>
|
465
470
|
<div class="tags">
|
466
|
-
|
471
|
+
|
467
472
|
<p class="tag_title">Overloads:</p>
|
468
473
|
<ul class="overload">
|
469
|
-
|
470
|
-
|
474
|
+
|
475
|
+
|
471
476
|
<li class="overload_item">
|
472
|
-
<span class="signature"
|
477
|
+
<span class="signature">#<strong>attr3</strong> ⇒ <tt>String</tt> </span>
|
473
478
|
<div class="docstring">
|
474
479
|
<div class="discussion">
|
475
480
|
Returns a string
|
@@ -477,30 +482,30 @@ end</pre>
|
|
477
482
|
</div>
|
478
483
|
</div>
|
479
484
|
<div class="tags">
|
480
|
-
|
485
|
+
|
481
486
|
<p class="tag_title">Returns:</p>
|
482
487
|
<ul class="return">
|
483
|
-
|
488
|
+
|
484
489
|
<li>
|
485
|
-
|
486
|
-
|
490
|
+
|
491
|
+
|
487
492
|
<span class='type'>(<tt>String</tt>)</span>
|
488
|
-
|
489
|
-
|
490
|
-
|
493
|
+
|
494
|
+
|
495
|
+
|
491
496
|
—
|
492
497
|
<div class='inline'>a string</div>
|
493
|
-
|
498
|
+
|
494
499
|
</li>
|
495
|
-
|
500
|
+
|
496
501
|
</ul>
|
497
502
|
|
498
503
|
</div>
|
499
504
|
</li>
|
500
|
-
|
501
|
-
|
505
|
+
|
506
|
+
|
502
507
|
<li class="overload_item">
|
503
|
-
<span class="signature"
|
508
|
+
<span class="signature">#<strong>attr3=</strong>(value) </span>
|
504
509
|
<div class="docstring">
|
505
510
|
<div class="discussion">
|
506
511
|
<p class="note returns_void">This method returns an undefined value.</p>
|
@@ -510,27 +515,27 @@ end</pre>
|
|
510
515
|
<div class="tags">
|
511
516
|
<p class="tag_title">Parameters:</p>
|
512
517
|
<ul class="param">
|
513
|
-
|
518
|
+
|
514
519
|
<li>
|
515
|
-
|
520
|
+
|
516
521
|
<span class='name'>value</span>
|
517
|
-
|
518
|
-
|
522
|
+
|
523
|
+
|
519
524
|
<span class='type'>(<tt>String</tt>)</span>
|
520
|
-
|
521
|
-
|
522
|
-
|
525
|
+
|
526
|
+
|
527
|
+
|
523
528
|
—
|
524
529
|
<div class='inline'>sets the string</div>
|
525
|
-
|
530
|
+
|
526
531
|
</li>
|
527
|
-
|
532
|
+
|
528
533
|
</ul>
|
529
534
|
|
530
535
|
|
531
536
|
</div>
|
532
537
|
</li>
|
533
|
-
|
538
|
+
|
534
539
|
</ul>
|
535
540
|
|
536
541
|
|
@@ -554,18 +559,18 @@ end</pre>
|
|
554
559
|
</tr>
|
555
560
|
</table>
|
556
561
|
</div>
|
557
|
-
|
558
|
-
|
562
|
+
|
563
|
+
|
559
564
|
<span id=""></span>
|
560
565
|
<div class="method_details ">
|
561
566
|
<h3 class="signature " id="attr4=-instance_method">
|
567
|
+
|
568
|
+
#<strong>attr4=</strong>(value) <span class="extras">(writeonly)</span>
|
569
|
+
|
562
570
|
|
563
|
-
|
564
|
-
|
565
|
-
|
566
|
-
|
567
|
-
|
571
|
+
|
568
572
|
|
573
|
+
|
569
574
|
</h3><div class="docstring">
|
570
575
|
<div class="discussion">
|
571
576
|
Sets the attribute attr4
|
@@ -575,21 +580,21 @@ end</pre>
|
|
575
580
|
<div class="tags">
|
576
581
|
<p class="tag_title">Parameters:</p>
|
577
582
|
<ul class="param">
|
578
|
-
|
583
|
+
|
579
584
|
<li>
|
580
|
-
|
585
|
+
|
581
586
|
<span class='name'>value</span>
|
582
|
-
|
583
|
-
|
587
|
+
|
588
|
+
|
584
589
|
<span class='type'></span>
|
585
|
-
|
586
|
-
|
587
|
-
|
590
|
+
|
591
|
+
|
592
|
+
|
588
593
|
—
|
589
594
|
<div class='inline'>the value to set the attribute attr4 to.</div>
|
590
|
-
|
595
|
+
|
591
596
|
</li>
|
592
|
-
|
597
|
+
|
593
598
|
</ul>
|
594
599
|
|
595
600
|
|
@@ -613,23 +618,23 @@ end</pre>
|
|
613
618
|
</tr>
|
614
619
|
</table>
|
615
620
|
</div>
|
616
|
-
|
621
|
+
|
617
622
|
</div>
|
618
623
|
|
619
624
|
|
620
625
|
<div id="class_method_details" class="method_details_list">
|
621
626
|
<h2>Class Method Details</h2>
|
622
627
|
|
623
|
-
|
628
|
+
|
624
629
|
<div class="method_details first">
|
625
630
|
<h3 class="signature first" id="a-class_method">
|
631
|
+
|
632
|
+
.<strong>a</strong>
|
633
|
+
|
626
634
|
|
627
|
-
|
628
|
-
|
629
|
-
|
630
|
-
|
631
|
-
|
635
|
+
|
632
636
|
|
637
|
+
|
633
638
|
</h3><table class="source_code">
|
634
639
|
<tr>
|
635
640
|
<td>
|
@@ -646,26 +651,26 @@ def self.a; end</pre>
|
|
646
651
|
</tr>
|
647
652
|
</table>
|
648
653
|
</div>
|
649
|
-
|
654
|
+
|
650
655
|
</div>
|
651
656
|
|
652
657
|
<div id="instance_method_details" class="method_details_list">
|
653
658
|
<h2>Instance Method Details</h2>
|
654
659
|
|
655
|
-
|
660
|
+
|
656
661
|
<div class="method_details first">
|
657
662
|
<h3 class="signature first" id="a-instance_method">
|
663
|
+
|
664
|
+
#<strong>a</strong>
|
665
|
+
|
658
666
|
|
659
|
-
|
660
|
-
|
661
|
-
|
662
|
-
|
667
|
+
|
663
668
|
<span class="aliases">Also known as:
|
664
669
|
<span class="names"><span id='b-instance_method'>b</span></span>
|
665
670
|
</span>
|
671
|
+
|
666
672
|
|
667
|
-
|
668
|
-
|
673
|
+
|
669
674
|
</h3><table class="source_code">
|
670
675
|
<tr>
|
671
676
|
<td>
|
@@ -682,28 +687,28 @@ def a; end</pre>
|
|
682
687
|
</tr>
|
683
688
|
</table>
|
684
689
|
</div>
|
685
|
-
|
690
|
+
|
686
691
|
<div class="method_details ">
|
687
692
|
<h3 class="signature " id="test_multi_overload-instance_method">
|
693
|
+
|
694
|
+
|
695
|
+
<span class="overload">#<strong>test_multi_overload</strong>(a) </span>
|
696
|
+
|
697
|
+
<span class="overload">#<strong>test_multi_overload</strong>(a, b) </span>
|
698
|
+
|
699
|
+
|
688
700
|
|
701
|
+
|
689
702
|
|
690
|
-
|
691
|
-
|
692
|
-
<span class="overload">- <strong>test_multi_overload</strong>(a, b) </span>
|
693
|
-
|
694
|
-
|
695
|
-
|
696
|
-
|
697
|
-
|
698
|
-
|
703
|
+
|
699
704
|
</h3><div class="docstring">
|
700
705
|
<div class="discussion">
|
701
|
-
|
706
|
+
|
702
707
|
|
703
708
|
</div>
|
704
709
|
</div>
|
705
710
|
<div class="tags">
|
706
|
-
|
711
|
+
|
707
712
|
|
708
713
|
</div><table class="source_code">
|
709
714
|
<tr>
|
@@ -721,24 +726,24 @@ def test_multi_overload(*args) end</pre>
|
|
721
726
|
</tr>
|
722
727
|
</table>
|
723
728
|
</div>
|
724
|
-
|
729
|
+
|
725
730
|
<div class="method_details ">
|
726
731
|
<h3 class="signature " id="test_overload-instance_method">
|
732
|
+
|
733
|
+
#<strong>test_overload</strong>(a)
|
734
|
+
|
727
735
|
|
728
|
-
|
729
|
-
|
730
|
-
|
731
|
-
|
732
|
-
|
736
|
+
|
733
737
|
|
738
|
+
|
734
739
|
</h3><div class="docstring">
|
735
740
|
<div class="discussion">
|
736
|
-
|
741
|
+
|
737
742
|
|
738
743
|
</div>
|
739
744
|
</div>
|
740
745
|
<div class="tags">
|
741
|
-
|
746
|
+
|
742
747
|
<div class="docstring">
|
743
748
|
<div class="discussion">
|
744
749
|
hello2
|
@@ -748,21 +753,21 @@ def test_multi_overload(*args) end</pre>
|
|
748
753
|
<div class="tags">
|
749
754
|
<p class="tag_title">Parameters:</p>
|
750
755
|
<ul class="param">
|
751
|
-
|
756
|
+
|
752
757
|
<li>
|
753
|
-
|
758
|
+
|
754
759
|
<span class='name'>a</span>
|
755
|
-
|
756
|
-
|
760
|
+
|
761
|
+
|
757
762
|
<span class='type'>(<tt>String</tt>)</span>
|
758
|
-
|
759
|
-
|
760
|
-
|
763
|
+
|
764
|
+
|
765
|
+
|
761
766
|
—
|
762
767
|
<div class='inline'>hi</div>
|
763
|
-
|
768
|
+
|
764
769
|
</li>
|
765
|
-
|
770
|
+
|
766
771
|
</ul>
|
767
772
|
|
768
773
|
|
@@ -785,16 +790,16 @@ def test_overload(*args) end</pre>
|
|
785
790
|
</tr>
|
786
791
|
</table>
|
787
792
|
</div>
|
788
|
-
|
793
|
+
|
789
794
|
<div class="method_details ">
|
790
795
|
<h3 class="signature " id="void_meth-instance_method">
|
796
|
+
|
797
|
+
#<strong>void_meth</strong>
|
798
|
+
|
791
799
|
|
792
|
-
|
793
|
-
|
794
|
-
|
795
|
-
|
796
|
-
|
800
|
+
|
797
801
|
|
802
|
+
|
798
803
|
</h3><div class="docstring">
|
799
804
|
<div class="discussion">
|
800
805
|
<p class="note returns_void">This method returns an undefined value.</p>
|
@@ -802,7 +807,7 @@ def test_overload(*args) end</pre>
|
|
802
807
|
</div>
|
803
808
|
</div>
|
804
809
|
<div class="tags">
|
805
|
-
|
810
|
+
|
806
811
|
|
807
812
|
</div><table class="source_code">
|
808
813
|
<tr>
|
@@ -820,6 +825,5 @@ def void_meth; end</pre>
|
|
820
825
|
</tr>
|
821
826
|
</table>
|
822
827
|
</div>
|
823
|
-
|
828
|
+
|
824
829
|
</div>
|
825
|
-
|