perl::critic::policyparameter(3pm) [debian man page]
Perl::Critic::PolicyParameter(3pm) User Contributed Perl Documentation Perl::Critic::PolicyParameter(3pm) 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.14.2 2012-06-07 Perl::Critic::PolicyParameter(3pm)
Check Out this Related Man Page
Perl::Critic::UserProfile(3pm) User Contributed Perl Documentation Perl::Critic::UserProfile(3pm) NAME
Perl::Critic::UserProfile - The contents of the user's profile, often .perlcriticrc. DESCRIPTION
This is a helper class that encapsulates the contents of the user's profile, which is usually stored in a .perlcriticrc file. There are no user-serviceable parts here. INTERFACE SUPPORT
This is considered to be a non-public class. Its interface is subject to change without notice. CONSTRUCTOR
" new( -profile =" $p ) > -profile is the path to the user's profile. If -profile is not defined, then it looks for the profile at ./.perlcriticrc and then $HOME/.perlcriticrc. If neither of those files exists, then the UserProfile is created with default values. This object does not take into account any command-line overrides; Perl::Critic::Config does that. METHODS
" options_processor() " Returns the Perl::Critic::OptionsProcessor object for this UserProfile. " policy_is_disabled( $policy ) " Given a reference to a Perl::Critic::Policy object or the name of one, returns true if the user has disabled that policy in their profile. " policy_is_enabled( $policy ) " Given a reference to a Perl::Critic::Policy object or the name of one, returns true if the user has explicitly enabled that policy in their user profile. " policy_params( $policy ) " Given a reference to a Perl::Critic::Policy object or the name of one, returns a Perl::Critic::PolicyConfig for the user's configuration parameters for that policy. " raw_policy_params( $policy ) " Given a reference to a Perl::Critic::Policy object or the name of one, returns a reference to a hash of the user's configuration parameters for that policy. " listed_policies() " Returns a list of the names of all the Policies that are mentioned in the profile. The Policy names will be fully qualified (e.g. Perl::Critic::Foo). " source() " The place where the profile information came from, if available. Usually the path to a .perlcriticrc. SEE ALSO
Perl::Critic::Config, Perl::Critic::OptionsProcessor AUTHOR
Jeffrey Ryan Thalhammer <jeff@imaginative-software.com> COPYRIGHT
Copyright (c) 2005-2011 Imaginative Software Systems. All rights reserved. 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.14.2 2012-06-07 Perl::Critic::UserProfile(3pm)