Class: YARD::Tags::OptionTag

Inherits:

Tag

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

Defined in:

lib/yard/tags/option_tag.rb

Instance Attribute Summary

• #name ⇒ String inherited from Tag

  A name associated with the tag.

• #object ⇒ CodeObjects::Base inherited from Tag

  The associated object.

• #pair ⇒ Object

  Returns the value of attribute pair.

• #tag_name ⇒ String inherited from Tag

  The name of the tag.

• #text ⇒ String^? inherited from Tag
• #types ⇒ Array<String>^? inherited from Tag

Instance Method Summary

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

  A new instance of OptionTag.

Constructor Details

#initialize(tag_name, name, pair) ⇒ OptionTag

Returns a new instance of OptionTag

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

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

Instance Attribute Details

#name ⇒ String Originally defined in class Tag

Returns a name associated with the tag

Returns:

• (String) —

  a name associated with the tag

#object ⇒ CodeObjects::Base Originally defined in class Tag

Returns the associated object

Returns:

• (CodeObjects::Base) —

  the associated object

#pair ⇒ Object

Returns the value of attribute pair

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

def pair
  @pair
end

#tag_name ⇒ String Originally defined in class Tag

Returns the name of the tag

Returns:

• (String) —

  the name of the tag

#text ⇒ String^? Originally defined in class Tag

Returns:

• (String) —

  the tag text associated with the tag

• (nil) —

  if no tag text is supplied

#types ⇒ Array<String>^? Originally defined in class Tag

Returns:

• (Array<String>) —

  a list of types associated with the tag

• (nil) —

  if no types are associated with the tag