Changeset 1023 for trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Maintenance.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/Maintenance.pm (modified) (4 diffs)

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

@@ -10 +10 @@
 
     LATMOS::Accounts::Maintenance
+
+=head1 FUNCTIONS
 
 =cut
@@ -20 +22 @@
     return $self->{_maintenance_base} = $base
 }
+
+=head2 find_next_expire_users ($expire)
+
+Return The list of users going to expire in C<$expire> delay.
+
+=cut
 
 sub find_next_expire_users {
@@ -155 +163 @@
 }
 
+=head2 find_expired_users ($expire)
+
+See L<LATMOS::Accounts::Base/find_expired_users>
+
+=cut
+
 sub find_expired_users {
     my ($self, $expire) = @_;
     $self->_base->find_expired_users($expire);
 }
+
+=head2 expired_account_reminder ( %options)
+
+Search account expired for more than C<$options{delay}> (default is 6 month)
+send mail to manager and summary to admin to aknoledge destruction.
+
+=cut
 
 sub expired_account_reminder {
@@ -240 +261 @@
 
 1;
+
+__END__
+
+=head1 SEE ALSO
+
+L<LATMOS::Accounts::Bases>
+
+=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