yard 0.9.29 → 0.9.30
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/docs/CodeObjects.md +115 -0
- data/docs/GettingStarted.md +679 -0
- data/docs/Handlers.md +152 -0
- data/docs/Overview.md +61 -0
- data/docs/Parser.md +191 -0
- data/docs/Tags.md +283 -0
- data/docs/TagsArch.md +123 -0
- data/docs/Templates.md +496 -0
- data/docs/WhatsNew.md +1245 -0
- data/docs/images/code-objects-class-diagram.png +0 -0
- 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/images/tags-class-diagram.png +0 -0
- data/docs/templates/default/fulldoc/html/full_list_tag.erb +9 -0
- data/docs/templates/default/fulldoc/html/setup.rb +6 -0
- data/docs/templates/default/layout/html/setup.rb +9 -0
- data/docs/templates/default/layout/html/tag_list.erb +11 -0
- data/docs/templates/default/yard_tags/html/list.erb +18 -0
- data/docs/templates/default/yard_tags/html/setup.rb +26 -0
- data/docs/templates/plugin.rb +70 -0
- data/lib/yard/version.rb +1 -1
- data/po/ja.po +31108 -0
- data/templates/default/class/dot/setup.rb +7 -0
- data/templates/default/class/dot/superklass.erb +3 -0
- data/templates/default/class/html/constructor_details.erb +8 -0
- data/templates/default/class/html/setup.rb +2 -0
- data/templates/default/class/html/subclasses.erb +4 -0
- data/templates/default/class/setup.rb +36 -0
- data/templates/default/class/text/setup.rb +12 -0
- data/templates/default/class/text/subclasses.erb +5 -0
- data/templates/default/constant/text/header.erb +11 -0
- data/templates/default/constant/text/setup.rb +4 -0
- data/templates/default/docstring/html/abstract.erb +4 -0
- data/templates/default/docstring/html/deprecated.erb +1 -0
- data/templates/default/docstring/html/index.erb +5 -0
- data/templates/default/docstring/html/note.erb +6 -0
- data/templates/default/docstring/html/private.erb +4 -0
- data/templates/default/docstring/html/returns_void.erb +1 -0
- data/templates/default/docstring/html/text.erb +1 -0
- data/templates/default/docstring/html/todo.erb +6 -0
- data/templates/default/docstring/setup.rb +52 -0
- data/templates/default/docstring/text/abstract.erb +2 -0
- data/templates/default/docstring/text/deprecated.erb +2 -0
- data/templates/default/docstring/text/index.erb +2 -0
- data/templates/default/docstring/text/note.erb +4 -0
- data/templates/default/docstring/text/private.erb +2 -0
- data/templates/default/docstring/text/returns_void.erb +1 -0
- data/templates/default/docstring/text/text.erb +1 -0
- data/templates/default/docstring/text/todo.erb +4 -0
- data/templates/default/fulldoc/html/css/common.css +1 -0
- data/templates/default/fulldoc/html/css/full_list.css +58 -0
- data/templates/default/fulldoc/html/css/style.css +497 -0
- data/templates/default/fulldoc/html/frames.erb +17 -0
- data/templates/default/fulldoc/html/full_list.erb +37 -0
- data/templates/default/fulldoc/html/full_list_class.erb +2 -0
- data/templates/default/fulldoc/html/full_list_file.erb +7 -0
- data/templates/default/fulldoc/html/full_list_method.erb +10 -0
- data/templates/default/fulldoc/html/js/app.js +314 -0
- data/templates/default/fulldoc/html/js/full_list.js +216 -0
- data/templates/default/fulldoc/html/js/jquery.js +4 -0
- data/templates/default/fulldoc/html/setup.rb +241 -0
- data/templates/default/layout/dot/header.erb +6 -0
- data/templates/default/layout/dot/setup.rb +15 -0
- data/templates/default/layout/html/breadcrumb.erb +11 -0
- data/templates/default/layout/html/files.erb +11 -0
- data/templates/default/layout/html/footer.erb +5 -0
- data/templates/default/layout/html/headers.erb +15 -0
- data/templates/default/layout/html/index.erb +2 -0
- data/templates/default/layout/html/layout.erb +24 -0
- data/templates/default/layout/html/listing.erb +4 -0
- data/templates/default/layout/html/objects.erb +32 -0
- data/templates/default/layout/html/script_setup.erb +4 -0
- data/templates/default/layout/html/search.erb +13 -0
- data/templates/default/layout/html/setup.rb +89 -0
- data/templates/default/method/html/header.erb +17 -0
- data/templates/default/method/setup.rb +4 -0
- data/templates/default/method/text/header.erb +1 -0
- data/templates/default/method_details/html/header.erb +3 -0
- data/templates/default/method_details/html/method_signature.erb +25 -0
- data/templates/default/method_details/html/source.erb +10 -0
- data/templates/default/method_details/setup.rb +11 -0
- data/templates/default/method_details/text/header.erb +10 -0
- data/templates/default/method_details/text/method_signature.erb +12 -0
- data/templates/default/method_details/text/setup.rb +11 -0
- data/templates/default/module/dot/child.erb +1 -0
- data/templates/default/module/dot/dependencies.erb +3 -0
- data/templates/default/module/dot/header.erb +6 -0
- data/templates/default/module/dot/info.erb +14 -0
- data/templates/default/module/dot/setup.rb +15 -0
- data/templates/default/module/html/attribute_details.erb +10 -0
- data/templates/default/module/html/attribute_summary.erb +8 -0
- data/templates/default/module/html/box_info.erb +43 -0
- data/templates/default/module/html/children.erb +8 -0
- data/templates/default/module/html/constant_summary.erb +17 -0
- data/templates/default/module/html/defines.erb +3 -0
- data/templates/default/module/html/header.erb +5 -0
- data/templates/default/module/html/inherited_attributes.erb +14 -0
- data/templates/default/module/html/inherited_constants.erb +8 -0
- data/templates/default/module/html/inherited_methods.erb +19 -0
- data/templates/default/module/html/item_summary.erb +40 -0
- data/templates/default/module/html/method_details_list.erb +9 -0
- data/templates/default/module/html/method_summary.erb +14 -0
- data/templates/default/module/html/methodmissing.erb +12 -0
- data/templates/default/module/html/pre_docstring.erb +1 -0
- data/templates/default/module/setup.rb +167 -0
- data/templates/default/module/text/children.erb +10 -0
- data/templates/default/module/text/class_meths_list.erb +8 -0
- data/templates/default/module/text/extends.erb +8 -0
- data/templates/default/module/text/header.erb +7 -0
- data/templates/default/module/text/includes.erb +8 -0
- data/templates/default/module/text/instance_meths_list.erb +8 -0
- data/templates/default/module/text/setup.rb +13 -0
- data/templates/default/onefile/html/files.erb +5 -0
- data/templates/default/onefile/html/headers.erb +6 -0
- data/templates/default/onefile/html/layout.erb +17 -0
- data/templates/default/onefile/html/readme.erb +3 -0
- data/templates/default/onefile/html/setup.rb +62 -0
- data/templates/default/root/dot/child.erb +3 -0
- data/templates/default/root/dot/setup.rb +6 -0
- data/templates/default/root/html/setup.rb +2 -0
- data/templates/default/tags/html/example.erb +11 -0
- data/templates/default/tags/html/index.erb +3 -0
- data/templates/default/tags/html/option.erb +24 -0
- data/templates/default/tags/html/overload.erb +14 -0
- data/templates/default/tags/html/see.erb +8 -0
- data/templates/default/tags/html/tag.erb +20 -0
- data/templates/default/tags/setup.rb +57 -0
- data/templates/default/tags/text/example.erb +12 -0
- data/templates/default/tags/text/index.erb +1 -0
- data/templates/default/tags/text/option.erb +20 -0
- data/templates/default/tags/text/overload.erb +19 -0
- data/templates/default/tags/text/see.erb +11 -0
- data/templates/default/tags/text/tag.erb +13 -0
- data/templates/guide/class/html/setup.rb +2 -0
- data/templates/guide/docstring/html/setup.rb +2 -0
- data/templates/guide/fulldoc/html/css/style.css +108 -0
- data/templates/guide/fulldoc/html/js/app.js +33 -0
- data/templates/guide/fulldoc/html/setup.rb +74 -0
- data/templates/guide/layout/html/layout.erb +81 -0
- data/templates/guide/layout/html/setup.rb +25 -0
- data/templates/guide/method/html/header.erb +18 -0
- data/templates/guide/method/html/setup.rb +22 -0
- data/templates/guide/module/html/header.erb +7 -0
- data/templates/guide/module/html/method_list.erb +5 -0
- data/templates/guide/module/html/setup.rb +27 -0
- data/templates/guide/onefile/html/files.erb +4 -0
- data/templates/guide/onefile/html/setup.rb +6 -0
- data/templates/guide/onefile/html/toc.erb +3 -0
- data/templates/guide/tags/html/setup.rb +9 -0
- metadata +151 -2
@@ -0,0 +1,108 @@
|
|
1
|
+
body { color: #3e4349; font-family: Georgia, serif; font-size: 17px; margin: 0; }
|
2
|
+
h1, h2, h3, h4, h5, h6 { font-weight: normal; color: #000; font-family: Georgia, serif; }
|
3
|
+
h1 { color: #040; }
|
4
|
+
h2 { color: #060; }
|
5
|
+
h3 { color: #070; }
|
6
|
+
h4 { color: #080; }
|
7
|
+
h5 { color: #090; }
|
8
|
+
#sidebar h2 { color: #2f2; }
|
9
|
+
strong { color: #000; }
|
10
|
+
.object_link, tt, code { font-family: 'Consolas', 'BitStream Vera Sans Mono', monospace; font-size: 14px; }
|
11
|
+
.method_header .path, .module_header .path { font-family: 'Consolas', 'BitStream Vera Sans Mono', monospace; }
|
12
|
+
.method_header .path.space, .module_header .path.space { padding-left: 5px; }
|
13
|
+
.method_header { font-size: 0.95em; }
|
14
|
+
.method_body { margin-left: 2em; }
|
15
|
+
.tags h3, .tags h4 { font-size: 0.9em; font-weight: bold; color: #3e4349; }
|
16
|
+
.tags .param .name { font-style: italic; }
|
17
|
+
.tags .option .name { font-family: monospace; color: #000; font-size: 0.8em; }
|
18
|
+
.tags .option .type, .tags .param .type { font-size: 10px; vertical-align: super; }
|
19
|
+
.tags .option .type tt, .tags .param .type tt,
|
20
|
+
.tags .option .type tt .object_link, .tags .param .type tt .object_link { font-size: 10px; }
|
21
|
+
.module_methods { margin-left: 2em; }
|
22
|
+
.method_header .since, .module_header .since { font-size: 0.75em; color: #888; vertical-align: super; }
|
23
|
+
ul { list-style: square; }
|
24
|
+
.inline { display: inline; }
|
25
|
+
.inline p:first-child { display: inline; }
|
26
|
+
.inline p { font-family: Georgia, serif; font-size: 16px; color: #3e4349; }
|
27
|
+
#filecontents table, .docstring table { border-collapse: collapse; }
|
28
|
+
#filecontents table th, #filecontents table td,
|
29
|
+
.docstring table th, .docstring table td { border: 1px solid #ccc; padding: 8px; padding-right: 17px; }
|
30
|
+
#filecontents table tr:nth-child(odd),
|
31
|
+
.docstring table tr:nth-child(odd) { background: #eee; }
|
32
|
+
#filecontents table tr:nth-child(even),
|
33
|
+
.docstring table tr:nth-child(even) { background: #fff; }
|
34
|
+
#filecontents table th, .docstring table th { background: #fff; }
|
35
|
+
.docstring .note { margin: 1em 0; }
|
36
|
+
.docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; border: 0; border-bottom: 1px dotted #bbb; }
|
37
|
+
.docstring h1 { font-size: 1.2em; }
|
38
|
+
.docstring h2 { font-size: 1.1em; }
|
39
|
+
.docstring h3 { font-size: 1.1em; }
|
40
|
+
.docstring h4 { font-size: 1.0em; font-weight: bold; }
|
41
|
+
.docstring h5 { font-size: 1.0em; font-weight: bold; }
|
42
|
+
.docstring h6 { font-size: 1.0em; font-weight: bold; }
|
43
|
+
#filecontents strong { font-weight: normal; color: #000; }
|
44
|
+
.readonly { font-size: 0.75em; color: #888; vertical-align: super; }
|
45
|
+
.rdoc-term { padding-right: 25px; font-weight: bold; }
|
46
|
+
.rdoc-list p { margin: 0; padding: 0; margin-bottom: 4px; }
|
47
|
+
|
48
|
+
#page { width: 940px; margin: 0px auto; }
|
49
|
+
#top_nav { background: #7d0; padding: 8px 12px; }
|
50
|
+
#inner_nav { width: 940px; margin: 0px auto; }
|
51
|
+
#inner_nav a { border: 0; text-decoration: none; color: #777; }
|
52
|
+
#inner_nav a:hover { color: #222; }
|
53
|
+
#top_nav .links { display: block; float: right; }
|
54
|
+
#content { margin-left: 30px; width: 660px; float: left; }
|
55
|
+
#sidebar { float: left; width: 200px; float: left; padding: 18px 10px; padding-top: 0; }
|
56
|
+
#sidebar h2 { font-weight: 100; color: #3e4349; font-size: 1.45em; }
|
57
|
+
#sidebar ol { padding-left: 16px; margin-left: 0; list-style: square; }
|
58
|
+
#sidebar a { color: #468; text-decoration: none; }
|
59
|
+
#sidebar a:hover { color: #000; background: #8e0; padding: 4px; }
|
60
|
+
#sidebar ol.top { padding-left: 0; margin-left: 0; list-style: none; }
|
61
|
+
#sidebar a { font-size: 0.9em; }
|
62
|
+
#footer { margin: 0 auto; width: 940px; text-align: center; margin-top: 30px; padding: 20px 0; color: #888; font-size: 0.8em; border-top: 1px dotted #bbb; }
|
63
|
+
#footer a { color: #444; }
|
64
|
+
#links strong { font-size: 0.95em; font-weight: normal; color: #000; }
|
65
|
+
|
66
|
+
a { color: #268; text-decoration: none; }
|
67
|
+
a:hover { color: #6ae; }
|
68
|
+
|
69
|
+
/* syntax highlighting */
|
70
|
+
.source_code { display: none; padding: 3px 8px; border-left: 8px solid #ddd; margin-top: 5px; }
|
71
|
+
#filecontents pre.code, .docstring pre.code, .source_code pre { font-family: monospace; }
|
72
|
+
#filecontents pre.code, .docstring pre.code { display: block; }
|
73
|
+
.source_code .lines { padding-right: 12px; color: #555; text-align: right; }
|
74
|
+
#filecontents pre.code, .docstring pre.code,
|
75
|
+
.tags pre.example {
|
76
|
+
font-size: 0.9em;
|
77
|
+
padding: 7px 30px;
|
78
|
+
margin: 15px -30px;
|
79
|
+
margin-left: -30px;
|
80
|
+
background: #eee;
|
81
|
+
line-height: 1.3em;
|
82
|
+
font-family: 'Consolas', 'BitStream Vera Sans Mono', monospace;
|
83
|
+
}
|
84
|
+
pre.code { color: #3e4349; }
|
85
|
+
pre.code .info.file { color: #555; }
|
86
|
+
pre.code .val { color: #036A07; }
|
87
|
+
pre.code .tstring_content,
|
88
|
+
pre.code .heredoc_beg, pre.code .heredoc_end,
|
89
|
+
pre.code .qwords_beg, pre.code .qwords_end,
|
90
|
+
pre.code .tstring, pre.code .dstring { color: #036A07; }
|
91
|
+
pre.code .fid, pre.code .rubyid_new, pre.code .rubyid_to_s,
|
92
|
+
pre.code .rubyid_to_sym, pre.code .rubyid_to_f,
|
93
|
+
pre.code .dot + pre.code .id,
|
94
|
+
pre.code .rubyid_to_i pre.code .rubyid_each { color: #0085FF; }
|
95
|
+
pre.code .comment { color: #0066FF; }
|
96
|
+
pre.code .const, pre.code .constant { color: #585CF6; }
|
97
|
+
pre.code .symbol { color: #C5060B; }
|
98
|
+
pre.code .kw,
|
99
|
+
pre.code .label,
|
100
|
+
pre.code .rubyid_require,
|
101
|
+
pre.code .rubyid_extend,
|
102
|
+
pre.code .rubyid_include { color: #0000FF; }
|
103
|
+
pre.code .ivar { color: #318495; }
|
104
|
+
pre.code .gvar,
|
105
|
+
pre.code .rubyid_backref,
|
106
|
+
pre.code .rubyid_nth_ref { color: #6D79DE; }
|
107
|
+
pre.code .regexp, .dregexp { color: #036A07; }
|
108
|
+
pre.code a { border-bottom: 1px dotted #bbf; }
|
@@ -0,0 +1,33 @@
|
|
1
|
+
function generateTOC() {
|
2
|
+
if ($('#filecontents').length == 0) return;
|
3
|
+
var _toc = $('<ol class="top"></ol>');
|
4
|
+
var show = false;
|
5
|
+
var toc = _toc;
|
6
|
+
var counter = 0;
|
7
|
+
var tags = ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
|
8
|
+
for (i in tags) { tags[i] = '#filecontents > ' + tags[i] }
|
9
|
+
var lastTag = parseInt(tags[0][1]);
|
10
|
+
$(tags.join(', ')).each(function() {
|
11
|
+
if (this.id == "filecontents") return;
|
12
|
+
show = true;
|
13
|
+
var thisTag = parseInt(this.tagName[1]);
|
14
|
+
if (this.id.length == 0) {
|
15
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
16
|
+
if ($('#' + proposedId).length > 0) proposedId += counter++;
|
17
|
+
this.id = proposedId;
|
18
|
+
}
|
19
|
+
if (thisTag > lastTag) {
|
20
|
+
for (var i = 0; i < thisTag - lastTag; i++) {
|
21
|
+
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
22
|
+
}
|
23
|
+
}
|
24
|
+
if (thisTag < lastTag) {
|
25
|
+
for (var i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
26
|
+
}
|
27
|
+
toc.append('<li><a href="#' + this.id + '">' + $(this).text() + '</a></li>');
|
28
|
+
lastTag = thisTag;
|
29
|
+
});
|
30
|
+
if (!show) return;
|
31
|
+
$('#toc').append()
|
32
|
+
$('#toc').append(_toc);
|
33
|
+
}
|
@@ -0,0 +1,74 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
include T('default/fulldoc/html')
|
3
|
+
|
4
|
+
module OverrideFileLinks
|
5
|
+
def resolve_links(text)
|
6
|
+
result = ''
|
7
|
+
log.enter_level(Logger::ERROR) { result = super }
|
8
|
+
result
|
9
|
+
end
|
10
|
+
|
11
|
+
def url_for(object, *args)
|
12
|
+
if CodeObjects::ExtraFileObject === object && object == options.readme
|
13
|
+
'index.html'
|
14
|
+
else
|
15
|
+
super
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
Template.extra_includes << OverrideFileLinks
|
21
|
+
|
22
|
+
def init
|
23
|
+
class << options.serializer
|
24
|
+
define_method(:serialized_path) do |object|
|
25
|
+
if CodeObjects::ExtraFileObject === object
|
26
|
+
super(object).sub(/^file\./, '').downcase
|
27
|
+
else
|
28
|
+
super(object)
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end if options.serializer
|
32
|
+
|
33
|
+
return serialize_onefile if options.onefile
|
34
|
+
|
35
|
+
generate_assets
|
36
|
+
options.delete(:objects)
|
37
|
+
options.files.each {|file| serialize_file(file) }
|
38
|
+
serialize_file(options.readme) if options.readme
|
39
|
+
end
|
40
|
+
|
41
|
+
def generate_assets
|
42
|
+
%w(js/jquery.js js/app.js css/style.css css/common.css).each do |file|
|
43
|
+
asset(file, file(file, true))
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
def serialize_file(file)
|
48
|
+
index = options.files.index(file)
|
49
|
+
outfile = file.name.downcase + '.html'
|
50
|
+
options.file = file
|
51
|
+
if file.attributes[:namespace]
|
52
|
+
options.object = Registry.at(file.attributes[:namespace])
|
53
|
+
end
|
54
|
+
options.object ||= Registry.root
|
55
|
+
|
56
|
+
if file == options.readme
|
57
|
+
serialize_index(options)
|
58
|
+
else
|
59
|
+
serialize_index(options) if !options.readme && index == 0
|
60
|
+
Templates::Engine.with_serializer(outfile, options.serializer) do
|
61
|
+
T('layout').run(options)
|
62
|
+
end
|
63
|
+
end
|
64
|
+
options.delete(:file)
|
65
|
+
end
|
66
|
+
|
67
|
+
def serialize_onefile
|
68
|
+
layout = Object.new.extend(T('layout'))
|
69
|
+
options.css_data = layout.stylesheets.map {|sheet| file(sheet, true) }.join("\n")
|
70
|
+
options.js_data = layout.javascripts.map {|script| file(script, true) }.join("")
|
71
|
+
Templates::Engine.with_serializer('onefile.html', options.serializer) do
|
72
|
+
T('onefile').run(options)
|
73
|
+
end
|
74
|
+
end
|
@@ -0,0 +1,81 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
+
<head>
|
5
|
+
<%= erb(:headers) %>
|
6
|
+
<script type="text/javascript">
|
7
|
+
$(function() {
|
8
|
+
$('.object_link').each(function() {
|
9
|
+
$(this).html($(this).find('a').html())
|
10
|
+
});
|
11
|
+
});
|
12
|
+
$(function() {
|
13
|
+
generateTOC();
|
14
|
+
if ($('#toc li').size() == 0) {
|
15
|
+
$('#sidebar h2.toc').hide();
|
16
|
+
}
|
17
|
+
})
|
18
|
+
</script>
|
19
|
+
</head>
|
20
|
+
<body>
|
21
|
+
<div id="top_nav">
|
22
|
+
<div id="inner_nav">
|
23
|
+
<% if options.readme != options.file && options.title %>
|
24
|
+
<span class="title"><strong><%= options.title %></strong>: <%= @page_title %></span>
|
25
|
+
<small class="links">
|
26
|
+
<% links = [@prevfile ? link_file(@prevfile, '←') : nil,
|
27
|
+
link_file('index.html', '↑'),
|
28
|
+
@nextfile ? link_file(@nextfile, '→') : nil].compact %>
|
29
|
+
<%= links.join(" ") %>
|
30
|
+
</small>
|
31
|
+
<% end %>
|
32
|
+
</div>
|
33
|
+
</div>
|
34
|
+
<div id="page">
|
35
|
+
<div id="sidebar">
|
36
|
+
<h2 class="toc">Table Of Contents</h2>
|
37
|
+
<div id="toc"></div>
|
38
|
+
|
39
|
+
<% if options.readme != options.file %>
|
40
|
+
<h2>Related Topics</h2>
|
41
|
+
<div id="links">
|
42
|
+
<ol class="top">
|
43
|
+
<% if options.readme %>
|
44
|
+
<li><%= link_file("index.html", "Documentation Overview") %></li>
|
45
|
+
<% end %>
|
46
|
+
<ol>
|
47
|
+
<% if @prevfile %>
|
48
|
+
<li>
|
49
|
+
<strong>Previous:</strong>
|
50
|
+
<%= link_file(@prevfile) %>
|
51
|
+
</li>
|
52
|
+
<% end %>
|
53
|
+
<% if @nextfile %>
|
54
|
+
<li>
|
55
|
+
<strong>Next:</strong>
|
56
|
+
<%= link_file(@nextfile) %>
|
57
|
+
</li>
|
58
|
+
<% end %>
|
59
|
+
</ol>
|
60
|
+
</ol>
|
61
|
+
</div>
|
62
|
+
<% else %>
|
63
|
+
<h2>List of Topics</h2>
|
64
|
+
<div id="links">
|
65
|
+
<ol class="top">
|
66
|
+
<li><a href="#">Documentation Overview</a></li>
|
67
|
+
<ol>
|
68
|
+
<% options.files.each do |file| %>
|
69
|
+
<li><%= link_file(file.filename, file.title) %></li>
|
70
|
+
<% end %>
|
71
|
+
</ol>
|
72
|
+
</ol>
|
73
|
+
</div>
|
74
|
+
<% end %>
|
75
|
+
</div>
|
76
|
+
<div id="content"><%= yieldall %></div>
|
77
|
+
</div>
|
78
|
+
<div style="clear:both"></div>
|
79
|
+
<%= erb(:footer) %>
|
80
|
+
</body>
|
81
|
+
</html>
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
include T('default/layout/html')
|
3
|
+
|
4
|
+
def init
|
5
|
+
super
|
6
|
+
|
7
|
+
@topfile = options.readme
|
8
|
+
if options.files
|
9
|
+
if @topfile
|
10
|
+
@toptitle = @topfile.attributes[:title] || "Documentation Overview"
|
11
|
+
end
|
12
|
+
@page_title = @file == options.readme ? options.title : @file.title
|
13
|
+
|
14
|
+
index = options.files.index(@file)
|
15
|
+
if index
|
16
|
+
@prevfile = index > 0 ? (options.files[index - 1] || options.readme) : nil
|
17
|
+
@nextfile = options.files[index + 1]
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
21
|
+
|
22
|
+
def diskfile
|
23
|
+
options.including_object = @object
|
24
|
+
super
|
25
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
<div class="method_header">
|
2
|
+
<% if options.in_module %>
|
3
|
+
<% if object.constructor? %>
|
4
|
+
<em>self.</em><span class="path"><strong>new</strong></span><big>(</big><%= format_args(object) %><big>)</big> <%= format_block(object) %>
|
5
|
+
<% else %>
|
6
|
+
<em><%= object.scope == :class ? 'self.' : '' %></em><span class="path"><strong><%= object.is_attribute? ? object.name.to_s.sub(/=$/, '') : object.name %></strong></span><% if object.is_attribute? %>
|
7
|
+
<% rw = object.attr_info %>
|
8
|
+
<% if rw && rw[:read] && !rw[:write] %><span class="readonly">readonly</span>
|
9
|
+
<% elsif rw && !rw[:read] && rw[:write] %><span class="writeonly">writeonly</span>
|
10
|
+
<% end %>
|
11
|
+
<% else %><big>(</big><%= format_args(object) %><big>)</big> <%= format_block(object) %><% end %>
|
12
|
+
<% end %>
|
13
|
+
<% else %>
|
14
|
+
<em>def</em> <span class="path space"><%= options.including_object.relative_path(object.namespace) %><big><%= object.send(:sep) %></big><strong><%= object.name %></strong></span><big>(</big><%= format_args(object) %><big>)</big> <%= format_block(object) %>
|
15
|
+
<% end %>
|
16
|
+
<% if object.has_tag?(:since) && object.namespace.tag(:since) != object.tag(:since) %><span class="since">since <%= object.tag(:since).text %></span><% end %>
|
17
|
+
</div>
|
18
|
+
<div class="method_body"><%= yieldall %></div>
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
def init
|
3
|
+
sections :header, [T('docstring')]
|
4
|
+
end
|
5
|
+
|
6
|
+
def format_args(object)
|
7
|
+
return if object.parameters.nil?
|
8
|
+
params = object.parameters
|
9
|
+
if object.has_tag?(:yield) || object.has_tag?(:yieldparam)
|
10
|
+
params.reject! do |param|
|
11
|
+
param[0].to_s[0, 1] == "&" &&
|
12
|
+
!object.tags(:param).any? {|t| t.name == param[0][1..-1] }
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
if params.empty?
|
17
|
+
""
|
18
|
+
else
|
19
|
+
args = params.map {|n, v| v ? "<em>#{h n}</em> = #{h v}" : "<em>" + n.to_s + "</em>" }.join(", ")
|
20
|
+
args
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,7 @@
|
|
1
|
+
<div class='module_header'>
|
2
|
+
<em><%= object.type %></em> <span class="path"><%= object.namespace == Registry.root ? '' : object.namespace.path + '::' %><strong><%= object.name %></strong></span>
|
3
|
+
<% if object.has_tag?(:since) %><span class="since">since <%= object.tag(:since).text %></span><% end %>
|
4
|
+
</div>
|
5
|
+
<div class="module_methods">
|
6
|
+
<%= yieldall %>
|
7
|
+
</div>
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
include Helpers::ModuleHelper
|
3
|
+
|
4
|
+
def init
|
5
|
+
sections :header, [T('docstring')], :method_list, [T('method')]
|
6
|
+
end
|
7
|
+
|
8
|
+
def method_list
|
9
|
+
@meths = object.meths(:inherited => false, :included => false)
|
10
|
+
cons = @meths.find(&:constructor?)
|
11
|
+
@meths = @meths.reject {|meth| special_method?(meth) }
|
12
|
+
@meths = sort_listing(prune_method_listing(@meths, false))
|
13
|
+
@meths.unshift(cons) if cons
|
14
|
+
erb(:method_list)
|
15
|
+
end
|
16
|
+
|
17
|
+
def sort_listing(list)
|
18
|
+
list.sort_by {|o| [o.scope.to_s, o.name.to_s.downcase] }
|
19
|
+
end
|
20
|
+
|
21
|
+
def special_method?(meth)
|
22
|
+
return true if meth.writer? && meth.attr_info[:read]
|
23
|
+
return true if meth.name(true) == 'new'
|
24
|
+
return true if meth.name(true) == '#method_missing'
|
25
|
+
return true if meth.constructor?
|
26
|
+
false
|
27
|
+
end
|
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.9.
|
4
|
+
version: 0.9.30
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Loren Segal
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-04-
|
11
|
+
date: 2023-04-09 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.
|
@@ -29,6 +29,27 @@ files:
|
|
29
29
|
- bin/yard
|
30
30
|
- bin/yardoc
|
31
31
|
- bin/yri
|
32
|
+
- docs/CodeObjects.md
|
33
|
+
- docs/GettingStarted.md
|
34
|
+
- docs/Handlers.md
|
35
|
+
- docs/Overview.md
|
36
|
+
- docs/Parser.md
|
37
|
+
- docs/Tags.md
|
38
|
+
- docs/TagsArch.md
|
39
|
+
- docs/Templates.md
|
40
|
+
- docs/WhatsNew.md
|
41
|
+
- docs/images/code-objects-class-diagram.png
|
42
|
+
- docs/images/handlers-class-diagram.png
|
43
|
+
- docs/images/overview-class-diagram.png
|
44
|
+
- docs/images/parser-class-diagram.png
|
45
|
+
- docs/images/tags-class-diagram.png
|
46
|
+
- docs/templates/default/fulldoc/html/full_list_tag.erb
|
47
|
+
- docs/templates/default/fulldoc/html/setup.rb
|
48
|
+
- docs/templates/default/layout/html/setup.rb
|
49
|
+
- docs/templates/default/layout/html/tag_list.erb
|
50
|
+
- docs/templates/default/yard_tags/html/list.erb
|
51
|
+
- docs/templates/default/yard_tags/html/setup.rb
|
52
|
+
- docs/templates/plugin.rb
|
32
53
|
- lib/rubygems_plugin.rb
|
33
54
|
- lib/yard.rb
|
34
55
|
- lib/yard/autoload.rb
|
@@ -239,6 +260,134 @@ files:
|
|
239
260
|
- lib/yard/templates/template_options.rb
|
240
261
|
- lib/yard/verifier.rb
|
241
262
|
- lib/yard/version.rb
|
263
|
+
- po/ja.po
|
264
|
+
- templates/default/class/dot/setup.rb
|
265
|
+
- templates/default/class/dot/superklass.erb
|
266
|
+
- templates/default/class/html/constructor_details.erb
|
267
|
+
- templates/default/class/html/setup.rb
|
268
|
+
- templates/default/class/html/subclasses.erb
|
269
|
+
- templates/default/class/setup.rb
|
270
|
+
- templates/default/class/text/setup.rb
|
271
|
+
- templates/default/class/text/subclasses.erb
|
272
|
+
- templates/default/constant/text/header.erb
|
273
|
+
- templates/default/constant/text/setup.rb
|
274
|
+
- templates/default/docstring/html/abstract.erb
|
275
|
+
- templates/default/docstring/html/deprecated.erb
|
276
|
+
- templates/default/docstring/html/index.erb
|
277
|
+
- templates/default/docstring/html/note.erb
|
278
|
+
- templates/default/docstring/html/private.erb
|
279
|
+
- templates/default/docstring/html/returns_void.erb
|
280
|
+
- templates/default/docstring/html/text.erb
|
281
|
+
- templates/default/docstring/html/todo.erb
|
282
|
+
- templates/default/docstring/setup.rb
|
283
|
+
- templates/default/docstring/text/abstract.erb
|
284
|
+
- templates/default/docstring/text/deprecated.erb
|
285
|
+
- templates/default/docstring/text/index.erb
|
286
|
+
- templates/default/docstring/text/note.erb
|
287
|
+
- templates/default/docstring/text/private.erb
|
288
|
+
- templates/default/docstring/text/returns_void.erb
|
289
|
+
- templates/default/docstring/text/text.erb
|
290
|
+
- templates/default/docstring/text/todo.erb
|
291
|
+
- templates/default/fulldoc/html/css/common.css
|
292
|
+
- templates/default/fulldoc/html/css/full_list.css
|
293
|
+
- templates/default/fulldoc/html/css/style.css
|
294
|
+
- templates/default/fulldoc/html/frames.erb
|
295
|
+
- templates/default/fulldoc/html/full_list.erb
|
296
|
+
- templates/default/fulldoc/html/full_list_class.erb
|
297
|
+
- templates/default/fulldoc/html/full_list_file.erb
|
298
|
+
- templates/default/fulldoc/html/full_list_method.erb
|
299
|
+
- templates/default/fulldoc/html/js/app.js
|
300
|
+
- templates/default/fulldoc/html/js/full_list.js
|
301
|
+
- templates/default/fulldoc/html/js/jquery.js
|
302
|
+
- templates/default/fulldoc/html/setup.rb
|
303
|
+
- templates/default/layout/dot/header.erb
|
304
|
+
- templates/default/layout/dot/setup.rb
|
305
|
+
- templates/default/layout/html/breadcrumb.erb
|
306
|
+
- templates/default/layout/html/files.erb
|
307
|
+
- templates/default/layout/html/footer.erb
|
308
|
+
- templates/default/layout/html/headers.erb
|
309
|
+
- templates/default/layout/html/index.erb
|
310
|
+
- templates/default/layout/html/layout.erb
|
311
|
+
- templates/default/layout/html/listing.erb
|
312
|
+
- templates/default/layout/html/objects.erb
|
313
|
+
- templates/default/layout/html/script_setup.erb
|
314
|
+
- templates/default/layout/html/search.erb
|
315
|
+
- templates/default/layout/html/setup.rb
|
316
|
+
- templates/default/method/html/header.erb
|
317
|
+
- templates/default/method/setup.rb
|
318
|
+
- templates/default/method/text/header.erb
|
319
|
+
- templates/default/method_details/html/header.erb
|
320
|
+
- templates/default/method_details/html/method_signature.erb
|
321
|
+
- templates/default/method_details/html/source.erb
|
322
|
+
- templates/default/method_details/setup.rb
|
323
|
+
- templates/default/method_details/text/header.erb
|
324
|
+
- templates/default/method_details/text/method_signature.erb
|
325
|
+
- templates/default/method_details/text/setup.rb
|
326
|
+
- templates/default/module/dot/child.erb
|
327
|
+
- templates/default/module/dot/dependencies.erb
|
328
|
+
- templates/default/module/dot/header.erb
|
329
|
+
- templates/default/module/dot/info.erb
|
330
|
+
- templates/default/module/dot/setup.rb
|
331
|
+
- templates/default/module/html/attribute_details.erb
|
332
|
+
- templates/default/module/html/attribute_summary.erb
|
333
|
+
- templates/default/module/html/box_info.erb
|
334
|
+
- templates/default/module/html/children.erb
|
335
|
+
- templates/default/module/html/constant_summary.erb
|
336
|
+
- templates/default/module/html/defines.erb
|
337
|
+
- templates/default/module/html/header.erb
|
338
|
+
- templates/default/module/html/inherited_attributes.erb
|
339
|
+
- templates/default/module/html/inherited_constants.erb
|
340
|
+
- templates/default/module/html/inherited_methods.erb
|
341
|
+
- templates/default/module/html/item_summary.erb
|
342
|
+
- templates/default/module/html/method_details_list.erb
|
343
|
+
- templates/default/module/html/method_summary.erb
|
344
|
+
- templates/default/module/html/methodmissing.erb
|
345
|
+
- templates/default/module/html/pre_docstring.erb
|
346
|
+
- templates/default/module/setup.rb
|
347
|
+
- templates/default/module/text/children.erb
|
348
|
+
- templates/default/module/text/class_meths_list.erb
|
349
|
+
- templates/default/module/text/extends.erb
|
350
|
+
- templates/default/module/text/header.erb
|
351
|
+
- templates/default/module/text/includes.erb
|
352
|
+
- templates/default/module/text/instance_meths_list.erb
|
353
|
+
- templates/default/module/text/setup.rb
|
354
|
+
- templates/default/onefile/html/files.erb
|
355
|
+
- templates/default/onefile/html/headers.erb
|
356
|
+
- templates/default/onefile/html/layout.erb
|
357
|
+
- templates/default/onefile/html/readme.erb
|
358
|
+
- templates/default/onefile/html/setup.rb
|
359
|
+
- templates/default/root/dot/child.erb
|
360
|
+
- templates/default/root/dot/setup.rb
|
361
|
+
- templates/default/root/html/setup.rb
|
362
|
+
- templates/default/tags/html/example.erb
|
363
|
+
- templates/default/tags/html/index.erb
|
364
|
+
- templates/default/tags/html/option.erb
|
365
|
+
- templates/default/tags/html/overload.erb
|
366
|
+
- templates/default/tags/html/see.erb
|
367
|
+
- templates/default/tags/html/tag.erb
|
368
|
+
- templates/default/tags/setup.rb
|
369
|
+
- templates/default/tags/text/example.erb
|
370
|
+
- templates/default/tags/text/index.erb
|
371
|
+
- templates/default/tags/text/option.erb
|
372
|
+
- templates/default/tags/text/overload.erb
|
373
|
+
- templates/default/tags/text/see.erb
|
374
|
+
- templates/default/tags/text/tag.erb
|
375
|
+
- templates/guide/class/html/setup.rb
|
376
|
+
- templates/guide/docstring/html/setup.rb
|
377
|
+
- templates/guide/fulldoc/html/css/style.css
|
378
|
+
- templates/guide/fulldoc/html/js/app.js
|
379
|
+
- templates/guide/fulldoc/html/setup.rb
|
380
|
+
- templates/guide/layout/html/layout.erb
|
381
|
+
- templates/guide/layout/html/setup.rb
|
382
|
+
- templates/guide/method/html/header.erb
|
383
|
+
- templates/guide/method/html/setup.rb
|
384
|
+
- templates/guide/module/html/header.erb
|
385
|
+
- templates/guide/module/html/method_list.erb
|
386
|
+
- templates/guide/module/html/setup.rb
|
387
|
+
- templates/guide/onefile/html/files.erb
|
388
|
+
- templates/guide/onefile/html/setup.rb
|
389
|
+
- templates/guide/onefile/html/toc.erb
|
390
|
+
- templates/guide/tags/html/setup.rb
|
242
391
|
homepage: http://yardoc.org
|
243
392
|
licenses:
|
244
393
|
- MIT
|