/**** * * Class RSLDoc is the top-level class of the RSL documentation generator. * RSLDoc uses the following subsidiary classes to generate the components * of the HTML documentation: * * Class Component Generated * ==================================================================== * RSLToDict Object and operation dictionaries * RSLIndex Module, object, and operation indices * RSLDetails Obj and op details files, using javascript functions. * RSLToUML UML-style diagrams * RSLToDFD Dataflow diagrams * * In the current implementation, only the RSLToDict class is defined; it * includes a preliminary version of index generation that will be moved to the * RSLIndex class in the next version of the system. The other three classes * are future work. * * The layout details of the documentation are given in the rsldoc reference * manual, q.v. The following is a summary of the html files that comprise the * documentation: * * File Description * ====================================================================== * index Index with frames. * * module-index Upper left frame, listing all the modules by * name. * * all-objs-index Middle left frame, listing all objects by name. * m1-objs-index Middle left frame, listing all objects in * module M1 by name. * ... * * mn-objs-index Middle left frame, listing all objects in * module Mn by name. * * all-ops-index Lower left frame, listing all operations by * name. * m1-ops-index Lower left frame, listing all operations in * module M1 by name. * ... * * mn-ops-index Lower left frame, listing all operations in * module Mn by name. * * all-dict Upper right frame, containing dictionary for * all objects and operations. * m1-dict Upper right frame, containing dictionary for * objects and operations in module M1. * ... * * mn-dict Upper right frame, containing dictionary for * objects and operations in module Mn. * * all-details Lower right frame, containing def details for * all objects and operations. * m1-details Lower right frame, containing def details for * objects and operations in module M1. * ... * * mn-details Lower right frame, containing def details for * objects and operations in module Mn. * */