Last Modified
2016-08-02 17:58:22 -0500
Requires
  • ftools
  • rdoc/options
  • rdoc/template
  • rdoc/markup/simple_markup
  • rdoc/markup/simple_markup/to_flow
  • cgi
  • rdoc/ri/ri_cache
  • rdoc/ri/ri_reader
  • rdoc/ri/ri_writer
  • rdoc/ri/ri_descriptions

Description

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.