1Perl::Critic::PolicyConUfsiegr(3C)ontributed Perl DocumePnetralt:i:oCnritic::PolicyConfig(3)
2
3
4

NAME

6       Perl::Critic::PolicyConfig - Configuration data for a Policy.
7

DESCRIPTION

9       A container for the configuration of a Policy.
10

INTERFACE SUPPORT

12       This is considered to be a non-public class.  Its interface is subject
13       to change without notice.
14

METHODS

16       "get_policy_short_name()"
17           The name of the policy this configuration is for.  Primarily here
18           for the sake of debugging.
19
20       " get_set_themes() "
21           The value of "set_themes" in the user's .perlcriticrc.
22
23       " get_add_themes() "
24           The value of "add_themes" in the user's .perlcriticrc.
25
26       " get_severity() "
27           The value of "severity" in the user's .perlcriticrc.
28
29       " is_maximum_violations_per_document_unlimited() "
30           Answer whether the value of "maximum_violations_per_document"
31           should be considered to be unlimited.
32
33       " get_maximum_violations_per_document() "
34           The value of "maximum_violations_per_document" in the user's
35           .perlcriticrc.
36
37       " get($parameter) "
38           Retrieve the value of the specified parameter in the user's
39           .perlcriticrc.
40
41       " remove($parameter) "
42           Delete the value of the specified parameter.
43
44       " is_empty() "
45           Answer whether there is any non-standard configuration information
46           left.
47
48       " get_parameter_names() "
49           Retrieve the names of the parameters in this object.
50
51       " set_profile_strictness($profile_strictness) "
52           Sets the profile strictness associated with the configuration.
53
54       " handle_extra_parameters($policy,$errors) "
55           Deals with any extra parameters according to the profile_strictness
56           setting.  To be called by Perl::Critic::Policy->new() once all
57           valid policies have been processed and removed from the
58           configuration.
59
60           If profile_strictness is $PROFILE_STRICTNESS_QUIET, extra policy
61           parameters are ignored.
62
63           If profile_strictness is $PROFILE_STRICTNESS_WARN, extra policy
64           parameters generate a warning.
65
66           If profile_strictness is $PROFILE_STRICTNESS_FATAL, extra policy
67           parameters generate a fatal error.
68
69           If no profile_strictness was set, the behavior is that specified by
70           $PROFILE_STRICTNESS_DEFAULT.
71

SEE ALSO

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

AUTHOR

76       Elliot Shank <perl@galumph.com>
77

79       Copyright (c) 2008-2009 Elliot Shank.  All rights reserved.
80
81       This program is free software; you can redistribute it and/or modify it
82       under the same terms as Perl itself.  The full text of this license can
83       be found in the LICENSE file included with this module.
84
85
86
87perl v5.12.1                      2010-09-08     Perl::Critic::PolicyConfig(3)
Impressum