major pod update from Tom Christiansen
[p5sagit/p5-mst-13.2.git] / lib / Tie / RefHash.pm
index 20f0d58..66de257 100644 (file)
@@ -1,11 +1,57 @@
-#
-# Tie/RefHash.pm - use references as hash keys 
-#
-# Documentation at the __END__
-#
-
-require 5.004;
 package Tie::RefHash;
+
+=head1 NAME
+
+Tie::RefHash - use references as hash keys
+
+=head1 SYNOPSIS
+
+    require 5.004;
+    use Tie::RefHash;
+    tie HASHVARIABLE, 'Tie::RefHash', LIST;
+
+    untie HASHVARIABLE;
+
+=head1 DESCRIPTION
+
+This module provides the ability to use references as hash keys if
+you first C<tie> the hash variable to this module.
+
+It is implemented using the standard perl TIEHASH interface.  Please
+see the C<tie> entry in perlfunc(1) and perltie(1) for more information.
+
+=head1 EXAMPLE
+
+    use Tie::RefHash;
+    tie %h, 'Tie::RefHash';
+    $a = [];
+    $b = {};
+    $c = \*main;
+    $d = \"gunk";
+    $e = sub { 'foo' };
+    %h = ($a => 1, $b => 2, $c => 3, $d => 4, $e => 5);
+    $a->[0] = 'foo';
+    $b->{foo} = 'bar';
+    for (keys %h) {
+       print ref($_), "\n";
+    }
+
+
+=head1 AUTHOR
+
+Gurusamy Sarathy        gsar@umich.edu
+
+=head1 VERSION
+
+Version 1.2    15 Dec 1996
+
+=head1 SEE ALSO
+
+perl(1), perlfunc(1), perltie(1)
+
+=cut
+
+require 5.003_11;
 use Tie::Hash;
 @ISA = qw(Tie::Hash);
 use strict;
@@ -75,62 +121,3 @@ sub CLEAR {
 }
 
 1;
-
-__END__
-
-=head1 NAME
-
-Tie::RefHash - use references as hash keys
-
-
-=head1 SYNOPSIS
-
-    require 5.004;
-    use Tie::RefHash;
-    tie HASHVARIABLE, 'Tie::RefHash', LIST;
-
-    untie HASHVARIABLE;
-
-
-=head1 DESCRIPTION
-
-This module provides the ability to use references as hash keys if
-you first C<tie> the hash variable to this module.
-
-It is implemented using the standard perl TIEHASH interface.  Please
-see the C<tie> entry in perlfunc(1) and perltie(1) for more information.
-
-
-=head1 EXAMPLE
-
-    use Tie::RefHash;
-    tie %h, 'Tie::RefHash';
-    $a = [];
-    $b = {};
-    $c = \*main;
-    $d = \"gunk";
-    $e = sub { 'foo' };
-    %h = ($a => 1, $b => 2, $c => 3, $d => 4, $e => 5);
-    $a->[0] = 'foo';
-    $b->{foo} = 'bar';
-    for (keys %h) {
-       print ref($_), "\n";
-    }
-
-
-=head1 AUTHOR
-
-Gurusamy Sarathy        gsar@umich.edu
-
-
-=head1 VERSION
-
-Version 1.2    15 Dec 1996
-
-
-=head1 SEE ALSO
-
-perl(1), perlfunc(1), perltie(1)
-
-
-=cut