Class: YARD::Tags::DefaultTag

Inherits:

Tag

• Object
• Tag
• YARD::Tags::DefaultTag

Defined in:

lib/yard/tags/default_tag.rb

Instance Attribute Summary

• #defaults ⇒ Object readonly

  Returns the value of attribute defaults.

• #name ⇒ String inherited from Tag

  A name associated with the tag.

• #object ⇒ CodeObjects::Base inherited from Tag

  The associated object.

• #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, text, types = nil, name = nil, defaults = nil) ⇒ DefaultTag constructor

  A new instance of DefaultTag.

Constructor Details

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

Returns a new instance of DefaultTag

# 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

#defaults ⇒ Object (readonly)

Returns the value of attribute defaults

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

def defaults
  @defaults
end

#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

#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