From: Dave Rolsky <autarch@houseabsolute.urth.org>
Date: Fri, 13 Mar 2009 23:18:26 +0000 (-0500)
Subject: Document definition_context
X-Git-Tag: 0.78_01~53
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=f881381757cf823671097756344ee1dad02cb473;hp=070bb6c98b09351644c335dc9614d9bbba5d2684;p=gitmo%2FClass-MOP.git

Document definition_context
---

diff --git a/lib/Class/MOP/Attribute.pm b/lib/Class/MOP/Attribute.pm
index 65925cf..aaf2e1e 100644
--- a/lib/Class/MOP/Attribute.pm
+++ b/lib/Class/MOP/Attribute.pm
@@ -646,6 +646,19 @@ a false value (C<0> or C<undef>).
 This method will uninitialize the attribute. After an attribute is
 cleared, its C<predicate> will return false.
 
+=item I<definition_context>
+
+Mostly, this exists as a hook for the benefit of Moose.
+
+This option should be a hash reference containing several keys which
+will be used when inlining the attribute's accessors. The keys should
+include C<line>, the line number where the attribute was created, and
+either C<file> or C<description>.
+
+This information will ultimately be used when eval'ing inlined
+accessor code so that error messages report a useful line and file
+name.
+
 =back
 
 =item B<< $attr->clone(%options) >>