yard-sketchup 1.4.1 → 1.5.1

data/lib/yard-sketchup/templates/default/method_details/html/method_signature.erb

@@ -1,26 +1,30 @@
-<h3 class="signature <%= 'first' if @index == 0 %>" id="<%= anchor_for(object) %>">
-  <a style="float: right;" href="#header" title="Return to Top">&uarr;</a>
-  <% 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>
+<h3 class="signature <%= 'first' if @index == 0 %>" id="<%= anchor_for(object) %>">
+  <a style="float: right;" href="#header" title="Return to Top">&uarr;</a>
+  <% 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 %>
+
+  <% if object.group %>
+    <span class="group_badge"><a href="#<%= object.group.gsub(' ', '_').downcase %>"><%= object.group %></a></span>
+  <% end %>
+</h3>

data/lib/yard-sketchup/templates/default/method_details/setup.rb

@@ -1,12 +1,12 @@
-# We don't want to expose our source code in the API docs.
-
-# https://groups.google.com/forum/#!topic/yardoc/-HH48h-aifs
-def source 
-  return 
-end
-
-# http://stackoverflow.com/a/10345917/486990
-#def init
-#  super
-#  sections.first.delete(:source)
+# We don't want to expose our source code in the API docs.
+
+# https://groups.google.com/forum/#!topic/yardoc/-HH48h-aifs
+def source 
+  return 
+end
+
+# http://stackoverflow.com/a/10345917/486990
+#def init
+#  super
+#  sections.first.delete(:source)
 #end

data/lib/yard-sketchup/templates/default/module/html/box_info.erb

@@ -1,37 +1,37 @@
-<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 %>
-
-</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 %>
+
+</div>
+

data/lib/yard-sketchup/templates/default/module/html/constant_summary.erb

@@ -1,17 +1,19 @@
-<% if constant_listing.size > 0 || object.constants.size > 0 %>
-  <h2>
-    Constant Summary
-    <a
-        id="constant_summary"
-        href="#constant_summary"
-        title="Permalink">#</a>
-  </h2>
-  <% if constant_listing.size > 0 %>
-    <dl class="constants">
-      <% constant_listing.each do |cnst| %>
-        <dt id="<%= anchor_for(cnst) %>" class="<%= cnst.has_tag?(:deprecated) ? 'deprecated' : '' %>"><%= cnst.namespace.to_s.empty? ? '' : "#{cnst.namespace}::" %><%= cnst.name %>
-        </dt>
-      <% end %>
-    </dl>
-  <% end %>
-<% end %>
+<% if constant_listing.size > 0 %>
+  <% groups(constant_listing, "Constant") do |list, name| %>
+    <h2>
+      <%= name %>
+      <a
+          id="<%= name.gsub(' ', '_').downcase %>"
+          href="#<%= name.gsub(' ', '_').downcase %>"
+          title="Permalink">#</a>
+      <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.namespace.to_s.empty? ? '' : "#{cnst.namespace}::" %><%= cnst.name %>
+        </dt>
+      <% end %>
+    </dl>
+  <% end %>
+<% end %>

data/lib/yard-sketchup/templates/default/module/html/method_summary.erb

@@ -1,18 +1,18 @@
-<% if method_listing.size > 0 %>
-  <% groups(method_listing) do |list, name| %>
-    <h2>
-      <%= name %>
-      <a
-          id="<%= name.gsub(' ', '_').downcase %>"
-          href="#<%= name.gsub(' ', '_').downcase %>"
-          title="Permalink">#</a>
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-
-    <ul class="summary">
-      <% list.each do |meth| %>
-        <%= yieldall :item => meth %>
-      <% end %>
-    </ul>
-  <% end %>
-<% end %>
+<% if method_listing.size > 0 %>
+  <% groups(method_listing) do |list, name| %>
+    <h2>
+      <%= name %>
+      <a
+          id="<%= name.gsub(' ', '_').downcase %>"
+          href="#<%= name.gsub(' ', '_').downcase %>"
+          title="Permalink">#</a>
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      <% list.each do |meth| %>
+        <%= yieldall :item => meth %>
+      <% end %>
+    </ul>
+  <% end %>
+<% end %>

data/lib/yard-sketchup/templates/inheritance/fulldoc/text/setup.rb

@@ -1,54 +1,54 @@
-require 'set'
-
-include Helpers::ModuleHelper
-
-MANIFEST_FILENAME = 'coverage.manifest'.freeze
-
-def init
-  list_all_classes
-end
-
-
-def all_objects
-  run_verifier(Registry.all)
-end
-
-def class_objects
-  run_verifier(Registry.all(:class))
-end
-
-def namespace_definition(object)
-  return if object.root?
-  definition = "#{object.type} #{object.path}"
-  if object.type == :class && object.superclass.name != :Object
-    definition << " < #{object.superclass.path}"
-  end
-  output = StringIO.new
-  # output.puts generate_docstring(object)
-  output.puts definition
-  output.string
-end
-
-def generate_mixins(object, scope)
-  output = StringIO.new
-  mixin_type = (scope == :class) ? 'extend' : 'include'
-  mixins = run_verifier(object.mixins(scope))
-  mixins = stable_sort_by(mixins, &:path)
-  mixins.each { |mixin|
-    output.puts "  #{mixin_type} #{mixin.path}"
-  }
-  output.string
-end
-
-def list_all_classes
-  # versions = Set.new
-  klasses = []
-  class_objects.each { |object|
-    # version_tag = object.tag(:version)
-    # versions << version_tag.text if version_tag
-    klasses << namespace_definition(object)
-  }
-  # puts klasses.sort.join("\n")
-  puts klasses.sort.join
-  exit # Avoid the YARD summary
-end
+require 'set'
+
+include Helpers::ModuleHelper
+
+MANIFEST_FILENAME = 'coverage.manifest'.freeze
+
+def init
+  list_all_classes
+end
+
+
+def all_objects
+  run_verifier(Registry.all)
+end
+
+def class_objects
+  run_verifier(Registry.all(:class))
+end
+
+def namespace_definition(object)
+  return if object.root?
+  definition = "#{object.type} #{object.path}"
+  if object.type == :class && object.superclass.name != :Object
+    definition << " < #{object.superclass.path}"
+  end
+  output = StringIO.new
+  # output.puts generate_docstring(object)
+  output.puts definition
+  output.string
+end
+
+def generate_mixins(object, scope)
+  output = StringIO.new
+  mixin_type = (scope == :class) ? 'extend' : 'include'
+  mixins = run_verifier(object.mixins(scope))
+  mixins = stable_sort_by(mixins, &:path)
+  mixins.each { |mixin|
+    output.puts "  #{mixin_type} #{mixin.path}"
+  }
+  output.string
+end
+
+def list_all_classes
+  # versions = Set.new
+  klasses = []
+  class_objects.each { |object|
+    # version_tag = object.tag(:version)
+    # versions << version_tag.text if version_tag
+    klasses << namespace_definition(object)
+  }
+  # puts klasses.sort.join("\n")
+  puts klasses.sort.join
+  exit # Avoid the YARD summary
+end