Class RDoc::ClassModule
In: rdoc/code_objects.rb
Parent: Context

ClassModule is the base class for objects representing either a class or a module.

Methods

Attributes

diagram  [RW] 
superclass  [R] 

Public Class methods

[Source]

# File rdoc/code_objects.rb, line 556
    def initialize(name, superclass = nil)
      @name       = name
      @diagram    = nil
      @superclass = superclass
      @comment    = ""
      super()
    end

Public Instance methods

[Source]

# File rdoc/code_objects.rb, line 591
    def find_class_named(name)
      return self if full_name == name
      @classes.each_value {|c| return c if c.find_class_named(name) }
      nil
    end

Return the fully qualified name of this class or module

[Source]

# File rdoc/code_objects.rb, line 565
    def full_name
      if @parent && @parent.full_name
        @parent.full_name + "::" + @name
      else
        @name
      end
    end

[Source]

# File rdoc/code_objects.rb, line 573
    def http_url(prefix)
      path = full_name.split("::")
      File.join(prefix, *path) + ".html"
    end

Return true if this object represents a module

[Source]

# File rdoc/code_objects.rb, line 579
    def is_module?
      false
    end

to_s is simply for debugging

[Source]

# File rdoc/code_objects.rb, line 584
    def to_s
      res = self.class.name + ": " + @name 
      res << @comment.to_s
      res << super
      res
    end

[Validate]