rdoc 6.3.4.1 → 8.0.0

data/ExampleRDoc.rdoc

@@ -1,208 +0,0 @@
-This document contains example output to show RDoc styling.  This file was
-created from a RDoc Markup file.
-
-== Headings
-
-You should not use headings beyond level 3, it is a sign of poor organization
-of your code or documentation.  It also becomes difficult for the user to
-figure out what you are attempting to explain to them as they have to track
-the multiple layers of nesting.
-
-= Heading level 1
-
-Above is a level one heading.
-
-These paragraphs are filler that exist so you can see how the heading
-interacts with paragraphs before and after the heading.  As you can see each
-different heading has a different amount of margin above and below.
-
-This should be sufficient to give you a proper picture of how it will appear in
-your documentation.
-
-== Heading level 2
-
-Above is a level two heading.
-
-These paragraphs are filler that exist so you can see how the heading
-interacts with paragraphs before and after the heading.  As you can see each
-different heading has a different amount of margin above and below.
-
-This should be sufficient to give you a proper picture of how it will appear in
-your documentation.
-
-=== Heading level 3
-
-Above is a level three heading.
-
-These paragraphs are filler that exist so you can see how the heading
-interacts with paragraphs before and after the heading.  As you can see each
-different heading has a different amount of margin above and below.
-
-This should be sufficient to give you a proper picture of how it will appear in
-your documentation.
-
-==== Heading level 4
-
-Above is a level four heading.
-
-These paragraphs are filler that exist so you can see how the heading
-interacts with paragraphs before and after the heading.  As you can see each
-different heading has a different amount of margin above and below.
-
-This should be sufficient to give you a proper picture of how it will appear in
-your documentation.
-
-===== Heading level 5
-
-Above is a level five heading.
-
-These paragraphs are filler that exist so you can see how the heading
-interacts with paragraphs before and after the heading.  As you can see each
-different heading has a different amount of margin above and below.
-
-This should be sufficient to give you a proper picture of how it will appear in
-your documentation.
-
-====== Heading level 6
-
-Above is a level six heading.
-
-These paragraphs are filler that exist so you can see how the heading
-interacts with paragraphs before and after the heading.  As you can see each
-different heading has a different amount of margin above and below.
-
-This should be sufficient to give you a proper picture of how it will appear in
-your documentation.
-
-== Paragraphs
-
-This is how a paragraph looks.  Since it is difficult to generate good content
-for paragraphs I have chosen to use {Riker Ipsum}[http://rikeripsum.com] for
-nonsense filler content.  In the previous sentence you can see how a link is
-formatted.
-
-Here is an example of *bold* and _emphasis_ styling.  Try not to combine the
-two or use them too often.  Here is an example of <code>inline verbatim
-text</code>.  That should be enough of a taste of inline markup in paragraphs.
-The Riker Ipsum filler follows:
-
-Shields up! Rrrrred alert! Well, I'll say this for him - he's sure of himself.
-and attack the Romulans. Worf, It's better than music. It's jazz. This should
-be interesting. When has justice ever been as simple as a rule book? Flair is
-what marks the difference between artistry and mere competence.
-
-Sorry, Data. I think you've let your personal feelings cloud your judgement. We
-finished our first sensor sweep of the neutral zone. Yes, absolutely, I do
-indeed concur, wholeheartedly! Mr. Worf, you do remember how to fire phasers? A
-lot of things can change in twelve years, Admiral. Your shields were failing,
-sir.
-
-== Verbatim sections
-
-A verbatim section typically contains source code or example output.  This is
-how verbatim blocks of code looks:
-
-  def local responder
-    responder.ping do |value|
-      return value
-    end
-  end
-  
-  def ping uri
-    @uri = uri
-    @remote = DRb::DRbObject.new_with_uri @uri
-  
-    @remote.ping do |value|
-      return value
-    end
-  end
-
-This is a paragraph following the verbatim block so you can see how leading and trailing paragraphs interact with it.
-
-== Unordered lists
-
-Here is an unordered list.  As you can see it uses non-numeral markers for each list item:
-
-* This is the top-most item in the list.
-* This is a second item in the list.
-
-  Unlike the first item, this item has more than one paragraph so you can see
-  how they interact.
-* This is a third item in the list.  Like the item before it, this item has a
-  second paragraph.
-
-  Here is the second paragraph in the list item.
-* A final list item.
-
-== Ordered lists
-
-Here is an ordered list.  As you can see it uses numeral markers for each list
-item:
-
-1. This is the first item in the list.
-1. This is the second item in the list.
-
-   Unlike the first item, this item has more than one paragraph so you can see
-   how they interact.
-1. This is the third item in the list.  Like the item before it, this item has
-   a second paragraph.
-
-   Here is the second paragraph in the third list item.
-1. The fourth and final list item.
-
-== Definition lists
-
-=== "Note" list
-
-The "note" syntax can be used to create a definition list:
-
-  note::
-    description
-
-Here is such a definition list:
-
-cat::
-  A cat is a small mammal that is commonly kept as a pet.
-
-dog::
-  A dog is a mammal that is also kept as a pet.  A dog may range in size from
-  smaller than a cat to larger than a human.
-
-  Typically dogs are easier to train to respond to commands than cats.
-
-rabbit::
-  Rabbits are also mammals, but are infrequently kept as pets.  Most rabbits
-  are wild.
-
-=== "Label" list
-
-The "label" syntax can be used to create a definition list:
-
-  [label]
-    description
-
-Here is such a definition list:
-
-[cat]
-  A cat is a small mammal that is commonly kept as a pet.
-
-[dog]
-  A dog is a mammal that is also kept as a pet.  A dog may range in size from
-  smaller than a cat to larger than a human.
-
-  Typically dogs are easier to train to respond to commands than cats.
-
-[rabbit]
-  Rabbits are also mammals, but are infrequently kept as pets.  Most rabbits
-  are wild.
-
-== Rule
-
-A rule is a horizontal divider between two paragraphs.  Following this
-paragraph is a rule.
-
----
-
-In historic versions of RDoc you could control the height of the rule in HTML
-output.  This is no longer true as HTML 5 does not support this.
-

data/Gemfile

@@ -1,12 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :development do
-  gem "rake"
-  gem "racc", "> 1.4.10"
-  gem "kpeg"
-  gem "test-unit"
-  gem "minitest" # for test_rdoc_rubygems_hook.rb
-  gem "rubocop"
-end

data/README.rdoc

@@ -1,129 +0,0 @@
-= \RDoc - Ruby Documentation System
-
-home :: https://github.com/ruby/rdoc
-rdoc :: https://ruby.github.io/rdoc
-bugs :: https://github.com/ruby/rdoc/issues
-code quality :: {<img src="https://codeclimate.com/github/ruby/rdoc/badges/gpa.svg" alt="Code Climate">}[https://codeclimate.com/github/ruby/rdoc]
-
-== Description
-
-RDoc produces HTML and command-line documentation for Ruby projects.  RDoc
-includes the +rdoc+ and +ri+ tools for generating and displaying documentation
-from the command-line.
-
-== Generating Documentation
-
-Once installed, you can create documentation using the +rdoc+ command
-
-  $ rdoc [options] [names...]
-
-For an up-to-date option summary, type
-
-  $ rdoc --help
-
-A typical use might be to generate documentation for a package of Ruby
-source (such as RDoc itself).
-
-  $ rdoc
-
-This command generates documentation for all the Ruby and C source
-files in and below the current directory.  These will be stored in a
-documentation tree starting in the subdirectory +doc+.
-
-You can make this slightly more useful for your readers by having the
-index page contain the documentation for the primary file.  In our
-case, we could type
-
-  % rdoc --main README.rdoc
-
-You'll find information on the various formatting tricks you can use
-in comment blocks in the documentation this generates.
-
-RDoc uses file extensions to determine how to process each file.  File names
-ending +.rb+ and +.rbw+ are assumed to be Ruby source.  Files
-ending +.c+ are parsed as C files.  All other files are assumed to
-contain just Markup-style markup (with or without leading '#' comment
-markers).  If directory names are passed to RDoc, they are scanned
-recursively for C and Ruby source files only.
-
-To generate documentation using +rake+ see RDoc::Task[https://ruby.github.io/rdoc/RDocTask.html].
-
-To generate documentation programmatically:
-
-  gem 'rdoc'
-  require 'rdoc/rdoc'
-
-  options = RDoc::Options.new
-  # see RDoc::Options
-
-  rdoc = RDoc::RDoc.new
-  rdoc.document options
-  # see RDoc::RDoc
-
-== Writing Documentation
-
-To write documentation for RDoc place a comment above the class, module,
-method, constant, or attribute you want documented:
-
-  ##
-  # This class represents an arbitrary shape by a series of points.
-
-  class Shape
-
-    ##
-    # Creates a new shape described by a +polyline+.
-    #
-    # If the +polyline+ does not end at the same point it started at the
-    # first pointed is copied and placed at the end of the line.
-    #
-    # An ArgumentError is raised if the line crosses itself, but shapes may
-    # be concave.
-
-    def initialize polyline
-      # ...
-    end
-
-  end
-
-The default comment markup format is the RDoc::Markup format.
-TomDoc[rdoc-ref:RDoc::TomDoc], Markdown[rdoc-ref:RDoc::Markdown] and
-RD[rdoc-ref:RDoc::RD] format comments are also supported.  You can set the
-default comment format for your entire project by creating a
-<tt>.rdoc_options</tt> file.  See RDoc::Options@Saved+Options for instructions
-on creating one.  You can also set the comment format for a single file
-through the +:markup:+ directive, but this is only recommended if you wish to
-switch markup formats.  See RDoc::Markup@Other+directives.
-
-Comments can contain directives that tell RDoc information that it cannot
-otherwise discover through parsing.  See RDoc::Markup@Directives to control
-what is or is not documented, to define method arguments or to break up
-methods in a class by topic.  See RDoc::Parser::Ruby for directives used to
-teach RDoc about metaprogrammed methods.
-
-See RDoc::Parser::C for documenting C extensions with RDoc.
-
-To determine how well your project is documented run <tt>rdoc -C lib</tt> to
-get a documentation coverage report.  <tt>rdoc -C1 lib</tt> includes parameter
-names in the documentation coverage report.
-
-== Bugs
-
-See CONTRIBUTING@Bugs for information on filing a bug report.  It's OK to file
-a bug report for anything you're having a problem with.  If you can't figure
-out how to make RDoc produce the output you like that is probably a
-documentation bug.
-
-== License
-
-RDoc is Copyright (c) 2001-2003 Dave Thomas, The Pragmatic Programmers.
-Portions (c) 2007-2011 Eric Hodel.  Portions copyright others, see individual
-files and LEGAL.rdoc for details.
-
-RDoc is free software, and may be redistributed under the terms specified in
-LICENSE.rdoc.
-
-== Warranty
-
-This software is provided "as is" and without any express or implied
-warranties, including, without limitation, the implied warranties of
-merchantability and fitness for a particular purpose.

data/RI.rdoc

@@ -1,57 +0,0 @@
-= RI
-
-+ri+ is a tool that allows Ruby documentation to be viewed on the command-line.
-
-You can use +ri+ to look up information from either the command line or
-interactively.  When you run +ri+ without any arguments it will launch in
-interactive mode.  In interactive mode you can tab-complete class and method
-names.
-
-== Usage
-
-To see information for a class, do:
-  ri ClassName
-
-For example, for the Array class, do:
-  ri Array
-
-To see information on a method on a class, do:
-  ri ClassName.method
-
-This will show both instance and class methods.  For example, the IO
-class defines both IO::read and IO#read:
-  ri IO.read
-
-To see information for an instance method, do:
-  ri ClassName#method_name
-
-For example, for Array's +join+ method, do:
-  ri Array#join
-
-To see information for a class method, do:
-  ri ClassName::method_name
-
-For example, for Module's +private+ method, do:
-  ri Module::private
-
-To read documentation 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:
-
-[<tt>-f</tt>]
-  Outputs ri data using the selected formatter.  You can see the available
-  formatters in <tt>ri --help</tt>
-[<tt>-T</tt>]
-  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.
-
-The +RI_PAGER+ environment variable allows you to choose a particular pager or
-particular options for your pager.
-

data/Rakefile

@@ -1,101 +0,0 @@
-$:.unshift File.expand_path 'lib'
-require 'rdoc/task'
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-task :docs    => :generate
-task :test    => [:normal_test, :rubygems_test]
-
-PARSER_FILES = %w[
-  lib/rdoc/rd/block_parser.ry
-  lib/rdoc/rd/inline_parser.ry
-  lib/rdoc/markdown.kpeg
-  lib/rdoc/markdown/literals.kpeg
-]
-
-$rdoc_rakefile = true
-
-task :default => :test
-
-RDoc::Task.new do |doc|
-  doc.main = 'README.rdoc'
-  doc.title = "rdoc #{RDoc::VERSION} Documentation"
-  doc.rdoc_dir = 'html'
-  doc.rdoc_files = FileList.new %w[lib/**/*.rb *.rdoc] - PARSER_FILES
-end
-
-task ghpages: :rdoc do
-  `git checkout gh-pages`
-  require "fileutils"
-  FileUtils.rm_rf "/tmp/html"
-  FileUtils.mv "html", "/tmp"
-  FileUtils.rm_rf "*"
-  FileUtils.cp_r Dir.glob("/tmp/html/*"), "."
-end
-
-Rake::TestTask.new(:normal_test) do |t|
-  t.libs << "test/rdoc"
-  t.verbose = true
-  t.deps = :generate
-  t.test_files = FileList["test/**/test_*.rb"].exclude("test/rdoc/test_rdoc_rubygems_hook.rb")
-end
-
-Rake::TestTask.new(:rubygems_test) do |t|
-  t.libs << "test/rdoc"
-  t.verbose = true
-  t.deps = :generate
-  t.pattern = "test/rdoc/test_rdoc_rubygems_hook.rb"
-end
-
-path = "pkg/#{Bundler::GemHelper.gemspec.full_name}"
-
-package_parser_files = PARSER_FILES.map do |parser_file|
-  name = File.basename(parser_file, File.extname(parser_file))
-  _path = File.dirname(parser_file)
-  package_parser_file = "#{path}/#{name}.rb"
-  parsed_file = "#{_path}/#{name}.rb"
-
-  file package_parser_file => parsed_file # ensure copy runs before racc
-
-  package_parser_file
-end
-
-parsed_files = PARSER_FILES.map do |parser_file|
-  ext = File.extname(parser_file)
-  parsed_file = "#{parser_file.chomp(ext)}.rb"
-
-  file parsed_file => parser_file do |t|
-    puts "Generating #{parsed_file}..."
-    case ext
-    when '.ry' # need racc
-      racc = Gem.bin_path 'racc', 'racc'
-      rb_file = parser_file.gsub(/\.ry\z/, ".rb")
-      ruby "#{racc} -l -o #{rb_file} #{parser_file}"
-      open(rb_file, 'r+') do |f|
-        newtext = "# frozen_string_literal: true\n#{f.read}"
-        f.rewind
-        f.write newtext
-      end
-    when '.kpeg' # need kpeg
-      kpeg = Gem.bin_path 'kpeg', 'kpeg'
-      rb_file = parser_file.gsub(/\.kpeg\z/, ".rb")
-      ruby "#{kpeg} -fsv -o #{rb_file} #{parser_file}"
-    end
-  end
-
-  parsed_file
-end
-
-task "#{path}.gem" => package_parser_files
-desc "Generate all files used racc and kpeg"
-task :generate => parsed_files
-
-begin
-  require 'rubocop/rake_task'
-rescue LoadError
-else
-  RuboCop::RakeTask.new(:rubocop) do |t|
-    t.options = [*parsed_files]
-  end
-  task :build => [:generate]#, "rubocop:auto_correct"]
-end

data/bin/console

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "rdoc"
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install

data/lib/rdoc/anon_class.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-##
-# An anonymous class like:
-#
-#   c = Class.new do end
-#
-# AnonClass is currently not used.
-
-class RDoc::AnonClass < RDoc::ClassModule
-end
-