summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README5
-rw-r--r--lib/WWW/Efa/Error/Setup.pm23
2 files changed, 26 insertions, 2 deletions
diff --git a/README b/README
index b3df4ba..20e8c80 100644
--- a/README
+++ b/README
@@ -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
diff --git a/lib/WWW/Efa/Error/Setup.pm b/lib/WWW/Efa/Error/Setup.pm
index 521bb55..e3de3e3 100644
--- a/lib/WWW/Efa/Error/Setup.pm
+++ b/lib/WWW/Efa/Error/Setup.pm
@@ -1,5 +1,28 @@
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;