Changeset 1023 for trunk/LATMOS-Accounts/lib/LATMOS/Accounts/SyncManager.pm

Timestamp:

05/29/12 10:25:51 (12 years ago)

Author:

nanardon

Message:

• complete POD

This patch a basic documentation to all functions.
It also add two test to ensure all POD syntax are correct and coverage is full.

File:

• trunk/LATMOS-Accounts/lib/LATMOS/Accounts/SyncManager.pm (modified) (4 diffs)

trunk/LATMOS-Accounts/lib/LATMOS/Accounts/SyncManager.pm

@@ -5 +5 @@
 use LATMOS::Accounts::Log;
 use LATMOS::Accounts;
+
+=head1 NAME
+
+LATMOS::Accounts::SyncManager - Routine task manager
+
+=head1 DESCRIPTION
+
+Handle Task process run by L<la-sync-manager>
+
+=head1 FUNCTIONS
+
+=cut
+
+=head2 new($config)
+
+Instaciate object. 
+
+C<$config> is a path to an alternative configuration file to default one.
+
+=cut
 
 sub new {
@@ -24 +44 @@
 }
 
+=head2 ini
+
+Return a reference to the L<Ini::Files> object handling configuration.
+
+=cut
+
 sub ini { $_[0]->{ini} }
 
+=head2 dbrev
+
+Return the current base revision
+
+=cut
+
 sub dbrev { $_[0]->{lastrev} }
+
+=head2 updrev
+
+Update status file with with current base revision as restart point
+
+=cut
 
 sub updrev {
@@ -37 +75 @@
 }
 
+=head2 list_modules
+
+List configured task module
+
+=cut
+
 sub list_modules {
     my ($self) = @_;
     $self->ini->Sections;
 }
+
+=head2 process_module($module, $dbrev)
+
+Process C<$module>.
+
+=cut
+
+# TODO what is $dbrev, why is it need here ??
 
 sub process_module {
@@ -90 +142 @@
 
 1;
+
+__END__
+
+=head1 SEE ALSO
+
+L<LATMOS::Accountsi::Task>
+
+=head1 AUTHOR
+
+Olivier Thauvin, E<lt>olivier.thauvin@latmos.ipsl.frE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2012 CNRS SA/CETP/LATMOS
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself, either Perl version 5.10.0 or,
+at your option, any later version of Perl 5 you may have available.
+
+=cut