Extended maintenance of Ruby 1.9.3 ended on February 23, 2015. Read more
A Module include in a class with #include
Creates a new Include for name
with
comment
# File rdoc/include.rb, line 16 def initialize(name, comment) super() @name = name self.comment = comment @module = nil # cache for module if found end
Includes are sorted by name
# File rdoc/include.rb, line 26 def <=> other return unless self.class === other name <=> other.name end
Full name based on module
# File rdoc/include.rb, line 40 def full_name m = self.module RDoc::ClassModule === m ? m.full_name : @name end
Attempts to locate the included module object. Returns the name if not known.
The scoping rules of Ruby to resolve the name of an included module are:
first look into the children of the current context;
if not found, look into the children of included modules, in reverse inclusion order;
if still not found, go up the hierarchy of names.
# File rdoc/include.rb, line 63 def module return @module if @module # search the current context return @name unless parent full_name = parent.child_name(@name) @module = RDoc::TopLevel.modules_hash[full_name] return @module if @module return @name if @name =~ /^::/ # search the includes before this one, in reverse order searched = parent.includes.take_while { |i| i != self }.reverse searched.each do |i| inc = i.module next if String === inc full_name = inc.child_name(@name) @module = RDoc::TopLevel.modules_hash[full_name] return @module if @module end # go up the hierarchy of names p = parent.parent while p full_name = p.child_name(@name) @module = RDoc::TopLevel.modules_hash[full_name] return @module if @module p = p.parent end @name end
Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.
If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.
If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.
If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.