Sha256: 94306b9d44c24ad741f26e9f0226df0fd00ddbf09cb1ccba617a30c95a44d88d

Contents?: true

Size: 1.1 KB

Versions: 47

Compression:

Stored size: 1.1 KB

Contents

def init
  return if object.docstring.blank? && !object.has_tag?(:api)
  sections :index, [:private, :deprecated, :abstract, :todo, :note, :returns_void, :text], T('tags')
end

def private
  return unless object.has_tag?(:api) && object.tag(:api).text == 'private'
  erb(:private)
end

def abstract
  return unless object.has_tag?(:abstract)
  erb(:abstract)
end

def deprecated
  return unless object.has_tag?(:deprecated)
  erb(:deprecated)
end

def todo
  return unless object.has_tag?(:todo)
  erb(:todo)
end

def note
  return unless object.has_tag?(:note)
  erb(:note)
end

def returns_void
  return unless object.type == :method
  return if object.name == :initialize && object.scope == :instance
  return unless object.tags(:return).size == 1 && object.tag(:return).types == ['void']
  erb(:returns_void)
end

def docstring_text
  text = ""
  unless object.tags(:overload).size == 1 && object.docstring.empty?
    text = object.docstring
  end

  if text.strip.empty? && object.tags(:return).size == 1 && object.tag(:return).text
    text = object.tag(:return).text.gsub(/\A([a-z])/) {|x| x.upcase }
  end

  text.strip
end

Version data entries

47 entries across 34 versions & 4 rubygems

Version Path
challah-1.0.0 vendor/bundle/gems/yard-0.8.6.1/templates/default/docstring/setup.rb
yard-0.8.6.2 templates/default/docstring/setup.rb
challah-1.0.0.beta3 vendor/bundle/gems/yard-0.8.6.1/templates/default/docstring/setup.rb
challah-1.0.0.beta3 vendor/bundle/gems/yard-0.8.5.2/templates/default/docstring/setup.rb
challah-1.0.0.beta3 vendor/bundle/gems/yard-0.8.6/templates/default/docstring/setup.rb
sidekiq-statsd-0.1.1 vendor/ruby/1.9.1/gems/yard-0.8.6.1/templates/default/docstring/setup.rb
sidekiq-statsd-0.1.0 vendor/ruby/1.9.1/gems/yard-0.8.6.1/templates/default/docstring/setup.rb
yard-0.8.6.1 templates/default/docstring/setup.rb
challah-1.0.0.beta2 vendor/bundle/gems/yard-0.8.6/templates/default/docstring/setup.rb
challah-1.0.0.beta2 vendor/bundle/gems/yard-0.8.5.2/templates/default/docstring/setup.rb
yard-0.8.6 templates/default/docstring/setup.rb
challah-1.0.0.beta vendor/bundle/gems/yard-0.8.5.2/templates/default/docstring/setup.rb
challah-1.0.0.beta vendor/bundle/gems/yard-0.8.3/templates/default/docstring/setup.rb
yard-0.8.5.2 templates/default/docstring/setup.rb
yard-0.8.5.1 templates/default/docstring/setup.rb
yard-0.8.5 templates/default/docstring/setup.rb
challah-0.9.1.beta.3 vendor/bundle/gems/yard-0.8.3/templates/default/docstring/setup.rb
yard-0.8.4.1 templates/default/docstring/setup.rb
yard-0.8.4 templates/default/docstring/setup.rb
challah-0.9.1.beta vendor/bundle/gems/yard-0.8.3/templates/default/docstring/setup.rb