class RDoc::Alias
Represent an alias, which is an old_name/new_name pair associated with a particular context
Attributes
name[R]
Aliased method's name
new_name[R]
Aliased method's name
old_name[R]
Aliasee method's name
singleton[RW]
Is this an alias declared in a singleton context?
text[R]
Source file token stream
Public Class Methods
new(text, old_name, new_name, comment, singleton = false)
click to toggle source
Creates a new Alias with a token stream of
text
that aliases old_name
to
new_name
, has comment
and is a
singleton
context.
Calls superclass method
RDoc::CodeObject.new
# File lib/rdoc/alias.rb, line 36 def initialize(text, old_name, new_name, comment, singleton = false) super() @text = text @singleton = singleton @old_name = old_name @new_name = new_name self.comment = comment end
Public Instance Methods
<=>(other)
click to toggle source
aref()
click to toggle source
HTML fragment reference for this alias
# File lib/rdoc/alias.rb, line 56 def aref type = singleton ? 'c' : 'i' "#alias-#{type}-#{html_name}" end
full_old_name()
click to toggle source
Full old name including namespace
# File lib/rdoc/alias.rb, line 64 def full_old_name @full_name || "#{parent.name}#{pretty_old_name}" end
html_name()
click to toggle source
HTML id-friendly version of #new_name
.
# File lib/rdoc/alias.rb, line 71 def html_name CGI.escape(@new_name.gsub('-', '-2D')).gsub('%','-').sub(/^-/, '') end
name_prefix()
click to toggle source
'::' for the alias of a singleton method/attribute, '#' for instance-level.
# File lib/rdoc/alias.rb, line 86 def name_prefix singleton ? '::' : '#' end
pretty_new_name()
click to toggle source
New name with prefix '::' or '#'.
# File lib/rdoc/alias.rb, line 100 def pretty_new_name "#{singleton ? '::' : '#'}#{@new_name}" end
Also aliased as: pretty_name
pretty_old_name()
click to toggle source
Old name with prefix '::' or '#'.
# File lib/rdoc/alias.rb, line 93 def pretty_old_name "#{singleton ? '::' : '#'}#{@old_name}" end