Jeffrey Ryan Thalhammer > Perl-Critic-1.120_01 > Perl::Critic::PolicyParameter::Behavior

Download:
Perl-Critic-1.120_01.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 1.120_01   Source   Latest Release: Perl-Critic-1.123

NAME ^

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

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.

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.

syntax highlighting: