From 8e8f031dc9350595c81d0da313d70bd8036047a9 Mon Sep 17 00:00:00 2001
From: Jesse Luehrs <doy@tozt.net>
Date: Thu, 24 Jun 2010 16:51:29 -0500
Subject: add docs

---
 lib/MooseX/Attribute/Shorthand.pm | 71 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 71 insertions(+)

diff --git a/lib/MooseX/Attribute/Shorthand.pm b/lib/MooseX/Attribute/Shorthand.pm
index f66e71f..67617a7 100644
--- a/lib/MooseX/Attribute/Shorthand.pm
+++ b/lib/MooseX/Attribute/Shorthand.pm
@@ -8,9 +8,80 @@ use Scalar::Util qw(reftype);
 
 =head1 SYNOPSIS
 
+    package Foo;
+    use Moose;
+    use MooseX::Attribute::Shorthand my_lazy_build => {
+        lazy => 1,
+        builder => sub { "_build_$_[0]" },
+        predicate => sub {
+            my $name = shift;
+            my $private = $name =~ s/^_//;
+            $private ? "_has_$name" : "has_$name";
+        },
+        clearer => sub {
+            my $name = shift;
+            my $private = $name =~ s/^_//;
+            $private ? "_clear_$name" : "clear_$name";
+        },
+    };
+
+    has public => (
+        is            => 'ro',
+        isa           => 'Str',
+        my_lazy_build => 1,
+    );
 
 =head1 DESCRIPTION
 
+This allows you to bundle up a group of attribute options into a single option,
+to make your attributes shorter and easier to read. This is an alternative to
+L<MooseX::Attributes::Curried>, which provides alternative exported functions.
+The options to allow are passed as a hash to the 'use' statement for this
+module, for instance:
+
+    use MooseX::Attribute::Shorthand string       => { ... },
+                                     lazy_require => { ... };
+
+The values of this hash will be hashrefs of attribute options that the new
+option should be replaced by. Basic options can just replace things statically,
+such as:
+
+    use MooseX::Attribute::Shorthand string => {
+        is  => 'ro',
+        isa => 'Str',
+    };
+
+More complicated attribute options can use subrefs as the values, which will be
+called, and have their return values used instead:
+
+    use MooseX::Attribute::Shorthand built_string => {
+        is      => 'ro',
+        isa     => 'Str',
+        builder => sub { "_build_$_[0]" },
+    };
+
+The subroutine gets the attribute name as the first argument, and the value
+given for the option as the second argument:
+
+    use MooseX::Attribute::Shorthand bool_with_default => {
+        is      => 'ro',
+        isa     => 'Bool',
+        default => sub { $_[1] },
+    };
+
+Finally, if you want to do more complicated things, you can override attribute
+options on the attribute metaclass for the new attribute option. The default is
+for the meta-attribute attribute to be "is => 'ro', isa => 'Bool'", so if you
+want to be able to pass different types of values to this object, you'll have
+to override that, by passing a hashref of options to the -meta_attr_options
+key:
+
+    use MooseX::Attribute::Shorthand date_string => {
+        is                 => 'ro',
+        isa                => 'Str',
+        default            => sub { sub { scalar localtime } },
+        -meta_attr_options => { isa => 'Str' },
+    };
 
 =cut
 
-- 
cgit v1.2.3-54-g00ecf