Class: RDoc::Attr

### Home Classes Methods

### In Files

- lib/rdoc/attr.rb

### Parent

RDoc::MethodAttr

### Methods

- ::new
- #==
- #add_alias
- #aref_prefix
- #definition
- #marshal_dump
- #marshal_load

### Files

- CONTRIBUTING.rdoc
- CVE-2013-0256.rdoc
- ExampleRDoc.rdoc
- LICENSE.rdoc
- Manifest.txt
- README.rdoc
- RI.rdoc
- Rakefile
- TODO.rdoc

### Class/Module Index

Quicksearch

- RDoc
- RDoc::Alias
- RDoc::AnonClass
- RDoc::AnyMethod
- RDoc::Attr
- RDoc::ClassModule
- RDoc::CodeObject
- RDoc::Comment
- RDoc::Constant
- RDoc::Context
- RDoc::Context::Section
- RDoc::CrossReference
- RDoc::ERBIO
- RDoc::ERBPartial
- RDoc::Encoding
- RDoc::Error
- RDoc::Extend
- RDoc::Gauntlet
- RDoc::Generator
- RDoc::Generator::Darkfish
- RDoc::Generator::JsonIndex
- RDoc::Generator::Markup
- RDoc::Generator::POT
- RDoc::Generator::RI
- RDoc::GhostMethod
- RDoc::Include
- RDoc::Markdown
- RDoc::Markdown::Literals
- RDoc::Markup
- RDoc::Markup::AttrChanger
- RDoc::Markup::AttrSpan
- RDoc::Markup::AttributeManager
- RDoc::Markup::Attributes
- RDoc::Markup::BlankLine
- RDoc::Markup::BlockQuote
- RDoc::Markup::Document
- RDoc::Markup::Formatter
- RDoc::Markup::FormatterTestCase
- RDoc::Markup::HardBreak
- RDoc::Markup::Include
- RDoc::Markup::IndentedParagraph
- RDoc::Markup::List
- RDoc::Markup::ListItem
- RDoc::Markup::Paragraph
- RDoc::Markup::Parser
- RDoc::Markup::Parser::Error
- RDoc::Markup::Parser::ParseError
- RDoc::Markup::PreProcess
- RDoc::Markup::Raw
- RDoc::Markup::Rule
- RDoc::Markup::Special
- RDoc::Markup::TextFormatterTestCase
- RDoc::Markup::ToAnsi
- RDoc::Markup::ToBs
- RDoc::Markup::ToHtml
- RDoc::Markup::ToHtmlCrossref
- RDoc::Markup::ToHtmlSnippet
- RDoc::Markup::ToJoinedParagraph
- RDoc::Markup::ToLabel
- RDoc::Markup::ToMarkdown
- RDoc::Markup::ToRdoc
- RDoc::Markup::ToTableOfContents
- RDoc::Markup::ToTest
- RDoc::Markup::ToTtOnly
- RDoc::Markup::Verbatim
- RDoc::MetaMethod
- RDoc::MethodAttr
- RDoc::Mixin
- RDoc::NormalClass
- RDoc::NormalModule
- RDoc::Options
- RDoc::Parser
- RDoc::Parser::C
- RDoc::Parser::ChangeLog
- RDoc::Parser::Markdown
- RDoc::Parser::RD
- RDoc::Parser::Ruby
- RDoc::Parser::RubyTools
- RDoc::Parser::Simple
- RDoc::Parser::Text
- RDoc::RD
- RDoc::RD::BlockParser
- RDoc::RD::Inline
- RDoc::RD::InlineParser
- RDoc::RDoc
- RDoc::RI
- RDoc::RI::Driver
- RDoc::RI::Driver::Error
- RDoc::RI::Driver::NotFoundError
- RDoc::RI::Error
- RDoc::RI::Paths
- RDoc::Require
- RDoc::RubyLex
- RDoc::RubyLex::Error
- RDoc::RubyToken
- RDoc::RubygemsHook
- RDoc::Servlet
- RDoc::SingleClass
- RDoc::Stats
- RDoc::Stats::Normal
- RDoc::Stats::Quiet
- RDoc::Stats::Verbose
- RDoc::Store
- RDoc::Store::Error
- RDoc::Store::MissingFileError
- RDoc::Task
- RDoc::Task
- RDoc::TestCase
- RDoc::TokenStream
- RDoc::TomDoc
- RDoc::TopLevel
- Object

No matching classes.

# RDoc::Attr

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

### Attributes

rw[RW]

Is the attribute readable ('R'), writable ('W') or both ('RW')?

### Public Class Methods

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

Creates a new Attr with body `text`, `name`, read/write status `rw` and `comment`. `singleton` marks this as a class attribute.

    # File lib/rdoc/attr.rb, line 24
    def initialize(text, name, rw, comment, singleton = false)
      super text, name

      @rw = rw
      @singleton = singleton
      self.comment = comment
    end

### Public Instance Methods

==(other) click to toggle source

Attributes are equal when their names, singleton and rw are identical

    # File lib/rdoc/attr.rb, line 35
    def == other
      self.class == other.class and
        self.name == other.name and
        self.rw == other.rw and
        self.singleton == other.singleton
    end

add_alias(an_alias, context) click to toggle source

Add `an_alias` as an attribute in `context`.

    # File lib/rdoc/attr.rb, line 45
    def add_alias(an_alias, context)
      new_attr = self.class.new(self.text, an_alias.new_name, self.rw,
                                self.comment, self.singleton)

      new_attr.record_location an_alias.file
      new_attr.visibility = self.visibility
      new_attr.is_alias_for = self
      @aliases << new_attr
      context.add_attribute new_attr
      new_attr
    end

aref_prefix() click to toggle source

The aref prefix for attributes

    # File lib/rdoc/attr.rb, line 60
    def aref_prefix
      'attribute'
    end

definition() click to toggle source

Returns attr_reader, attr_writer or attr_accessor as appropriate.

    # File lib/rdoc/attr.rb, line 77
    def definition
      case @rw
      when 'RW' then 'attr_accessor'
      when 'R'  then 'attr_reader'
      when 'W'  then 'attr_writer'
      end
    end

marshal_dump() click to toggle source

Dumps this Attr for use by ri. See also marshal_load

    # File lib/rdoc/attr.rb, line 101
    def marshal_dump
      [ MARSHAL_VERSION,
        @name,
        full_name,
        @rw,
        @visibility,
        parse(@comment),
        singleton,
        @file.relative_name,
        @parent.full_name,
        @parent.class,
        @section.title
      ]
    end

marshal_load(array) click to toggle source

Loads this Attr from `array`. For a loaded Attr the following methods will return cached values:

- full_name

- parent_name

    # File lib/rdoc/attr.rb, line 123
    def marshal_load array
      initialize_visibility

      @aliases      = []
      @parent       = nil
      @parent_name  = nil
      @parent_class = nil
      @section      = nil
      @file         = nil

      version        = array[0]
      @name          = array[1]
      @full_name     = array[2]
      @rw            = array[3]
      @visibility    = array[4]
      @comment       = array[5]
      @singleton     = array[6] || false # MARSHAL_VERSION == 0
      #                      7 handled below
      @parent_name   = array[8]
      @parent_class  = array[9]
      @section_title = array[10]

      @file = RDoc::TopLevel.new array[7] if version > 1

      @parent_name ||= @full_name.split('#', 2).first
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.