Gecko [ www.corporacionhdm.com.pe ]

Name	Size	Permission	Date
context	[ DIR ]	drwxr-xr-x	2024-03-03 22:43
generator	[ DIR ]	drwxr-xr-x	2024-03-03 22:43
markdown	[ DIR ]	drwxr-xr-x	2024-03-03 22:43
markup	[ DIR ]	drwxr-xr-x	2024-03-03 22:43
parser	[ DIR ]	drwxr-xr-x	2024-03-03 22:43
rd	[ DIR ]	drwxr-xr-x	2024-03-03 22:43
ri	[ DIR ]	drwxr-xr-x	2024-03-03 22:43
stats	[ DIR ]	drwxr-xr-x	2024-03-03 22:43
alias.rb	2.09 KB	-rw-r--r--	2012-11-27 04:28
anon_class.rb	142 B	-rw-r--r--	2012-11-27 04:28
any_method.rb	5.9 KB	-rw-r--r--	2013-01-23 01:02
attr.rb	3.73 KB	-rw-r--r--	2013-01-23 01:02
class_module.rb	19.15 KB	-rw-r--r--	2013-01-23 01:02
code_object.rb	7.71 KB	-rw-r--r--	2013-01-23 01:02
code_objects.rb	121 B	-rw-r--r--	2012-11-27 04:28
comment.rb	5.39 KB	-rw-r--r--	2012-11-27 08:54
constant.rb	3.34 KB	-rw-r--r--	2012-11-27 08:54
context.rb	28.26 KB	-rw-r--r--	2012-12-06 06:20
cross_reference.rb	5.81 KB	-rw-r--r--	2013-01-04 06:16
encoding.rb	2.74 KB	-rw-r--r--	2012-12-18 08:24
erb_partial.rb	370 B	-rw-r--r--	2012-11-27 04:28
erbio.rb	794 B	-rw-r--r--	2011-05-15 11:55
extend.rb	2.53 KB	-rw-r--r--	2012-11-27 04:28
generator.rb	1.72 KB	-rw-r--r--	2012-11-27 04:28
ghost_method.rb	114 B	-rw-r--r--	2012-11-27 04:28
include.rb	2.61 KB	-rw-r--r--	2012-11-27 04:28
known_classes.rb	2.58 KB	-rw-r--r--	2011-06-29 21:17
markdown.rb	380.09 KB	-rw-r--r--	2012-12-01 03:58
markup.rb	28.31 KB	-rw-r--r--	2012-11-27 04:28
meta_method.rb	99 B	-rw-r--r--	2012-11-27 04:28
method_attr.rb	8.57 KB	-rw-r--r--	2012-11-27 04:28
normal_class.rb	2.06 KB	-rw-r--r--	2012-11-27 04:28
normal_module.rb	1.36 KB	-rw-r--r--	2012-11-27 04:28
options.rb	28.49 KB	-rw-r--r--	2012-12-11 07:44
parser.rb	7.83 KB	-rw-r--r--	2013-01-04 06:16
rd.rb	3.54 KB	-rw-r--r--	2012-11-27 04:28
rdoc.rb	13.25 KB	-rw-r--r--	2012-12-13 07:58
require.rb	935 B	-rw-r--r--	2012-11-27 04:28
ri.rb	315 B	-rw-r--r--	2012-11-27 04:28
ruby_lex.rb	27.23 KB	-rw-r--r--	2012-12-18 07:31
ruby_token.rb	11.21 KB	-rw-r--r--	2012-12-18 07:31
rubygems_hook.rb	4.91 KB	-rw-r--r--	2012-12-14 05:16
servlet.rb	10.83 KB	-rw-r--r--	2013-02-05 08:24
single_class.rb	330 B	-rw-r--r--	2012-11-27 04:28
stats.rb	9.78 KB	-rw-r--r--	2012-11-27 04:28
store.rb	22.32 KB	-rw-r--r--	2013-01-25 00:15
task.rb	7.66 KB	-rw-r--r--	2012-11-27 04:28
test_case.rb	3.46 KB	-rw-r--r--	2012-11-29 23:34
text.rb	7.59 KB	-rw-r--r--	2015-01-30 07:13
token_stream.rb	2.46 KB	-rw-r--r--	2012-11-27 04:28
tom_doc.rb	5.7 KB	-rw-r--r--	2013-01-04 06:16
top_level.rb	5.4 KB	-rw-r--r--	2013-01-23 01:02

Rename

##
# Base class for the RDoc code tree.
#
# We contain the common stuff for contexts (which are containers) and other
# elements (methods, attributes and so on)
#
# Here's the tree of the CodeObject subclasses:
#
# * RDoc::Context
#   * RDoc::TopLevel
#   * RDoc::ClassModule
#     * RDoc::AnonClass (never used so far)
#     * RDoc::NormalClass
#     * RDoc::NormalModule
#     * RDoc::SingleClass
# * RDoc::MethodAttr
#   * RDoc::Attr
#   * RDoc::AnyMethod
#     * RDoc::GhostMethod
#     * RDoc::MetaMethod
# * RDoc::Alias
# * RDoc::Constant
# * RDoc::Require
# * RDoc::Include

class RDoc::CodeObject

include RDoc::Text

##
  # Our comment

attr_reader :comment

##
  # Do we document our children?

attr_reader :document_children

##
  # Do we document ourselves?

attr_reader :document_self

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

attr_reader :done_documenting

##
  # Which file this code object was defined in

attr_reader :file

##
  # Force documentation of this CodeObject

attr_reader :force_documentation

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

attr_accessor :line

##
  # Hash of arbitrary metadata for this CodeObject

attr_reader :metadata

##
  # Offset in #file where this CodeObject was defined
  #--
  # TODO character or byte?

attr_accessor :offset

##
  # Sets the parent CodeObject

attr_writer :parent

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

attr_reader :received_nodoc

##
  # Set the section this CodeObject is in

attr_writer :section

##
  # The RDoc::Store for this object.

attr_accessor :store

##
  # We are the model of the code, but we know that at some point we will be
  # worked on by viewers. By implementing the Viewable protocol, viewers can
  # associated themselves with these objects.

attr_accessor :viewer

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

def initialize
    @metadata      = {}
    @comment       = ''
    @parent        = nil
    @parent_name   = nil # for loading
    @parent_class  = nil # for loading
    @section       = nil
    @section_title = nil # for loading
    @file          = nil
    @full_name     = nil
    @store         = nil

initialize_visibility
  end

##
  # Initializes state for visibility of this CodeObject and its children.

def initialize_visibility # :nodoc:
    @document_children   = true
    @document_self       = true
    @done_documenting    = false
    @force_documentation = false
    @received_nodoc      = false
    @ignored             = false
  end

##
  # Replaces our comment with +comment+, unless it is empty.

def comment=(comment)
    @comment = case comment
               when NilClass               then ''
               when RDoc::Markup::Document then comment
               when RDoc::Comment          then comment.normalize
               else
                 if comment and not comment.empty? then
                   normalize_comment comment
                 else
                   # HACK correct fix is to have #initialize create @comment
                   #      with the correct encoding
                   if String === @comment and
                      Object.const_defined? :Encoding and @comment.empty? then
                     @comment.force_encoding comment.encoding
                   end
                   @comment
                 end
               end
  end

##
  # Should this CodeObject be shown in documentation?

def display?
    @document_self and not @ignored
  end

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

def document_children=(document_children)
    @document_children = document_children unless @done_documenting
  end

##
  # Enables or disables documentation of this CodeObject unless it has been
  # turned off by :enddoc:.  If the argument is +nil+ it means the
  # documentation is turned off by +:nodoc:+.

def document_self=(document_self)
    return if @done_documenting

@document_self = document_self
    @received_nodoc = true if document_self.nil?
  end

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

def documented?
    @received_nodoc or !@comment.empty?
  end

##
  # Turns documentation on/off, and turns on/off #document_self
  # and #document_children.
  #
  # Once documentation has been turned off (by +:enddoc:+),
  # the object will refuse to turn #document_self or
  # #document_children on, so +:doc:+ and +:start_doc:+ directives
  # will have no effect in the current file.

def done_documenting=(value)
    @done_documenting = value
    @document_self = !value
    @document_children = @document_self
  end

##
  # Yields each parent of this CodeObject.  See also
  # RDoc::ClassModule#each_ancestor

def each_parent
    code_object = self

while code_object = code_object.parent do
      yield code_object
    end

self
  end

##
  # File name where this CodeObject was found.
  #
  # See also RDoc::Context#in_files

def file_name
    return unless @file

@file.absolute_name
  end

##
  # Force the documentation of this object unless documentation
  # has been turned off by :enddoc:
  #--
  # HACK untested, was assigning to an ivar

def force_documentation=(value)
    @force_documentation = value unless @done_documenting
  end

##
  # Sets the full_name overriding any computed full name.
  #
  # Set to +nil+ to clear RDoc's cached value

def full_name= full_name
    @full_name = full_name
  end

##
  # Use this to ignore a CodeObject and all its children until found again
  # (#record_location is called).  An ignored item will not be shown in
  # documentation.
  #
  # See github issue #55
  #
  # The ignored status is temporary in order to allow implementation details
  # to be hidden.  At the end of processing a file RDoc allows all classes
  # and modules to add new documentation to previously created classes.
  #
  # If a class was ignored (via stopdoc) then reopened later with additional
  # documentation it should be shown.  If a class was ignored and never
  # reopened it should not be shown.  The ignore flag allows this to occur.

def ignore
    @ignored = true

stop_doc
  end

##
  # Has this class been ignored?

def ignored?
    @ignored
  end

##
  # Our parent CodeObject.  The parent may be missing for classes loaded from
  # legacy RI data stores.

def parent
    return @parent if @parent
    return nil unless @parent_name

if @parent_class == RDoc::TopLevel then
      @parent = @store.add_file @parent_name
    else
      @parent = @store.find_class_or_module @parent_name

return @parent if @parent

begin
        @parent = @store.load_class @parent_name
      rescue RDoc::Store::MissingFileError
        nil
      end
    end
  end

##
  # File name of our parent

def parent_file_name
    @parent ? @parent.base_name : '(unknown)'
  end

##
  # Name of our parent

def parent_name
    @parent ? @parent.full_name : '(unknown)'
  end

##
  # Records the RDoc::TopLevel (file) where this code object was defined

def record_location top_level
    @ignored = false
    @file = top_level
  end

##
  # The section this CodeObject is in.  Sections allow grouping of constants,
  # attributes and methods inside a class or module.

def section
    return @section if @section

@section = parent.add_section @section_title if parent
  end

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

def start_doc
    return if @done_documenting

@document_self = true
    @document_children = true
    @ignored = false
  end

##
  # Disable capture of documentation

def stop_doc
    @document_self = false
    @document_children = false
  end

end