class
Ruby latest stable (v2_5_5)
-
0 notes
- Superclass:
Object
- 1_8_6_287
- 1_8_7_72
- 1_8_7_330
- 1_9_1_378 (0)
- 1_9_2_180
- 1_9_3_125
- 1_9_3_392
- 2_1_10
- 2_2_9
- 2_4_6
- 2_5_5
- 2_6_3
- What's this?
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.
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.