Changeset 19 for trunk

Timestamp:

09/27/05 17:40:11 (19 years ago)

Author:

thauvin

Message:

update doc

File:

• trunk/soft/ObsData/ObsData/Archive.pm (modified) (2 diffs, 1 prop)

trunk/soft/ObsData/ObsData/Archive.pm

@@ -79 +79 @@
             DIR => $self->_tempdir,
             UNLINK => 1,
-        ) or return undef;
+        ) or do {
+            seterror("Can't create tempfile: $!");
+            return undef;
+        };
     }
     
     if(!copy($self->{archive}, $fh)) {
         unlink($fname);
+        seterror("Cant copy the archive: $!");
         return undef;
     }
@@ -116 +120 @@
 __END__
 
-=HEAD1 Method
+=head1 NAME
 
-=item new
+ObsData::Archive - Transparently extract files from arbitrary archives
 
-Create a new archive object
+=head1 SYNOPSIS
 
-=item ls
+    use ObsData::Archive;
+    my $file = "foo.tar.gz";
+    my $oa = ObsData::Archive->new($file) or die ObsData::Archive->error;
+    my @content = $oa->ls;
+    foreach (@content) {
+        $oa->extract($_, "./$_") or die ObsData::Archive->error;
+    }
+
+=head1 METHODS
+
+=head2 new($file, %options)
+
+Create a new archive object by reading $file.
+
+Return undef on error and set error status.
+See L<error>.
+
+=head2 ls
 
 list the content of the archive
 
-=item extract
+=head2 extract
 
 Extract a file from the archive and return the filename of extract file
+
+=head1 CLASS METHODS
+
+=head2 error
+
+Return the last error encoutered
+
+=head1 AUTHORS
+
+Olivier Thauvin <olivier.thauvin@aerov.jussieu.fr>
+
+=cut