Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

perl::critic::policyparameter(3) [centos man page]

Perl::Critic::PolicyParameter(3)			User Contributed Perl Documentation			  Perl::Critic::PolicyParameter(3)

NAME

       Perl::Critic::PolicyParameter - Metadata about a parameter for a Policy.

DESCRIPTION

       A provider of validation and parsing of parameter values and metadata about the parameter.

INTERFACE SUPPORT

       This is considered to be a public class.  Any changes to its interface will go through a deprecation cycle.

METHODS

       "get_name()"
	   Return the name of the parameter.  This is the key that will be looked for in the .perlcriticrc.

       "get_description()"
	   Return an explanation of the significance of the parameter, as provided by the developer of the policy.

       "get_default_string()"
	   Return a representation of the default value of this parameter as it would appear if it was specified in a .perlcriticrc file.

       "parse_and_validate_config_value( $parser, $config )"
	   Extract the configuration value for this parameter from the overall configuration and initialize the policy based upon it.

       "generate_full_description()"
	   Produce a more complete explanation of the significance of this parameter than the value returned by "get_description()".

	   If no description can be derived, returns the empty string.

	   Note that the result may contain multiple lines.

       "to_formatted_string( $format )"
	   Generate a string representation of this parameter, based upon the 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  The name of the parameter.

	   %d  The description, as supplied by the programmer.

	   %D  The default value, in a parsable form.

	   %f  The full description, which is an extension of the value returned by %d.  Takes a parameter of a prefix for the beginning of each
	       line.

SEE ALSO

       "MAKING YOUR POLICY CONFIGURABLE" in Perl::Critic::DEVELOPER

AUTHOR

       Elliot Shank <perl@galumph.com>

COPYRIGHT

       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 v5.16.3							    2014-06-09					  Perl::Critic::PolicyParameter(3)

Check Out this Related Man Page

Perl::Critic::Exception::AggregateConfiguration(3)	User Contributed Perl Documentation	Perl::Critic::Exception::AggregateConfiguration(3)

NAME

       Perl::Critic::Exception::AggregateConfiguration - A collection of a set of problems found in the configuration and/or command-line options.

DESCRIPTION

       A set of configuration settings can have multiple problems.  This is an object for collecting all the problems found so that the user can
       see them in one run.

INTERFACE SUPPORT

       This is considered to be a public class.  Any changes to its interface will go through a deprecation cycle.

METHODS

       "add_exception( $exception )"
	   Accumulate the parameter with rest of the exceptions.

       "add_exceptions_from( $aggregate )"
	   Accumulate the exceptions from another instance of this class.

       "exceptions()"
	   Returns a reference to an array of the collected exceptions.

       "add_exception_or_rethrow( $eval_error )"
	   If the parameter is an instance of Perl::Critic::Exception::Configuration or Perl::Critic::Exception::AggregateConfiguration, add it.
	   Otherwise, "die" with the parameter, if it is a reference, or "confess" with it.  If the parameter is false, simply returns.

       "has_exceptions()"
	   Answer whether any configuration problems have been found.

       "full_message()"
	   Concatenate the exception messages.	See "full_message" in Exception::Class.

AUTHOR

       Elliot Shank <perl@galumph.com>

COPYRIGHT

       Copyright (c) 2007-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 v5.16.3							    2014-06-09			Perl::Critic::Exception::AggregateConfiguration(3)
Man Page