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

[kyoki at bestpractical.com]

Author: kyoki
Date: Sun Jul 27 22:32:04 2008
New Revision: 14554

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

Log:
 r30086 at nyx:  kyoki | 2008-07-27 22:31:59 -0400
 some more documentation


Modified: Data-Plist/lib/Data/Plist/BinaryReader.pm
==============================================================================
--- Data-Plist/lib/Data/Plist/BinaryReader.pm	(original)
+++ Data-Plist/lib/Data/Plist/BinaryReader.pm	Sun Jul 27 22:32:04 2008
@@ -242,6 +242,16 @@
     ];
 }
 
+=head2 read_dict $size
+
+Takes an integer C<$size> indicating the number of
+key-value pairs contained in the dict. Returns an array
+containing the string "dict" and the references pointing to
+the location of the key-value pairs of the dict in the
+file.
+
+=cut
+
 sub read_dict {
     my $self = shift;
     my ($size) = @_;
@@ -262,6 +272,17 @@
     return [ "dict", \%dict ];
 }
 
+=head2 read_uid $size
+
+Takes an integer C<$size> indicating number of bytes needed
+to encode the uid (2**C<$size> = number of bytes) and then
+passes it to L</read_integer> to be dealt with, since uids
+are stored identically to integers. Returns an array
+containing the string "uid" and the uid read from the
+filehandle.
+
+=cut
+
 sub read_uid {
     my $self = shift;
     my ($size) = @_;
@@ -310,6 +331,15 @@
     return $self->$method($size);
 }
 
+=head2 open_string $string
+
+Takes a string of binary information in Apple's binary
+property list format C<$string>. Checks to ensure that it's
+of the correct format and then passes its superclass's
+L</open_string>.
+
+=cut
+
 sub open_string {
     my $self = shift;
     my ($str) = @_;