yard 0.9.18 → 0.9.23

data/templates/guide/fulldoc/html/js/app.js

@@ -1,33 +1,33 @@
-function generateTOC() {
-  if ($('#filecontents').length == 0) return;
-  var _toc = $('<ol class="top"></ol>');
-  var show = false;
-  var toc = _toc;
-  var counter = 0;
-  var tags = ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
-  for (i in tags) { tags[i] = '#filecontents > ' + tags[i] }
-  var lastTag = parseInt(tags[0][1]);
-  $(tags.join(', ')).each(function() {
-    if (this.id == "filecontents") return;
-    show = true;
-    var thisTag = parseInt(this.tagName[1]);
-    if (this.id.length == 0) {
-      var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
-      if ($('#' + proposedId).length > 0) proposedId += counter++;
-      this.id = proposedId;
-    }
-    if (thisTag > lastTag) {
-      for (var i = 0; i < thisTag - lastTag; i++) {
-        var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
-      }
-    }
-    if (thisTag < lastTag) {
-      for (var i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
-    }
-    toc.append('<li><a href="#' + this.id + '">' + $(this).text() + '</a></li>');
-    lastTag = thisTag;
-  });
-  if (!show) return;
-  $('#toc').append()
-  $('#toc').append(_toc);
-}
+function generateTOC() {
+  if ($('#filecontents').length == 0) return;
+  var _toc = $('<ol class="top"></ol>');
+  var show = false;
+  var toc = _toc;
+  var counter = 0;
+  var tags = ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
+  for (i in tags) { tags[i] = '#filecontents > ' + tags[i] }
+  var lastTag = parseInt(tags[0][1]);
+  $(tags.join(', ')).each(function() {
+    if (this.id == "filecontents") return;
+    show = true;
+    var thisTag = parseInt(this.tagName[1]);
+    if (this.id.length == 0) {
+      var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
+      if ($('#' + proposedId).length > 0) proposedId += counter++;
+      this.id = proposedId;
+    }
+    if (thisTag > lastTag) {
+      for (var i = 0; i < thisTag - lastTag; i++) {
+        var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
+      }
+    }
+    if (thisTag < lastTag) {
+      for (var i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
+    }
+    toc.append('<li><a href="#' + this.id + '">' + $(this).text() + '</a></li>');
+    lastTag = thisTag;
+  });
+  if (!show) return;
+  $('#toc').append()
+  $('#toc').append(_toc);
+}

data/templates/guide/fulldoc/html/setup.rb

@@ -1,74 +1,74 @@
-# frozen_string_literal: true
-include T('default/fulldoc/html')
-
-module OverrideFileLinks
-  def resolve_links(text)
-    result = ''
-    log.enter_level(Logger::ERROR) { result = super }
-    result
-  end
-
-  def url_for(object, *args)
-    if CodeObjects::ExtraFileObject === object && object == options.readme
-      'index.html'
-    else
-      super
-    end
-  end
-end
-
-Template.extra_includes << OverrideFileLinks
-
-def init
-  class << options.serializer
-    define_method(:serialized_path) do |object|
-      if CodeObjects::ExtraFileObject === object
-        super(object).sub(/^file\./, '').downcase
-      else
-        super(object)
-      end
-    end
-  end if options.serializer
-
-  return serialize_onefile if options.onefile
-
-  generate_assets
-  options.delete(:objects)
-  options.files.each {|file| serialize_file(file) }
-  serialize_file(options.readme) if options.readme
-end
-
-def generate_assets
-  %w(js/jquery.js js/app.js css/style.css css/common.css).each do |file|
-    asset(file, file(file, true))
-  end
-end
-
-def serialize_file(file)
-  index = options.files.index(file)
-  outfile = file.name.downcase + '.html'
-  options.file = file
-  if file.attributes[:namespace]
-    options.object = Registry.at(file.attributes[:namespace])
-  end
-  options.object ||= Registry.root
-
-  if file == options.readme
-    serialize_index(options)
-  else
-    serialize_index(options) if !options.readme && index == 0
-    Templates::Engine.with_serializer(outfile, options.serializer) do
-      T('layout').run(options)
-    end
-  end
-  options.delete(:file)
-end
-
-def serialize_onefile
-  layout = Object.new.extend(T('layout'))
-  options.css_data = layout.stylesheets.map {|sheet| file(sheet, true) }.join("\n")
-  options.js_data = layout.javascripts.map {|script| file(script, true) }.join("")
-  Templates::Engine.with_serializer('onefile.html', options.serializer) do
-    T('onefile').run(options)
-  end
-end
+# frozen_string_literal: true
+include T('default/fulldoc/html')
+
+module OverrideFileLinks
+  def resolve_links(text)
+    result = ''
+    log.enter_level(Logger::ERROR) { result = super }
+    result
+  end
+
+  def url_for(object, *args)
+    if CodeObjects::ExtraFileObject === object && object == options.readme
+      'index.html'
+    else
+      super
+    end
+  end
+end
+
+Template.extra_includes << OverrideFileLinks
+
+def init
+  class << options.serializer
+    define_method(:serialized_path) do |object|
+      if CodeObjects::ExtraFileObject === object
+        super(object).sub(/^file\./, '').downcase
+      else
+        super(object)
+      end
+    end
+  end if options.serializer
+
+  return serialize_onefile if options.onefile
+
+  generate_assets
+  options.delete(:objects)
+  options.files.each {|file| serialize_file(file) }
+  serialize_file(options.readme) if options.readme
+end
+
+def generate_assets
+  %w(js/jquery.js js/app.js css/style.css css/common.css).each do |file|
+    asset(file, file(file, true))
+  end
+end
+
+def serialize_file(file)
+  index = options.files.index(file)
+  outfile = file.name.downcase + '.html'
+  options.file = file
+  if file.attributes[:namespace]
+    options.object = Registry.at(file.attributes[:namespace])
+  end
+  options.object ||= Registry.root
+
+  if file == options.readme
+    serialize_index(options)
+  else
+    serialize_index(options) if !options.readme && index == 0
+    Templates::Engine.with_serializer(outfile, options.serializer) do
+      T('layout').run(options)
+    end
+  end
+  options.delete(:file)
+end
+
+def serialize_onefile
+  layout = Object.new.extend(T('layout'))
+  options.css_data = layout.stylesheets.map {|sheet| file(sheet, true) }.join("\n")
+  options.js_data = layout.javascripts.map {|script| file(script, true) }.join("")
+  Templates::Engine.with_serializer('onefile.html', options.serializer) do
+    T('onefile').run(options)
+  end
+end

data/templates/guide/layout/html/layout.erb

@@ -1,81 +1,81 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-  <head>
-    <%= erb(:headers) %>
-		<script type="text/javascript" charset="utf-8">
-			$(function() {
-				$('.object_link').each(function() {
-					$(this).html($(this).find('a').html())
-				});
-			});
-			$(function() {
-				generateTOC();
-				if ($('#toc li').size() == 0) {
-					$('#sidebar h2.toc').hide();
-				}
-			})
-		</script>
-  </head>
-  <body>
-		<div id="top_nav">
-			<div id="inner_nav">
-				<% if options.readme != options.file && options.title %>
-					<span class="title"><strong><%= options.title %></strong>: <%= @page_title %></span>
-					<small class="links">
-						<% links = [@prevfile ? link_file(@prevfile, '&larr;') : nil,
-						            link_file('index.html', '&uarr;'),
-									@nextfile ? link_file(@nextfile, '&rarr;') : nil].compact %>
-						<%= links.join(" ") %>
-					</small>
-				<% end %>
-			</div>
-		</div>
-		<div id="page">
-			<div id="sidebar">
-				<h2 class="toc">Table Of Contents</h2>
-				<div id="toc"></div>
-
-				<% if options.readme != options.file %>
-				<h2>Related Topics</h2>
-				<div id="links">
-					<ol class="top">
-						<% if options.readme %>
-							<li><%= link_file("index.html", "Documentation Overview") %></li>
-						<% end %>
-						<ol>
-							<% if @prevfile %>
-								<li>
-									<strong>Previous:</strong>
-									<%= link_file(@prevfile) %>
-								</li>
-							<% end %>
-							<% if @nextfile %>
-							<li>
-								<strong>Next:</strong>
-								<%= link_file(@nextfile) %>
-							</li>
-							<% end %>
-						</ol>
-					</ol>
-				</div>
-				<% else %>
-				<h2>List of Topics</h2>
-				<div id="links">
-					<ol class="top">
-						<li><a href="#">Documentation Overview</a></li>
-						<ol>
-							<% options.files.each do |file| %>
-							<li><%= link_file(file.filename, file.title) %></li>
-							<% end %>
-						</ol>
-					</ol>
-				</div>
-				<% end %>
-			</div>
-	    <div id="content"><%= yieldall %></div>
-		</div>
-		<div style="clear:both"></div>
-    <%= erb(:footer) %>
-  </body>
-</html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <%= erb(:headers) %>
+		<script type="text/javascript">
+			$(function() {
+				$('.object_link').each(function() {
+					$(this).html($(this).find('a').html())
+				});
+			});
+			$(function() {
+				generateTOC();
+				if ($('#toc li').size() == 0) {
+					$('#sidebar h2.toc').hide();
+				}
+			})
+		</script>
+  </head>
+  <body>
+		<div id="top_nav">
+			<div id="inner_nav">
+				<% if options.readme != options.file && options.title %>
+					<span class="title"><strong><%= options.title %></strong>: <%= @page_title %></span>
+					<small class="links">
+						<% links = [@prevfile ? link_file(@prevfile, '&larr;') : nil,
+						            link_file('index.html', '&uarr;'),
+									@nextfile ? link_file(@nextfile, '&rarr;') : nil].compact %>
+						<%= links.join(" ") %>
+					</small>
+				<% end %>
+			</div>
+		</div>
+		<div id="page">
+			<div id="sidebar">
+				<h2 class="toc">Table Of Contents</h2>
+				<div id="toc"></div>
+
+				<% if options.readme != options.file %>
+				<h2>Related Topics</h2>
+				<div id="links">
+					<ol class="top">
+						<% if options.readme %>
+							<li><%= link_file("index.html", "Documentation Overview") %></li>
+						<% end %>
+						<ol>
+							<% if @prevfile %>
+								<li>
+									<strong>Previous:</strong>
+									<%= link_file(@prevfile) %>
+								</li>
+							<% end %>
+							<% if @nextfile %>
+							<li>
+								<strong>Next:</strong>
+								<%= link_file(@nextfile) %>
+							</li>
+							<% end %>
+						</ol>
+					</ol>
+				</div>
+				<% else %>
+				<h2>List of Topics</h2>
+				<div id="links">
+					<ol class="top">
+						<li><a href="#">Documentation Overview</a></li>
+						<ol>
+							<% options.files.each do |file| %>
+							<li><%= link_file(file.filename, file.title) %></li>
+							<% end %>
+						</ol>
+					</ol>
+				</div>
+				<% end %>
+			</div>
+	    <div id="content"><%= yieldall %></div>
+		</div>
+		<div style="clear:both"></div>
+    <%= erb(:footer) %>
+  </body>
+</html>

data/templates/guide/layout/html/setup.rb

@@ -1,25 +1,25 @@
-# frozen_string_literal: true
-include T('default/layout/html')
-
-def init
-  super
-
-  @topfile = options.readme
-  if options.files
-    if @topfile
-      @toptitle = @topfile.attributes[:title] || "Documentation Overview"
-    end
-    @page_title = @file == options.readme ? options.title : @file.title
-
-    index = options.files.index(@file)
-    if index
-      @prevfile = index > 0 ? (options.files[index - 1] || options.readme) : nil
-      @nextfile = options.files[index + 1]
-    end
-  end
-end
-
-def diskfile
-  options.including_object = @object
-  super
-end
+# frozen_string_literal: true
+include T('default/layout/html')
+
+def init
+  super
+
+  @topfile = options.readme
+  if options.files
+    if @topfile
+      @toptitle = @topfile.attributes[:title] || "Documentation Overview"
+    end
+    @page_title = @file == options.readme ? options.title : @file.title
+
+    index = options.files.index(@file)
+    if index
+      @prevfile = index > 0 ? (options.files[index - 1] || options.readme) : nil
+      @nextfile = options.files[index + 1]
+    end
+  end
+end
+
+def diskfile
+  options.including_object = @object
+  super
+end

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

@@ -1,18 +1,18 @@
-<div class="method_header">
-  <% if options.in_module %>
-    <% if object.constructor? %>
-      <em>self.</em><span class="path"><strong>new</strong></span><big>(</big><%= format_args(object) %><big>)</big> <%= format_block(object) %>
-    <% else %>
-      <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? %>
-        <% rw = object.attr_info %>
-        <% if rw && rw[:read] && !rw[:write] %><span class="readonly">readonly</span>
-        <% elsif rw && !rw[:read] && rw[:write] %><span class="writeonly">writeonly</span>
-        <% end %>
-        <% else %><big>(</big><%= format_args(object) %><big>)</big> <%= format_block(object) %><% end %>
-    <% end %>
-  <% else %>
-    <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) %>
-  <% end %>
-  <% if object.has_tag?(:since) && object.namespace.tag(:since) != object.tag(:since) %><span class="since">since <%= object.tag(:since).text %></span><% end %>
-</div>
+<div class="method_header">
+  <% if options.in_module %>
+    <% if object.constructor? %>
+      <em>self.</em><span class="path"><strong>new</strong></span><big>(</big><%= format_args(object) %><big>)</big> <%= format_block(object) %>
+    <% else %>
+      <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? %>
+        <% rw = object.attr_info %>
+        <% if rw && rw[:read] && !rw[:write] %><span class="readonly">readonly</span>
+        <% elsif rw && !rw[:read] && rw[:write] %><span class="writeonly">writeonly</span>
+        <% end %>
+        <% else %><big>(</big><%= format_args(object) %><big>)</big> <%= format_block(object) %><% end %>
+    <% end %>
+  <% else %>
+    <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) %>
+  <% end %>
+  <% if object.has_tag?(:since) && object.namespace.tag(:since) != object.tag(:since) %><span class="since">since <%= object.tag(:since).text %></span><% end %>
+</div>
 <div class="method_body"><%= yieldall %></div>