123456789_123456789_123456789_123456789_123456789_

Class: YARD::Tags::OptionTag

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Tag
Instance Chain:
self, Tag
Inherits: YARD::Tags::Tag
Defined in: lib/yard/tags/option_tag.rb

Class Method Summary

Tag - Inherited

.new

Creates a new tag object with a tag name and text.

Instance Attribute Summary

Instance Method Summary

Tag - Inherited

#explain_types

Provides a plain English summary of the type specification, or nil if no types are provided or parsable.

#type

Convenience method to access the first type specified.

Constructor Details

.new(tag_name, name, pair) ⇒ OptionTag

[ GitHub ]

  
# File 'lib/yard/tags/option_tag.rb', line 7

def initialize(tag_name, name, pair)
  super(tag_name, nil, nil, name)
  @pair = pair
end

Instance Attribute Details

#pair (rw)

[ GitHub ]

  
# File 'lib/yard/tags/option_tag.rb', line 5

attr_accessor :pair