yard 0.9.28 → 0.9.29

data/templates/guide/fulldoc/html/css/style.css

@@ -1,108 +0,0 @@
-body { color: #3e4349; font-family: Georgia, serif; font-size: 17px; margin: 0; }
-h1, h2, h3, h4, h5, h6 { font-weight: normal; color: #000; font-family: Georgia, serif; }
-h1 { color: #040; }
-h2 { color: #060; }
-h3 { color: #070; }
-h4 { color: #080; }
-h5 { color: #090; }
-#sidebar h2 { color: #2f2; }
-strong { color: #000; }
-.object_link, tt, code { font-family: 'Consolas', 'BitStream Vera Sans Mono', monospace; font-size: 14px; }
-.method_header .path, .module_header .path { font-family: 'Consolas', 'BitStream Vera Sans Mono', monospace; }
-.method_header .path.space, .module_header .path.space { padding-left: 5px; }
-.method_header { font-size: 0.95em; }
-.method_body { margin-left: 2em; }
-.tags h3, .tags h4 { font-size: 0.9em; font-weight: bold; color: #3e4349; }
-.tags .param .name { font-style: italic; }
-.tags .option .name { font-family: monospace; color: #000; font-size: 0.8em; }
-.tags .option .type, .tags .param .type { font-size: 10px; vertical-align: super; }
-.tags .option .type tt, .tags .param .type tt,
-.tags .option .type tt .object_link, .tags .param .type tt .object_link { font-size: 10px; }
-.module_methods { margin-left: 2em; }
-.method_header .since, .module_header .since { font-size: 0.75em; color: #888; vertical-align: super; }
-ul { list-style: square; }
-.inline { display: inline; }
-.inline p:first-child { display: inline; }
-.inline p { font-family: Georgia, serif; font-size: 16px; color: #3e4349; }
-#filecontents table, .docstring table { border-collapse: collapse; }
-#filecontents table th, #filecontents table td,
-.docstring table th, .docstring table td { border: 1px solid #ccc; padding: 8px; padding-right: 17px; }
-#filecontents table tr:nth-child(odd),
-.docstring table tr:nth-child(odd) { background: #eee; }
-#filecontents table tr:nth-child(even),
-.docstring table tr:nth-child(even) { background: #fff; }
-#filecontents table th, .docstring table th { background: #fff; }
-.docstring .note { margin: 1em 0; }
-.docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; border: 0; border-bottom: 1px dotted #bbb; }
-.docstring h1 { font-size: 1.2em; }
-.docstring h2 { font-size: 1.1em; }
-.docstring h3 { font-size: 1.1em; }
-.docstring h4 { font-size: 1.0em; font-weight: bold; }
-.docstring h5 { font-size: 1.0em; font-weight: bold; }
-.docstring h6 { font-size: 1.0em; font-weight: bold; }
-#filecontents strong { font-weight: normal; color: #000; }
-.readonly { font-size: 0.75em; color: #888; vertical-align: super; }
-.rdoc-term { padding-right: 25px; font-weight: bold; }
-.rdoc-list p { margin: 0; padding: 0; margin-bottom: 4px; }
-
-#page { width: 940px; margin: 0px auto; }
-#top_nav { background: #7d0; padding: 8px 12px; }
-#inner_nav { width: 940px; margin: 0px auto; }
-#inner_nav a { border: 0; text-decoration: none; color: #777; }
-#inner_nav a:hover { color: #222; }
-#top_nav .links { display: block; float: right; }
-#content { margin-left: 30px; width: 660px; float: left; }
-#sidebar { float: left; width: 200px; float: left; padding: 18px 10px; padding-top: 0; }
-#sidebar h2 { font-weight: 100; color: #3e4349; font-size: 1.45em; }
-#sidebar ol { padding-left: 16px; margin-left: 0; list-style: square; }
-#sidebar a { color: #468; text-decoration: none; }
-#sidebar a:hover { color: #000; background: #8e0; padding: 4px; }
-#sidebar ol.top { padding-left: 0; margin-left: 0; list-style: none; }
-#sidebar a { font-size: 0.9em; }
-#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; }
-#footer a { color: #444; }
-#links strong { font-size: 0.95em; font-weight: normal; color: #000; }
-
-a { color: #268; text-decoration: none; }
-a:hover { color: #6ae; }
-
-/* syntax highlighting */
-.source_code { display: none; padding: 3px 8px; border-left: 8px solid #ddd; margin-top: 5px; }
-#filecontents pre.code, .docstring pre.code, .source_code pre { font-family: monospace; }
-#filecontents pre.code, .docstring pre.code { display: block; }
-.source_code .lines { padding-right: 12px; color: #555; text-align: right; }
-#filecontents pre.code, .docstring pre.code,
-.tags pre.example {
-  font-size: 0.9em;
-  padding: 7px 30px;
-  margin: 15px -30px;
-  margin-left: -30px;
-  background: #eee;
-  line-height: 1.3em;
-  font-family: 'Consolas', 'BitStream Vera Sans Mono', monospace;
- }
-pre.code { color: #3e4349; }
-pre.code .info.file { color: #555; }
-pre.code .val { color: #036A07; }
-pre.code .tstring_content,
-pre.code .heredoc_beg, pre.code .heredoc_end,
-pre.code .qwords_beg, pre.code .qwords_end,
-pre.code .tstring, pre.code .dstring { color: #036A07; }
-pre.code .fid, pre.code .rubyid_new, pre.code .rubyid_to_s,
-pre.code .rubyid_to_sym, pre.code .rubyid_to_f,
-pre.code .dot + pre.code .id,
-pre.code .rubyid_to_i pre.code .rubyid_each { color: #0085FF; }
-pre.code .comment { color: #0066FF; }
-pre.code .const, pre.code .constant { color: #585CF6; }
-pre.code .symbol { color: #C5060B; }
-pre.code .kw,
-pre.code .label,
-pre.code .rubyid_require,
-pre.code .rubyid_extend,
-pre.code .rubyid_include { color: #0000FF; }
-pre.code .ivar { color: #318495; }
-pre.code .gvar,
-pre.code .rubyid_backref,
-pre.code .rubyid_nth_ref { color: #6D79DE; }
-pre.code .regexp, .dregexp { color: #036A07; }
-pre.code a { border-bottom: 1px dotted #bbf; }

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

@@ -1,33 +0,0 @@
-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 +0,0 @@
-# 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 +0,0 @@
-<!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 +0,0 @@
-# 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 +0,0 @@
-<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>

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

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-def init
-  sections :header, [T('docstring')]
-end
-
-def format_args(object)
-  return if object.parameters.nil?
-  params = object.parameters
-  if object.has_tag?(:yield) || object.has_tag?(:yieldparam)
-    params.reject! do |param|
-      param[0].to_s[0, 1] == "&" &&
-        !object.tags(:param).any? {|t| t.name == param[0][1..-1] }
-    end
-  end
-
-  if params.empty?
-    ""
-  else
-    args = params.map {|n, v| v ? "<em>#{h n}</em> = #{h v}" : "<em>" + n.to_s + "</em>" }.join(", ")
-    args
-  end
-end

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

@@ -1,7 +0,0 @@
-<div class='module_header'>
-  <em><%= object.type %></em> <span class="path"><%= object.namespace == Registry.root ? '' : object.namespace.path + '::' %><strong><%= object.name %></strong></span>
-  <% if object.has_tag?(:since) %><span class="since">since <%= object.tag(:since).text %></span><% end %>
-</div>
-<div class="module_methods">
-  <%= yieldall %>
-</div>

data/templates/guide/module/html/method_list.erb

@@ -1,5 +0,0 @@
-<div class="module_methods">
-  <% @meths.each_with_index do |meth, i| %>
-    <%= yieldall(:object => meth, :index => i, :in_module => true) %>
-  <% end %>
-</div>

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-include Helpers::ModuleHelper
-
-def init
-  sections :header, [T('docstring')], :method_list, [T('method')]
-end
-
-def method_list
-  @meths = object.meths(:inherited => false, :included => false)
-  cons = @meths.find(&:constructor?)
-  @meths = @meths.reject {|meth| special_method?(meth) }
-  @meths = sort_listing(prune_method_listing(@meths, false))
-  @meths.unshift(cons) if cons
-  erb(:method_list)
-end
-
-def sort_listing(list)
-  list.sort_by {|o| [o.scope.to_s, o.name.to_s.downcase] }
-end
-
-def special_method?(meth)
-  return true if meth.writer? && meth.attr_info[:read]
-  return true if meth.name(true) == 'new'
-  return true if meth.name(true) == '#method_missing'
-  return true if meth.constructor?
-  false
-end

data/templates/guide/onefile/html/files.erb

@@ -1,4 +0,0 @@
-<% @files.each do |file| %>
-  <% @file = file %>
-  <%= diskfile %>
-<% end %>

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

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-include T('default/onefile/html')
-
-def init
-  sections :layout, [:toc, :files]
-end

data/templates/guide/onefile/html/toc.erb

@@ -1,3 +0,0 @@
-<h1><%= @title %></h1>
-<h2>Table of Contents</h2>
-<div id="toc" class="one-file"></div>

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

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-include T('default/tags/html')
-
-def init
-  super
-  [:since, :see, :return].each do |section|
-    sections[:index].delete(section)
-  end
-end

data/yard.gemspec

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-require File.expand_path('../lib/yard/version', __FILE__)
-
-Gem::Specification.new do |s|
-  s.name          = "yard"
-  s.summary       = "Documentation tool for consistent and usable documentation in Ruby."
-  s.description   = <<-eof
-    YARD is a documentation generation tool for the Ruby programming language.
-    It enables the user to generate consistent, usable documentation that can be
-    exported to a number of formats very easily, and also supports extending for
-    custom Ruby constructs such as custom class level definitions.
-  eof
-  s.version       = YARD::VERSION
-  s.author        = "Loren Segal"
-  s.email         = "lsegal@soen.ca"
-  s.homepage      = "http://yardoc.org"
-  s.platform      = Gem::Platform::RUBY
-  s.files         = `git ls-files`.strip.split(/\s+/).reject {|f| f.match(%r{^spec/}) }
-  s.require_paths = ['lib']
-  s.executables   = ['yard', 'yardoc', 'yri']
-  s.license = 'MIT' if s.respond_to?(:license=)
-  s.metadata['yard.run'] = 'yri'
-
-  s.add_runtime_dependency 'webrick', '~> 1.7.0'
-end