Pod on get_recurring

git-svn-id: https://ledger-smb.svn.sourceforge.net/svnroot/ledger-smb/trunk@1457 4979c152-3d1c-0410-bac9-87ea11338e46

1 files changed, 11 insertions, 0 deletions

diff --git a/LedgerSMB/Form.pm b/LedgerSMB/Form.pm
index 5b89a64a..31c4fc20 100644
--- a/LedgerSMB/Form.pm
+++ b/LedgerSMB/Form.pm
@@ -2438,6 +2438,17 @@ sub save_status {
     $dbh->commit;
 }
 
+=item $form->get_recurring();
+
+Sets $form->{recurring} to contain info about the recurrence schedule for the
+action $form->{id}.  $form->{recurring} is of the same form used by
+$form->save_recurring($dbh2, $myconfig).
+
+  reference,startdate,repeat,unit,howmany,payment,print,email,message
+       text      date    int text     int     int  text  text    text
+
+=cut
+
 sub get_recurring {
 
     my ($self) = @_;