voloko-sdoc 0.1.7 → 0.1.9

data/rdoc/RI.txt

@@ -1,58 +0,0 @@
-= RI
-== Background
-+ri+ is a tool that allows Ruby documentation to be viewed on the command-line.
-It is part of RDoc and is expected to work on any platform supported by Ruby.
-
-+ri+ will be a bit slow the first time that it runs (or any time that the
-underlying documentation changes) because it builds a cache in the +.ri+
-directory within the user's home directory in order to make future accesses
-faster.
-
-== Usage
-To see information for a class, do:
-  ri class_name
-
-For example, for the +Array+ class, do
-  ri Array
-
-To see information for an instance method, do:
-  ri class_name#method_name
-
-For example, for Array's +join+ method, do:
-  ri Array#join
-
-To see information for a class method, do:
-  ri class_name.method_name
-
-For example, for Module's +private+ method, do:
-  ri Module.private
-
-To search for all methods containing +read+, do:
-  ri read
-
-To search for all methods starting with +read+, do:
-  ri '^read'
-
-To search for all +read+ methods, do:
-  ri '^read$'
-
-== Options
-+ri+ supports a variety of options, all of which can be viewed via +--help+.
-Of particular interest, are:
-[-d directory]
-  List of directories from which to source documentation in addition to
-  the standard directories.  May be repeated.  This can be used to specify
-  the location of site-specific documentation (which can be generated with
-  RDoc).
-[-i]
-  This makes +ri+ go into interactive mode.  When +ri+ is in interactive mode,
-  it will allow the user to disambiguate lists of methods in case multiple
-  methods match against a method search string.  It also will allow the user
-  to enter in a method name (with auto-completion, if readline is supported)
-  when viewing a class.
-[-T]
-  Send output to stdout, rather than to a pager.
-
-All options also can be specified through the +RI+ environment variable.
-Command-line options always override those specified in the +RI+ environment
-variable.

data/rdoc/Rakefile

@@ -1,70 +0,0 @@
-require 'hoe'
-
-$rdoc_rakefile = true
-
-$:.unshift 'lib'
-require 'rdoc'
-
-Hoe.new "rdoc", RDoc::VERSION do |rdoc|
-  rdoc.developer 'Eric Hodel', 'drbrain@segment7.net'
-  rdoc.developer 'Dave Thomas', ''
-  rdoc.developer 'Phil Hagelberg', 'technomancy@gmail.com'
-  rdoc.developer 'Tony Strauss', 'tony.strauss@designingpatterns.com'
-  rdoc.remote_rdoc_dir = ''
-
-  rdoc.extra_dev_deps << ['minitest', '~> 1.3']
-  rdoc.spec_extras['required_rubygems_version'] = '>= 1.3'
-  rdoc.spec_extras['homepage'] = 'http://rdoc.rubyforge.org'
-end
-
-# These tasks expect to have the following directory structure:
-#
-#   git/git.rubini.us/code # Rubinius git HEAD checkout
-#   svn/ruby/trunk         # ruby subversion HEAD checkout
-#   svn/rdoc/trunk         # RDoc subversion HEAD checkout
-#
-# If you don't have this directory structure, set RUBY_PATH and/or
-# RUBINIUS_PATH.
-
-diff_options = "-urpN --exclude '*svn*' --exclude '*swp' --exclude '*rbc'"
-rsync_options = "-avP --exclude '*svn*' --exclude '*swp' --exclude '*rbc' --exclude '*.rej' --exclude '*.orig'"
-
-rubinius_dir = ENV['RUBINIUS_PATH'] || '../../../git/git.rubini.us/code'
-ruby_dir = ENV['RUBY_PATH'] || '../../ruby/trunk'
-
-desc "Updates Ruby HEAD with the currently checked-out copy of RDoc."
-task :update_ruby do
-  sh "rsync #{rsync_options} bin/rdoc #{ruby_dir}/bin/rdoc"
-  sh "rsync #{rsync_options} bin/ri #{ruby_dir}/bin/ri"
-  sh "rsync #{rsync_options} lib/ #{ruby_dir}/lib"
-  sh "rsync #{rsync_options} test/ #{ruby_dir}/test/rdoc"
-end
-
-desc "Diffs Ruby HEAD with the currently checked-out copy of RDoc."
-task :diff_ruby do
-  options = "-urpN --exclude '*svn*' --exclude '*swp' --exclude '*rbc'"
-
-  sh "diff #{diff_options} bin/rdoc #{ruby_dir}/bin/rdoc; true"
-  sh "diff #{diff_options} bin/ri #{ruby_dir}/bin/ri; true"
-  sh "diff #{diff_options} lib/rdoc.rb #{ruby_dir}/lib/rdoc.rb; true"
-  sh "diff #{diff_options} lib/rdoc #{ruby_dir}/lib/rdoc; true"
-  sh "diff #{diff_options} test #{ruby_dir}/test/rdoc; true"
-end
-
-desc "Updates Rubinius HEAD with the currently checked-out copy of RDoc."
-task :update_rubinius do
-  sh "rsync #{rsync_options} bin/rdoc #{rubinius_dir}/lib/bin/rdoc.rb"
-  sh "rsync #{rsync_options} bin/ri #{rubinius_dir}/lib/bin/ri.rb"
-  sh "rsync #{rsync_options} lib/ #{rubinius_dir}/lib"
-  sh "rsync #{rsync_options} test/ #{rubinius_dir}/test/rdoc"
-end
-
-desc "Diffs Rubinius HEAD with the currently checked-out copy of RDoc."
-task :diff_rubinius do
-  sh "diff #{diff_options} bin/rdoc #{rubinius_dir}/lib/bin/rdoc.rb; true"
-  sh "diff #{diff_options} bin/ri #{rubinius_dir}/lib/bin/ri.rb; true"
-  sh "diff #{diff_options} lib/rdoc.rb #{rubinius_dir}/lib/rdoc.rb; true"
-  sh "diff #{diff_options} lib/rdoc #{rubinius_dir}/lib/rdoc; true"
-  sh "diff #{diff_options} test #{rubinius_dir}/test/rdoc; true"
-end
-

data/rdoc/bin/rdoc

@@ -1,35 +0,0 @@
-#!/usr/bin/env ruby
-#
-#  RDoc: Documentation tool for source code
-#        (see lib/rdoc/rdoc.rb for more information)
-#
-#  Copyright (c) 2003 Dave Thomas
-#  Released under the same terms as Ruby
-#
-#  $Revision: 15033 $
-
-require 'rdoc/rdoc'
-
-begin
-  r = RDoc::RDoc.new
-  r.document ARGV
-rescue Interrupt
-  $stderr.puts
-  $stderr.puts "Interrupted"
-  exit 1
-rescue SystemExit
-  raise
-rescue Exception => e
-  if $DEBUG_RDOC then
-    $stderr.puts e.message
-    $stderr.puts "#{e.backtrace.join "\n\t"}"
-    $stderr.puts
-  else
-    $stderr.puts "uh-oh! RDoc had a problem:"
-    $stderr.puts e.message
-    $stderr.puts
-    $stderr.puts "run with --debug for full backtrace"
-  end
-  exit 1
-end
-

data/rdoc/bin/ri

@@ -1,5 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rdoc/ri/driver'
-
-RDoc::RI::Driver.run ARGV

data/rdoc/lib/rdoc/alias.rb

@@ -1,54 +0,0 @@
-require 'rdoc/code_object'
-
-##
-# Represent an alias, which is an old_name/new_name pair associated with a
-# particular context
-
-class RDoc::Alias < RDoc::CodeObject
-
-  ##
-  # Allow comments to be overridden
-
-  attr_writer :comment
-
-  ##
-  # Aliased name
-
-  attr_accessor :new_name
-
-  ##
-  # Aliasee's name
-
-  attr_accessor :old_name
-
-  ##
-  # Source file token stream
-
-  attr_accessor :text
-
-  ##
-  # Creates a new Alias with a token stream of +text+ that aliases +old_name+
-  # to +new_name+ and has +comment+
-
-  def initialize(text, old_name, new_name, comment)
-    super()
-    @text = text
-    @old_name = old_name
-    @new_name = new_name
-    self.comment = comment
-  end
-
-  def inspect # :nodoc:
-    "#<%s:0x%x %s.alias_method %s, %s>" % [
-      self.class, object_id,
-      parent.name, @old_name, @new_name,
-    ]
-  end
-
-  def to_s # :nodoc:
-    "alias: #{self.old_name} -> #{self.new_name}\n#{self.comment}"
-  end
-
-end
-
-

data/rdoc/lib/rdoc/anon_class.rb

@@ -1,10 +0,0 @@
-require 'rdoc/class_module'
-
-##
-# An anonymous class like:
-#
-#   c = Class.new do end
-
-class RDoc::AnonClass < RDoc::ClassModule
-end
-

data/rdoc/lib/rdoc/any_method.rb

@@ -1,190 +0,0 @@
-require 'rdoc/code_object'
-require 'rdoc/tokenstream'
-
-##
-# AnyMethod is the base class for objects representing methods
-
-class RDoc::AnyMethod < RDoc::CodeObject
-
-  ##
-  # Method name
-
-  attr_writer :name
-
-  ##
-  # public, protected, private
-
-  attr_accessor :visibility
-
-  ##
-  # Parameters yielded by the called block
-
-  attr_accessor :block_params
-
-  ##
-  # Don't rename \#initialize to \::new
-
-  attr_accessor :dont_rename_initialize
-
-  ##
-  # Is this a singleton method?
-
-  attr_accessor :singleton
-
-  ##
-  # Source file token stream
-
-  attr_reader :text
-
-  ##
-  # Array of other names for this method
-
-  attr_reader :aliases
-
-  ##
-  # Fragment reference for this method
-
-  attr_reader :aref
-
-  ##
-  # The method we're aliasing
-
-  attr_accessor :is_alias_for
-
-  ##
-  # Parameters for this method
-
-  attr_overridable :params, :param, :parameters, :parameter
-
-  ##
-  # Different ways to call this method
-
-  attr_accessor :call_seq
-
-  include RDoc::TokenStream
-
-  ##
-  # Resets method fragment reference counter
-
-  def self.reset
-    @@aref = 'M000000'
-  end
-
-  reset
-
-  def initialize(text, name)
-    super()
-    @text = text
-    @name = name
-    @token_stream  = nil
-    @visibility    = :public
-    @dont_rename_initialize = false
-    @block_params  = nil
-    @aliases       = []
-    @is_alias_for  = nil
-    @call_seq = nil
-
-    @aref  = @@aref
-    @@aref = @@aref.succ
-  end
-
-  ##
-  # Order by #singleton then #name
-
-  def <=>(other)
-    [@singleton ? 0 : 1, @name] <=> [other.singleton ? 0 : 1, other.name]
-  end
-
-  ##
-  # Adds +method+ as an alias for this method
-
-  def add_alias(method)
-    @aliases << method
-  end
-
-  ##
-  # HTML id-friendly method name
-
-  def html_name
-    @name.gsub(/[^a-z]+/, '-')
-  end
-
-  def inspect # :nodoc:
-    alias_for = @is_alias_for ? " (alias for #{@is_alias_for.name})" : nil
-      "#<%s:0x%x %s%s%s (%s)%s>" % [
-        self.class, object_id,
-        parent_name,
-        singleton ? '::' : '#',
-        name,
-        visibility,
-        alias_for,
-      ]
-  end
-
-  ##
-  # Full method name including namespace
-
-  def full_name
-    "#{@parent.full_name}#{pretty_name}"
-  end
-
-  ##
-  # Method name
-
-  def name
-    return @name if @name
-
-    @name = @call_seq[/^.*?\.(\w+)/, 1] || @call_seq
-  end
-
-  ##
-  # Pretty parameter list for this method
-
-  def param_seq
-    params = params.gsub(/\s*\#.*/, '')
-    params = params.tr("\n", " ").squeeze(" ")
-    params = "(#{params})" unless p[0] == ?(
-
-    if block = block_params then # yes, =
-      # If this method has explicit block parameters, remove any explicit
-      # &block
-      params.sub!(/,?\s*&\w+/)
-
-      block.gsub!(/\s*\#.*/, '')
-      block = block.tr("\n", " ").squeeze(" ")
-      if block[0] == ?(
-        block.sub!(/^\(/, '').sub!(/\)/, '')
-      end
-      params << " { |#{block}| ... }"
-    end
-
-    params
-  end
-
-  ##
-  # Path to this method
-
-  def path
-    "#{@parent.path}##{@aref}"
-  end
-
-  ##
-  # Method name with class/instance indicator
-
-  def pretty_name
-    "#{singleton ? '::' : '#'}#{@name}"
-  end
-
-  def to_s # :nodoc:
-    "#{self.class.name}: #{full_name} (#{@text})\n#{@comment}"
-  end
-
-  ##
-  # Type of method (class or instance)
-
-  def type
-    singleton ? 'class' : 'instance'
-  end
-
-end
-

data/rdoc/lib/rdoc/attr.rb

@@ -1,79 +0,0 @@
-require 'rdoc/code_object'
-
-##
-# An attribute created by \#attr, \#attr_reader, \#attr_writer or
-# \#attr_accessor
-
-class RDoc::Attr < RDoc::CodeObject
-
-  ##
-  # Name of the attribute
-
-  attr_accessor :name
-
-  ##
-  # Is the attribute readable, writable or both?
-
-  attr_accessor :rw
-
-  ##
-  # Source file token stream
-
-  attr_accessor :text
-
-  ##
-  # public, protected, private
-
-  attr_accessor :visibility
-
-  def initialize(text, name, rw, comment)
-    super()
-    @text = text
-    @name = name
-    @rw = rw
-    @visibility = :public
-    self.comment = comment
-  end
-
-  ##
-  # Attributes are ordered by name
-
-  def <=>(other)
-    self.name <=> other.name
-  end
-
-  ##
-  # An HTML id-friendly representation of #name
-
-  def html_name
-    @name.gsub(/[^a-z]+/, '-')
-  end
-
-  def inspect # :nodoc:
-    attr = case rw
-           when 'RW' then :attr_accessor
-           when 'R'  then :attr_reader
-           when 'W'  then :attr_writer
-           else
-               " (#{rw})"
-           end
-
-      "#<%s:0x%x %s.%s :%s>" % [
-        self.class, object_id,
-        parent_name, attr, @name,
-      ]
-  end
-
-  ##
-  # URL path for this attribute
-
-  def path
-    "#{@parent.path}##{@name}"
-  end
-
-  def to_s # :nodoc:
-    "attr: #{self.name} #{self.rw}\n#{self.comment}"
-  end
-
-end
-

data/rdoc/lib/rdoc/cache.rb

@@ -1,41 +0,0 @@
-require 'thread'
-require 'singleton'
-
-##
-# A generic, thread-safe in-memory cache. It's used for caching
-# RDoc::TemplatePage objects when generating RDoc output.
-
-class RDoc::Cache
-
-  include Singleton
-
-  ##
-  # Creates a new, empty cache
-
-  def initialize
-    @contents = {}
-    @lock = Mutex.new
-  end
-
-  ##
-  # Checks whether there's a value in the cache with key +key+. If so, then
-  # that value will be returned. Otherwise, the given block will be run, and
-  # its return value will be put into the cache, and returned.
-
-  def cache(key)
-    @lock.synchronize do
-      @contents[key] ||= yield
-    end
-  end
-
-  ##
-  # Clears the contents of the cache
-
-  def clear
-    @lock.synchronize do
-      @contents.clear
-    end
-  end
-
-end
-

data/rdoc/lib/rdoc/class_module.rb

@@ -1,87 +0,0 @@
-require 'rdoc/context'
-
-##
-# ClassModule is the base class for objects representing either a class or a
-# module.
-
-class RDoc::ClassModule < RDoc::Context
-
-  attr_accessor :diagram
-
-  ##
-  # Creates a new ClassModule with +name+ with optional +superclass+
-
-  def initialize(name, superclass = 'Object')
-    @diagram    = nil
-    @full_name  = nil
-    @name       = name
-    @superclass = superclass
-    super()
-  end
-
-  ##
-  # Finds a class or module with +name+ in this namespace or its descendents
-
-  def find_class_named(name)
-    return self if full_name == name
-    @classes.each_value {|c| return c if c.find_class_named(name) }
-    nil
-  end
-
-  ##
-  # Return the fully qualified name of this class or module
-
-  def full_name
-    @full_name ||= if RDoc::ClassModule === @parent then
-                     "#{@parent.full_name}::#{@name}"
-                   else
-                     @name
-                   end
-  end
-
-  ##
-  # 'module' or 'class'
-
-  def type
-    module? ? 'module' : 'class'
-  end
-
-  ##
-  # Does this object represent a module?
-
-  def module?
-    false
-  end
-
-  ##
-  # Path to this class or module
-
-  def path
-    http_url RDoc::RDoc.current.generator.class_dir
-  end
-
-  ##
-  # Get the superclass of this class.  Attempts to retrieve the superclass
-  # object, returns the name if it is not known.
-
-  def superclass
-    raise NoMethodError, "#{full_name} is a module" if module?
-
-    RDoc::TopLevel.find_class_named(@superclass) || @superclass
-  end
-
-  ##
-  # Set the superclass of this class to +superclass+
-
-  def superclass=(superclass)
-    raise NoMethodError, "#{full_name} is a module" if module?
-
-    @superclass = superclass if @superclass.nil? or @superclass == 'Object'
-  end
-
-  def to_s # :nodoc:
-    "#{self.class}: #{full_name} #{@comment} #{super}"
-  end
-
-end
-