yard 0.8.1 → 0.8.2
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.
- data/ChangeLog +192 -0
- data/README.md +9 -2
- data/Rakefile +8 -14
- data/lib/yard.rb +1 -1
- data/lib/yard/autoload.rb +3 -2
- data/lib/yard/cli/graph.rb +28 -10
- data/lib/yard/cli/yardoc.rb +4 -1
- data/lib/yard/code_objects/proxy.rb +22 -17
- data/lib/yard/docstring_parser.rb +7 -7
- data/lib/yard/globals.rb +2 -2
- data/lib/yard/handlers/base.rb +3 -2
- data/lib/yard/handlers/c/handler_methods.rb +1 -0
- data/lib/yard/handlers/c/init_handler.rb +7 -5
- data/lib/yard/handlers/c/override_comment_handler.rb +9 -1
- data/lib/yard/handlers/ruby/class_condition_handler.rb +4 -2
- data/lib/yard/handlers/ruby/legacy/class_condition_handler.rb +4 -2
- data/lib/yard/handlers/ruby/legacy/mixin_handler.rb +4 -6
- data/lib/yard/handlers/ruby/mixin_handler.rb +3 -3
- data/lib/yard/handlers/ruby/visibility_handler.rb +1 -1
- data/lib/yard/i18n/locale.rb +50 -0
- data/lib/yard/i18n/text.rb +110 -9
- data/lib/yard/logging.rb +99 -8
- data/lib/yard/parser/c/c_parser.rb +1 -1
- data/lib/yard/parser/source_parser.rb +5 -4
- data/lib/yard/registry.rb +20 -12
- data/lib/yard/registry_store.rb +6 -1
- data/lib/yard/rubygems/doc_manager.rb +9 -5
- data/lib/yard/serializers/yardoc_serializer.rb +1 -0
- data/lib/yard/server/commands/base.rb +3 -2
- data/lib/yard/server/doc_server_serializer.rb +2 -0
- data/lib/yard/server/templates/default/method_details/html/permalink.erb +4 -0
- data/lib/yard/server/templates/default/method_details/html/setup.rb +4 -0
- data/lib/yard/tags/default_factory.rb +12 -4
- data/lib/yard/tags/directives.rb +1 -0
- data/lib/yard/templates/engine.rb +13 -6
- data/lib/yard/templates/template_options.rb +8 -1
- data/spec/cli/graph_spec.rb +10 -0
- data/spec/cli/yri_spec.rb +12 -2
- data/spec/code_objects/proxy_spec.rb +19 -3
- data/spec/handlers/c/class_handler_spec.rb +1 -2
- data/spec/handlers/c/init_handler_spec.rb +11 -0
- data/spec/handlers/c/override_comment_handler_spec.rb +3 -0
- data/spec/handlers/class_condition_handler_spec.rb +5 -0
- data/spec/handlers/dsl_handler_spec.rb +1 -0
- data/spec/handlers/examples/class_condition_handler_001.rb.txt +8 -0
- data/spec/handlers/mixin_handler_spec.rb +2 -1
- data/spec/i18n/locale_spec.rb +62 -0
- data/spec/i18n/text_spec.rb +144 -35
- data/spec/logging_spec.rb +21 -0
- data/spec/parser/c_parser_spec.rb +36 -0
- data/spec/parser/source_parser_spec.rb +11 -8
- data/spec/registry_spec.rb +26 -0
- data/spec/rubygems/doc_manager_spec.rb +112 -0
- data/spec/tags/default_factory_spec.rb +8 -2
- data/spec/tags/directives_spec.rb +7 -0
- data/spec/templates/examples/module001.html +0 -4
- data/spec/templates/examples/module002.html +0 -1
- data/spec/templates/examples/module003.html +0 -1
- data/spec/templates/examples/module004.html +171 -172
- data/spec/templates/module_spec.rb +4 -0
- data/templates/default/fulldoc/html/js/app.js +24 -18
- data/templates/default/fulldoc/html/setup.rb +5 -1
- data/templates/default/module/html/attribute_details.erb +1 -2
- metadata +9 -4
- data/lib/yard/server/templates/default/fulldoc/html/js/live.js +0 -17
@@ -147,6 +147,8 @@ describe YARD::Templates::Engine.template(:default, :module) do
|
|
147
147
|
end
|
148
148
|
|
149
149
|
module Foo
|
150
|
+
def self.not_included; end
|
151
|
+
|
150
152
|
# Docs for xyz
|
151
153
|
def xyz; end
|
152
154
|
# Docs for bar_attr
|
@@ -154,6 +156,8 @@ describe YARD::Templates::Engine.template(:default, :module) do
|
|
154
156
|
end
|
155
157
|
|
156
158
|
module Bar
|
159
|
+
def self.not_included; end
|
160
|
+
|
157
161
|
# @group Booya
|
158
162
|
|
159
163
|
# Docs for baz in Booya group
|
@@ -103,28 +103,34 @@ function keyboardShortcuts() {
|
|
103
103
|
|
104
104
|
function summaryToggle() {
|
105
105
|
$('.summary_toggle').click(function() {
|
106
|
-
|
107
|
-
|
108
|
-
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
109
|
-
if (next.hasClass('compact')) {
|
110
|
-
next.toggle();
|
111
|
-
next.nextAll('ul.summary').first().toggle();
|
112
|
-
}
|
113
|
-
else if (next.hasClass('summary')) {
|
114
|
-
var list = $('<ul class="summary compact" />');
|
115
|
-
list.html(next.html());
|
116
|
-
list.find('.summary_desc, .note').remove();
|
117
|
-
list.find('a').each(function() {
|
118
|
-
$(this).html($(this).find('strong').html());
|
119
|
-
$(this).parent().html($(this)[0].outerHTML);
|
120
|
-
});
|
121
|
-
next.before(list);
|
122
|
-
next.toggle();
|
106
|
+
if (localStorage) {
|
107
|
+
localStorage.summaryCollapsed = $(this).text();
|
123
108
|
}
|
109
|
+
$('.summary_toggle').each(function() {
|
110
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
111
|
+
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
112
|
+
if (next.hasClass('compact')) {
|
113
|
+
next.toggle();
|
114
|
+
next.nextAll('ul.summary').first().toggle();
|
115
|
+
}
|
116
|
+
else if (next.hasClass('summary')) {
|
117
|
+
var list = $('<ul class="summary compact" />');
|
118
|
+
list.html(next.html());
|
119
|
+
list.find('.summary_desc, .note').remove();
|
120
|
+
list.find('a').each(function() {
|
121
|
+
$(this).html($(this).find('strong').html());
|
122
|
+
$(this).parent().html($(this)[0].outerHTML);
|
123
|
+
});
|
124
|
+
next.before(list);
|
125
|
+
next.toggle();
|
126
|
+
}
|
127
|
+
});
|
124
128
|
return false;
|
125
129
|
});
|
126
130
|
if (localStorage) {
|
127
|
-
if (localStorage.summaryCollapsed == "collapse")
|
131
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
132
|
+
$('.summary_toggle').first().click();
|
133
|
+
}
|
128
134
|
else localStorage.summaryCollapsed = "expand";
|
129
135
|
}
|
130
136
|
}
|
@@ -85,7 +85,11 @@ end
|
|
85
85
|
# created.
|
86
86
|
# @param [String] content the contents that are saved to the file.
|
87
87
|
def asset(path, content)
|
88
|
-
|
88
|
+
if options.serializer
|
89
|
+
log.capture("Generating asset #{path}") do
|
90
|
+
options.serializer.serialize(path, content)
|
91
|
+
end
|
92
|
+
end
|
89
93
|
end
|
90
94
|
|
91
95
|
# @return [Array<String>] Stylesheet files that are additionally loaded for the
|
@@ -3,8 +3,7 @@
|
|
3
3
|
<h2><%= scope.to_s.capitalize %> Attribute Details</h2>
|
4
4
|
<% list.each_with_index do |meth, i| %>
|
5
5
|
<% rw = meth.attr_info %>
|
6
|
-
<span id="<%= anchor_for(rw[:write]) %>"></span>
|
7
|
-
<span id="<%= anchor_for(rw[:read]) %>"></span>
|
6
|
+
<span id="<%= anchor_for(rw[meth.reader? ? :write : :read]) %>"></span>
|
8
7
|
<%= yieldall :object => meth, :owner => object, :index => i %>
|
9
8
|
<% end %>
|
10
9
|
</div>
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: yard
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.8.
|
4
|
+
version: 0.8.2
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -9,7 +9,7 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2012-
|
12
|
+
date: 2012-06-07 00:00:00.000000000 -04:00
|
13
13
|
default_executable:
|
14
14
|
dependencies: []
|
15
15
|
description: ! " YARD is a documentation generation tool for the Ruby programming
|
@@ -141,6 +141,7 @@ files:
|
|
141
141
|
- lib/yard/handlers/ruby/struct_handler_methods.rb
|
142
142
|
- lib/yard/handlers/ruby/visibility_handler.rb
|
143
143
|
- lib/yard/handlers/ruby/yield_handler.rb
|
144
|
+
- lib/yard/i18n/locale.rb
|
144
145
|
- lib/yard/i18n/message.rb
|
145
146
|
- lib/yard/i18n/messages.rb
|
146
147
|
- lib/yard/i18n/pot_generator.rb
|
@@ -193,10 +194,11 @@ files:
|
|
193
194
|
- lib/yard/server/templates/default/fulldoc/html/css/custom.css
|
194
195
|
- lib/yard/server/templates/default/fulldoc/html/images/processing.gif
|
195
196
|
- lib/yard/server/templates/default/fulldoc/html/js/autocomplete.js
|
196
|
-
- lib/yard/server/templates/default/fulldoc/html/js/live.js
|
197
197
|
- lib/yard/server/templates/default/layout/html/breadcrumb.erb
|
198
198
|
- lib/yard/server/templates/default/layout/html/script_setup.erb
|
199
199
|
- lib/yard/server/templates/default/layout/html/setup.rb
|
200
|
+
- lib/yard/server/templates/default/method_details/html/permalink.erb
|
201
|
+
- lib/yard/server/templates/default/method_details/html/setup.rb
|
200
202
|
- lib/yard/server/templates/doc_server/library_list/html/contents.erb
|
201
203
|
- lib/yard/server/templates/doc_server/library_list/html/headers.erb
|
202
204
|
- lib/yard/server/templates/doc_server/library_list/html/library_list.erb
|
@@ -240,6 +242,7 @@ files:
|
|
240
242
|
- spec/cli/config_spec.rb
|
241
243
|
- spec/cli/diff_spec.rb
|
242
244
|
- spec/cli/gems_spec.rb
|
245
|
+
- spec/cli/graph_spec.rb
|
243
246
|
- spec/cli/help_spec.rb
|
244
247
|
- spec/cli/i18n_spec.rb
|
245
248
|
- spec/cli/list_spec.rb
|
@@ -320,6 +323,7 @@ files:
|
|
320
323
|
- spec/handlers/spec_helper.rb
|
321
324
|
- spec/handlers/visibility_handler_spec.rb
|
322
325
|
- spec/handlers/yield_handler_spec.rb
|
326
|
+
- spec/i18n/locale_spec.rb
|
323
327
|
- spec/i18n/message_spec.rb
|
324
328
|
- spec/i18n/messages_spec.rb
|
325
329
|
- spec/i18n/pot_generator_spec.rb
|
@@ -345,6 +349,7 @@ files:
|
|
345
349
|
- spec/rake/yardoc_task_spec.rb
|
346
350
|
- spec/registry_spec.rb
|
347
351
|
- spec/registry_store_spec.rb
|
352
|
+
- spec/rubygems/doc_manager_spec.rb
|
348
353
|
- spec/serializers/data/serialized_yardoc/checksums
|
349
354
|
- spec/serializers/data/serialized_yardoc/objects/Foo/bar_i.dat
|
350
355
|
- spec/serializers/data/serialized_yardoc/objects/Foo/baz_i.dat
|
@@ -582,7 +587,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
582
587
|
version: '0'
|
583
588
|
requirements: []
|
584
589
|
rubyforge_project: yard
|
585
|
-
rubygems_version: 1.3.9.
|
590
|
+
rubygems_version: 1.3.9.5
|
586
591
|
signing_key:
|
587
592
|
specification_version: 3
|
588
593
|
summary: Documentation tool for consistent and usable documentation in Ruby.
|
@@ -1,17 +0,0 @@
|
|
1
|
-
function methodPermalinks() {
|
2
|
-
if ($($('#content h1')[0]).text().match(/^Method:/)) return;
|
3
|
-
|
4
|
-
$('#method_details .signature, #constructor_details .signature, ' +
|
5
|
-
'.method_details .signature, #method_missing_details .signature').each(function() {
|
6
|
-
var id = this.id;
|
7
|
-
var match = id.match(/^(.+?)-(class|instance)_method$/);
|
8
|
-
if (match) {
|
9
|
-
var name = match[1];
|
10
|
-
var scope = match[2] == "class" ? "." : ":";
|
11
|
-
var url = window.location.pathname + scope + escape(name);
|
12
|
-
$(this).prepend('<a class="permalink" href="' + url + '">permalink</a>');
|
13
|
-
}
|
14
|
-
});
|
15
|
-
}
|
16
|
-
|
17
|
-
$(methodPermalinks);
|