summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--lib/MooseX/ABC.pm11
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/MooseX/ABC.pm b/lib/MooseX/ABC.pm
index c4c1c69..3ced614 100644
--- a/lib/MooseX/ABC.pm
+++ b/lib/MooseX/ABC.pm
@@ -28,6 +28,17 @@ MooseX::ABC - abstract base classes for Moose
=head1 DESCRIPTION
+This module adds basic abstract base class functionality to Moose. Doing C<use MooseX::ABC> turns the using class into an abstract class - it cannot be instantiated. It also allows you to mark certain methods in the class as L</required>, meaning that if a class inherits from this class without implementing that method, it will die at compile time.
+
+=cut
+
+=head1 EXPORTS
+
+=cut
+
+=head2 requires METHOD_NAMES
+
+Takes a list of methods that classes inheriting from this one must implement. If a class inherits from this class without implementing each method listed here, an error will be thrown when compiling the class.
=cut