Sha256: e94c65defd0155e4d7c824b0bed9b255f298a3f814e1488df818b4d04d7cb201

Contents?: true

Size: 1.24 KB

Versions: 19

Compression:

Stored size: 1.24 KB

Contents

def init
  tags = Tags::Library.visible_tags - [:abstract, :deprecated, :note, :todo]
  create_tag_methods(tags - [:example, :option, :overload, :see])
  sections :index, tags
  sections.any(:overload).push(T('docstring'))
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)
end

def param
  tag(:param) if object.type == :method
end

private

def tag(name, opts = nil)
  return unless object.has_tag?(name)
  opts ||= options_for_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

def create_tag_methods(tags)
  tags.each do |tag|
    next if respond_to?(tag)
    instance_eval(<<-eof, __FILE__, __LINE__ + 1)
      def #{tag}; tag(#{tag.inspect}) end
    eof
  end
end

def options_for_tag(tag)
  opts = {:no_types => true, :no_names => true}
  case Tags::Library.factory_method_for(tag)
  when :with_types
    opts[:no_types] = false
  when :with_types_and_name
    opts[:no_types] = false
    opts[:no_names] = false
  when :with_name
    opts[:no_names] = false
  end
  opts
end

Version data entries

19 entries across 19 versions & 2 rubygems

Version Path
challah-0.6.2 vendor/bundle/gems/yard-0.7.5/templates/default/tags/setup.rb
challah-0.6.1 vendor/bundle/gems/yard-0.7.5/templates/default/tags/setup.rb
challah-0.6.0 vendor/bundle/gems/yard-0.7.5/templates/default/tags/setup.rb
challah-0.5.4 vendor/bundle/gems/yard-0.7.5/templates/default/tags/setup.rb
challah-0.5.3 vendor/bundle/gems/yard-0.7.5/templates/default/tags/setup.rb
challah-0.5.2 vendor/bundle/gems/yard-0.7.5/templates/default/tags/setup.rb
challah-0.5.1 vendor/bundle/gems/yard-0.7.5/templates/default/tags/setup.rb
challah-0.5.0 vendor/bundle/gems/yard-0.7.5/templates/default/tags/setup.rb
challah-0.4.1 vendor/bundle/gems/yard-0.7.5/templates/default/tags/setup.rb
challah-0.4.0 vendor/bundle/gems/yard-0.7.5/templates/default/tags/setup.rb
challah-0.3.5 vendor/bundle/gems/yard-0.7.5/templates/default/tags/setup.rb
challah-0.3.4 vendor/bundle/gems/yard-0.7.5/templates/default/tags/setup.rb
challah-0.3.3 vendor/bundle/gems/yard-0.7.5/templates/default/tags/setup.rb
challah-0.3.2 vendor/bundle/gems/yard-0.7.5/templates/default/tags/setup.rb
challah-0.3.1 vendor/bundle/gems/yard-0.7.5/templates/default/tags/setup.rb
challah-0.3.0 vendor/bundle/gems/yard-0.7.5/templates/default/tags/setup.rb
challah-0.2.1 vendor/bundle/gems/yard-0.7.5/templates/default/tags/setup.rb
challah-0.2.0 vendor/bundle/gems/yard-0.7.5/templates/default/tags/setup.rb
yard-0.7.5 templates/default/tags/setup.rb