Class RDoc::ClassModule
In: code_objects.rb
parsers/parse_f95.rb
doc-tmp/rdoc/code_objects.rb
Parent: Context

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

Methods

find_class_named   find_class_named   find_file_named   full_name   full_name   http_url   http_url   is_module?   is_module?   new   new   to_s   to_s  

Public Class methods

new(name, superclass = nil)

[Source]

     # File doc-tmp/rdoc/code_objects.rb, line 564
564:     def initialize(name, superclass = nil)
565:       @name       = name
566:       @diagram    = nil
567:       @superclass = superclass
568:       @comment    = ""
569:       super()
570:     end
new(name, superclass = nil)

[Source]

     # File code_objects.rb, line 564
564:     def initialize(name, superclass = nil)
565:       @name       = name
566:       @diagram    = nil
567:       @superclass = superclass
568:       @comment    = ""
569:       super()
570:     end

Public Instance methods

find_class_named(name)

[Source]

     # File doc-tmp/rdoc/code_objects.rb, line 599
599:     def find_class_named(name)
600:       return self if full_name == name
601:       @classes.each_value {|c| return c if c.find_class_named(name) }
602:       nil
603:     end
find_class_named(name)

[Source]

     # File code_objects.rb, line 599
599:     def find_class_named(name)
600:       return self if full_name == name
601:       @classes.each_value {|c| return c if c.find_class_named(name) }
602:       nil
603:     end
find_file_named(name, method=nil, ignore_case=nil)

[Source]

     # File parsers/parse_f95.rb, line 815
815:     def find_file_named(name, method=nil, ignore_case=nil)
816:       parent.find_file_named(name, method, ignore_case)
817:     end
full_name()

Return the fully qualified name of this class or module

[Source]

     # File doc-tmp/rdoc/code_objects.rb, line 573
573:     def full_name
574:       if @parent && @parent.full_name
575:         @parent.full_name + "::" + @name
576:       else
577:         @name
578:       end
579:     end
full_name()

Return the fully qualified name of this class or module

[Source]

     # File code_objects.rb, line 573
573:     def full_name
574:       if @parent && @parent.full_name
575:         @parent.full_name + "::" + @name
576:       else
577:         @name
578:       end
579:     end
http_url(prefix)

[Source]

     # File doc-tmp/rdoc/code_objects.rb, line 581
581:     def http_url(prefix)
582:       path = full_name.split("::")
583:       File.join(prefix, *path) + ".html"
584:     end
http_url(prefix)

[Source]

     # File code_objects.rb, line 581
581:     def http_url(prefix)
582:       path = full_name.split("::")
583:       File.join(prefix, *path) + ".html"
584:     end
is_module?()

Return true if this object represents a module

[Source]

     # File code_objects.rb, line 587
587:     def is_module?
588:       false
589:     end
is_module?()

Return true if this object represents a module

[Source]

     # File doc-tmp/rdoc/code_objects.rb, line 587
587:     def is_module?
588:       false
589:     end
to_s()

to_s is simply for debugging

[Source]

     # File doc-tmp/rdoc/code_objects.rb, line 592
592:     def to_s
593:       res = self.class.name + ": " + @name 
594:       res << @comment.to_s
595:       res << super
596:       res
597:     end
to_s()

to_s is simply for debugging

[Source]

     # File code_objects.rb, line 592
592:     def to_s
593:       res = self.class.name + ": " + @name 
594:       res << @comment.to_s
595:       res << super
596:       res
597:     end

[Validate]