Class: Origen::Specs::Note

Inherits:
Object show all
Defined in:
lib/origen/specs/note.rb

Overview

This class is used to store spec note information used to document IP

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, type, options = {}) ⇒ Note

Returns a new instance of Note.



7
8
9
10
11
12
13
14
 
# File 'lib/origen/specs/note.rb', line 7

def initialize(id, type, options = {})
  @id = id
  @type = type
  @mode = options[:mode]
  @audience = options[:audience]
  @text = options[:text]
  @markup = options[:markup]
end

Instance Attribute Details

#audience ⇒ Object

Returns the value of attribute audience.



5
6
7
 
# File 'lib/origen/specs/note.rb', line 5

def audience
  @audience
end

#id ⇒ Object

Returns the value of attribute id.



5
6
7
 
# File 'lib/origen/specs/note.rb', line 5

def id
  @id
end

#markup ⇒ Object

Returns the value of attribute markup.



5
6
7
 
# File 'lib/origen/specs/note.rb', line 5

def markup
  @markup
end

#mode ⇒ Object

Returns the value of attribute mode.



5
6
7
 
# File 'lib/origen/specs/note.rb', line 5

def mode
  @mode
end

#text ⇒ Object

Returns the value of attribute text.



5
6
7
 
# File 'lib/origen/specs/note.rb', line 5

def text
  @text
end

#type ⇒ Object

Returns the value of attribute type.



5
6
7
 
# File 'lib/origen/specs/note.rb', line 5

def type
  @type
end