debian man page for devel::cover::db

Devel::Cover::DB(3pm)					User Contributed Perl Documentation				     Devel::Cover::DB(3pm)

NAME
       Devel::Cover::DB - Code coverage metrics for Perl

VERSION
       version 0.89

SYNOPSIS
	use Devel::Cover::DB;

	my $db = Devel::Cover::DB->new(db => "my_coverage_db");
	$db->print_summary(statement => 1, pod => 1);
	$db->print_details;

DESCRIPTION
       This module provides access to a database of code coverage information.

METHODS
   new
	my $db = Devel::Cover::DB->new(db => "my_coverage_db");

       Contructs the DB from the specified database.

   cover
	my $cover = $db->cover;

       Returns a Devel::Cover::DB::Cover object.  From here all the coverage data may be accessed.

	my $cover = $db->cover;
	for my $file ($cover->items)
	{
	    print "$file
";
	    my $f = $cover->file($file);
	    for my $criterion ($f->items)
	    {
		print "  $criterion
";
		my $c = $f->criterion($criterion);
		for my $location ($c->items)
		{
		    my $l = $c->location($location);
		    print "    $location @$l
";
		}
	    }
	}

       Data for different criteria will be in different formats, so that will need special handling.  This is not yet documented so your best bet
       for now is to look at some of the simpler reports and/or the source.

       The methods in the above example are actually aliases for methods in Devel::Cover::DB::Base (the base class for all Devel::Cover::DB::*
       classes):

       o   Devel::Cover::DB::Base->values

	   Aliased to Devel::Cover::DB::Cover->files, Devel::Cover::DB::File->criteria, Devel::Cover::DB::Criterion->locations, and
	   Devel::Cover::DB::Location->data

       o   Devel::Cover::DB::Base->get

	   Aliased to Devel::Cover::DB::Cover->file, Devel::Cover::DB::File->criteriom, Devel::Cover::DB::Criterion->location, and
	   Devel::Cover::DB::Location->datum

       Instead of calling $file->criterion("x") you can also call $file->x.

   is_valid
	my $valid = $db->is_valid;

       Returns true if $db is valid (or looks valid, the function is too lax).

SEE ALSO
	Devel::Cover
	Devel::Cover::DB::Base
	Devel::Cover::DB::Cover
	Devel::Cover::DB::File
	Devel::Cover::DB::Criterion
	Devel::Cover::DB::Location

BUGS
       Huh?

LICENCE
       Copyright 2001-2012, Paul Johnson (paul@pjcj.net)

       This software is free.  It is licensed under the same terms as Perl itself.

       The latest version of this software should be available from my homepage: http://www.pjcj.net

perl v5.14.2							    2012-06-15						     Devel::Cover::DB(3pm)