rdoc 3.1 → 6.3.3

data/Manifest.txt

@@ -1,158 +0,0 @@
-.autotest
-.document
-History.txt
-LICENSE.txt
-Manifest.txt
-README.txt
-RI.txt
-Rakefile
-bin/rdoc
-bin/ri
-lib/rdoc.rb
-lib/rdoc/alias.rb
-lib/rdoc/anon_class.rb
-lib/rdoc/any_method.rb
-lib/rdoc/attr.rb
-lib/rdoc/class_module.rb
-lib/rdoc/code_object.rb
-lib/rdoc/code_objects.rb
-lib/rdoc/constant.rb
-lib/rdoc/context.rb
-lib/rdoc/encoding.rb
-lib/rdoc/erbio.rb
-lib/rdoc/gauntlet.rb
-lib/rdoc/generator.rb
-lib/rdoc/generator/darkfish.rb
-lib/rdoc/generator/markup.rb
-lib/rdoc/generator/ri.rb
-lib/rdoc/generator/template/darkfish/.document
-lib/rdoc/generator/template/darkfish/classpage.rhtml
-lib/rdoc/generator/template/darkfish/filepage.rhtml
-lib/rdoc/generator/template/darkfish/images/brick.png
-lib/rdoc/generator/template/darkfish/images/brick_link.png
-lib/rdoc/generator/template/darkfish/images/bug.png
-lib/rdoc/generator/template/darkfish/images/bullet_black.png
-lib/rdoc/generator/template/darkfish/images/bullet_toggle_minus.png
-lib/rdoc/generator/template/darkfish/images/bullet_toggle_plus.png
-lib/rdoc/generator/template/darkfish/images/date.png
-lib/rdoc/generator/template/darkfish/images/find.png
-lib/rdoc/generator/template/darkfish/images/loadingAnimation.gif
-lib/rdoc/generator/template/darkfish/images/macFFBgHack.png
-lib/rdoc/generator/template/darkfish/images/package.png
-lib/rdoc/generator/template/darkfish/images/page_green.png
-lib/rdoc/generator/template/darkfish/images/page_white_text.png
-lib/rdoc/generator/template/darkfish/images/page_white_width.png
-lib/rdoc/generator/template/darkfish/images/plugin.png
-lib/rdoc/generator/template/darkfish/images/ruby.png
-lib/rdoc/generator/template/darkfish/images/tag_green.png
-lib/rdoc/generator/template/darkfish/images/wrench.png
-lib/rdoc/generator/template/darkfish/images/wrench_orange.png
-lib/rdoc/generator/template/darkfish/images/zoom.png
-lib/rdoc/generator/template/darkfish/index.rhtml
-lib/rdoc/generator/template/darkfish/js/darkfish.js
-lib/rdoc/generator/template/darkfish/js/jquery.js
-lib/rdoc/generator/template/darkfish/js/quicksearch.js
-lib/rdoc/generator/template/darkfish/js/thickbox-compressed.js
-lib/rdoc/generator/template/darkfish/rdoc.css
-lib/rdoc/ghost_method.rb
-lib/rdoc/include.rb
-lib/rdoc/known_classes.rb
-lib/rdoc/markup.rb
-lib/rdoc/markup/attribute_manager.rb
-lib/rdoc/markup/blank_line.rb
-lib/rdoc/markup/document.rb
-lib/rdoc/markup/formatter.rb
-lib/rdoc/markup/formatter_test_case.rb
-lib/rdoc/markup/heading.rb
-lib/rdoc/markup/inline.rb
-lib/rdoc/markup/list.rb
-lib/rdoc/markup/list_item.rb
-lib/rdoc/markup/paragraph.rb
-lib/rdoc/markup/parser.rb
-lib/rdoc/markup/pre_process.rb
-lib/rdoc/markup/raw.rb
-lib/rdoc/markup/rule.rb
-lib/rdoc/markup/text_formatter_test_case.rb
-lib/rdoc/markup/to_ansi.rb
-lib/rdoc/markup/to_bs.rb
-lib/rdoc/markup/to_html.rb
-lib/rdoc/markup/to_html_crossref.rb
-lib/rdoc/markup/to_rdoc.rb
-lib/rdoc/markup/to_test.rb
-lib/rdoc/markup/verbatim.rb
-lib/rdoc/meta_method.rb
-lib/rdoc/method_attr.rb
-lib/rdoc/normal_class.rb
-lib/rdoc/normal_module.rb
-lib/rdoc/options.rb
-lib/rdoc/parser.rb
-lib/rdoc/parser/c.rb
-lib/rdoc/parser/ruby.rb
-lib/rdoc/parser/ruby_tools.rb
-lib/rdoc/parser/simple.rb
-lib/rdoc/rdoc.rb
-lib/rdoc/require.rb
-lib/rdoc/ri.rb
-lib/rdoc/ri/driver.rb
-lib/rdoc/ri/formatter.rb
-lib/rdoc/ri/paths.rb
-lib/rdoc/ri/store.rb
-lib/rdoc/ruby_lex.rb
-lib/rdoc/ruby_token.rb
-lib/rdoc/single_class.rb
-lib/rdoc/stats.rb
-lib/rdoc/stats/normal.rb
-lib/rdoc/stats/quiet.rb
-lib/rdoc/stats/verbose.rb
-lib/rdoc/task.rb
-lib/rdoc/text.rb
-lib/rdoc/token_stream.rb
-lib/rdoc/top_level.rb
-test/README
-test/binary.dat
-test/hidden.zip.txt
-test/test.ja.rdoc
-test/test.ja.txt
-test/test.txt
-test/test_attribute_manager.rb
-test/test_rdoc_alias.rb
-test/test_rdoc_any_method.rb
-test/test_rdoc_attr.rb
-test/test_rdoc_class_module.rb
-test/test_rdoc_code_object.rb
-test/test_rdoc_constant.rb
-test/test_rdoc_context.rb
-test/test_rdoc_encoding.rb
-test/test_rdoc_generator_darkfish.rb
-test/test_rdoc_generator_ri.rb
-test/test_rdoc_include.rb
-test/test_rdoc_markup.rb
-test/test_rdoc_markup_attribute_manager.rb
-test/test_rdoc_markup_document.rb
-test/test_rdoc_markup_paragraph.rb
-test/test_rdoc_markup_parser.rb
-test/test_rdoc_markup_pre_process.rb
-test/test_rdoc_markup_raw.rb
-test/test_rdoc_markup_to_ansi.rb
-test/test_rdoc_markup_to_bs.rb
-test/test_rdoc_markup_to_html.rb
-test/test_rdoc_markup_to_html_crossref.rb
-test/test_rdoc_markup_to_rdoc.rb
-test/test_rdoc_method_attr.rb
-test/test_rdoc_normal_class.rb
-test/test_rdoc_normal_module.rb
-test/test_rdoc_options.rb
-test/test_rdoc_parser.rb
-test/test_rdoc_parser_c.rb
-test/test_rdoc_parser_ruby.rb
-test/test_rdoc_parser_simple.rb
-test/test_rdoc_rdoc.rb
-test/test_rdoc_require.rb
-test/test_rdoc_ri_driver.rb
-test/test_rdoc_ri_paths.rb
-test/test_rdoc_ri_store.rb
-test/test_rdoc_task.rb
-test/test_rdoc_text.rb
-test/test_rdoc_top_level.rb
-test/xref_data.rb
-test/xref_test_case.rb

data/README.txt

@@ -1,45 +0,0 @@
-= \RDoc - Ruby Documentation System
-
-* {RDoc Project Page}[http://rubyforge.org/projects/rdoc/]
-* {RDoc Documentation}[http://rdoc.rubyforge.org/]
-* {RDoc Bug Tracker}[http://rubyforge.org/tracker/?atid=2472&group_id=627&func=browse]
-
-== DESCRIPTION:
-
-RDoc produces HTML and command-line documentation for Ruby projects.  RDoc
-includes the +rdoc+ and +ri+ tools for generating and displaying online
-documentation.
-
-See RDoc for a description of RDoc's markup and basic use.
-
-== SYNOPSIS:
-
-To generate HTML documentation:
-
-  rdoc .
-
-To generate documentation programmatically:
-
-  gem 'rdoc'
-  require 'rdoc/rdoc'
-  # ... see RDoc
-
-== BUGS:
-
-If you find a bug, please report it at the RDoc project's
-tracker[http://rubyforge.org/tracker/?group_id=627] on RubyForge
-
-== LICENSE:
-
-RDoc is Copyright (c) 2001-2003 Dave Thomas, The Pragmatic Programmers.
-Portions (c) 2007-2010 Eric Hodel.  Portions copyright others, see individual
-files for details.
-
-It is free software, and may be redistributed under the terms specified in
-LICENSE.txt.
-
-== WARRANTY:
-
-This software is provided "as is" and without any express or implied
-warranties, including, without limitation, the implied warranties of
-merchantibility and fitness for a particular purpose.

data/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/bin/ri

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

data/lib/rdoc/gauntlet.rb

@@ -1,52 +0,0 @@
-require 'rdoc/rdoc'
-require 'gauntlet'
-require 'fileutils'
-
-##
-# Allows for testing of RDoc against every gem
-
-class RDoc::Gauntlet < Gauntlet
-
-  ##
-  # Runs an RDoc generator for gem +name+
-
-  def run name
-    return if self.data.key? name
-
-    dir = File.expand_path "~/.gauntlet/data/rdoc/#{name}"
-    FileUtils.rm_rf dir if File.exist? dir
-
-    yaml = File.read 'gemspec'
-    spec = Gem::Specification.from_yaml yaml
-
-    args = %W[--ri --op #{dir}]
-    args.push(*spec.rdoc_options)
-    args << spec.require_paths
-    args << spec.extra_rdoc_files
-    args = args.flatten.map { |a| a.to_s }
-    args.delete '--quiet'
-
-    puts "#{name} - rdoc #{args.join ' '}"
-
-    self.dirty = true
-    r = RDoc::RDoc.new
-
-    begin
-      r.document args
-      self.data[name] = true
-      puts 'passed'
-      FileUtils.rm_rf dir
-    rescue Interrupt, StandardError, RDoc::Error, SystemStackError => e
-      puts "failed - (#{e.class}) #{e.message}"
-      self.data[name] = false
-    end
-  rescue Gem::Exception
-    puts "bad gem #{name}"
-  ensure
-    puts
-  end
-
-end
-
-RDoc::Gauntlet.new.run_the_gauntlet if $0 == __FILE__
-

data/lib/rdoc/generator/template/darkfish/classpage.rhtml

@@ -1,296 +0,0 @@
-<?xml version="1.0" encoding="<%= @options.charset %>"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <meta content="text/html; charset=<%= @options.charset %>" http-equiv="Content-Type" />
-
-  <title><%= klass.type.capitalize %>: <%= klass.full_name %></title>
-
-  <link rel="stylesheet" href="<%= rel_prefix %>/rdoc.css" type="text/css" media="screen" />
-
-  <script src="<%= rel_prefix %>/js/jquery.js" type="text/javascript"
-    charset="utf-8"></script>
-  <script src="<%= rel_prefix %>/js/thickbox-compressed.js" type="text/javascript"
-    charset="utf-8"></script>
-  <script src="<%= rel_prefix %>/js/quicksearch.js" type="text/javascript"
-    charset="utf-8"></script>
-  <script src="<%= rel_prefix %>/js/darkfish.js" type="text/javascript"
-    charset="utf-8"></script>
-
-</head>
-<body class="<%= klass.type %>">
-
-  <div id="metadata">
-    <div id="home-metadata">
-      <div id="home-section" class="section">
-        <h3 class="section-header">
-          <a href="<%= rel_prefix %>/index.html">Home</a>
-          <a href="<%= rel_prefix %>/index.html#classes">Classes</a>
-          <a href="<%= rel_prefix %>/index.html#methods">Methods</a>
-        </h3>
-      </div>
-    </div>
-
-    <div id="file-metadata">
-      <div id="file-list-section" class="section">
-        <h3 class="section-header">In Files</h3>
-        <div class="section-body">
-          <ul>
-          <% klass.in_files.each do |tl| %>
-            <li><a href="<%= rel_prefix %>/<%= h tl.path %>?TB_iframe=true&amp;height=550&amp;width=785"
-              class="thickbox" title="<%= h tl.absolute_name %>"><%= h tl.absolute_name %></a></li>
-          <% end %>
-          </ul>
-        </div>
-      </div>
-
-      <% if !svninfo.empty? %>
-      <div id="file-svninfo-section" class="section">
-        <h3 class="section-header">Subversion Info</h3>
-        <div class="section-body">
-          <dl class="svninfo">
-            <dt>Rev</dt>
-            <dd><%= svninfo[:rev] %></dd>
-
-            <dt>Last Checked In</dt>
-            <dd><%= svninfo[:commitdate].strftime('%Y-%m-%d %H:%M:%S') %>
-              (<%= svninfo[:commitdelta] %> ago)</dd>
-
-            <dt>Checked in by</dt>
-            <dd><%= svninfo[:committer] %></dd>
-          </dl>
-        </div>
-      </div>
-      <% end %>
-    </div>
-
-    <div id="class-metadata">
-
-      <!-- Parent Class -->
-      <% if klass.type == 'class' %>
-      <div id="parent-class-section" class="section">
-        <h3 class="section-header">Parent</h3>
-        <% if klass.superclass and not String === klass.superclass then %>
-        <p class="link"><a href="<%= klass.aref_to klass.superclass.path %>"><%= klass.superclass.full_name %></a></p>
-        <% else %>
-        <p class="link"><%= klass.superclass %></p>
-        <% end %>
-      </div>
-      <% end %>
-
-      <!-- Namespace Contents -->
-      <% unless klass.classes_and_modules.empty? %>
-      <div id="namespace-list-section" class="section">
-        <h3 class="section-header">Namespace</h3>
-        <ul class="link-list">
-          <% (klass.modules.sort + klass.classes.sort).each do |mod| %>
-          <li><span class="type"><%= mod.type.upcase %></span> <a href="<%= klass.aref_to mod.path %>"><%= mod.full_name %></a></li>
-          <% end %>
-        </ul>
-      </div>
-      <% end %>
-
-      <!-- Method Quickref -->
-      <% unless klass.method_list.empty? %>
-      <div id="method-list-section" class="section">
-        <h3 class="section-header">Methods</h3>
-        <ul class="link-list">
-          <% klass.each_method do |meth| %>
-          <li><a href="#<%= meth.aref %>"><%= meth.singleton ? '::' : '#' %><%= meth.name %></a></li>
-          <% end %>
-        </ul>
-      </div>
-      <% end %>
-
-      <!-- Included Modules -->
-      <% unless klass.includes.empty? %>
-      <div id="includes-section" class="section">
-        <h3 class="section-header">Included Modules</h3>
-        <ul class="link-list">
-        <% klass.each_include do |inc| %>
-        <% unless String === inc.module %>
-          <li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a></li>
-        <% else %>
-          <li><span class="include"><%= inc.name %></span></li>
-        <% end %>
-        <% end %>
-        </ul>
-      </div>
-      <% end %>
-    </div>
-
-    <div id="project-metadata">
-      <% simple_files = @files.select {|tl| tl.parser == RDoc::Parser::Simple } %>
-      <% unless simple_files.empty? then %>
-      <div id="fileindex-section" class="section project-section">
-        <h3 class="section-header">Files</h3>
-        <ul>
-        <% simple_files.each do |file| %>
-          <li class="file"><a href="<%= rel_prefix %>/<%= file.path %>"><%= h file.base_name %></a></li>
-        <% end %>
-        </ul>
-      </div>
-      <% end %>
-
-      <div id="classindex-section" class="section project-section">
-        <h3 class="section-header">Class/Module Index
-          <span class="search-toggle"><img src="<%= rel_prefix %>/images/find.png"
-            height="16" width="16" alt="[+]"
-            title="show/hide quicksearch" /></span></h3>
-        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
-        <fieldset>
-          <legend>Quicksearch</legend>
-          <input type="text" name="quicksearch" value=""
-            class="quicksearch-field" />
-        </fieldset>
-        </form>
-
-        <ul class="link-list">
-        <% @modsort.each do |index_klass| %>
-          <li><a href="<%= rel_prefix %>/<%= index_klass.path %>"><%= index_klass.full_name %></a></li>
-        <% end %>
-        </ul>
-        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
-      </div>
-
-      <% if $DEBUG_RDOC %>
-      <div id="debugging-toggle"><img src="<%= rel_prefix %>/images/bug.png"
-        alt="toggle debugging" height="16" width="16" /></div>
-      <% end %>
-    </div>
-  </div>
-
-  <div id="documentation">
-    <h1 class="<%= klass.type %>"><%= klass.full_name %></h1>
-
-    <div id="description">
-      <%= klass.description %>
-    </div>
-
-    <!-- Constants -->
-    <% unless klass.constants.empty? %>
-    <div id="constants-list" class="section">
-      <h3 class="section-header">Constants</h3>
-      <dl>
-      <% klass.each_constant do |const| %>
-        <dt><a name="<%= const.name %>"><%= const.name %></a></dt>
-        <% if const.comment %>
-        <dd class="description"><%= const.description.strip %></dd>
-        <% else %>
-        <dd class="description missing-docs">(Not documented)</dd>
-        <% end %>
-      <% end %>
-      </dl>
-    </div>
-    <% end %>
-
-    <!-- Attributes -->
-    <% unless klass.attributes.empty? %>
-    <div id="attribute-method-details" class="method-section section">
-      <h3 class="section-header">Attributes</h3>
-
-      <% klass.each_attribute do |attrib| %>
-      <div id="<%= attrib.html_name %>-attribute-method" class="method-detail">
-        <a name="<%= h attrib.name %>"></a>
-        <% if attrib.rw =~ /w/i %>
-        <a name="<%= h attrib.name %>="></a>
-        <% end %>
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name"><%= h attrib.name %></span><span
-            class="attribute-access-type">[<%= attrib.rw %>]</span>
-        </div>
-
-        <div class="method-description">
-        <% if attrib.comment %>
-        <%= attrib.description.strip %>
-        <% else %>
-        <p class="missing-docs">(Not documented)</p>
-        <% end %>
-        </div>
-      </div>
-      <% end %>
-    </div>
-    <% end %>
-
-    <!-- Methods -->
-    <% klass.methods_by_type.each do |type, visibilities|
-       next if visibilities.empty?
-       visibilities.each do |visibility, methods|
-         next if methods.empty? %>
-    <div id="<%= visibility %>-<%= type %>-method-details" class="method-section section">
-      <h3 class="section-header"><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h3>
-
-    <% methods.each do |method| %>
-      <div id="<%= method.html_name %>-method" class="method-detail <%= method.is_alias_for ? "method-alias" : '' %>">
-        <a name="<%= h method.aref %>"></a>
-
-        <% if method.call_seq %>
-        <% method.call_seq.strip.split("\n").each_with_index do |call_seq, i| %>
-        <div class="method-heading">
-          <span class="method-callseq"><%= call_seq.strip.gsub(/->/, '&rarr;').gsub( /^\w.+\./m, '') %></span>
-          <% if i == 0 %>
-          <span class="method-click-advice">click to toggle source</span>
-          <% end %>
-        </div>
-        <% end %>
-        <% else %>
-        <div class="method-heading">
-          <span class="method-name"><%= h method.name %></span><span
-            class="method-args"><%= method.params %></span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <% end %>
-
-        <div class="method-description">
-          <% if method.comment %>
-          <%= method.description.strip %>
-          <% else %>
-          <p class="missing-docs">(Not documented)</p>
-          <% end %>
-
-          <% if method.token_stream %>
-          <div class="method-source-code"
-            id="<%= method.html_name %>-source">
-<pre>
-<%= method.markup_code %>
-</pre>
-          </div>
-          <% end %>
-        </div>
-
-        <% unless method.aliases.empty? %>
-        <div class="aliases">
-          Also aliased as: <%= method.aliases.map do |aka|
-            if aka.parent then # HACK lib/rexml/encodings
-              %{<a href="#{klass.aref_to aka.path}">#{h aka.name}</a>}
-            else
-              h aka.name
-            end
-          end.join ", " %>
-        </div>
-        <% end %>
-
-        <% if method.is_alias_for then %>
-        <div class="aliases">
-          Alias for: <a href="<%= klass.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
-        </div>
-        <% end %>
-      </div>
-
-    <% end %>
-    </div>
-  <% end
-     end %>
-
-  </div>
-
-  <div id="validator-badges">
-    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
-      Rdoc Generator</a> <%= RDoc::Generator::Darkfish::VERSION %></small>.</p>
-  </div>
-
-</body>
-</html>
-