In Files

  • rdoc/code_objects.rb

Methods

Files

Class/Module Index [+]

Quicksearch

RDoc::Alias

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

Attributes

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

Public Class Methods

new(text, old_name, new_name, comment) click to toggle 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() click to toggle source
 
               # File rdoc/code_objects.rb, line 701
def to_s
  "alias: #{self.old_name} ->  #{self.new_name}\n#{self.comment}"
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus