Class: YARD::Tags::OptionTag

Inherits:
Tag
  • Object
show all
Defined in:
lib/yard/tags/option_tag.rb

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (OptionTag) initialize(tag_name, name, pair)

Returns a new instance of OptionTag



6
7
8
9
# 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

- (String) name Originally defined in class Tag

Returns a name associated with the tag

Returns:

  • (String)

    a name associated with the tag

- (CodeObjects::Base) object Originally defined in class Tag

Returns the associated object

Returns:

- (Object) pair

Returns the value of attribute pair



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

def pair
  @pair
end

- (String) tag_name Originally defined in class Tag

Returns the name of the tag

Returns:

  • (String)

    the name of the tag

- (String?) text Originally defined in class Tag

Returns:

  • (String)

    the tag text associated with the tag

  • (nil)

    if no tag text is supplied

- (Array<String>?) types 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