Class RDoc::Generator::XML
In: lib/rdoc/generator/xml.rb
Parent: RDoc::Generator::HTML

Generate XML output as one big file

Methods

build_class_list   build_indices   for   gen_an_index   gen_class_index   gen_file_index   gen_into   gen_method_index   generate   generate_xml   new  

Classes and Modules

Module RDoc::Generator::XML::RDF
Module RDoc::Generator::XML::XML

Public Class methods

for(options)

Standard generator factory

Public Instance methods

build_indices()

Generate:

  • a list of HtmlFile objects for each TopLevel object.
  • a list of HtmlClass objects for each first level class or module in the TopLevel objects
  • a complete list of all hyperlinkable terms (file, class, module, and method names)
generate(info)

Build the initial indices and output objects based on an array of TopLevel objects containing the extracted information.

generate_xml()

Generate all the HTML. For the one-file case, we generate all the information in to one big hash

[Validate]

ruby-doc.org is a community service provided by James Britt and Happy Camper Studios, a Phoenix, Arizona, Ruby application development company.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.