class RDoc::Alias

表示一个别名,它是一个与特定上下文关联的 old_name/new_name 对

属性

name[R]

被别名的方法的名称

new_name[R]

被别名的方法的名称

old_name[R]

被别名的方法的名称

singleton[RW]

这是一个在单例上下文中声明的别名吗?

text[R]

源文件令牌流

公共类方法

new(text, old_name, new_name, comment, singleton = false) 点击以切换源代码

创建一个新的 Alias,其令牌流为 text,将 old_name 别名为 new_name,具有 comment,并且处于 singleton 上下文中。

调用超类方法 RDoc::CodeObject::new
# File rdoc/code_object/alias.rb, line 37
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

公共实例方法

<=>(other) 点击以切换源代码

首先按 singleton 排序,然后按 new_name 排序

# File rdoc/code_object/alias.rb, line 50
def <=>(other)
  [@singleton ? 0 : 1, new_name] <=> [other.singleton ? 0 : 1, other.new_name]
end
aref() 点击以切换源代码

此别名的 HTML 片段引用

# File rdoc/code_object/alias.rb, line 57
def aref
  type = singleton ? 'c' : 'i'
  "#alias-#{type}-#{html_name}"
end
full_old_name() 点击以切换源代码

包括命名空间的完整旧名称

# File rdoc/code_object/alias.rb, line 65
def full_old_name
  @full_name || "#{parent.name}#{pretty_old_name}"
end
html_name() 点击以切换源代码

#new_name 的 HTML ID 友好版本。

# File rdoc/code_object/alias.rb, line 72
def html_name
  CGI.escape(@new_name.gsub('-', '-2D')).gsub('%', '-').sub(/^-/, '')
end
name_prefix() 点击以切换源代码

单例方法/属性的别名为 '::',实例级别的为 '#'。

# File rdoc/code_object/alias.rb, line 87
def name_prefix
  singleton ? '::' : '#'
end
pretty_name()
别名为: pretty_new_name
pretty_new_name() 点击以切换源代码

带有前缀 '::' 或 '#' 的新名称。

# File rdoc/code_object/alias.rb, line 101
def pretty_new_name
  "#{singleton ? '::' : '#'}#{@new_name}"
end
也别名为: pretty_name
pretty_old_name() 点击以切换源代码

带有前缀 '::' 或 '#' 的旧名称。

# File rdoc/code_object/alias.rb, line 94
def pretty_old_name
  "#{singleton ? '::' : '#'}#{@old_name}"
end