.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Perl::Critic::Statistics 3pm" .TH Perl::Critic::Statistics 3pm 2023-07-26 "perl v5.38.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME Perl::Critic::Statistics \- Compile stats on Perl::Critic violations. .SH DESCRIPTION .IX Header "DESCRIPTION" This class accumulates statistics on Perl::Critic violations across one or more files. NOTE: This class is experimental and subject to change. .SH "INTERFACE SUPPORT" .IX Header "INTERFACE SUPPORT" This is considered to be a non-public class. Its interface is subject to change without notice. .SH METHODS .IX Header "METHODS" .ie n .IP new() 4 .el .IP \f(CWnew()\fR 4 .IX Item "new()" Create a new instance of Perl::Critic::Statistics. No arguments are supported at this time. .ie n .IP """ accumulate( $doc, \e@violations ) """ 4 .el .IP "\f(CW accumulate( $doc, \e@violations ) \fR" 4 .IX Item " accumulate( $doc, @violations ) " Accumulates statistics about the \f(CW$doc\fR and the \f(CW@violations\fR that were found. .ie n .IP modules() 4 .el .IP \f(CWmodules()\fR 4 .IX Item "modules()" The number of chunks of code (usually files) that have been analyzed. .ie n .IP subs() 4 .el .IP \f(CWsubs()\fR 4 .IX Item "subs()" The total number of subroutines analyzed by this Critic. .ie n .IP statements() 4 .el .IP \f(CWstatements()\fR 4 .IX Item "statements()" The total number of statements analyzed by this Critic. .ie n .IP lines() 4 .el .IP \f(CWlines()\fR 4 .IX Item "lines()" The total number of lines of code analyzed by this Critic. .ie n .IP lines_of_blank() 4 .el .IP \f(CWlines_of_blank()\fR 4 .IX Item "lines_of_blank()" The total number of blank lines analyzed by this Critic. This includes only blank lines in code, not POD or data. .ie n .IP lines_of_comment() 4 .el .IP \f(CWlines_of_comment()\fR 4 .IX Item "lines_of_comment()" The total number of comment lines analyzed by this Critic. This includes only lines whose first non-whitespace character is \f(CW\*(C`#\*(C'\fR. .ie n .IP lines_of_data() 4 .el .IP \f(CWlines_of_data()\fR 4 .IX Item "lines_of_data()" The total number of lines of data section analyzed by this Critic, not counting the \f(CW\*(C`_\|_END_\|_\*(C'\fR or \f(CW\*(C`_\|_DATA_\|_\*(C'\fR line. POD in a data section is counted as POD, not data. .ie n .IP lines_of_perl() 4 .el .IP \f(CWlines_of_perl()\fR 4 .IX Item "lines_of_perl()" The total number of lines of Perl code analyzed by this Critic. Perl appearing in the data section is not counted. .ie n .IP lines_of_pod() 4 .el .IP \f(CWlines_of_pod()\fR 4 .IX Item "lines_of_pod()" The total number of lines of POD analyzed by this Critic. Pod occurring in a data section is counted as POD, not as data. .ie n .IP violations_by_severity() 4 .el .IP \f(CWviolations_by_severity()\fR 4 .IX Item "violations_by_severity()" The number of violations of each severity found by this Critic as a reference to a hash keyed by severity. .ie n .IP violations_by_policy() 4 .el .IP \f(CWviolations_by_policy()\fR 4 .IX Item "violations_by_policy()" The number of violations of each policy found by this Critic as a reference to a hash keyed by full policy name. .ie n .IP total_violations() 4 .el .IP \f(CWtotal_violations()\fR 4 .IX Item "total_violations()" The total number of violations found by this Critic. .ie n .IP statements_other_than_subs() 4 .el .IP \f(CWstatements_other_than_subs()\fR 4 .IX Item "statements_other_than_subs()" The total number of statements minus the number of subroutines. Useful because a subroutine is considered a statement by PPI. .ie n .IP average_sub_mccabe() 4 .el .IP \f(CWaverage_sub_mccabe()\fR 4 .IX Item "average_sub_mccabe()" The average McCabe score of all scanned subroutines. .ie n .IP violations_per_file() 4 .el .IP \f(CWviolations_per_file()\fR 4 .IX Item "violations_per_file()" The total violations divided by the number of modules. .ie n .IP violations_per_statement() 4 .el .IP \f(CWviolations_per_statement()\fR 4 .IX Item "violations_per_statement()" The total violations divided by the number statements minus subroutines. .ie n .IP violations_per_line_of_code() 4 .el .IP \f(CWviolations_per_line_of_code()\fR 4 .IX Item "violations_per_line_of_code()" The total violations divided by the lines of code. .SH AUTHOR .IX Header "AUTHOR" Elliot Shank \f(CW\*(C`\*(C'\fR .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright (c) 2007\-2011 Elliot Shank. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module.