summaryrefslogtreecommitdiff
path: root/lib/WWW/Efa
diff options
context:
space:
mode:
authorDaniel Friesel <derf@derf.homelinux.org>2010-08-13 16:59:12 +0200
committerDaniel Friesel <derf@derf.homelinux.org>2010-08-13 16:59:12 +0200
commit829d1e13497374ef04ce83ed690f5782796e0d62 (patch)
treebcc369460f074dfbd09d5d501fc0ae07ee32c4eb /lib/WWW/Efa
parent311e480283c8eb693419e7abada749fb80e10dda (diff)
Add README, begin documentation for Efa::Error::Setup
Diffstat (limited to 'lib/WWW/Efa')
-rw-r--r--lib/WWW/Efa/Error/Setup.pm23
1 files changed, 23 insertions, 0 deletions
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;