Contents

def init
  return if object.docstring.blank?
  sections :index, [:deprecated, :abstract, :todo, :note, :returns_void, :text], T('tags')
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

6 entries across 6 versions & 1 rubygems

Version	Path
yard-0.5.4	templates/default/docstring/setup.rb
yard-0.5.3	templates/default/docstring/setup.rb
yard-0.5.2	templates/default/docstring/setup.rb
yard-0.5.1p1	templates/default/docstring/setup.rb
yard-0.5.1	templates/default/docstring/setup.rb
yard-0.5.0	templates/default/docstring/setup.rb