Commit 829d1e13 authored by Birte Kristina Friesel's avatar Birte Kristina Friesel
Browse files

Add README, begin documentation for Efa::Error::Setup

parent 311e4802
Loading
Loading
Loading
Loading
+3 −2
Original line number Diff line number Diff line
@@ -14,7 +14,8 @@ Installation
See also the Module::Build documentation.

Extra modules required for testing:
 - Test::More
 - Test::Command
 - Test::Compile
 - Test::More
 - Test::Pod
 - Test::Command
 - Test::Synopsis
+23 −0
Original line number Diff line number Diff line
package WWW::Efa::Error::Setup;

=head1 NAME

WWW::Efa::Error::Setup - WWW::Efa error, happened in ->new()

=head1 SYNOPSIS

    use WWW::Efa::Error::Setup;

    my $error = WWW::Efa::Error::Setup->new(
        'max_interchanges', '-1', 'Must be positive'
    );

    die $error->as_string();
    # WWW::Efa setup error: Wrong arg for option max_interchanges: -1
    # Must be positive

=head1 DESCRIPTION

Class for all WWW::Efa-internal errors occuring during initialization. Usually
caused by missing or invalid setup arguments.

=cut

use strict;
use warnings;
use 5.010;