123456789_123456789_123456789_123456789_123456789_

Class: RDoc::Markup::Special

Relationships & Source Files
Inherits: Object
Defined in: lib/rdoc/markup/special.rb

Overview

Hold details of a special sequence

Class Method Summary

Instance Attribute Summary

Instance Method Summary

  • #==(o)

    Specials are equal when the have the same text and type.

  • #inspect Internal use only
  • #to_s Internal use only

Constructor Details

.new(type, text) ⇒ Special

Creates a new special sequence of #type with #text

[ GitHub ] 

  


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



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


  







Instance Attribute Details



  

    #text   (rw)
  



  

    

Special text


  



  [ GitHub ]


  

  


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



attr_accessor :text


  








  

    #type   (readonly)
  



  

    

Special type


  



  [ GitHub ]


  

  


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



attr_reader   :type


  







Instance Method Details



  

    #==(o)  
  



  

    

Specials are equal when the have the same text and type


  



  [ GitHub ]


  

  


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



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


  








  

    #inspect  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# 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  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



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