[Bps-public-commit] r14642 - in Data-Plist: . lib/Data/Plist

[kyoki at bestpractical.com]

Author: kyoki
Date: Wed Jul 30 13:11:42 2008
New Revision: 14642

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

Log:
 r30183 at nyx:  kyoki | 2008-07-30 13:11:08 -0400
 a few edits


Modified: Data-Plist/lib/Data/Plist.pm
==============================================================================
--- Data-Plist/lib/Data/Plist.pm	(original)
+++ Data-Plist/lib/Data/Plist.pm	Wed Jul 30 13:11:42 2008
@@ -20,6 +20,10 @@
 
 =head1 DESCRIPTION
 
+Plists are intermediate structures from which nested array
+structures of the format specified in L</SERIALIZED DATA>,
+perl data structures and Objective C data structures can be
+obtained.
 
 =cut
 
@@ -188,6 +192,15 @@
     }
 }
 
+=head2 reify $data
+
+Takes serialized data (see L</SERIALIZED DATA>) C<$data>
+and checks if it's a keyed archive (see L</SERIALIZED
+DATA>). If the data is a keyed archive, it blesses it into
+the appropriate perl class.
+
+=cut
+
 sub reify {
     my $self = shift;
     my ( $data ) = @_;

Modified: Data-Plist/lib/Data/Plist/Writer.pm
==============================================================================
--- Data-Plist/lib/Data/Plist/Writer.pm	(original)
+++ Data-Plist/lib/Data/Plist/Writer.pm	Wed Jul 30 13:11:42 2008
@@ -37,12 +37,14 @@
 
 =head2 new
 
-Creates a new writer.
+Creates a new writer. 'serialize' is set to 1 since it's
+assumed that data being passed in will be perl data
+structures that need to be serialized. Users may set it to
+0 when creating a writer if they wish to use preserialized
+data.
 
 =cut
 
-# XXX: Doc the serialize argument
-
 sub new {
     my $class = shift;
     my %args = ( serialize => 1, @_ );
@@ -84,17 +86,13 @@
 
 =head2 fold_uids $data
 
-Takes a slightly modified Objective C archive made with
-NSKeyedArchiver C<$data> and unfolds it, assigning UIDs to
-its contents. Returns a nested collection of arrays
-formatted for writing.
+Takes a serialized object C<$data> (see
+L<Data::Plist/SERIALIZED DATA>) and rewrites it as a keyed
+archive (see L<Data::Plist/KEYED ARCHIVES>) by folding on
+UIDs.
 
 =cut
 
-# XXX This implies that $data is an NSKeyedArchiver.  It takes a
-# serialized object, and rewrites it into the format that
-# NSKeyedArchiver would have written, by folding on UIDs.
-
 sub fold_uids {
     my $self = shift;
     my $data = shift;