RDoc::Require

A file loaded by #require

Attributes

name[RW]

Name of the required file

Public Class Methods

new(name, comment) click to toggle source

Creates a new Require that loads name with comment

 
               # File rdoc/require.rb, line 16
def initialize(name, comment)
  super()
  @name = name.gsub(/'|"/, "") #'
  @top_level = nil
  self.comment = comment
end

Public Instance Methods

top_level() click to toggle source

The RDoc::TopLevel corresponding to this require, or nil if not found.

 
               # File rdoc/require.rb, line 39
def top_level
  @top_level ||= begin
    tl = RDoc::TopLevel.all_files_hash[name + '.rb']

    if tl.nil? and RDoc::TopLevel.all_files.first.full_name =~ %r(^lib/) then
      # second chance
      tl = RDoc::TopLevel.all_files_hash['lib/' + name + '.rb']
    end

    tl
  end
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.

Home Classes Methods

In Files

Parent

Methods

Class/Module Index

RDoc::Require

Attributes

Public Class Methods

Public Instance Methods