Changeset 1023 for trunk/LATMOS-Accounts/bin

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.

Location:

trunk/LATMOS-Accounts/bin

Files:

• la-search (modified) (1 diff)
• la-sql-edit-form (modified) (2 diffs)
• la-sql-rev (modified) (1 diff)
• la-sync-manager (modified) (2 diffs)

trunk/LATMOS-Accounts/bin/la-search

@@ -75 +75 @@
 =back
 
+=back
+
 =cut
 

trunk/LATMOS-Accounts/bin/la-sql-edit-form

@@ -9 +9 @@
 =head1 NAME
 
-    la-edit - Tools to edit forms (accreq)
+    la-sql-edit-form - Tools to edit forms (accreq)
 
 =head1 SYNOPSIS
 
-    la-edit [options] obj_id
+    la-sql-edit-form formid
 
 =cut
@@ -113 +113 @@
 =head2 SYNTAX
 
-The form must be describe in YAML format (L<TODO: Wikipedia link>).
+The form must be describe in YAML format (L<http://en.wikipedia.org/wiki/YAML>).
 
 =head2 OPTIONS

trunk/LATMOS-Accounts/bin/la-sql-rev

@@ -35 +35 @@
 Query this specific base instead of the default one.
 
+=back
+
 =cut
 

trunk/LATMOS-Accounts/bin/la-sync-manager

@@ -11 +11 @@
 use LATMOS::Accounts::Task;
 
+=head1 NAME
+
+    la-sync-manager - Daemon performing synchronisation and various tasks
+
+=head1 SYNOPSIS
+
+    la-sync-manager [options...]
+
+=cut
+
 GetOptions(
     'nodaemon' => \my $nodaemon,
     'c|config=s'   => \my $config,
     'help'         => sub { pod2usage(0) },
-    'test'         => \my $test,
     'wait=i'       => \my $wait,
 ) or pod2usage();
+
+=head1 OPTIONS
+
+=over 4
+
+=item --nodaemon
+
+Don't go into background
+
+=item -c|--config configdir
+
+Use this configuration instead default one
+
+=item --help
+
+Display this help
+
+=item --wait minutes
+
+Wait this number of minutes before process synchronisation (default is 5
+minutes)
+
+=back
+
+=cut
 
 my $needsync = 2;
@@ -118 +152 @@
 }
 
+__END__
+
+=head1 SEE ALSO
+
+L<la-sync-manager.ini>, L<latmos-accounts.ini>
+
+=head1 AUTHOR
+
+Olivier Thauvin, E<lt>olivier.thauvin@latmos.ipsl.frE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2008, 2009, 2010, 2011, 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