Class: YARD::Tags::OptionTag

Inherits:

Tag

• Object
• Tag
• YARD::Tags::OptionTag

Defined in:

lib/yard/tags/option_tag.rb

Instance Attribute Summary

• #pair ⇒ Object

  Returns the value of attribute pair.

Attributes inherited from Tag

#name, #object, #tag_name, #text, #types

Instance Method Summary

• #initialize(tag_name, name, pair) ⇒ OptionTag constructor

  A new instance of OptionTag.

Methods inherited from Tag

#explain_types, #type

Constructor Details

#initialize(tag_name, name, pair) ⇒ OptionTag

Returns a new instance of OptionTag.

# 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 ⇒ Object

Returns the value of attribute pair.

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

def pair
  @pair
end