Changeset 6610

Timestamp:

Mar 16, 2006, 12:03:53 PM (20 years ago)

Author:

jhoblitt

Message:

document ->new()

File:

• trunk/DataStore/lib/DataStore/Record.pm (modified) (2 diffs)

trunk/DataStore/lib/DataStore/Record.pm

@@ -1 +1 @@
 # Copyright (C) 2006  Joshua Hoblitt
 #
-# $Id: Record.pm,v 1.6 2006-03-16 21:57:29 jhoblitt Exp $
+# $Id: Record.pm,v 1.7 2006-03-16 22:03:53 jhoblitt Exp $
 
 package DataStore::Record;
@@ -47 +47 @@
 
 =over 4
+
+=item * C<new()>
+
+Basic constructor.
+
+    my $dsp = DataStore::Record->new(
+        uri => 'http://example.com/',
+    );
+
+Accepts a mandatory hash and returns a L<DataStore::Record> object.
+
+=over 4
+
+=item * uri
+
+A valid I<HTTP> URI as a string. 
+
+=back
 
 =cut