.\" -*- 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::PolicyConfig 3pm"
.TH Perl::Critic::PolicyConfig 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::PolicyConfig \- Configuration data for a Policy.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A container for the configuration of a Policy.
.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 get_policy_short_name() 4
.el .IP \f(CWget_policy_short_name()\fR 4
.IX Item "get_policy_short_name()"
The name of the policy this configuration is for.  Primarily here for
the sake of debugging.
.ie n .IP " get_set_themes() " 4
.el .IP "\f(CW get_set_themes() \fR" 4
.IX Item " get_set_themes() "
The value of \f(CW\*(C`set_themes\*(C'\fR in the user's \fI.perlcriticrc\fR.
.ie n .IP " get_add_themes() " 4
.el .IP "\f(CW get_add_themes() \fR" 4
.IX Item " get_add_themes() "
The value of \f(CW\*(C`add_themes\*(C'\fR in the user's \fI.perlcriticrc\fR.
.ie n .IP " get_severity() " 4
.el .IP "\f(CW get_severity() \fR" 4
.IX Item " get_severity() "
The value of \f(CW\*(C`severity\*(C'\fR in the user's \fI.perlcriticrc\fR.
.ie n .IP " is_maximum_violations_per_document_unlimited() " 4
.el .IP "\f(CW is_maximum_violations_per_document_unlimited() \fR" 4
.IX Item " is_maximum_violations_per_document_unlimited() "
Answer whether the value of \f(CW\*(C`maximum_violations_per_document\*(C'\fR should
be considered to be unlimited.
.ie n .IP " get_maximum_violations_per_document() " 4
.el .IP "\f(CW get_maximum_violations_per_document() \fR" 4
.IX Item " get_maximum_violations_per_document() "
The value of \f(CW\*(C`maximum_violations_per_document\*(C'\fR in the user's
\&\fI.perlcriticrc\fR.
.ie n .IP " get($parameter) " 4
.el .IP "\f(CW get($parameter) \fR" 4
.IX Item " get($parameter) "
Retrieve the value of the specified parameter in the user's
\&\fI.perlcriticrc\fR.
.ie n .IP " remove($parameter) " 4
.el .IP "\f(CW remove($parameter) \fR" 4
.IX Item " remove($parameter) "
Delete the value of the specified parameter.
.ie n .IP " is_empty() " 4
.el .IP "\f(CW is_empty() \fR" 4
.IX Item " is_empty() "
Answer whether there is any non-standard configuration information
left.
.ie n .IP " get_parameter_names() " 4
.el .IP "\f(CW get_parameter_names() \fR" 4
.IX Item " get_parameter_names() "
Retrieve the names of the parameters in this object.
.ie n .IP " set_profile_strictness($profile_strictness) " 4
.el .IP "\f(CW set_profile_strictness($profile_strictness) \fR" 4
.IX Item " set_profile_strictness($profile_strictness) "
Sets the profile strictness associated with the configuration.
.ie n .IP """ handle_extra_parameters($policy,$errors) """ 4
.el .IP "\f(CW handle_extra_parameters($policy,$errors) \fR" 4
.IX Item " handle_extra_parameters($policy,$errors) "
Deals with any extra parameters according to the profile_strictness
setting.  To be called by Perl::Critic::Policy\->\fBnew()\fR once all valid
policies have been processed and removed from the configuration.
.Sp
If profile_strictness is \f(CW$PROFILE_STRICTNESS_QUIET\fR, extra policy
parameters are ignored.
.Sp
If profile_strictness is \f(CW$PROFILE_STRICTNESS_WARN\fR, extra policy
parameters generate a warning.
.Sp
If profile_strictness is \f(CW$PROFILE_STRICTNESS_FATAL\fR, extra policy
parameters generate a fatal error.
.Sp
If no profile_strictness was set, the behavior is that specified by
\&\f(CW$PROFILE_STRICTNESS_DEFAULT\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
"MAKING YOUR POLICY CONFIGURABLE" in Perl::Critic::DEVELOPER
.SH AUTHOR
.IX Header "AUTHOR"
Elliot Shank <perl@galumph.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2008\-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.