Class YARD::BaseTag

Object
  |
  +--YARD::BaseTag

Represents a tag and its respective tag name and value.

Attributes

text [R]

Constructor Summary

initialize(text)

Public Class Method Summary

Object inherited(subclass)
Object parse_tag(text)
      Parses tag text from a doc string and returns a new tag .
Array tag_library
      Return all valid tags in the tag library .
String tag_name
      Returns the tag name that the class responds to .

Public Instance Method Summary

Object tag_name
Object text
      Returns the value of attribute text .
Object text=(value)
      Sets the attribute text .

Public Class Method Details

inherited

public Object inherited(subclass)

parse_tag

public Object parse_tag(text)

Parses tag text from a doc string and returns a new tag

tag_library

public Array tag_library

Return all valid tags in the tag library

Returns:
a list of valid tags that are registered as being handled

tag_name

public String tag_name

Returns the tag name that the class responds to. If the class name does not accurately represent the tag name, this method should be overrided by subclasses to return the correct tag name.

Returns:
the tag name the class represents

Public Instance Method Details

tag_name

public Object tag_name

See Also:
BaseTag::tag_name

text

public Object text

Returns the value of attribute text

text=

public Object text=(value)

Sets the attribute text

Parameters:
value - the value to set the attribute text to.