NAME

Code::Statistics::Metric - base class for Code::Statistic metrics

VERSION

version 1.102370

measure Returns the metric of the given target. Is called with the metric class name and a target object of unspecified type. This function should be overridden with specific logic to actually retrieve the metric data.

incompatible_with Returns true if the given target is explicitly not supported by this metric. Is called with the metric class name and a string representing the target identifiers after 'Code::Statistics::Target::'. Default is that all metrics are compatible with all targets.

force_support Returns true if the given target is forcibly supported by this metric. Is called with the metric class name and a string representing the target identifiers after 'Code::Statistics::Target::'. Default is that no forcing happens.

Has higher precedence than 'incompatible_with' and should be used to
override incompatibilities set by other targets.

short_name Allows a metric to return a short name, which can be used by shell report builders for example. Default is the class name, with 'Code::Statistics::Metric::' stripped out. Override to customize.

is_insignificant Returns true if the metric is considered statistically insignificant. Default is false.

AUTHOR

Christian Walde <mithaldu@yahoo.de>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2010 by Christian Walde.

This is free software, licensed under:

DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE, Version 2, December 2004