Class: Decode::Comment::Attribute

Inherits:
Tag
  • Object
show all
Defined in:
lib/decode/comment/attribute.rb

Overview

Describes an attribute type.

  • ‘@attribute [Integer] The person’s age.‘

Direct Known Subclasses

Raises, Returns, Throws

Constant Summary collapse

PATTERN = 
/\A\[(?<type>.*?)\](\s+(?<details>.*?))?\Z/

Instance Attribute Summary collapse

Attributes inherited from Tag

#directive

Attributes inherited from Node

#children

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Tag

match, parse

Methods inherited from Node

#add, #children?, #each, #filter, #text, #traverse

Constructor Details

#initialize(directive, type) ⇒ Attribute

Returns a new instance of Attribute.



27
28
29
30
31
 
# File 'lib/decode/comment/attribute.rb', line 27

def initialize(directive, type)
	super(directive)
	
	@type = type
end

Instance Attribute Details

#type ⇒ Object (readonly)

The type of the attribute.



35
36
37
 
# File 'lib/decode/comment/attribute.rb', line 35

def type
  @type
end

Class Method Details

.build(directive, match) ⇒ Object 



17
18
19
20
21
22
23
24
25
 
# File 'lib/decode/comment/attribute.rb', line 17

def self.build(directive, match)
	node = self.new(directive, match[:type])
	
	if details = match[:details]
		node.add(Text.new(details))
	end
	
	return node
end