In Files

  • rdoc/code_objects.rb

Files

Class/Module Index [+]

Quicksearch

RDoc::Attr

Represent attributes

Attributes

name[RW]
rw[RW]
text[RW]
visibility[RW]

Public Class Methods

new(text, name, rw, comment) click to toggle source
 
               # File rdoc/code_objects.rb, line 980
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
 
               # File rdoc/code_objects.rb, line 989
def <=>(other)
  self.name <=> other.name
end
            
inspect() click to toggle source
 
               # File rdoc/code_objects.rb, line 993
def inspect
  attr = case rw
         when 'RW' then :attr_accessor
         when 'R'  then :attr_reader
         when 'W'  then :attr_writer
         else
           " (#{rw})"
         end

  "#<%s:0x%x %s.%s :%s>" % [
    self.class, object_id,
    parent_name, attr, @name,
  ]
end
            
to_s() click to toggle source
 
               # File rdoc/code_objects.rb, line 1008
def to_s
  "attr: #{self.name} #{self.rw}\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