yard 0.9.16 → 0.9.17

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

@@ -1,22 +1,22 @@
-# 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
+# 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 +1,7 @@
-<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 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 +1,5 @@
-<div class="module_methods">
-  <% @meths.each_with_index do |meth, i| %>
-    <%= yieldall(:object => meth, :index => i, :in_module => true) %>
-  <% end %>
+<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 +1,27 @@
-# 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
+# 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 +1,4 @@
-<% @files.each do |file| %>
-  <% @file = file %>
-  <%= diskfile %>
-<% end %>
+<% @files.each do |file| %>
+  <% @file = file %>
+  <%= diskfile %>
+<% end %>

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

@@ -1,6 +1,6 @@
-# frozen_string_literal: true
-include T('default/onefile/html')
-
-def init
-  sections :layout, [:toc, :files]
-end
+# 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 +1,3 @@
-<h1><%= @title %></h1>
-<h2>Table of Contents</h2>
-<div id="toc" class="one-file"></div>
+<h1><%= @title %></h1>
+<h2>Table of Contents</h2>
+<div id="toc" class="one-file"></div>

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

@@ -1,9 +1,9 @@
-# frozen_string_literal: true
-include T('default/tags/html')
-
-def init
-  super
-  [:since, :see, :return].each do |section|
-    sections[:index].delete(section)
-  end
-end
+# 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,43 +1,43 @@
-# 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.date          = Time.now.strftime('%Y-%m-%d')
-  s.author        = "Loren Segal"
-  s.email         = "lsegal@soen.ca"
-  s.homepage      = "http://yardoc.org"
-  s.platform      = Gem::Platform::RUBY
-  s.files         = Dir.glob("{docs,bin,lib,spec,templates,benchmarks}/**/*") +
-                    ['CHANGELOG.md', 'LICENSE', 'LEGAL', 'README.md', 'Rakefile', '.yardopts', __FILE__]
-  s.require_paths = ['lib']
-  s.executables   = ['yard', 'yardoc', 'yri']
-  s.license = 'MIT' if s.respond_to?(:license=)
-  s.metadata['yard.run'] = 'yri'
-  s.post_install_message = <<-eof
---------------------------------------------------------------------------------
-As of YARD v0.9.2:
-
-RubyGems "--document=yri,yard" hooks are now supported. You can auto-configure
-YARD to automatically build the yri index for installed gems by typing:
-
-    $ yard config --gem-install-yri
-
-See `yard config --help` for more information on RubyGems install hooks.
-
-You can also add the following to your .gemspec to have YARD document your gem
-on install:
-
-    spec.metadata["yard.run"] = "yri" # use "yard" to build full HTML docs.
-
---------------------------------------------------------------------------------
-eof
-end
+# 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.date          = Time.now.strftime('%Y-%m-%d')
+  s.author        = "Loren Segal"
+  s.email         = "lsegal@soen.ca"
+  s.homepage      = "http://yardoc.org"
+  s.platform      = Gem::Platform::RUBY
+  s.files         = Dir.glob("{docs,bin,lib,spec,templates,benchmarks}/**/*") +
+                    ['CHANGELOG.md', 'LICENSE', 'LEGAL', 'README.md', 'Rakefile', '.yardopts', __FILE__]
+  s.require_paths = ['lib']
+  s.executables   = ['yard', 'yardoc', 'yri']
+  s.license = 'MIT' if s.respond_to?(:license=)
+  s.metadata['yard.run'] = 'yri'
+  s.post_install_message = <<-eof
+--------------------------------------------------------------------------------
+As of YARD v0.9.2:
+
+RubyGems "--document=yri,yard" hooks are now supported. You can auto-configure
+YARD to automatically build the yri index for installed gems by typing:
+
+    $ yard config --gem-install-yri
+
+See `yard config --help` for more information on RubyGems install hooks.
+
+You can also add the following to your .gemspec to have YARD document your gem
+on install:
+
+    spec.metadata["yard.run"] = "yri" # use "yard" to build full HTML docs.
+
+--------------------------------------------------------------------------------
+eof
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.9.16
+  version: 0.9.17
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-11 00:00:00.000000000 Z
+date: 2019-01-21 00:00:00.000000000 Z
 dependencies: []
 description: |2
       YARD is a documentation generation tool for the Ruby programming language.
@@ -383,6 +383,7 @@ files:
 - spec/parser/examples/array.c.txt
 - spec/parser/examples/example1.rb.txt
 - spec/parser/examples/extrafile.c.txt
+- spec/parser/examples/file.c.txt
 - spec/parser/examples/multifile.c.txt
 - spec/parser/examples/namespace.cpp.txt
 - spec/parser/examples/override.c.txt
@@ -638,8 +639,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.0
 signing_key: 
 specification_version: 4
 summary: Documentation tool for consistent and usable documentation in Ruby.