Class YARD::ParamTag

Object
  |
  +--YARD::BaseTag
      |
      +--YARD::BaseTypeTag
          |
          +--YARD::ParamTag

Attributes

name [R]

initialize(name, text, types = [])

Create a new param tag with a description and declared types

Parameters:: [String] name - the parameter name specified by the tag
[String] text - a description of the parameter
[Array] types - the optional types that the parameter accepts

ParamTag parse_tag(text)
Parses a typed tag’s value section and returns a new ParamTag object .

Public class methods inherited from YARD::BaseTypeTag
`extract_types_and_text`, `extract_name_and_text`

Public class methods inherited from YARD::BaseTag
`tag_library`, `tag_name`, `inherited`

Object	`name` Returns the value of attribute `name` .
Object	`name=(value)` Sets the attribute `name` .

Public instance methods inherited from YARD::BaseTypeTag
`type`, `types`, `types=`

Public instance methods inherited from YARD::BaseTag
`text`, `tag_name`, `text=`

public ParamTag self.parse_tag(text)

Parses a typed tag’s value section and returns a new ParamTag object

Overrides:: parse_tag in class YARD::BaseTag
Parameters:: [String] text - the raw tag value to parse type specifications from
Returns:: the new typed tag object with the type values parsed from raw text

public Object name

Returns the value of attribute name

public Object name=(value)

Sets the attribute name