class Origen::Specs::Note

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

Attributes

audience[RW]

Audience should be :ac or :dc, but this might have been phased out.

TODO:  Check to see if :type has been deprecated or is still needed
id[RW]

id is the id for the note. The goal for the id is to allow multiple specs to reference one note. spec.notes = [id1, id2, id3] spec1.notes = [id1, id4, id5]

internal_comment[RW]

Internal comment that could be used to know why the note was needed. Think of this as a breadcrumb to find out about more information on the note.

markup[RW]

Markup of the text field. Currently markup has been tested with

  • DITA

  • XML

  • HTML

Need to test the following markup

  • Markdown

mode[RW]

Mode will match the mode that this note belongs to.

TODO:  Check to see if :mode has been deprecated or is still needed
number[RW]

Note Number. Optional. If not set, then DITA will make the number

text[RW]

Plain text of the note. No Mark-up allowed in this field.

type[RW]

Type should be :ac or :dc, but this might have been phased out.

TODO:  Check to see if :type has been deprecated or is still needed

Public Class Methods

new(id, type, options = {}) click to toggle source

Initialize the class

# File lib/origen/specs/note.rb, line 44
def initialize(id, type, options = {})
  @id = id
  @type = type
  @mode = options[:mode]
  @audience = options[:audience]
  @text = options[:text]
  @markup = options[:markup]
  @internal_comment = options[:internal_comment]
  @number = options[:number]
end