Class RDoc::Alias
In: rdoc/code_objects.rb
Parent: CodeObject

Represent an alias, which is an old_name/ new_name pair associated with a particular context

Methods

new   to_s  

Attributes

comment  [RW] 
new_name  [RW] 
old_name  [RW] 
text  [RW] 

Public Class methods

new(text, old_name, new_name, comment)

[Source]

# File rdoc/code_objects.rb, line 693
    def initialize(text, old_name, new_name, comment)
      super()
      @text = text
      @old_name = old_name
      @new_name = new_name
      self.comment = comment
    end

Public Instance methods

to_s()

[Source]

# File rdoc/code_objects.rb, line 701
    def to_s
      "alias: #{self.old_name} ->  #{self.new_name}\n#{self.comment}"
    end

[Validate]

ruby-doc.org is hosted and run by James Britt and Happy Camper Studios, a Ruby application development company in Phoenix, Arizona. Ruby-doc.org was created in 2002 to promote the Ruby language and to help other Ruby hackers.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.