class Origen::Specs::Exhibit
This class is used to store spec exhibit information used to document IP
Attributes
Block ID that this exhibit is being used in.
Description for the Exhibit
Description Override
. This allows for the SoC to use a different description
ID for the exhibit. This allows the exhibit to reference easier
Do we include the exhibit in this block
Markup needed for the exhibit
Reference link
Reference Override
. This allows for the SoC to use a different figure (e.g. Power Supplies are different)
Title for the Exhibit
.
Title Override
. Allows for the SoC to override the title so that it makes more sense
Type of exhibit. Currently only :fig is supported. In the future, this could be :topic or :table or anything else
Public Class Methods
Source
# File lib/origen/specs/exhibit.rb, line 38 def initialize(id, type, overrides, options = {}) @id = id @type = type @title = options[:title] @description = options[:description] @reference = options[:reference] @title_override = overrides[:title] @reference_override = overrides[:reference] @description_override = overrides[:description] @markup = options[:markup] @include_exhibit = true @include_exhibit = options[:include_exhibit] unless options[:include_exhibit].nil? @block_id = options[:block_id] end