1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

Complete RDoc namespace change

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@15018 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
drbrain 2008-01-13 03:13:37 +00:00
parent 937b7ab8b5
commit ec519b9b43
15 changed files with 45 additions and 46 deletions

View file

@ -219,7 +219,7 @@ Options are:
[<tt>--template</tt> <i>name</i>] [<tt>--template</tt> <i>name</i>]
specify an alternate template to use when generating output (the specify an alternate template to use when generating output (the
default is 'standard'). This template should be in a directory default is 'standard'). This template should be in a directory
accessible via $: as rdoc/generators/xxxx_template, where 'xxxx' accessible via $: as rdoc/generator/xxxx_template, where 'xxxx'
depends on the output formatter. depends on the output formatter.
[<tt>--version</tt>] [<tt>--version</tt>]

View file

@ -4,7 +4,7 @@ require 'rdoc/options'
require 'rdoc/markup/simple_markup' require 'rdoc/markup/simple_markup'
require 'rdoc/template' require 'rdoc/template'
module RDoc::Generators module RDoc::Generator
## ##
# Name of sub-direcory that holds file descriptions # Name of sub-direcory that holds file descriptions

View file

@ -1,6 +1,6 @@
require 'rdoc/generators/html' require 'rdoc/generator/html'
class RDoc::Generators::CHM < RDoc::Generators::HTML class RDoc::Generator::CHM < RDoc::Generator::HTML
HHC_PATH = "c:/Program Files/HTML Help Workshop/hhc.exe" HHC_PATH = "c:/Program Files/HTML Help Workshop/hhc.exe"

View file

@ -1,9 +1,9 @@
require 'rdoc/generators/chm' require 'rdoc/generator/chm'
require 'rdoc/generators/html/html' require 'rdoc/generator/html/html'
module RDoc::Generators::CHM::CHM module RDoc::Generator::CHM::CHM
HTML = RDoc::Generators::HTML::HTML HTML = RDoc::Generator::HTML::HTML
INDEX = HTML::INDEX INDEX = HTML::INDEX

View file

@ -1,9 +1,9 @@
require 'fileutils' require 'fileutils'
require 'rdoc/generators' require 'rdoc/generator'
require 'rdoc/markup/simple_markup/to_html' require 'rdoc/markup/simple_markup/to_html'
module RDoc::Generators module RDoc::Generator
## ##
# Build a hash of all items that can be cross-referenced. # Build a hash of all items that can be cross-referenced.
@ -61,8 +61,8 @@ module RDoc::Generators
# (defined in MarkUp). If we fine the corresponding reference, # (defined in MarkUp). If we fine the corresponding reference,
# generate a hyperlink. If the name we're looking for contains # generate a hyperlink. If the name we're looking for contains
# no punctuation, we look for it up the module/class chain. For # no punctuation, we look for it up the module/class chain. For
# example, HyperlinkHtml is found, even without the Generators:: # example, HyperlinkHtml is found, even without the Generator::
# prefix, because we look for it in module Generators first. # prefix, because we look for it in module Generator first.
def handle_special_CROSSREF(special) def handle_special_CROSSREF(special)
name = special.text name = special.text
@ -1168,7 +1168,7 @@ module RDoc::Generators
end end
## ##
# Generators may need to return specific subclasses depending on the # Generator may need to return specific subclasses depending on the
# options they are passed. Because of this we create them using a factory # options they are passed. Because of this we create them using a factory
def self.for(options) def self.for(options)
@ -1221,8 +1221,8 @@ module RDoc::Generators
template = @options.template template = @options.template
unless template =~ %r{/|\\} then unless template =~ %r{/|\\} then
template = File.join("rdoc/generators", template = File.join('rdoc', 'generator', @options.generator.key,
@options.generator.key, template) template)
end end
require template require template

View file

@ -1,7 +1,7 @@
require 'rdoc/generators/html' require 'rdoc/generator/html'
require 'rdoc/generators/html/html' require 'rdoc/generator/html/html'
module RDoc::Generators::HTML::HEFSS module RDoc::Generator::HTML::HEFSS
FONTS = "Verdana, Arial, Helvetica, sans-serif" FONTS = "Verdana, Arial, Helvetica, sans-serif"

View file

@ -1,5 +1,5 @@
require 'rdoc/generators/html' require 'rdoc/generator/html'
require 'rdoc/generators/html/one_page_html' require 'rdoc/generator/html/one_page_html'
## ##
# = CSS2 RDoc HTML template # = CSS2 RDoc HTML template
@ -21,7 +21,7 @@ require 'rdoc/generators/html/one_page_html'
# send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California # send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California
# 94305, USA. # 94305, USA.
module RDoc::Generators::HTML::HTML module RDoc::Generator::HTML::HTML
FONTS = "Verdana,Arial,Helvetica,sans-serif" FONTS = "Verdana,Arial,Helvetica,sans-serif"

View file

@ -1,6 +1,6 @@
require 'rdoc/generators/html' require 'rdoc/generator/html'
module RDoc::Generators::HTML::KILMER module RDoc::Generator::HTML::KILMER
FONTS = "Verdana, Arial, Helvetica, sans-serif" FONTS = "Verdana, Arial, Helvetica, sans-serif"

View file

@ -1,6 +1,6 @@
require 'rdoc/generators/html' require 'rdoc/generator/html'
module RDoc::Generators::HTML::ONE_PAGE_HTML module RDoc::Generator::HTML::ONE_PAGE_HTML
CONTENTS_XML = <<-EOF CONTENTS_XML = <<-EOF
<% if defined? classes and classes["description"] then %> <% if defined? classes and classes["description"] then %>

View file

@ -1,4 +1,4 @@
require 'rdoc/generators' require 'rdoc/generator'
require 'rdoc/markup/simple_markup/to_flow' require 'rdoc/markup/simple_markup/to_flow'
require 'rdoc/ri/cache' require 'rdoc/ri/cache'
@ -6,10 +6,10 @@ require 'rdoc/ri/reader'
require 'rdoc/ri/writer' require 'rdoc/ri/writer'
require 'rdoc/ri/descriptions' require 'rdoc/ri/descriptions'
class RDoc::Generators::RI class RDoc::Generator::RI
## ##
# Generators may need to return specific subclasses depending on the # Generator may need to return specific subclasses depending on the
# options they are passed. Because of this we create them using a factory # options they are passed. Because of this we create them using a factory
def self.for(options) def self.for(options)
@ -21,7 +21,7 @@ class RDoc::Generators::RI
end end
## ##
# Set up a new RDoc::Generators::RI. # Set up a new RDoc::Generator::RI.
def initialize(options) #:not-new: def initialize(options) #:not-new:
@options = options @options = options

View file

@ -1,9 +1,9 @@
require 'rdoc/generators/html' require 'rdoc/generator/html'
## ##
# Generate XML output as one big file # Generate XML output as one big file
class RDoc::Generators::XML < RDoc::Generators::HTML class RDoc::Generator::XML < RDoc::Generator::HTML
## ##
# Standard generator factory # Standard generator factory
@ -42,16 +42,16 @@ class RDoc::Generators::XML < RDoc::Generators::HTML
def build_indices def build_indices
@info.each do |toplevel| @info.each do |toplevel|
@files << RDoc::Generators::HtmlFile.new(toplevel, @options, RDoc::Generators::FILE_DIR) @files << RDoc::Generator::HtmlFile.new(toplevel, @options, RDoc::Generator::FILE_DIR)
end end
RDoc::TopLevel.all_classes_and_modules.each do |cls| RDoc::TopLevel.all_classes_and_modules.each do |cls|
build_class_list(cls, @files[0], RDoc::Generators::CLASS_DIR) build_class_list(cls, @files[0], RDoc::Generator::CLASS_DIR)
end end
end end
def build_class_list(from, html_file, class_dir) def build_class_list(from, html_file, class_dir)
@classes << RDoc::Generators::HtmlClass.new(from, html_file, class_dir, @options) @classes << RDoc::Generator::HtmlClass.new(from, html_file, class_dir, @options)
from.each_classmodule do |mod| from.each_classmodule do |mod|
build_class_list(mod, html_file, class_dir) build_class_list(mod, html_file, class_dir)
end end
@ -98,7 +98,7 @@ class RDoc::Generators::XML < RDoc::Generators::HTML
end end
def gen_method_index def gen_method_index
gen_an_index(RDoc::Generators::HtmlMethod.all_methods, 'Methods') gen_an_index(RDoc::Generator::HtmlMethod.all_methods, 'Methods')
end end
def gen_an_index(collection, title) def gen_an_index(collection, title)

View file

@ -1,6 +1,6 @@
require 'rdoc/generators/xml' require 'rdoc/generator/xml'
module RDoc::Generators::XML::RDF module RDoc::Generator::XML::RDF
CONTENTS_RDF = <<-EOF CONTENTS_RDF = <<-EOF
<% if defined? classes and classes["description"] then %> <% if defined? classes and classes["description"] then %>

View file

@ -1,6 +1,6 @@
require 'rdoc/generators/xml' require 'rdoc/generator/xml'
module RDoc::Generators::XML::XML module RDoc::Generator::XML::XML
CONTENTS_XML = <<-EOF CONTENTS_XML = <<-EOF
<% if defined? classes and classes["description"] then %> <% if defined? classes and classes["description"] then %>

View file

@ -135,7 +135,7 @@ class RDoc::Options
## ##
# Template class for file generation # Template class for file generation
#-- #--
# HACK around dependencies in lib/rdoc/generators/html.rb # HACK around dependencies in lib/rdoc/generator/html.rb
attr_accessor :template_class # :nodoc: attr_accessor :template_class # :nodoc:

View file

@ -57,21 +57,20 @@ module RDoc
Generator = Struct.new(:file_name, :class_name, :key) Generator = Struct.new(:file_name, :class_name, :key)
## ##
# This is the list of output generators that we # This is the list of output generator that we support
# support
GENERATORS = {} GENERATORS = {}
$LOAD_PATH.collect do |d| $LOAD_PATH.collect do |d|
File.expand_path d File.expand_path d
end.find_all do |d| end.find_all do |d|
File.directory? "#{d}/rdoc/generators" File.directory? "#{d}/rdoc/generator"
end.each do |dir| end.each do |dir|
Dir.entries("#{dir}/rdoc/generators").each do |gen| Dir.entries("#{dir}/rdoc/generator").each do |gen|
next unless /(\w+)\.rb$/ =~ gen next unless /(\w+)\.rb$/ =~ gen
type = $1 type = $1
unless GENERATORS.has_key? type unless GENERATORS.has_key? type
GENERATORS[type] = Generator.new("rdoc/generators/#{gen}", GENERATORS[type] = Generator.new("rdoc/generator/#{gen}",
"#{type.upcase}".intern, "#{type.upcase}".intern,
type) type)
end end
@ -266,7 +265,7 @@ module RDoc
require gen.file_name require gen.file_name
gen_class = Generators.const_get(gen.class_name) gen_class = ::RDoc::Generator.const_get gen.class_name
gen = gen_class.for(options) gen = gen_class.for(options)
pwd = Dir.pwd pwd = Dir.pwd