vcs.maemo.org Git - pkg-perl/blob - deb-src/libperl-critic-perl/libperl-critic-perl-1.088/lib/Perl/Critic/Exception/Configuration/Generic.pm

   1 ##############################################################################
   2 #      $URL: http://perlcritic.tigris.org/svn/perlcritic/trunk/Perl-Critic/lib/Perl/Critic/Exception/Configuration/Generic.pm $
   3 #     $Date: 2008-07-03 10:19:10 -0500 (Thu, 03 Jul 2008) $
   4 #   $Author: clonezone $
   5 # $Revision: 2489 $
   6 ##############################################################################
   7
   8 package Perl::Critic::Exception::Configuration::Generic;
   9
  10 use 5.006001;
  11 use strict;
  12 use warnings;
  13
  14 use Readonly;
  15
  16 our $VERSION = '1.088';
  17
  18 #-----------------------------------------------------------------------------
  19
  20 use Exception::Class (
  21     'Perl::Critic::Exception::Configuration::Generic' => {
  22         isa         => 'Perl::Critic::Exception::Configuration',
  23         description =>
  24             q{A problem with Perl::Critic configuration that isn't related to an option.},
  25         alias       => 'throw_generic',
  26     },
  27 );
  28
  29 #-----------------------------------------------------------------------------
  30
  31 Readonly::Array our @EXPORT_OK => qw< throw_generic >;
  32
  33 #-----------------------------------------------------------------------------
  34
  35 1;
  36
  37 __END__
  38
  39 #-----------------------------------------------------------------------------
  40
  41 =pod
  42
  43 =for stopwords
  44
  45 =head1 NAME
  46
  47 Perl::Critic::Exception::Configuration::Generic - A problem with L<Perl::Critic> configuration that doesn't involve an option.
  48
  49 =head1 DESCRIPTION
  50
  51 A representation of a problem found with the configuration of L<Perl::Critic>,
  52 whether from a F<.perlcriticrc>, another profile file, or command line.
  53
  54 This covers things like file reading and parsing errors.
  55
  56
  57 =head1 CLASS METHODS
  58
  59 =over
  60
  61 =item C<< throw( message => $message, source => $source ) >>
  62
  63 See L<Exception::Class/"throw">.
  64
  65
  66 =item C<< new( message => $message, source => $source ) >>
  67
  68 See L<Exception::Class/"new">.
  69
  70
  71 =back
  72
  73
  74 =head1 AUTHOR
  75
  76 Elliot Shank <perl@galumph.com>
  77
  78 =head1 COPYRIGHT
  79
  80 Copyright (c) 2007-2008 Elliot Shank.  All rights reserved.
  81
  82 This program is free software; you can redistribute it and/or modify
  83 it under the same terms as Perl itself.  The full text of this license
  84 can be found in the LICENSE file included with this module.
  85
  86 =cut
  87
  88 # Local Variables:
  89 #   mode: cperl
  90 #   cperl-indent-level: 4
  91 #   fill-column: 78
  92 #   indent-tabs-mode: nil
  93 #   c-indentation-style: bsd
  94 # End:
  95 # ex: set ts=8 sts=4 sw=4 tw=78 ft=perl expandtab shiftround :