Sha256: 5d945174f45fd3a8ebab1cf8b0c3dd8e6c59d23862f27227e8d6384695a46fb6

Contents?: true

Size: 1.04 KB

Versions: 10

Compression:

Stored size: 1.04 KB

Contents

def init
  sections :index, [:example, :overload, [T('docstring')], :param, :option, :yields, 
    :yieldparam, :yieldreturn, :return, :raises, :see, :author, :since, :version]
end

def param
  tag :param
end

def yields
  tag :yield, :no_names => true
end

def yieldparam
  tag :yieldparam
end

def yieldreturn
  tag :yieldreturn, :no_names => true
end

def return
  if object.type == :method
    return if object.name == :initialize && object.scope == :instance
    return if object.tags(:return).size == 1 && object.tag(:return).types == ['void']
  end
  tag :return, :no_names => true
end

def raises
  tag :raise, :no_names => true
end

def author
  tag :author, :no_types => true, :no_names => true
end

def since
  tag :since, :no_types => true, :no_names => true
end

def version
  tag :version, :no_types => true, :no_names => true
end

def tag(name, opts = {})
  return unless object.has_tag?(name)
  @no_names = true if opts[:no_names]
  @no_types = true if opts[:no_types]
  @name = name
  out = erb('tag')
  @no_names, @no_types = nil, nil
  out
end

Version data entries

10 entries across 10 versions & 1 rubygems

Version Path
yard-0.5.8 templates/default/tags/setup.rb
yard-0.5.7 templates/default/tags/setup.rb
yard-0.5.6 templates/default/tags/setup.rb
yard-0.5.5 templates/default/tags/setup.rb
yard-0.5.4 templates/default/tags/setup.rb
yard-0.5.3 templates/default/tags/setup.rb
yard-0.5.2 templates/default/tags/setup.rb
yard-0.5.1p1 templates/default/tags/setup.rb
yard-0.5.1 templates/default/tags/setup.rb
yard-0.5.0 templates/default/tags/setup.rb