From: Dave Rolsky <autarch@houseabsolute.urth.org>
Date: Sat, 21 Mar 2009 14:44:06 +0000 (-0500)
Subject: docs for MM::Method::Augmented
X-Git-Tag: 0.72_01~47
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=c03bf2a6fa069ff2cb46b8849ead519b08eebc8c;p=gitmo%2FMoose.git

docs for MM::Method::Augmented
---

diff --git a/lib/Moose/Meta/Method/Augmented.pm b/lib/Moose/Meta/Method/Augmented.pm
index 43af0c5..16a4379 100644
--- a/lib/Moose/Meta/Method/Augmented.pm
+++ b/lib/Moose/Meta/Method/Augmented.pm
@@ -66,19 +66,42 @@ Moose::Meta::Method::Augmented - A Moose Method metaclass for augmented methods
 
 =head1 DESCRIPTION
 
-This class implements method augmenting logic for the L<Moose> C<augment> keyword.
+This class implements method augmentation logic for the L<Moose>
+C<augment> keyword.
 
-This involves setting up C<inner> for the superclass body, and dispatching to
-the superclass from the normal body.
+The augmentation subroutine reference will be invoked explicitly using
+the C<inner> keyword from the parent class's method definition.
 
-The subclass definition (the augmentation itself) will be invoked explicitly
-using the C<inner> keyword from the parent class's method definition.
+=head1 INHERITANCE
+
+C<Moose::Meta::Method::Augmented> is a subclass of L<Moose::Meta::Method>.
 
 =head1 METHODS
 
 =over 4
 
-=item B<new>
+=item B<< Moose::Meta::Method::Augmented->new(%options) >>
+
+This constructs a new object. It accepts the following options:
+
+=over 8
+
+=item * class
+
+The metaclass object for the class in which the augmentation is being
+declared. This option is required.
+
+=item * name
+
+The name of the method which we are augmenting. This method must exist
+in one of the class's superclasses. This option is required.
+
+=item * method
+
+The subroutine reference which implements the augmentation. This
+option is required.
+
+=back
 
 =back