yard 0.9.18 → 0.9.19

data/templates/default/method/html/header.erb

@@ -1,17 +1,17 @@
-<h1>Method: <%= object.path %></h1>
-<div class="box_info">
-  <dl>
-    <dt class="">Defined in:</dt>
-    <dd class="">
-    <%= object.file %><% if object.files.size > 1 %><span class="defines">,<br />
-      <%= object.files[1..-1].map {|f| f.first }.join(",<br /> ") %></div>
-    <% end %>
-    </dd>
-  </dl>
-</div>
-
-<div class="method_details_list">
-  <div id="method_details">
-    <%= yieldall :index => 0 %>
-  </div>
+<h1>Method: <%= object.path %></h1>
+<div class="box_info">
+  <dl>
+    <dt class="">Defined in:</dt>
+    <dd class="">
+    <%= object.file %><% if object.files.size > 1 %><span class="defines">,<br />
+      <%= object.files[1..-1].map {|f| f.first }.join(",<br /> ") %></div>
+    <% end %>
+    </dd>
+  </dl>
+</div>
+
+<div class="method_details_list">
+  <div id="method_details">
+    <%= yieldall :index => 0 %>
+  </div>
 </div>

data/templates/default/method/setup.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: true
-def init
-  sections :header, [T('method_details')]
-end
+# frozen_string_literal: true
+def init
+  sections :header, [T('method_details')]
+end

data/templates/default/method_details/html/header.erb

@@ -1,3 +1,3 @@
-<div class="method_details <%= @index == 0 ? 'first' : '' %>">
-  <%= yieldall %>
+<div class="method_details <%= @index == 0 ? 'first' : '' %>">
+  <%= yieldall %>
 </div>

data/templates/default/method_details/html/method_signature.erb

@@ -1,25 +1,25 @@
-<h3 class="signature <%= 'first' if @index == 0 %>" id="<%= anchor_for(object) %>">
-  <% if object.tags(:overload).size == 1 %>
-    <%= signature(object.tag(:overload), false) %>
-  <% elsif object.tags(:overload).size > 1 %>
-    <% object.tags(:overload).each do |overload| %>
-      <span class="overload"><%= signature(overload, false) %></span>
-    <% end %>
-  <% else %>
-    <%= signature(object, false) %>
-  <% end %>
-
-  <% if object.aliases.size > 0 %>
-    <span class="aliases">Also known as:
-    <span class="names"><%= object.aliases.map {|o|
-      "<span id='#{anchor_for(o)}'>" + h(o.name.to_s) + "</span>" }.join(", ") %></span>
-    </span>
-  <% end %>
-
-  <% if owner != object.namespace %>
-    <span class="not_defined_here">
-      Originally defined in <%= object.namespace.type %>
-        <%= linkify object, owner.relative_path(object.namespace) %>
-    </span>
-  <% end %>
+<h3 class="signature <%= 'first' if @index == 0 %>" id="<%= anchor_for(object) %>">
+  <% if object.tags(:overload).size == 1 %>
+    <%= signature(object.tag(:overload), false) %>
+  <% elsif object.tags(:overload).size > 1 %>
+    <% object.tags(:overload).each do |overload| %>
+      <span class="overload"><%= signature(overload, false) %></span>
+    <% end %>
+  <% else %>
+    <%= signature(object, false) %>
+  <% end %>
+
+  <% if object.aliases.size > 0 %>
+    <span class="aliases">Also known as:
+    <span class="names"><%= object.aliases.map {|o|
+      "<span id='#{anchor_for(o)}'>" + h(o.name.to_s) + "</span>" }.join(", ") %></span>
+    </span>
+  <% end %>
+
+  <% if owner != object.namespace %>
+    <span class="not_defined_here">
+      Originally defined in <%= object.namespace.type %>
+        <%= linkify object, owner.relative_path(object.namespace) %>
+    </span>
+  <% end %>
 </h3>

data/templates/default/method_details/html/source.erb

@@ -1,10 +1,10 @@
-<table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines"><%= "\n\n\n" %><%= h format_lines(object) %></pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File '<%= h object.file %>'<% if object.line %>, line <%= object.line %><% end %></span><%= "\n\n" %><%= html_syntax_highlight object.source %></pre>
-    </td>
-  </tr>
+<table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines"><%= "\n\n\n" %><%= h format_lines(object) %></pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '<%= h object.file %>'<% if object.line %>, line <%= object.line %><% end %></span><%= "\n\n" %><%= html_syntax_highlight object.source %></pre>
+    </td>
+  </tr>
 </table>

data/templates/default/method_details/setup.rb

@@ -1,11 +1,11 @@
-# frozen_string_literal: true
-def init
-  sections :header, [:method_signature, T('docstring'), :source]
-end
-
-def source
-  return if owner != object.namespace
-  return if Tags::OverloadTag === object
-  return if object.source.nil?
-  erb(:source)
-end
+# frozen_string_literal: true
+def init
+  sections :header, [:method_signature, T('docstring'), :source]
+end
+
+def source
+  return if owner != object.namespace
+  return if Tags::OverloadTag === object
+  return if object.source.nil?
+  erb(:source)
+end

data/templates/default/method_details/text/header.erb

@@ -1,10 +1,10 @@
-<%= title_align_right format_object_title(object) %>
-
-<%= align_right "(Defined in: #{object.file})" %>
-<% if object.aliases.size > 0 %>
-
-<%= align_right "(Also known as: #{object.aliases.map {|o| o.name(true).to_s }.join(',')})" %>
-<% end %>
-
-<%= yieldall %>
-
+<%= title_align_right format_object_title(object) %>
+
+<%= align_right "(Defined in: #{object.file})" %>
+<% if object.aliases.size > 0 %>
+
+<%= align_right "(Also known as: #{object.aliases.map {|o| o.name(true).to_s }.join(',')})" %>
+<% end %>
+
+<%= yieldall %>
+

data/templates/default/method_details/text/method_signature.erb

@@ -1,12 +1,12 @@
-
-<% if object.tags(:overload).size == 1 %>
-<%= indent wrap(signature(object.tag(:overload))) %>
-<% elsif object.tags(:overload).size > 1 %>
-<% object.tags(:overload).each do |overload| %>
-<%= indent wrap(signature(overload)) %>
-<% end %>
-<% else %>
-<%= indent wrap(signature(object)) %>
-<% end %>
-<%= hr %>
-
+
+<% if object.tags(:overload).size == 1 %>
+<%= indent wrap(signature(object.tag(:overload))) %>
+<% elsif object.tags(:overload).size > 1 %>
+<% object.tags(:overload).each do |overload| %>
+<%= indent wrap(signature(overload)) %>
+<% end %>
+<% else %>
+<%= indent wrap(signature(object)) %>
+<% end %>
+<%= hr %>
+

data/templates/default/method_details/text/setup.rb

@@ -1,11 +1,11 @@
-# frozen_string_literal: true
-def init
-  super
-  sections.last.pop
-end
-
-def format_object_title(object)
-  title = "Method: #{object.name(true)}"
-  title += " (#{object.namespace})" unless object.namespace.root?
-  title
-end
+# frozen_string_literal: true
+def init
+  super
+  sections.last.pop
+end
+
+def format_object_title(object)
+  title = "Method: #{object.name(true)}"
+  title += " (#{object.namespace})" unless object.namespace.root?
+  title
+end

data/templates/default/module/dot/child.erb

@@ -1 +1 @@
-<%= format_path object %> [label="{<%= yieldall.gsub("\n", '') %>}" rank=sink];
+<%= format_path object %> [label="{<%= yieldall.gsub("\n", '') %>}" rank=sink];

data/templates/default/module/dot/dependencies.erb

@@ -1,3 +1,3 @@
-<% object.mixins(:instance).each do |obj| %>
-  <%= format_path object %> -> <%= format_path obj %> [style=dotted arrowType=none];
+<% object.mixins(:instance).each do |obj| %>
+  <%= format_path object %> -> <%= format_path obj %> [style=dotted arrowType=none];
 <% end %>

data/templates/default/module/dot/header.erb

@@ -1,6 +1,6 @@
-subgraph cluster_<%= format_path object %> {
-  label = "<%= h(object.name) unless object.path == "" %>"; labelloc=b;
-  <% for obj in @modules %>
-    <%= yieldall :object => obj %>
-  <% end %>
-}
+subgraph cluster_<%= format_path object %> {
+  label = "<%= h(object.name) unless object.path == "" %>"; labelloc=b;
+  <% for obj in @modules %>
+    <%= yieldall :object => obj %>
+  <% end %>
+}

data/templates/default/module/dot/info.erb

@@ -1,14 +1,14 @@
-<%= object.type %> <%= h object.name %>
-<% if options.full %>
-|
-<% object.attributes.each do |scope, list| %>
-<% list.sort_by {|name, rw| name.to_s }.each do |name, rw| %>
-<%= uml_visibility(rw.values.compact.first) %> <%= h (rw[:read]||rw[:write]).name(true).gsub(/=$/,'') %> [<%= 'R' if rw[:read] %><%= 'W' if rw[:write] %>]\l
-<% end %>
-<% end %>
-|
-<% method_listing.each do |obj| %>
-<%= uml_visibility obj %> <%= h obj.name(true) %>
-<%= h(" : #{obj.tag(:return).types.first}") if obj.has_tag?(:return) && obj.tag(:return).types && obj.tag(:return).types.size > 0 %>\l
-<% end %>
+<%= object.type %> <%= h object.name %>
+<% if options.full %>
+|
+<% object.attributes.each do |scope, list| %>
+<% list.sort_by {|name, rw| name.to_s }.each do |name, rw| %>
+<%= uml_visibility(rw.values.compact.first) %> <%= h (rw[:read]||rw[:write]).name(true).gsub(/=$/,'') %> [<%= 'R' if rw[:read] %><%= 'W' if rw[:write] %>]\l
+<% end %>
+<% end %>
+|
+<% method_listing.each do |obj| %>
+<%= uml_visibility obj %> <%= h obj.name(true) %>
+<%= h(" : #{obj.tag(:return).types.first}") if obj.has_tag?(:return) && obj.tag(:return).types && obj.tag(:return).types.size > 0 %>\l
+<% end %>
 <% end %>

data/templates/default/module/dot/setup.rb

@@ -1,15 +1,15 @@
-# frozen_string_literal: true
-def init
-  @modules = object.children.select {|o| o.type == :module }
-  @classes = object.children.select {|o| o.type == :class }
-  sections :child, [:info], :classes, [T('class')], :header, [T('module')], :dependencies
-end
-
-def dependencies
-  return unless options.dependencies
-  erb(:dependencies)
-end
-
-def classes
-  @classes.map {|k| yieldall :object => k }.join("\n")
-end
+# frozen_string_literal: true
+def init
+  @modules = object.children.select {|o| o.type == :module }
+  @classes = object.children.select {|o| o.type == :class }
+  sections :child, [:info], :classes, [T('class')], :header, [T('module')], :dependencies
+end
+
+def dependencies
+  return unless options.dependencies
+  erb(:dependencies)
+end
+
+def classes
+  @classes.map {|k| yieldall :object => k }.join("\n")
+end

data/templates/default/module/html/attribute_details.erb

@@ -1,10 +1,10 @@
-<% scopes(attr_listing) do |list, scope| %>
-  <div id="<%= scope %>_attr_details" class="attr_details">
-    <h2><%= scope.to_s.capitalize %> Attribute Details</h2>
-    <% list.each_with_index do |meth, i| %>
-      <% rw = meth.attr_info %>
-      <span id="<%= anchor_for(rw[meth.reader? ? :write : :read]) %>"></span>
-      <%= yieldall :object => meth, :owner => object, :index => i %>
-    <% end %>
-  </div>
-<% end %>
+<% scopes(attr_listing) do |list, scope| %>
+  <div id="<%= scope %>_attr_details" class="attr_details">
+    <h2><%= scope.to_s.capitalize %> Attribute Details</h2>
+    <% list.each_with_index do |meth, i| %>
+      <% rw = meth.attr_info %>
+      <span id="<%= anchor_for(rw[meth.reader? ? :write : :read]) %>"></span>
+      <%= yieldall :object => meth, :owner => object, :index => i %>
+    <% end %>
+  </div>
+<% end %>

data/templates/default/module/html/attribute_summary.erb

@@ -1,8 +1,8 @@
-<% groups(attr_listing, "Attribute") do |list, name| %>
-  <h2><%= name %> <small><a href="#" class="summary_toggle">collapse</a></small></h2>
-  <ul class="summary">
-    <% list.each do |meth| %>
-      <%= yieldall :item => meth %>
-    <% end %>
-  </ul>
-<% end %>
+<% groups(attr_listing, "Attribute") do |list, name| %>
+  <h2><%= name %> <small><a href="#" class="summary_toggle">collapse</a></small></h2>
+  <ul class="summary">
+    <% list.each do |meth| %>
+      <%= yieldall :item => meth %>
+    <% end %>
+  </ul>
+<% end %>

data/templates/default/module/html/box_info.erb

@@ -1,43 +1,43 @@
-<div class="box_info">
-  <% if CodeObjects::ClassObject === object && object.superclass %>
-  <dl>
-    <dt>Inherits:</dt>
-    <dd>
-      <span class="inheritName"><%= linkify object.superclass %></span>
-      <% if object.superclass.name != :BasicObject %>
-        <ul class="fullTree">
-          <li><%= linkify P(:Object) %></li>
-          <% object.inheritance_tree.reverse.each_with_index do |obj, i| %>
-            <li class="next"><%= obj == object ? obj.path : linkify(obj) %></li>
-          <% end %>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      <% end %>
-    </dd>
-  </dl>
-  <% end %>
-
-  <% [[:class, "Extended by"], [:instance, "Includes"]].each do |scope, name| %>
-  <% if (mix = run_verifier(object.mixins(scope))).size > 0 %>
-  <dl>
-      <dt><%= name %>:</dt>
-      <dd><%= mix.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>
-  </dl>
-  <% end %>
-  <% end %>
-
-  <% if (mixed_into = mixed_into(object)).size > 0 %>
-  <dl>
-    <dt>Included in:</dt>
-    <dd><%= mixed_into.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>
-  </dl>
-  <% end %>
-
-  <% unless object.root? %>
-  <dl>
-    <dt>Defined in:</dt>
-    <dd><%= erb(:defines) %></dd>
-  </dl>
-  <% end %>
-</div>
-
+<div class="box_info">
+  <% if CodeObjects::ClassObject === object && object.superclass %>
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName"><%= linkify object.superclass %></span>
+      <% if object.superclass.name != :BasicObject %>
+        <ul class="fullTree">
+          <li><%= linkify P(:Object) %></li>
+          <% object.inheritance_tree.reverse.each_with_index do |obj, i| %>
+            <li class="next"><%= obj == object ? obj.path : linkify(obj) %></li>
+          <% end %>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      <% end %>
+    </dd>
+  </dl>
+  <% end %>
+
+  <% [[:class, "Extended by"], [:instance, "Includes"]].each do |scope, name| %>
+  <% if (mix = run_verifier(object.mixins(scope))).size > 0 %>
+  <dl>
+      <dt><%= name %>:</dt>
+      <dd><%= mix.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>
+  </dl>
+  <% end %>
+  <% end %>
+
+  <% if (mixed_into = mixed_into(object)).size > 0 %>
+  <dl>
+    <dt>Included in:</dt>
+    <dd><%= mixed_into.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>
+  </dl>
+  <% end %>
+
+  <% unless object.root? %>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd><%= erb(:defines) %></dd>
+  </dl>
+  <% end %>
+</div>
+

data/templates/default/module/html/children.erb

@@ -1,8 +1,8 @@
-<h2>Defined Under Namespace</h2>
-<p class="children">
-  <% @inner.each do |name, list| %>
-    <% if list.size > 0 %>
-      <strong class="<%= name %>"><%= name.to_s.capitalize %>:</strong> <%= list.map {|child| linkify(child, child.name(true)) }.join(", ") %>
-    <% end %>
-  <% end %>
-</p>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+  <% @inner.each do |name, list| %>
+    <% if list.size > 0 %>
+      <strong class="<%= name %>"><%= name.to_s.capitalize %>:</strong> <%= list.map {|child| linkify(child, child.name(true)) }.join(", ") %>
+    <% end %>
+  <% end %>
+</p>

data/templates/default/module/html/constant_summary.erb

@@ -1,17 +1,17 @@
-<% if constant_listing.size > 0 %>
-  <% groups(constant_listing, "Constant") do |list, name| %>
-    <h2>
-      <%= name %>
-      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
-    </h2>
-
-    <dl class="constants">
-      <% list.each do |cnst| %>
-        <dt id="<%= anchor_for(cnst) %>" class="<%= cnst.has_tag?(:deprecated) ? 'deprecated' : '' %>"><%= cnst.name %> =
-          <%= yieldall :object => cnst %>
-        </dt>
-        <dd><pre class="code"><%= format_constant cnst.value %></pre></dd>
-      <% end %>
-    </dl>
-  <% end %>
-<% end %>
+<% if constant_listing.size > 0 %>
+  <% groups(constant_listing, "Constant") do |list, name| %>
+    <h2>
+      <%= name %>
+      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+    </h2>
+
+    <dl class="constants">
+      <% list.each do |cnst| %>
+        <dt id="<%= anchor_for(cnst) %>" class="<%= cnst.has_tag?(:deprecated) ? 'deprecated' : '' %>"><%= cnst.name %> =
+          <%= yieldall :object => cnst %>
+        </dt>
+        <dd><pre class="code"><%= format_constant cnst.value %></pre></dd>
+      <% end %>
+    </dl>
+  <% end %>
+<% end %>