Changeset 184

Timestamp:

01/12/06 16:01:14 (18 years ago)

Author:

thauvin

Message:

• add few doc, remove useless old code

File:

• trunk/soft/ObsData/ObsData/Repository.pm (modified) (6 diffs, 1 prop)

trunk/soft/ObsData/ObsData/Repository.pm

@@ -285 +285 @@
 our @ISA = qw(ObsData::Repository);
 
-=head3 new
+=head3 new($info, %param)
+
+Return a new ObsData::Repository::dir::archive object.
+
+$info is an ObsData::Repository or ObsData::Repository::dir object
+
+%param are:
+    
+    archivefile => the archive file to read
 
 =cut
@@ -337 +345 @@
 }
 
-=head2 getvalue
+=head2 getvalue($var, $default)
+
+Return a value from status file related to current archive.
 
 =cut
@@ -347 +357 @@
 
 =head2 setvalue
+
+Define a value related to current archive file.
 
 =cut
@@ -361 +373 @@
 }
 
-=head2 get_data_value
+=head2 get_data_value($datafile, $var, $default)
+
+Return a value from status file related to current archive about $datafile.
 
 =cut
@@ -374 +388 @@
 }
 
-=head2 set_data_value
+=head2 set_data_value($datafile, $var, $val, $comment)
+
+Set a value and optionnaly a comment for $datafile found in archive file
 
 =cut
@@ -390 +406 @@
 
 =cut
-
-#sub DESTROY {
-#    my ($self) = @_;
-#    $self->logging(0, "Destroy ObsData::Repository::archive for %s", ref($self));
-#    $self->SUPER::DESTROY();
-#}
 
 =head3 default_choice($oevent)