RDoc::Include

A Module include in a class with #include

Attributes

name[RW]

Name of included module

Public Class Methods

new(name, comment) click to toggle source

Creates a new Include for name with comment 

    # File lib/rdoc/include.rb, line 16
16:   def initialize(name, comment)
17:     super()
18:     @name = name
19:     self.comment = comment
20:   end

Public Instance Methods

<=>(other) click to toggle source

Includes are sorted by name 

    # File lib/rdoc/include.rb, line 25
25:   def <=> other
26:     return unless self.class === other
27: 
28:     name <=> other.name
29:   end
full_name() click to toggle source

Full name based on module 

    # File lib/rdoc/include.rb, line 39
39:   def full_name
40:     m = self.module
41:     RDoc::ClassModule === m ? m.full_name : @name
42:   end
module() click to toggle source

Attempts to locate the included module object. Returns the name if not known. 

    # File lib/rdoc/include.rb, line 56
56:   def module
57:     RDoc::TopLevel.find_module_named(@name) || @name
58:   end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.