summaryrefslogtreecommitdiff
path: root/lib/rdoc/generators/xml_generator.rb
diff options
context:
space:
mode:
authordrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2008-01-07 00:42:03 +0000
committerdrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2008-01-07 00:42:03 +0000
commitb0f13cfebec316491909e312608834c87792ca9f (patch)
treec112e9d435bdc587b43a841b06045bcf15cc74af /lib/rdoc/generators/xml_generator.rb
parentee6abe32523845d5c63f1c3bd23ecf555f4d0827 (diff)
Clean up comments and whitespace in RDoc generators
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@14919 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/rdoc/generators/xml_generator.rb')
-rw-r--r--lib/rdoc/generators/xml_generator.rb16
1 files changed, 8 insertions, 8 deletions
diff --git a/lib/rdoc/generators/xml_generator.rb b/lib/rdoc/generators/xml_generator.rb
index 561a9ad694..8034fac517 100644
--- a/lib/rdoc/generators/xml_generator.rb
+++ b/lib/rdoc/generators/xml_generator.rb
@@ -1,4 +1,3 @@
-
require 'rdoc/options'
require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
@@ -6,16 +5,18 @@ require 'rdoc/generators/html_generator'
module Generators
+ ##
# Generate XML output as one big file
class XMLGenerator < HTMLGenerator
+ ##
# Standard generator factory
+
def XMLGenerator.for(options)
XMLGenerator.new(options)
end
-
def initialize(*args)
super
end
@@ -23,7 +24,7 @@ module Generators
##
# Build the initial indices and output objects
# based on an array of TopLevel objects containing
- # the extracted information.
+ # the extracted information.
def generate(info)
@info = info
@@ -35,7 +36,6 @@ module Generators
generate_xml
end
-
##
# Generate:
#
@@ -66,14 +66,14 @@ module Generators
##
# Generate all the HTML. For the one-file case, we generate
# all the information in to one big hash
- #
+
def generate_xml
- values = {
+ values = {
'charset' => @options.charset,
'files' => gen_into(@files),
'classes' => gen_into(@classes)
}
-
+
# this method is defined in the template file
write_extra_pages if defined? write_extra_pages
@@ -107,7 +107,6 @@ module Generators
gen_an_index(HtmlMethod.all_methods, 'Methods')
end
-
def gen_an_index(collection, title)
res = []
collection.sort.each do |f|
@@ -126,3 +125,4 @@ module Generators
end
end
+