.\" -*- 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::PolicyListing 3pm"
.TH Perl::Critic::PolicyListing 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::PolicyListing \- Display minimal information about Policies.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a helper class that formats a set of Policy objects for
pretty-printing.  There are no user-serviceable parts here.
.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 CONSTRUCTOR
.IX Header "CONSTRUCTOR"
.ie n .IP """new( \-policies => \e@POLICY_OBJECTS )""" 4
.el .IP "\f(CWnew( \-policies => \e@POLICY_OBJECTS )\fR" 4
.IX Item "new( -policies => @POLICY_OBJECTS )"
Returns a reference to a new \f(CW\*(C`Perl::Critic::PolicyListing\*(C'\fR object.
.SH METHODS
.IX Header "METHODS"
.IP \fBto_string()\fR 4
.IX Item "to_string()"
Returns a string representation of this \f(CW\*(C`PolicyListing\*(C'\fR.  See
"OVERLOADS" for more information.
.SH OVERLOADS
.IX Header "OVERLOADS"
When a Perl::Critic::PolicyListing is
evaluated in string context, it produces a one-line summary of the
default severity, policy name, and default themes for each
Perl::Critic::Policy object that was given to
the constructor of this \f(CW\*(C`PolicyListing\*(C'\fR.
.SH AUTHOR
.IX Header "AUTHOR"
Jeffrey Ryan Thalhammer <jeff@imaginative\-software.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2005\-2011 Imaginative Software Systems.  All rights reserved.
.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.