Add docs for the undocumented classes

[gitmo/MooseX-Storage.git] / lib / MooseX / Storage / Engine / Trait / DisableCycleDetection.pm

diff --git a/lib/MooseX/Storage/Engine/Trait/DisableCycleDetection.pm b/lib/MooseX/Storage/Engine/Trait/DisableCycleDetection.pm
index b0ab38c..db732de 100644 (file)
--- a/lib/MooseX/Storage/Engine/Trait/DisableCycleDetection.pm
+++ b/lib/MooseX/Storage/Engine/Trait/DisableCycleDetection.pm
@@ -9,3 +9,64 @@ around 'check_for_cycle_in_collapse' => sub {
 
 1;
 
+=head1 NAME
+
+MooseX::Storage::Engine::Trait::DisableCycleDetection - A custom trait to bypass cycle detection
+
+=head1 SYNOPSIS
+
+    package Double;
+    use Moose;
+    use MooseX::Storage;
+    with Storage( traits => ['DisableCycleDetection'] );
+
+    has 'x' => ( is => 'rw', isa => 'HashRef' );
+    has 'y' => ( is => 'rw', isa => 'HashRef' );
+
+    my $ref = {};
+
+    my $double = Double->new( 'x' => $ref, 'y' => $ref );
+
+    $double->pack;
+
+=head1 DESCRIPTION
+
+C<MooseX::Storage> implements a primitive check for circular references.
+This check also triggers on simple cases as shown in the Synopsis.
+Providing the C<DisableCycleDetection> traits disables checks for any cyclical
+references, so if you know what you are doing, you can bypass this check.
+
+This trait is applied to an instance of L<MooseX::Storage::Engine>, for the
+user-visible version shown in the SYNOPSIS, see L<MooseX::Storage::Traits::DisableCycleDetection>
+
+=head1 METHODS
+
+=head2 Introspection
+
+=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.little@iinteractive.comE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright 2007-2008 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
+