summaryrefslogtreecommitdiff
path: root/FS/FS/detail_format.pm
diff options
context:
space:
mode:
authorMark Wells <mark@freeside.biz>2014-05-05 09:58:49 -0700
committerMark Wells <mark@freeside.biz>2014-05-05 09:58:49 -0700
commit757e46b0e68d6f729618b4ed20c420b5a9665ade (patch)
tree75c0929d9e0561345a670d1231c45918057c891d /FS/FS/detail_format.pm
parent3aec21e14476ee3d33d4cf92e029e8543dabf009 (diff)
perldoc cleanup
Diffstat (limited to 'FS/FS/detail_format.pm')
-rw-r--r--FS/FS/detail_format.pm45
1 files changed, 28 insertions, 17 deletions
diff --git a/FS/FS/detail_format.pm b/FS/FS/detail_format.pm
index 2417b3a..c90d313 100644
--- a/FS/FS/detail_format.pm
+++ b/FS/FS/detail_format.pm
@@ -34,19 +34,19 @@ a subclass.
OPTIONS may contain:
-- buffer: an arrayref to store details into. This may avoid the need for
- a large copy operation at the end of processing. However, since
- summary formats will produce nothing until the end of processing,
- C<finish> must be called after all CDRs have been appended.
+- buffer: an arrayref to store details into. This may avoid the need for a
+large copy operation at the end of processing. However, since summary formats
+will produce nothing until the end of processing, C<finish> must be called
+after all CDRs have been appended.
-- inbound: a flag telling the formatter to format CDRs for display to
- the receiving party, rather than the originator. In this case, the
- L<FS::cdr_termination> object will be fetched and its values used for
- rated_price, rated_seconds, rated_minutes, and svcnum. This can be
- changed with the C<inbound> method.
+- inbound: a flag telling the formatter to format CDRs for display to the
+receiving party, rather than the originator. In this case, the
+L<FS::cdr_termination> object will be fetched and its values used for
+rated_price, rated_seconds, rated_minutes, and svcnum. This can be changed
+with the C<inbound> method.
-- locale: a locale string to use for static text and date formats. This
- is optional.
+- locale: a locale string to use for static text and date formats. This is
+optional.
=cut
@@ -84,6 +84,8 @@ sub new {
=head1 METHODS
+=over 4
+
=item inbound VALUE
Set/get the 'inbound' flag.
@@ -163,12 +165,21 @@ Takes a single CDR and returns an invoice detail to describe it.
By default, this maps the following fields from the CDR:
-rated_price => amount
-rated_classnum => classnum
-rated_seconds => duration
-rated_regionname => regionname
-accountcode => accountcode
-startdate => startdate
+=over 4
+
+=item rated_price => amount
+
+=item rated_classnum => classnum
+
+=item rated_seconds => duration
+
+=item rated_regionname => regionname
+
+=item accountcode => accountcode
+
+=item startdate => startdate
+
+=back
It then calls C<columns> on the CDR to obtain a list of detail
columns, formats them as a CSV string, and stores that in the