.\" -*- 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::Exception::Configuration::Option 3pm"
.TH Perl::Critic::Exception::Configuration::Option 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::Exception::Configuration::Option \- A problem with an option in the Perl::Critic configuration.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A representation of a problem found with an option in the
configuration of Perl::Critic, whether from a
\&\fI.perlcriticrc\fR, another profile file, or command line.
.PP
This is an abstract class.  It should never be instantiated.
.SH "INTERFACE SUPPORT"
.IX Header "INTERFACE SUPPORT"
This is considered to be a public class.  Any changes to its interface
will go through a deprecation cycle.
.SH METHODS
.IX Header "METHODS"
.ie n .IP option_name() 4
.el .IP \f(CWoption_name()\fR 4
.IX Item "option_name()"
The name of the option that was found to be in error.
.ie n .IP option_value() 4
.el .IP \f(CWoption_value()\fR 4
.IX Item "option_value()"
The value of the option that was found to be in error.
.ie n .IP message_suffix() 4
.el .IP \f(CWmessage_suffix()\fR 4
.IX Item "message_suffix()"
Any text that should be applied to end of the standard message for
this kind of exception.
.ie n .IP message() 4
.el .IP \f(CWmessage()\fR 4
.IX Item "message()"
.PD 0
.ie n .IP error() 4
.el .IP \f(CWerror()\fR 4
.IX Item "error()"
.PD
Overridden to call \f(CWfull_message()\fR.  I.e. any message string in the
superclass is ignored.
.ie n .IP full_message() 4
.el .IP \f(CWfull_message()\fR 4
.IX Item "full_message()"
Overridden to turn it into an abstract method to force subclasses to
implement it.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Perl::Critic::Exception::Configuration::Option::Global
Perl::Critic::Exception::Configuration::Option::Policy
.SH AUTHOR
.IX Header "AUTHOR"
Elliot Shank <perl@galumph.com>
.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.