Bartłomiej Syguła > Devel-CoverReport > Devel::CoverReport::Formatter

Download:
Devel-CoverReport-0.05.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 0.05   Source  

DESCRIPTION ^

Base class for report formatters.

WARNING ^

Consider this module to be an early ALPHA. It does the job for me, so it's here.

This is my first CPAN module, so I expect that some things may be a bit rough around edges.

The plan is, to fix both those issues, and remove this warning in next immediate release.

API ^

new

Constructor for report formatters derived from Devel::CoverReport::Formatter.

add_report

Open new report.

Parameters: $self + (HASH) code - report codename, used to uniquely identify a report. basename - file, where report will be saved. Without extension. title - short title for the report.

close_report

Close selected report, format it and write to disk.

Parameters: (ARRAY) $self $code - report's code.

add_table

Add table to the report.

Parameters: (ARRAY) $self $report_code - codename of the report, to which new table will be appended. $table_code - table's codename, must be unique withing single report. $table_params - parameters for the Devel::CoverReport::Table object.

Returns: $table_object - Devel::CoverReport::Table object.

finalize

Clean-up formatter (flush what was not flushed yet, etc).

process_formatter_start

This method should be overwritten - according to taste - in child classes.

process_report_start

This method should be overwritten - according to taste - in child classes.

process_table_start

This method should be overwritten - according to taste - in child classes.

process_row

This method should be overwritten - according to taste - in child classes.

process_summary

This method should be overwritten - according to taste - in child classes.

process_table_end

This method should be overwritten - according to taste - in child classes.

process_report_end

This method should be overwritten - according to taste - in child classes.

process_formatter_end

This method should be overwritten - according to taste - in child classes.

LICENCE ^

Copyright 2009-2011, Bartłomiej Syguła (perl@bs502.pl)

This is free software. It is licensed, and can be distributed under the same terms as Perl itself.

For more, see my website: http://bs502.pl/

syntax highlighting: