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 666
666:     def initialize(name, superclass = nil)
667:       @name       = name
668:       @diagram    = nil
669:       @superclass = superclass
670:       @comment    = ""
671:       super()
672:     end

Public Instance methods

[Source]

     # File code_objects.rb, line 701
701:     def find_class_named(name)
702:       return self if full_name == name
703:       @classes.each_value {|c| return c if c.find_class_named(name) }
704:       nil
705:     end

[Source]

     # File code_objects.rb, line 707
707:     def find_file_named(name, method=nil, ignore_case=nil)
708:       parent.find_file_named(name, method, ignore_case)
709:     end

Return the fully qualified name of this class or module

[Source]

     # File code_objects.rb, line 675
675:     def full_name
676:       if @parent && @parent.full_name
677:         @parent.full_name + "::" + @name
678:       else
679:         @name
680:       end
681:     end

[Source]

     # File code_objects.rb, line 683
683:     def http_url(prefix)
684:       path = full_name.split("::")
685:       File.join(prefix, *path) + ".html"
686:     end

Return true if this object represents a module

[Source]

     # File code_objects.rb, line 689
689:     def is_module?
690:       false
691:     end

to_s is simply for debugging

[Source]

     # File code_objects.rb, line 694
694:     def to_s
695:       res = self.class.name + ": " + @name 
696:       res << @comment.to_s
697:       res << super
698:       res
699:     end

[Validate]