POD updates
authorivan <ivan>
Wed, 25 Jun 2008 20:11:11 +0000 (20:11 +0000)
committerivan <ivan>
Wed, 25 Jun 2008 20:11:11 +0000 (20:11 +0000)
FS/FS/cust_bill.pm
FS/FS/cust_main.pm

index 7b05cad..c404b8b 100644 (file)
@@ -557,19 +557,27 @@ sub apply_payments_and_credits {
 
 }
 
-=item generate_email PARAMHASH
+=item generate_email OPTION => VALUE ...
 
-PARAMHASH can contain the following:
+Options:
 
 =over 4
 
-=item from       => sender address, required
+=item from
 
-=item tempate    => alternate template name, optional
+sender address, required
 
-=item print_text => text attachment arrayref, optional
+=item tempate
 
-=item subject    => email subject, optional
+alternate template name, optional
+
+=item print_text
+
+text attachment arrayref, optional
+
+=item subject
+
+email subject, optional
 
 =back
 
index 19323e8..53bf9f3 100644 (file)
@@ -5259,15 +5259,24 @@ Available options are:
 
 =over 4
 
-=item unapplied_date - set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting, probably a bad idea for event triggering)
+=item unapplied_date
 
-=item total - set to true to remove all customer comparison clauses, for totals
+set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting (or is it?), probably a bad idea for event triggering)
 
-=item where - WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
+=item total
 
-=item join - JOIN clause (typically used with the total option)
+(unused.  obsolete?)
+set to true to remove all customer comparison clauses, for totals
 
-=item 
+=item where
+
+(unused.  obsolete?)
+WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
+
+=item join
+
+(unused.  obsolete?)
+JOIN clause (typically used with the total option)
 
 =back