From: ivan Date: Sat, 18 Feb 2006 02:11:44 +0000 (+0000) Subject: update POD documentation left behind from example template X-Git-Tag: BEFORE_FINAL_MASONIZE~211 X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=commitdiff_plain;h=d8b70477cf7fd3b87464940f13e85547ccdbd31d update POD documentation left behind from example template --- diff --git a/FS/FS/cust_tax_exempt_pkg.pm b/FS/FS/cust_tax_exempt_pkg.pm index 28fa24327..128921b9c 100644 --- a/FS/FS/cust_tax_exempt_pkg.pm +++ b/FS/FS/cust_tax_exempt_pkg.pm @@ -56,8 +56,8 @@ inherits from FS::Record. The following fields are currently supported: =item new HASHREF -Creates a new exemption record. To add the example to the database, see -L<"insert">. +Creates a new exemption record. To add the examption record to the database, +see L<"insert">. Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the I method. @@ -96,7 +96,7 @@ returns the error, otherwise returns false. =item check -Checks all fields to make sure this is a valid example. If there is +Checks all fields to make sure this is a valid exemption record. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. diff --git a/FS/FS/domain_record.pm b/FS/FS/domain_record.pm index 3c65a1a05..6513abf25 100644 --- a/FS/FS/domain_record.pm +++ b/FS/FS/domain_record.pm @@ -59,7 +59,7 @@ supported: =item new HASHREF -Creates a new entry. To add the example to the database, see L<"insert">. +Creates a new entry. To add the entry to the database, see L<"insert">. Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the I method. @@ -229,7 +229,7 @@ sub replace { =item check -Checks all fields to make sure this is a valid example. If there is +Checks all fields to make sure this is a valid entry. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. diff --git a/FS/FS/msgcat.pm b/FS/FS/msgcat.pm index 855b8b291..cbdc1d633 100644 --- a/FS/FS/msgcat.pm +++ b/FS/FS/msgcat.pm @@ -52,7 +52,8 @@ If you just want to B message catalogs, see L. =item new HASHREF -Creates a new example. To add the example to the database, see L<"insert">. +Creates a new message catalog entry. To add the message catalog entry to the +database, see L<"insert">. Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the I method. @@ -91,8 +92,8 @@ returns the error, otherwise returns false. =item check -Checks all fields to make sure this is a valid example. If there is -an error, returns the error, otherwise returns false. Called by the insert +Checks all fields to make sure this is a valid message catalog entry. If there +is an error, returns the error, otherwise returns false. Called by the insert and replace methods. =cut diff --git a/FS/FS/nas.pm b/FS/FS/nas.pm index 3495339e0..97b0ea17d 100644 --- a/FS/FS/nas.pm +++ b/FS/FS/nas.pm @@ -98,7 +98,7 @@ returns the error, otherwise returns false. =item check -Checks all fields to make sure this is a valid example. If there is +Checks all fields to make sure this is a valid NAS. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. diff --git a/FS/FS/part_bill_event.pm b/FS/FS/part_bill_event.pm index 8143e3473..98e15d4a2 100644 --- a/FS/FS/part_bill_event.pm +++ b/FS/FS/part_bill_event.pm @@ -61,8 +61,8 @@ FS::Record. The following fields are currently supported: =item new HASHREF -Creates a new invoice event definition. To add the example to the database, -see L<"insert">. +Creates a new invoice event definition. To add the invoice event definition to +the database, see L<"insert">. Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the I method. diff --git a/FS/FS/port.pm b/FS/FS/port.pm index 253727ba7..c26ca85d4 100644 --- a/FS/FS/port.pm +++ b/FS/FS/port.pm @@ -52,7 +52,7 @@ from FS::Record. The following fields are currently supported: =item new HASHREF -Creates a new port. To add the example to the database, see L<"insert">. +Creates a new port. To add the port to the database, see L<"insert">. Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the I method. @@ -91,7 +91,7 @@ returns the error, otherwise returns false. =item check -Checks all fields to make sure this is a valid example. If there is +Checks all fields to make sure this is a valid port. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. diff --git a/FS/FS/prepay_credit.pm b/FS/FS/prepay_credit.pm index 92f2a3032..38e87ad91 100644 --- a/FS/FS/prepay_credit.pm +++ b/FS/FS/prepay_credit.pm @@ -61,7 +61,7 @@ fields are currently supported: =item new HASHREF -Creates a new pre-paid credit. To add the example to the database, see +Creates a new pre-paid credit. To add the pre-paid credit to the database, see L<"insert">. Note that this stores the hash reference, not a distinct copy of the hash it diff --git a/FS/FS/queue.pm b/FS/FS/queue.pm index f42d99837..5f8bf11f0 100644 --- a/FS/FS/queue.pm +++ b/FS/FS/queue.pm @@ -68,7 +68,7 @@ FS::Record. The following fields are currently supported: =item new HASHREF -Creates a new job. To add the example to the database, see L<"insert">. +Creates a new job. To add the job to the database, see L<"insert">. Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the I method. diff --git a/FS/FS/queue_arg.pm b/FS/FS/queue_arg.pm index 39c71192f..c96ff1236 100644 --- a/FS/FS/queue_arg.pm +++ b/FS/FS/queue_arg.pm @@ -46,7 +46,7 @@ FS::Record. The following fields are currently supported: =item new HASHREF -Creates a new argument. To add the example to the database, see L<"insert">. +Creates a new argument. To add the argument to the database, see L<"insert">. Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the I method. diff --git a/FS/FS/rate_detail.pm b/FS/FS/rate_detail.pm index 7d54355fb..1964be2f4 100644 --- a/FS/FS/rate_detail.pm +++ b/FS/FS/rate_detail.pm @@ -56,7 +56,8 @@ inherits from FS::Record. The following fields are currently supported: =item new HASHREF -Creates a new example. To add the example to the database, see L<"insert">. +Creates a new call plan rate. To add the call plan rate to the database, see +L<"insert">. Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the I method. @@ -95,7 +96,7 @@ returns the error, otherwise returns false. =item check -Checks all fields to make sure this is a valid example. If there is +Checks all fields to make sure this is a valid call plan rate. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. diff --git a/FS/FS/reg_code_pkg.pm b/FS/FS/reg_code_pkg.pm index 9b9a87712..837b755e6 100644 --- a/FS/FS/reg_code_pkg.pm +++ b/FS/FS/reg_code_pkg.pm @@ -49,7 +49,8 @@ supported: =item new HASHREF -Creates a new example. To add the example to the database, see L<"insert">. +Creates a new registration code. To add the registration code to the database, +see L<"insert">. Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the I method.