Changeset 1012 for trunk

Timestamp:

05/21/12 19:37:05 (12 years ago)

Author:

nanardon

Message:

• more API documentation

Location:

trunk/LATMOS-Accounts/lib/LATMOS

Files:

• Accounts.pm (modified) (5 diffs)
• Accounts/Bases/Sql/OCHelper/Accreq.pm (modified) (3 diffs)

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

@@ -97 +97 @@
     $self
 }
+
+=head2 call_batch_sync
+
+Send signal to L<la-sync-manager> daemon to synchronize bases.
+
+=cut
 
 sub call_batch_sync {
@@ -198 +204 @@
 }
 
+=head2 default_synchro_name
+
+Return de default synchronisation name
+
+=cut
+
 sub default_synchro_name {
     my ($self) = @_;
@@ -203 +215 @@
 }
 
+=head2 list_synchro
+
+List synchronisation setup in L<latmos-accounts.ini>
+
+=cut
+
 sub list_synchro {
     my ($self) = @_;
     grep { $_ } map { /^sync:(.*)$/; $1 } $self->Sections
 }
+
+=head2 default_synchro
+
+Return a reference to default synchronisation object
+
+=cut
 
 sub default_synchro {
@@ -217 +241 @@
 }
 
-sub sync_from_name {
-    my ($self, $syncname) = @_;
-    return if (!$syncname);
-    $self->val("sync:$syncname", 'from', $self->default_base_name);
-}
+=head2 create_synchro($name, %options)
+
+Return a reference to synchronisation object for C<$name> synchronisation.
+
+=cut
 
 sub create_synchro {
@@ -257 +281 @@
 }
 
+=head2 sync_access($name, %options)
+
+Return a L<LATMOS::Accounts::SynchAccess> object over C<$name> synchronisation.
+
+=cut
+
 sub sync_access {
     my ($self, $name, %options) = @_;

trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Bases/Sql/OCHelper/Accreq.pm

@@ -2 +2 @@
 
 # $Id: Accreq.pm 2041 2010-04-18 13:16:39Z nanardon $
+
+=head1 NAME
+
+    LATMOS::Accounts::Bases::Sql::OCHelper::User - Helper to create accreq
+    object
+
+=cut
 
 use strict;
@@ -20 +27 @@
         if ($self->base->create_c_object($self->otype,
                 strftime('%Y%m%d%H%M%S', localtime),
-                %{$info->{contentss} || {}},
+                %{$info->{contents} || {}},
             )) {
             return 'CREATED';
@@ -31 +38 @@
 }
 
+=head1 SEE ALSO
+
+L<LATMOS::Accounts>
+
+=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
+
 1;