Class RDoc::ClassModule
In: 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 code_objects.rb, line 662
662:     def initialize(name, superclass = nil)
663:       @name       = name
664:       @diagram    = nil
665:       @superclass = superclass
666:       @comment    = ""
667:       super()
668:     end

Public Instance methods

[Source]

     # File code_objects.rb, line 697
697:     def find_class_named(name)
698:       return self if full_name == name
699:       @classes.each_value {|c| return c if c.find_class_named(name) }
700:       nil
701:     end

[Source]

     # File code_objects.rb, line 703
703:     def find_file_named(name, method=nil, ignore_case=nil)
704:       parent.find_file_named(name, method, ignore_case)
705:     end

Return the fully qualified name of this class or module

[Source]

     # File code_objects.rb, line 671
671:     def full_name
672:       if @parent && @parent.full_name
673:         @parent.full_name + "::" + @name
674:       else
675:         @name
676:       end
677:     end

[Source]

     # File code_objects.rb, line 679
679:     def http_url(prefix)
680:       path = full_name.split("::")
681:       File.join(prefix, *path) + ".html"
682:     end

Return true if this object represents a module

[Source]

     # File code_objects.rb, line 685
685:     def is_module?
686:       false
687:     end

to_s is simply for debugging

[Source]

     # File code_objects.rb, line 690
690:     def to_s
691:       res = self.class.name + ": " + @name 
692:       res << @comment.to_s
693:       res << super
694:       res
695:     end

[Validate]