Class

RDoc::Diagram

Inheritance
< Object

Draw a set of diagrams representing the modules and classes in the system. We draw one diagram for each file, and one for each toplevel class or module. This means there will be overlap. However, it also means that you‘ll get better context for objects.

To use, simply

  d = Diagram.new(info)   # pass in collection of top level infos
  d.draw

The results will be written to the dot subdirectory. The process also sets the diagram attribute in each object it graphs to the name of the file containing the image. This can be used by output generators to insert images.

Constants

Name   Description
DOT_PATH = "dot"
FONT = "Arial"

Methods

Class

Visibility Signature
public new (info, options)

Instance

Visibility Signature
public draw ()

Class Method Detail

new(info, options)

Pass in the set of top level objects. The method also creates the subdirectory to hold the images

Instance Method Detail

draw()

Draw the diagrams. We traverse the files, drawing a diagram for each. We also traverse each top-level class and module in that file drawing a diagram for these too.