Class: RDoc::Markup::Special

Inherits:
Object
  • Object
show all
Defined in:
lib/rdoc/markup/special.rb

Overview

frozen_string_literal: false

Hold details of a special sequence

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type, text) ⇒ Special

Creates a new special sequence of type with text



20
21
22
 
# File 'lib/rdoc/markup/special.rb', line 20

def initialize(type, text)
  @type, @text = type, text
end

Instance Attribute Details

#text ⇒ Object

Special text



15
16
17
 
# File 'lib/rdoc/markup/special.rb', line 15

def text
  @text
end

#type ⇒ Object (readonly)

Special type



10
11
12
 
# File 'lib/rdoc/markup/special.rb', line 10

def type
  @type
end

Instance Method Details

#==(o) ⇒ Object

Specials are equal when the have the same text and type



27
28
29
 
# File 'lib/rdoc/markup/special.rb', line 27

def ==(o)
  self.text == o.text && self.type == o.type
end

#inspect ⇒ Object

:nodoc:



31
32
33
34
 
# File 'lib/rdoc/markup/special.rb', line 31

def inspect # :nodoc:
  "#<RDoc::Markup::Special:0x%x @type=%p, @text=%p>" % [
    object_id, @type, text.dump]
end

#to_s ⇒ Object

:nodoc:



36
37
38
 
# File 'lib/rdoc/markup/special.rb', line 36

def to_s # :nodoc:
  "Special: type=#{type} text=#{text.dump}"
end