no-getopt stuff

[gitmo/MooseX-Getopt.git] / lib / MooseX / Getopt / Meta / NoGetopt.pm

diff --git a/lib/MooseX/Getopt/Meta/NoGetopt.pm b/lib/MooseX/Getopt/Meta/NoGetopt.pm
index c7c1d99..d0d859d 100644 (file)
--- a/lib/MooseX/Getopt/Meta/NoGetopt.pm
+++ b/lib/MooseX/Getopt/Meta/NoGetopt.pm
@@ -14,4 +14,66 @@ no Moose;
 package Moose::Meta::Attribute::Custom::NoGetopt;
 sub register_implementation { 'MooseX::Getopt::Meta::NoGetopt' }
 
-1;
\ No newline at end of file
+1;
+
+__END__
+
+=pod
+
+=head1 NAME
+
+MooseX::NoGetopt::Meta::Attribute - Optional meta attribute for custom option names
+
+=head1 SYNOPSIS
+
+  package App;
+  use Moose;
+  
+  with 'MooseX::Getopt';
+  
+  has 'data' => (
+      metaclass => 'NoGetOpt',  # do not attempt to capture this param  
+      is        => 'ro',
+      isa       => 'Str',
+      default   => 'file.dat',
+  );
+
+=head1 DESCRIPTION
+
+This is a custom attribute metaclass which can be used to specify 
+that a specific attribute should B<not> be processed by 
+C<MooseX::Getopt>. All you need to do is specify the C<NoGetOpt> 
+metaclass.
+
+  has 'foo' => (metaclass => 'NoGetopt', ... );
+
+=head1 METHODS
+
+=over 4
+
+=item B<meta>
+
+=back
+
+=head1 BUGS
+
+All complex software has bugs lurking in it, and this module is no 
+exception. If you find a bug please either email me, or add the bug
+to cpan-RT.
+
+=head1 AUTHOR
+
+Stevan Little E<lt>stevan@iinteractive.comE<gt>
+
+Chris Prather  C<< <perigrin@cpan.org> >>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright 2007 by Infinity Interactive, Inc.
+
+L<http://www.iinteractive.com>
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut