123456789_123456789_123456789_123456789_123456789_

Class: RDoc::Require

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, CodeObject
Instance Chain:
self, CodeObject, Generator::Markup, Text
Inherits: RDoc::CodeObject
Defined in: lib/rdoc/require.rb

Overview

A file loaded by #require

Constant Summary

Text - Included

MARKUP_FORMAT, TO_HTML_CHARACTERS

Class Method Summary

CodeObject - Inherited

.new

Creates a new CodeObject that will document itself and its children.

Instance Attribute Summary

  • #name rw

    Name of the required file.

CodeObject - Inherited

#comment

Our comment.
#comment=

Replaces our comment with comment, unless it is empty.
#display?

Should this CodeObject be displayed in output?
#document_children

Do we document our children?
#document_children=

Enables or disables documentation of this CodeObject’s children unless it has been turned off by :enddoc:
#document_self

Do we document ourselves?
#document_self=

Enables or disables documentation of this CodeObject unless it has been turned off by :enddoc:.
#documented?

Does this object have a comment with content or is #received_nodoc true?
#done_documenting

Are we done documenting (ie, did we come across a :enddoc:)?
#done_documenting=

Turns documentation on/off, and turns on/off #document_self and #document_children.
#file

Which file this code object was defined in.
#force_documentation

Force documentation of this CodeObject.
#force_documentation=

Force the documentation of this object unless documentation has been turned off by :enddoc:
#full_name=

Sets the full_name overriding any computed full name.
#ignored?

Has this class been ignored?
#line

Line in #file where this CodeObject was defined.
#metadata

Hash of arbitrary metadata for this CodeObject.
#parent

Our parent CodeObject.
#parent=

Sets the parent CodeObject.
#received_nodoc

Did we ever receive a :nodoc: directive?
#section

The section this CodeObject is in.
#section=

Set the section this CodeObject is in.
#store

The Store for this object.
#store=

Sets the store that contains this CodeObject.
#suppressed?

Has this class been suppressed?
#viewer

We are the model of the code, but we know that at some point we will be worked on by viewers.

Text - Included

#language

Instance Method Summary

CodeObject - Inherited

#each_parent

Yields each parent of this CodeObject.
#file_name

File name where this CodeObject was found.
#ignore

Use this to ignore a CodeObject and all its children until found again (#record_location is called).
#options

The options instance from the store this CodeObject is attached to, or a default options instance if the CodeObject is not attached.
#parent_file_name

File name of our parent.
#parent_name

Name of our parent.
#record_location

Records the TopLevel (file) where this code object was defined.
#start_doc

Enable capture of documentation unless documentation has been turned off by :enddoc:
#stop_doc

Disable capture of documentation.
#suppress

Use this to suppress a CodeObject and all its children until the next file it is seen in or documentation is discovered.
#initialize_visibility

Initializes state for visibility of this CodeObject and its children.

Generator::Markup - Included

#aref_to

Generates a relative URL from this object’s path to target_path
#as_href

Generates a relative URL from from_path to this object’s path.
#cvs_url

Build a webcvs URL starting for the given url with full_path appended as the destination path.
#description

Handy wrapper for marking up this object’s comment.
#formatter

Creates an Markup::ToHtmlCrossref formatter.

Text - Included

#expand_tabs

Expands tab characters in text to eight spaces.
#flush_left

Flush text left based on the shortest line.
#markup

Convert a string in markup format into HTML.
#normalize_comment

Strips hashes, expands tabs then flushes text to the left.
#parse

Normalizes text then builds a Markup::Document from it.
#snippet

The first limit characters of text as HTML.
#strip_hashes

Strips leading # characters from text
#strip_newlines

Strips leading and trailing n characters from text
#strip_stars

Strips /* */ style comments.
#to_html

Converts ampersand, dashes, ellipsis, quotes, copyright and registered trademark symbols in text to properly encoded characters.
#wrap

Wraps txt to line_len

Constructor Details

.new(name, comment) ⇒ Require

Creates a new Require that loads #name with comment

[ GitHub ] 

  


# File 'lib/rdoc/require.rb', line 15



def initialize(name, comment)
  super()
  @name = name.gsub(/'|"/, "") #'
  @top_level = nil
  self.comment = comment
end


  







Instance Attribute Details



  

    #name   (rw)
  



  

    

Name of the required file


  



  [ GitHub ]


  

  


# File 'lib/rdoc/require.rb', line 10



attr_accessor :name


  







Instance Method Details



  

    #inspect  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rdoc/require.rb', line 22



def inspect # :nodoc:
  "#<%s:0x%x require '%s' in %s>" % [
    self.class,
    object_id,
    @name,
    parent_file_name,
  ]
end


  








  

    #to_s  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rdoc/require.rb', line 31



def to_s # :nodoc:
  "require #{name} in: #{parent}"
end


  








  

    #top_level  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/rdoc/require.rb', line 38



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