Changeset 104

Timestamp:

12/10/05 23:01:17 (18 years ago)

Author:

thauvin

Message:

• more documentation

File:

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

trunk/soft/ObsData/ObsData.pm

@@ -117 +117 @@
 }
 
+=head2 loglevel($level)
+
+Return the text human readable log level associate to $level number
+
+=cut
+
 sub loglevel {
     my $l = pop(@_);
@@ -154 +160 @@
     $self->{config}->val($section, $var, $default);
 }
+
+=head2 config_mtime
+
+Return the modification time of config file currently used
+
+=cut
 
 sub config_mtime {
@@ -239 +251 @@
 }
 
+=head2 match_data_type($datatype, $label)
+
+Check if $label match the regexp associate to $datatype, return match values
+or nothing if no match.
+
+=cut
+
 sub match_data_type {
     my ($self, $datatype, $label) = @_;
@@ -249 +268 @@
 }
 
+=head2 find_match_data_type($label)
+
+Check if $label match one of the regexp associate to datatype in the
+configuration, if yes, return the datatype and assiociate values, else
+return nothing
+
+=cut
+
 sub find_match_data_type {
     my ($self, $label) = @_;
@@ -258 +285 @@
     }
 }
+
+=head2 build_dest_filename($label, $datatype)
+
+Build the destination file from original filename ($label) and optionnaly
+from $datatype. Return the datatype and the filename. If no datatype apply,
+return undef, if destination file cannot be build, return only the datatype.
+
+If $datatype is not defined, the function try to find the right datatype from
+configuration.
+
+=cut
 
 sub build_dest_filename {