Class: CTioga2::Commands::Documentation::MarkedUpText::MarkupLink

Inherits:
MarkupItem
  • Object
show all
Defined in:
lib/ctioga2/commands/doc/markup.rb

Overview

A link to a type/group/command

Instance Attribute Summary collapse

Attributes inherited from MarkupItem

#doc

Instance Method Summary collapse

Constructor Details

#initialize(doc, target, type) ⇒ MarkupLink

target is the name of the target, which can be of type ‘group’, ‘command’ and ‘type’.



108
109
110
111
 
# File 'lib/ctioga2/commands/doc/markup.rb', line 108

def initialize(doc, target, type)
  super(doc)
  @target = doc.send("#{type}s")[target]
end

Instance Attribute Details

#target ⇒ Object

The object target of the link



104
105
106
 
# File 'lib/ctioga2/commands/doc/markup.rb', line 104

def target
  @target
end

Instance Method Details

#dump_string ⇒ Object 



121
122
123
 
# File 'lib/ctioga2/commands/doc/markup.rb', line 121

def dump_string
  return "link: #{@target}"
end

#to_s ⇒ Object 



113
114
115
116
117
118
119
 
# File 'lib/ctioga2/commands/doc/markup.rb', line 113

def to_s
  if @target
    return @target.name
  else
    return "unknown"
  end
end