Class RDoc::Generator::HTML
In: lib/rdoc/generator/html.rb
Parent: Object

We‘re responsible for generating all the HTML files from the object tree defined in code_objects.rb. We generate:

files
an html file for each input file given. These input files appear as objects of class TopLevel
classes
an html file for each class or module encountered. These classes are not grouped by file: if a file contains four classes, we‘ll generate an html file for the file itself, and four html files for the individual classes.
indices
we generate three indices for files, classes, and methods. These are displayed in a browser like window with three index panes across the top and the selected description below

Method descriptions appear in whatever entity (file, class, or module) that contains them.

We generate files in a structure below a specified subdirectory, normally doc. 

 opdir
    |
    |___ files
    |       |__  per file summaries
    |
    |___ classes
            |__ per class/module descriptions

HTML is generated using the Template class.

Methods

for   generate   new  

Included Modules

RDoc::Generator::MarkUp

Public Class methods

for(options)

Generator may need to return specific subclasses depending on the options they are passed. Because of this we create them using a factory

new(options)

Set up a new HTML generator. Basically all we do here is load up the correct output temlate

Public Instance methods

generate(toplevels)

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

[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.