/ 
DMOSS-0.01_1
River stage zero No dependents
/ DMOSS::Plugin

NAME

DMOSS::Plugin - DMOSS base class for plugins

VERSION

version 0.01_1

SYNOPSIS

package DMOSS::Plugin::MyPlugin;
use parent qw/DMOSS::Plugin/;

DESCRIPTION

This should be the base class for all DMOSS plugins. The main functions a plugin needs to overwrite are:

name

This function returns the name of the plugin.

process

This function is used process each file, and it create attributes to add to the package tree.

reduce

This function is used to reduce resutls from different files to a single attribute.

report

This function returns the report snippet for each attribute. If the return value is a reference to a list a table is created in the final report.

report_headers

This function can be used to return a reference to a list that contains the column headers for the table of attributes reports.

grade

This function grades the software package, it should return a value between 0 and 1.

EXAMPLES

For examples view the DMOSS::Plugin::* included in this distribution.

AUTHOR

Nuno Carvalho <smash@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Project Natura <natura@natura.di.uminho.pt>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.