oracular (3) Autodia::Handler::Perl.3pm.gz

Provided by: autodia_2.14-5_all bug

NAME
       Autodia::Handler::Perl.pm - AutoDia handler for perl


DESCRIPTION
       HandlerPerl parses files into a Diagram Object, which all handlers use. The role of the handler is to
       parse through the file extracting information such as Class names, attributes, methods and properties.

       HandlerPerl parses files using simple perl rules. A possible alternative would be to write HandlerCPerl
       to handle C style perl or HandleHairyPerl to handle hairy perl.

       HandlerPerl is registered in the Autodia.pm module, which contains a hash of language names and the name
       of their respective language - in this case:

       %language_handlers = { .. , perl => "perlHandler", .. };


METHODS
   CONSTRUCTION METHOD
       use Autodia::Handler::Perl;

       my $handler = Autodia::Handler::Perl->New(\%Config);

       This creates a new handler using the Configuration hash to provide rules selected at the command line.

   ACCESSOR METHODS
       $handler->Parse(filename); # where filename includes full or relative path.

       This parses the named file and returns 1 if successful or 0 if the file could not be opened.

       $handler->output(); # any arguments are ignored.

       This outputs the Dia XML file according to the rules in the %Config hash passed at initialisation of the
       object.


SEE ALSO
       Autodia::Handler

       Autodia::Diagram


AUTHOR
       Aaron Trevena, <aaron.trevena@gmail.com>


       Copyright (C) 2001-2007 by Aaron Trevena

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl
       itself, either Perl version 5.8.1 or, at your option, any later version of Perl 5 you may have available.