NAME

UML::Sequence - This package makes UML sequence diagrams, often by running the code.

SYNOPSIS

use UML::Sequence;

my $tree = UML::Sequence->new(\@methods, \@outline, \&parse_method);
print $tree->build_xml_sequence('Title');

DESCRIPTION

To use this package, or see how to use it, see genericseq.pl and seq2svg.pl.

This class helps produce UML sequence diagrams. build_xml_sequence returns a string (suitable for printing to a file) which the seq2svg.pl script converts into svg.

To control the appearance of the sequence diagram, pass to the constructor:

1 a reference to an array containing the signatures you want to hear about or a reference to a hash whose keys are the signatures you want 2 a reference to an array containing the lines in the outline of calls 3 a reference to a sub which takes signatures and returns class and method names

To build the array references and supply the code reference consult UML::Sequence::SimpleSeq, UML::Sequence::JavaSeq, or UML::Sequence::PerlSeq. To see one way to call these look in the supplied genericseq script.

EXPORT

None, this module is object oriented.

EDIT HISTORY

0.01 Jan 2003  Initial release.
0.02 Feb 2003  Corrected diagrams so separate instances have their own life
               lines.
               Included samples directory with instructions for producing
               the samples (see samples/README in the distribution).
0.03 Mar 2003  See Changes file (this release didn't affect this file)

AUTHOR

Phil Crow, <philcrow2000@yahoo.com>

SEE ALSO

genericseq.pl seq2svg.pl

COPYRIGHT

Copyright 2003, Philip Crow, all rights reserved. You may modify and/or redistribute this code in the same manner as Perl itself.