Autodia.pm - The configuration and Utility perl module for AutoDia.
AutoDia takes source files as input and using a handler parses them to create documentation through templates. The handlers allow AutoDia to parse any language by providing a handler and registering in in autodia.pm. The templates allow the output to be heavily customised from Dia XML to simple HTML and seperates the logic of the application from the presentation of the results.
AutoDia is written in perl and defaults to the perl handler and file extension matching unless a language is specified using the -l switch.
AutoDia requires Template Toolkit and Perl 5. Some handlers and templates may require additional software.
Helpful information, links and news can be found at the autodia website - http://www.aarontrevena.co.uk/opensource/autodia/
To add handlers or languages edit this file.
Add the language or name of the parser and the name of the module to the %handlers hash in the getHandlers function.
for example :
"perl" => 'HandlerPerl',
Documentation on writing your own handler can be found in the HandlerPerl and Handler perl modules
Add the name of the pattern and a hashreference to its properties to %patterns in the get_patterns function.
"perl" => \%perl,
Create a hash of its properties that will be pointed to by the above hashref
my %perl = ( regex => '\w+\.p[ml]$', wildcards => [ "pl", "pm", ], );
use the autodia.pl script to run autodia.
Aaron Trevena, <email@example.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.
To install Autodia, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.