RDoc::Attr

An attribute created by #attr, #attr_reader, #attr_writer or #attr_accessor

Attributes

name[RW]

Name of the attribute

rw[RW]

Is the attribute readable, writable or both?

text[RW]

Source file token stream

visibility[RW]

public, protected, private

Public Class Methods

new(text, name, rw, comment) click to toggle source

(Not documented)

# File lib/rdoc/attr.rb, line 29
  def initialize(text, name, rw, comment)
    super()
    @text = text
    @name = name
    @rw = rw
    @visibility = :public
    self.comment = comment
  end

Public Instance Methods

<=>(other) click to toggle source

Attributes are ordered by name

# File lib/rdoc/attr.rb, line 41
  def <=>(other)
    self.name <=> other.name
  end

html_name() click to toggle source

An HTML id-friendly representation of name

# File lib/rdoc/attr.rb, line 48
  def html_name
    @name.gsub(/[^a-z]+/, '-')
  end

path() click to toggle source

URL path for this attribute

# File lib/rdoc/attr.rb, line 70
  def path
    "#{@parent.path}##{@name}"
  end

In Files

Parent

Methods

Included Modules

Files

Class Index

RDoc::Attr

Attributes

Public Class Methods

Public Instance Methods