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

Perl-Critic documentation Contained in the Perl-Critic distribution.

Index

Code Index:

NAME

Top

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

DESCRIPTION

Top

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

Top

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

METHODS

Top

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

Top

Elliot Shank <perl@galumph.com>

COPYRIGHT

Top

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-Critic documentation Contained in the Perl-Critic distribution. 
##############################################################################
#      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/distributions/Perl-Critic/lib/Perl/Critic/PolicyParameter/Behavior.pm $
#     $Date: 2011-05-15 16:34:46 -0500 (Sun, 15 May 2011) $
#   $Author: clonezone $
# $Revision: 4078 $
##############################################################################

package Perl::Critic::PolicyParameter::Behavior;

use 5.006001;
use strict;
use warnings;

use Perl::Critic::Utils qw{ :characters };

our $VERSION = '1.116';

#-----------------------------------------------------------------------------

sub new {
    my $class = shift;

    return bless {}, $class;
}

#-----------------------------------------------------------------------------

sub initialize_parameter {
    my ($self, $parameter, $specification) = @_;

    return;
}

#-----------------------------------------------------------------------------

sub generate_parameter_description {
    my ($self, $parameter) = @_;

    return $parameter->_get_description_with_trailing_period();
}

#-----------------------------------------------------------------------------

1;

__END__

#-----------------------------------------------------------------------------


# Local Variables:
#   mode: cperl
#   cperl-indent-level: 4
#   fill-column: 78
#   indent-tabs-mode: nil
#   c-indentation-style: bsd
# End:
# ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :