[Bps-public-commit] r14593 - in Data-Plist: .

[kyoki at bestpractical.com]

Author: kyoki
Date: Tue Jul 29 12:11:00 2008
New Revision: 14593

Modified:
   Data-Plist/   (props changed)
   Data-Plist/lib/Data/Plist/Reader.pm

Log:
 r30128 at nyx:  kyoki | 2008-07-29 12:10:58 -0400
 pod for Reader.pm. same failure mode(s) as the previous commit


Modified: Data-Plist/lib/Data/Plist/Reader.pm
==============================================================================
--- Data-Plist/lib/Data/Plist/Reader.pm	(original)
+++ Data-Plist/lib/Data/Plist/Reader.pm	Tue Jul 29 12:11:00 2008
@@ -1,13 +1,50 @@
+=head1 NAME
+
+Data::Plist::Reader - Abstract superclass for BinaryReader
+
+=head1 SYNOPSIS
+
+ # Create new
+ $read = Data::Plist::BinaryReader->new;
+
+ # Reading from a string C<$str>
+ my $plist = $read->open_string($str);
+
+ # Writing from file C<$filename>
+ $plist = $read->read($filename);
+
+=head1 DESCRIPTION
+
+C<Data::Plist::Reader> is an abstract superclass of
+BinaryReader. Takes either a string or a filehandle
+containing binary data formatted as an Apple binary
+property list and returns it as a C<Data::Plist>.
+
+=cut
+
 package Data::Plist::Reader;
 
 use strict;
 use warnings;
 
+=head2 new
+
+Create a new reader.
+
+=cut
+
 sub new {
     my $class = shift;
     return bless {} => $class;
 }
 
+=head2 open_string $content
+
+Takes binary data C<$content> and reads it into a
+filehandle. Then passes that filehandle to L</open_fh>.
+
+=cut
+
 sub open_string {
     my $self = shift;
     my ($content) = @_;
@@ -17,6 +54,13 @@
     return $self->open_fh($fh);
 }
 
+=head2 open_file $filename
+
+Takes a filename C<$filename> and reads its data into a
+filehandle. Then passes the filehandle to L</open_fh>.
+
+=cut
+
 sub open_file {
     my $self = shift;
     my ($filename) = @_;
@@ -27,6 +71,13 @@
     return $self->open_fh($fh);
 }
 
+=head2 open_fh
+
+Place-holder method for Reader's subclass. Currently
+unimplemented.
+
+=cut
+
 sub open_fh {
     my $self = shift;