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

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

Methods

find_class_named   full_name   http_url   is_module?   new   to_s  

Attributes

diagram  [RW] 
superclass  [R] 

Public Class methods

new(name, superclass = nil)

[Source]

     # File lib/rdoc/code_objects.rb, line 556
556:     def initialize(name, superclass = nil)
557:       @name       = name
558:       @diagram    = nil
559:       @superclass = superclass
560:       @comment    = ""
561:       super()
562:     end

Public Instance methods

find_class_named(name)

[Source]

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

Return the fully qualified name of this class or module

[Source]

     # File lib/rdoc/code_objects.rb, line 565
565:     def full_name
566:       if @parent && @parent.full_name
567:         @parent.full_name + "::" + @name
568:       else
569:         @name
570:       end
571:     end
http_url(prefix)

[Source]

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

Return true if this object represents a module

[Source]

     # File lib/rdoc/code_objects.rb, line 579
579:     def is_module?
580:       false
581:     end
to_s()

to_s is simply for debugging

[Source]

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

[Validate]