Perl::Critic::PolicyParameter - Metadata about a parameter for a Policy. |
Perl::Critic::PolicyParameter - Metadata about a parameter for a Policy.
A provider of validation and parsing of parameter values and metadata about the parameter.
This is considered to be a public class. Any changes to its interface will go through a deprecation cycle.
get_name()
get_description()
get_default_string()
parse_and_validate_config_value( $parser, $config )
generate_full_description()
get_description()
.
If no description can be derived, returns the empty string.
Note that the result may contain multiple lines.
to_formatted_string( $format )
The format is a combination of literal and escape characters similar
to the way sprintf
works. If you want to know the specific
formatting capabilities, look at String::Format.
Valid escape characters are:
%n
%d
%D
%f
%d
. Takes a parameter of a prefix for the beginning of each line.
MAKING YOUR POLICY CONFIGURABLE in the Perl::Critic::DEVELOPER manpage
Elliot Shank <perl@galumph.com>
Copyright (c) 2006-2011 Elliot Shank.
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.
Perl::Critic::PolicyParameter - Metadata about a parameter for a Policy. |