logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Perl::Critic::PolicyParameter::Behavior - Default type-specific actions for a parameter.

Author

       Elliot Shank <perl@galumph.com>

Description

       Provides a standard set of functionality for a Perl::Critic::PolicyParameter so that the developer of a
       policy does not have to provide it her/himself.  The developer can override most of the functionality in
       the subclasses; these are just defaults.

       All subclasses have singleton instances held onto by Perl::Critic::PolicyParameter.

Interface Support

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

Methods

       "initialize_parameter( $parameter, $specification )"
           Plug  in  the  functionality  this behavior provides into the parameter, based upon the configuration
           provided by the specification.  The configuration items looked for depends upon the specific behavior
           subclass.

       generate_parameter_description( $parameter )
           Create a description of the parameter, based upon  the  description  on  the  parameter  itself,  but
           enhancing it with information from this behavior.

           Note  that  this  may  return  "undef" if the parameter itself doesn't have a description.  Also, the
           returned value may include multiple lines.

Name

       Perl::Critic::PolicyParameter::Behavior - Default type-specific actions for a parameter.

See Also