Build all packages removed dependencies of libtest-exception-perl libtest-warn-perl...
[dh-make-perl] / dev / i386 / libperl-critic-perl / libperl-critic-perl-1.088 / lib / Perl / Critic / PolicyParameter / Behavior.pm
diff --git a/dev/i386/libperl-critic-perl/libperl-critic-perl-1.088/lib/Perl/Critic/PolicyParameter/Behavior.pm b/dev/i386/libperl-critic-perl/libperl-critic-perl-1.088/lib/Perl/Critic/PolicyParameter/Behavior.pm
new file mode 100644 (file)
index 0000000..47e3503
--- /dev/null
@@ -0,0 +1,115 @@
+##############################################################################
+#      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/lib/Perl/Critic/PolicyParameter/Behavior.pm $
+#     $Date: 2008-07-03 10:19:10 -0500 (Thu, 03 Jul 2008) $
+#   $Author: clonezone $
+# $Revision: 2489 $
+##############################################################################
+
+package Perl::Critic::PolicyParameter::Behavior;
+
+use 5.006001;
+use strict;
+use warnings;
+
+use Perl::Critic::Utils qw{ :characters };
+
+our $VERSION = '1.088';
+
+#-----------------------------------------------------------------------------
+
+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__
+
+#-----------------------------------------------------------------------------
+
+=pod
+
+=for stopwords
+
+=head1 NAME
+
+Perl::Critic::PolicyParameter::Behavior - Default type-specific actions for a parameter.
+
+
+=head1 DESCRIPTION
+
+Provides a standard set of functionality for a
+L<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
+L<Perl::Critic::PolicyParameter>.
+
+
+=head1 METHODS
+
+=over
+
+=item C<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.
+
+=item C<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 C<undef> if the parameter itself doesn't
+have a description.  Also, the returned value may include multiple
+lines.
+
+=back
+
+
+=head1 AUTHOR
+
+Elliot Shank <perl@galumph.com>
+
+=head1 COPYRIGHT
+
+Copyright (c) 2006-2008 Elliot Shank.  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.
+
+=cut
+
+# 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 :