Changeset 1018 for trunk/LATMOS-Accounts/lib/LATMOS

Timestamp:

05/22/12 11:40:11 (12 years ago)

Author:

nanardon

Message:

• fullfill documentation for L::A::Task and L::A::Log modules

Location:

trunk/LATMOS-Accounts/lib/LATMOS

Files:

• Accounts.pm (modified) (1 diff)
• Accounts/Log.pm (modified) (1 diff)
• Accounts/Task.pm (modified) (4 diffs)

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

@@ -317 +317 @@
 =head1 COPYRIGHT AND LICENSE
 
-Copyright (C) 2009 by Thauvin Olivier
+Copyright (C) 2009, 2010, 2011, 2012 by Thauvin Olivier
 
 This library is free software; you can redistribute it and/or modify

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

@@ -157 +157 @@
 }
 
+=head2 lastmessage($level)
+
+Return the last message for C<$level> (LA_ERROR by default)
+
+=cut
+
 sub lastmessage {
     my ($level) = @_;

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

@@ -4 +4 @@
 use warnings;
 use LATMOS::Accounts::Log;
+
+=head1 NAME
+
+    LATMOS::Accounts::Task
+
+=head1 DESCRIPTION
+
+Parent class for regular task run by L<la-sync-manager>
+
+=head1 FUNCTIONS
+
+=head2 new($module, %options)
+
+Instanciate a new task of type C<$module>
+
+The module must provide a C<_new()> function.
+
+=cut
 
 sub new {
@@ -19 +37 @@
 }
 
+=head2 init
+
+Call at task startup, can be overload
+
+=cut
+
 sub init {
     return 1;
 }
+
+=head2 needupd($baserev, $syncm)
+
+This function is to call to check if the module have to run or not.
+
+C<$baserev> is the current base revision en C<$syncm> the revision when
+la-sync-manager was run.
+
+By default return true only if base has changed, overload for different
+behavior.
+
+=cut
 
 sub needupd {
@@ -36 +72 @@
 }
 
+=head2 run
+
+Must be provided by module, do the desired work.
+
+=cut
+
 sub run {
     return 1;
 }
+
+=head2 post
+
+Call after C<run()>
+
+=cut
 
 sub post {
@@ -44 +92 @@
 
 1;
+
+__END__
+
+=head1 SEE ALSO
+
+L<LATMOS::Accounts::Sync>
+
+=head1 AUTHOR
+
+Thauvin Olivier, E<lt>olivier.thauvin@latmos.ipsl.frE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2009, 2010, 2011, 2012 by Thauvin Olivier
+
+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