Class: YARD::Tags::DefaultTag

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

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (DefaultTag) initialize(tag_name, text, types = nil, name = nil, defaults = nil)

Returns a new instance of DefaultTag



6
7
8
9
# File 'lib/yard/tags/default_tag.rb', line 6

def initialize(tag_name, text, types = nil, name = nil, defaults = nil)
  super(tag_name, text, types, name)
  @defaults = defaults
end

Instance Attribute Details

- (Object) defaults (readonly)

Returns the value of attribute defaults



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

def defaults
  @defaults
end

- (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:

- (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