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
@@ -29,7 +29,7 @@ end
|
|
29
29
|
# @param [CodeObject] object to be saved to HTML
|
30
30
|
def serialize(object)
|
31
31
|
options.object = object
|
32
|
-
serialize_index(options) if object == '_index.html' && options.
|
32
|
+
serialize_index(options) if object == '_index.html' && options.readme.nil?
|
33
33
|
Templates::Engine.with_serializer(object, options.serializer) do
|
34
34
|
T('layout').run(options)
|
35
35
|
end
|
@@ -48,7 +48,7 @@ end
|
|
48
48
|
# @params [Hash] options contains data and flags that influence the output
|
49
49
|
def serialize_index(options)
|
50
50
|
Templates::Engine.with_serializer('index.html', options.serializer) do
|
51
|
-
T('layout').run(options)
|
51
|
+
T('layout').run(options.merge(:index => true))
|
52
52
|
end
|
53
53
|
end
|
54
54
|
|
@@ -172,28 +172,71 @@ def generate_frameset
|
|
172
172
|
asset(url_for_frameset, erb(:frames))
|
173
173
|
end
|
174
174
|
|
175
|
+
# @api private
|
176
|
+
class TreeContext
|
177
|
+
|
178
|
+
def initialize
|
179
|
+
@depth = 0
|
180
|
+
@even_odd = Alternator.new(:even, :odd)
|
181
|
+
end
|
182
|
+
|
183
|
+
def nest
|
184
|
+
@depth += 1
|
185
|
+
yield
|
186
|
+
@depth -= 1
|
187
|
+
end
|
188
|
+
|
189
|
+
# @return [String] Returns a css pixel offset, e.g. "30px"
|
190
|
+
def indent
|
191
|
+
"#{(@depth + 2) * 15}px"
|
192
|
+
end
|
193
|
+
|
194
|
+
def classes
|
195
|
+
classes = []
|
196
|
+
classes << 'collapsed' if @depth > 0
|
197
|
+
classes << @even_odd.next if @depth < 2
|
198
|
+
classes
|
199
|
+
end
|
200
|
+
|
201
|
+
class Alternator
|
202
|
+
def initialize(first, second)
|
203
|
+
@next = first
|
204
|
+
@after = second
|
205
|
+
end
|
206
|
+
def next
|
207
|
+
@next, @after = @after, @next
|
208
|
+
@after
|
209
|
+
end
|
210
|
+
end
|
211
|
+
|
212
|
+
end
|
213
|
+
|
175
214
|
# @return [String] HTML output of the classes to be displayed in the
|
176
215
|
# full_list_class template.
|
177
|
-
def class_list(root = Registry.root)
|
216
|
+
def class_list(root = Registry.root, tree = TreeContext.new)
|
178
217
|
out = ""
|
179
218
|
children = run_verifier(root.children)
|
180
219
|
if root == Registry.root
|
181
220
|
children += @items.select {|o| o.namespace.is_a?(CodeObjects::Proxy) }
|
182
221
|
end
|
183
|
-
children.
|
222
|
+
children.compact.sort_by(&:path).each do |child|
|
184
223
|
if child.is_a?(CodeObjects::NamespaceObject)
|
185
224
|
name = child.namespace.is_a?(CodeObjects::Proxy) ? child.path : child.name
|
186
225
|
has_children = run_verifier(child.children).any? {|o| o.is_a?(CodeObjects::NamespaceObject) }
|
187
|
-
out << "<li>"
|
226
|
+
out << "<li id='object_#{child.path}' class='#{tree.classes.join(' ')}'>"
|
227
|
+
out << "<div class='item' style='padding-left:#{tree.indent}'>"
|
188
228
|
out << "<a class='toggle'></a> " if has_children
|
189
229
|
out << linkify(child, name)
|
190
230
|
out << " < #{child.superclass.name}" if child.is_a?(CodeObjects::ClassObject) && child.superclass
|
191
231
|
out << "<small class='search_info'>"
|
192
232
|
out << child.namespace.title
|
193
233
|
out << "</small>"
|
234
|
+
out << "</div>"
|
235
|
+
tree.nest do
|
236
|
+
out << "<ul>#{class_list(child, tree)}</ul>" if has_children
|
237
|
+
end
|
194
238
|
out << "</li>"
|
195
|
-
out << "<ul>#{class_list(child)}</ul>" if has_children
|
196
239
|
end
|
197
240
|
end
|
198
241
|
out
|
199
|
-
end
|
242
|
+
end
|
@@ -8,6 +8,4 @@
|
|
8
8
|
<%= @breadcrumb.size > 0 ? " » " : "" %>
|
9
9
|
<span class="title"><%= object.root? ? "Top Level Namespace" : object.name(true) %></span>
|
10
10
|
<% end %>
|
11
|
-
|
12
|
-
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
13
11
|
</div>
|
@@ -1,4 +1,5 @@
|
|
1
|
-
<meta
|
1
|
+
<meta charset="<%= charset %>">
|
2
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
2
3
|
<title>
|
3
4
|
<%= h @page_title %>
|
4
5
|
<% if options.title && @page_title != options.title %>
|
@@ -1,20 +1,26 @@
|
|
1
|
-
<!DOCTYPE html
|
2
|
-
|
3
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
4
3
|
<head>
|
5
4
|
<%= erb(:headers) %>
|
6
5
|
</head>
|
7
6
|
<body>
|
8
|
-
<div
|
9
|
-
<%=
|
10
|
-
|
11
|
-
<div class="clear"></div>
|
7
|
+
<div class="nav_wrap">
|
8
|
+
<iframe id="nav" src="<%= @nav_url %>"></iframe>
|
9
|
+
<div id="resizer"></div>
|
12
10
|
</div>
|
13
11
|
|
14
|
-
<
|
12
|
+
<div id="main" tabindex="-1">
|
13
|
+
<div id="header">
|
14
|
+
<%= erb(:breadcrumb) %>
|
15
|
+
<%= erb(:search) %>
|
16
|
+
<div class="clear"></div>
|
17
|
+
</div>
|
15
18
|
|
16
|
-
|
19
|
+
<iframe id="search_frame" src="<%= @nav_url %>"></iframe>
|
17
20
|
|
18
|
-
|
21
|
+
<div id="content"><%= yieldall %></div>
|
22
|
+
|
23
|
+
<%= erb(:footer) %>
|
24
|
+
</div>
|
19
25
|
</body>
|
20
26
|
</html>
|
@@ -1,5 +1,4 @@
|
|
1
1
|
<script type="text/javascript" charset="utf-8">
|
2
|
-
|
2
|
+
pathId = <%= @path ? @path.inspect : 'null' %>;
|
3
3
|
relpath = '<%= u = url_for(''); u + (u != '' ? '/' : '') %>';
|
4
|
-
framesUrl = "<%= url_for_frameset %>#!<%= url_for(@file || @object, nil, false) %>";
|
5
4
|
</script>
|
@@ -1,8 +1,13 @@
|
|
1
1
|
<div id="search">
|
2
|
-
<% menu_lists.each do |field| %>
|
2
|
+
<% [menu_lists.first].each do |field| %>
|
3
3
|
<a class="full_list_link" id="<%= field[:type] %>_list_link"
|
4
4
|
href="<%= url_for_list(field[:type]) %>">
|
5
|
-
|
5
|
+
|
6
|
+
<svg width="24" height="24">
|
7
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
8
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
9
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
10
|
+
</svg>
|
6
11
|
</a>
|
7
12
|
<% end %>
|
8
13
|
</div>
|
@@ -44,6 +44,22 @@ def index
|
|
44
44
|
erb(:index)
|
45
45
|
end
|
46
46
|
|
47
|
+
def layout
|
48
|
+
@nav_url = url_for_list(!@file || options.index ? 'class' : 'file')
|
49
|
+
|
50
|
+
if !object || object.is_a?(String)
|
51
|
+
@path = nil
|
52
|
+
elsif @file
|
53
|
+
@path = @file.path
|
54
|
+
elsif !object.is_a?(YARD::CodeObjects::NamespaceObject)
|
55
|
+
@path = object.parent.path
|
56
|
+
else
|
57
|
+
@path = object.path
|
58
|
+
end
|
59
|
+
|
60
|
+
erb(:layout)
|
61
|
+
end
|
62
|
+
|
47
63
|
def diskfile
|
48
64
|
@file.attributes[:markup] ||= markup_for_file('', @file.filename)
|
49
65
|
data = htmlify(@file.contents, @file.attributes[:markup])
|
@@ -1,13 +1,14 @@
|
|
1
1
|
<h1>Method: <%= object.path %></h1>
|
2
|
-
<
|
3
|
-
<
|
4
|
-
|
2
|
+
<div class="box_info">
|
3
|
+
<dl>
|
4
|
+
<dt class="">Defined in:</dt>
|
5
|
+
<dd class="">
|
5
6
|
<%= object.file %><% if object.files.size > 1 %><span class="defines">,<br />
|
6
7
|
<%= object.files[1..-1].map {|f| f.first }.join(",<br /> ") %></div>
|
7
8
|
<% end %>
|
8
|
-
|
9
|
-
</dl>
|
10
|
-
|
9
|
+
</dd>
|
10
|
+
</dl>
|
11
|
+
</div>
|
11
12
|
|
12
13
|
<div class="method_details_list">
|
13
14
|
<div id="method_details">
|
@@ -1,5 +1,5 @@
|
|
1
1
|
<% groups(attr_listing, "Attribute") do |list, name| %>
|
2
|
-
<h2><%= name %> <small
|
2
|
+
<h2><%= name %> <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
3
3
|
<ul class="summary">
|
4
4
|
<% list.each do |meth| %>
|
5
5
|
<%= yieldall :item => meth %>
|
@@ -1,8 +1,8 @@
|
|
1
|
-
|
2
|
-
<dl class="box">
|
1
|
+
<div class="box_info">
|
3
2
|
<% if CodeObjects::ClassObject === object && object.superclass %>
|
4
|
-
|
5
|
-
<
|
3
|
+
<dl>
|
4
|
+
<dt>Inherits:</dt>
|
5
|
+
<dd>
|
6
6
|
<span class="inheritName"><%= linkify object.superclass %></span>
|
7
7
|
<% if object.superclass.name != :BasicObject %>
|
8
8
|
<ul class="fullTree">
|
@@ -13,25 +13,31 @@
|
|
13
13
|
</ul>
|
14
14
|
<a href="#" class="inheritanceTree">show all</a>
|
15
15
|
<% end %>
|
16
|
-
|
17
|
-
|
16
|
+
</dd>
|
17
|
+
</dl>
|
18
18
|
<% end %>
|
19
|
+
|
19
20
|
<% [[:class, "Extended by"], [:instance, "Includes"]].each do |scope, name| %>
|
20
|
-
|
21
|
-
|
22
|
-
<
|
23
|
-
|
24
|
-
|
21
|
+
<% if (mix = run_verifier(object.mixins(scope))).size > 0 %>
|
22
|
+
<dl>
|
23
|
+
<dt><%= name %>:</dt>
|
24
|
+
<dd><%= mix.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>
|
25
|
+
</dl>
|
26
|
+
<% end %>
|
25
27
|
<% end %>
|
28
|
+
|
26
29
|
<% if (mixed_into = mixed_into(object)).size > 0 %>
|
27
|
-
|
28
|
-
<
|
29
|
-
|
30
|
+
<dl>
|
31
|
+
<dt>Included in:</dt>
|
32
|
+
<dd><%= mixed_into.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>
|
33
|
+
</dl>
|
30
34
|
<% end %>
|
35
|
+
|
31
36
|
<% unless object.root? %>
|
32
|
-
|
33
|
-
<
|
37
|
+
<dl>
|
38
|
+
<dt>Defined in:</dt>
|
39
|
+
<dd><%= erb(:defines) %></dd>
|
40
|
+
</dl>
|
34
41
|
<% end %>
|
35
|
-
</
|
36
|
-
<div class="clear"></div>
|
42
|
+
</div>
|
37
43
|
|
@@ -1,13 +1,11 @@
|
|
1
|
-
<% if constant_listing.size > 0
|
1
|
+
<% if constant_listing.size > 0 %>
|
2
2
|
<h2>Constant Summary</h2>
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
</dl>
|
12
|
-
<% end %>
|
3
|
+
<dl class="constants">
|
4
|
+
<% constant_listing.each do |cnst| %>
|
5
|
+
<dt id="<%= anchor_for(cnst) %>" class="<%= cnst.has_tag?(:deprecated) ? 'deprecated' : '' %>"><%= cnst.name %> =
|
6
|
+
<%= yieldall :object => cnst %>
|
7
|
+
</dt>
|
8
|
+
<dd><pre class="code"><%= format_constant cnst.value %></pre></dd>
|
9
|
+
<% end %>
|
10
|
+
</dl>
|
13
11
|
<% end %>
|
@@ -1,7 +1,7 @@
|
|
1
1
|
<li class="<%= @item.visibility %> <%= @item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
|
2
2
|
<span class="summary_signature">
|
3
3
|
<% if @item.tags(:overload).size == 1 %>
|
4
|
-
<%= signature(@item.tag(:overload), true, !@item.attr_info) %>
|
4
|
+
<%= signature(@item.tag(:overload), true, false, !@item.attr_info) %>
|
5
5
|
<% else %>
|
6
6
|
<%= signature(@item, true, false, !@item.attr_info) %>
|
7
7
|
<% end %>
|
data/yard.gemspec
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: yard
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.9.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Loren Segal
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2016-07-04 00:00:00.000000000 Z
|
12
12
|
dependencies: []
|
13
13
|
description: |2
|
14
14
|
YARD is a documentation generation tool for the Ruby programming language.
|
@@ -136,6 +136,7 @@ files:
|
|
136
136
|
- lib/yard/handlers/ruby/class_variable_handler.rb
|
137
137
|
- lib/yard/handlers/ruby/comment_handler.rb
|
138
138
|
- lib/yard/handlers/ruby/constant_handler.rb
|
139
|
+
- lib/yard/handlers/ruby/decorator_handler_methods.rb
|
139
140
|
- lib/yard/handlers/ruby/dsl_handler.rb
|
140
141
|
- lib/yard/handlers/ruby/dsl_handler_methods.rb
|
141
142
|
- lib/yard/handlers/ruby/exception_handler.rb
|
@@ -166,6 +167,7 @@ files:
|
|
166
167
|
- lib/yard/handlers/ruby/module_handler.rb
|
167
168
|
- lib/yard/handlers/ruby/private_class_method_handler.rb
|
168
169
|
- lib/yard/handlers/ruby/private_constant_handler.rb
|
170
|
+
- lib/yard/handlers/ruby/public_class_method_handler.rb
|
169
171
|
- lib/yard/handlers/ruby/struct_handler_methods.rb
|
170
172
|
- lib/yard/handlers/ruby/visibility_handler.rb
|
171
173
|
- lib/yard/handlers/ruby/yield_handler.rb
|
@@ -320,8 +322,10 @@ files:
|
|
320
322
|
- spec/handlers/c/struct_handler_spec.rb
|
321
323
|
- spec/handlers/class_condition_handler_spec.rb
|
322
324
|
- spec/handlers/class_handler_spec.rb
|
325
|
+
- spec/handlers/class_method_handler_shared_examples.rb
|
323
326
|
- spec/handlers/class_variable_handler_spec.rb
|
324
327
|
- spec/handlers/constant_handler_spec.rb
|
328
|
+
- spec/handlers/decorator_handler_methods_spec.rb
|
325
329
|
- spec/handlers/dsl_handler_spec.rb
|
326
330
|
- spec/handlers/examples/alias_handler_001.rb.txt
|
327
331
|
- spec/handlers/examples/attribute_handler_001.rb.txt
|
@@ -336,9 +340,6 @@ files:
|
|
336
340
|
- spec/handlers/examples/method_handler_001.rb.txt
|
337
341
|
- spec/handlers/examples/mixin_handler_001.rb.txt
|
338
342
|
- spec/handlers/examples/module_handler_001.rb.txt
|
339
|
-
- spec/handlers/examples/private_class_method_handler_001.rb.txt
|
340
|
-
- spec/handlers/examples/private_class_method_handler_002.rb.txt
|
341
|
-
- spec/handlers/examples/private_class_method_handler_003.rb.txt
|
342
343
|
- spec/handlers/examples/private_constant_handler_001.rb.txt
|
343
344
|
- spec/handlers/examples/process_handler_001.rb.txt
|
344
345
|
- spec/handlers/examples/visibility_handler_001.rb.txt
|
@@ -354,6 +355,7 @@ files:
|
|
354
355
|
- spec/handlers/private_class_method_handler_spec.rb
|
355
356
|
- spec/handlers/private_constant_handler_spec.rb
|
356
357
|
- spec/handlers/processor_spec.rb
|
358
|
+
- spec/handlers/public_class_method_handler_spec.rb
|
357
359
|
- spec/handlers/ruby/base_spec.rb
|
358
360
|
- spec/handlers/ruby/legacy/base_spec.rb
|
359
361
|
- spec/handlers/spec_helper.rb
|
@@ -603,9 +605,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
603
605
|
- !ruby/object:Gem::Version
|
604
606
|
version: '0'
|
605
607
|
requirements: []
|
606
|
-
rubyforge_project:
|
607
|
-
rubygems_version: 2.
|
608
|
+
rubyforge_project:
|
609
|
+
rubygems_version: 2.5.1
|
608
610
|
signing_key:
|
609
611
|
specification_version: 4
|
610
612
|
summary: Documentation tool for consistent and usable documentation in Ruby.
|
611
613
|
test_files: []
|
614
|
+
has_rdoc: yard
|