This is a set of documentation generation utilities that we used for
a project we worked on for our employers.  

It's not perfect.  It's not polished, but it works.

We thought it might be useful so we're releasing it.  

Kyle R. Burton
Wed Jan 17 11:12:22 EST 2001



lineage.pl
--------------------------------------------------------------------------------
This program takes a path and searches the path for .pm files, parsing
them to gather the package name, methods, and fields.  Once it has
parsed that basic information it figures out the parents and children 
of each of the packages via the ISA arrays.

  ./lineage.pl <path> > output_from_lineage.txt

from_pm.pl
--------------------------------------------------------------------------------
This program is designed to parse the output of lineage.pl, which it then
uses [in combination with HTML::Embperl] to produce XML files for the 
Dia program.  The generated XML files are simple UML diagrams that show
the member variables [fields] and methods for the object.

To create the interlinked html doc:

  ./from_pm.pl < output_from_lineage.txt

to create the Dia XML UML diagrams:

  ./from_pm.pl -x < output_from_lineage.txt