RDoc::AnyMethod

AnyMethod is the base class for objects representing methods

Attributes

aliases[R]

block_params[RW]

call_seq[RW]

dont_rename_initialize[RW]

is_alias_for[RW]

name[RW]

singleton[RW]

visibility[RW]

Public Class Methods

new(text, name) click to toggle source

 
               # File rdoc/code_objects.rb, line 636
def initialize(text, name)
  super()
  @text = text
  @name = name
  @token_stream  = nil
  @visibility    = :public
  @dont_rename_initialize = false
  @block_params  = nil
  @aliases       = []
  @is_alias_for  = nil
  @comment = ""
  @call_seq = nil
end

Public Instance Methods

<=>(other) click to toggle source

 
               # File rdoc/code_objects.rb, line 650
def <=>(other)
  @name <=> other.name
end

add_alias(method) click to toggle source

 
               # File rdoc/code_objects.rb, line 682
def add_alias(method)
  @aliases << method
end

param_seq() click to toggle source

 
               # File rdoc/code_objects.rb, line 660
    def param_seq
      p = params.gsub(/\s*\#.*/, '')
      p = p.tr("\n", " ").squeeze(" ")
      p = "(" + p + ")" unless p[0] == (

      if (block = block_params)
        # If this method has explicit block parameters, remove any
        # explicit &block
$stderr.puts p
        p.sub!(/,?\s*&\w+/)
$stderr.puts p

        block.gsub!(/\s*\#.*/, '')
        block = block.tr("\n", " ").squeeze(" ")
        if block[0] == (
          block.sub!(/^\(/, '').sub!(/\)/, '')
        end
        p << " {|#{block}| ...}"
      end
      p
    end

to_s() click to toggle source

 
               # File rdoc/code_objects.rb, line 654
def to_s
  res = self.class.name + ": " + @name + " (" + @text + ")\n"
  res << @comment.to_s
  res
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 see Improve the docs, or visit Documenting-ruby.org.

Home Classes Methods

In Files

Parent

Methods

Included Modules

Files

Class/Module Index

RDoc::AnyMethod

Attributes

Public Class Methods

Public Instance Methods