[freeside-commits] freeside/FS/FS access_right.pm, 1.1, 1.2 access_user_pref.pm, 1.2, 1.3 access_usergroup.pm, 1.1, 1.2 pay_batch.pm, 1.12, 1.13

Ivan,,, ivan at wavetail.420.am
Wed Oct 3 17:51:36 PDT 2007


Update of /home/cvs/cvsroot/freeside/FS/FS
In directory wavetail:/tmp/cvs-serv10001

Modified Files:
	access_right.pm access_user_pref.pm access_usergroup.pm 
	pay_batch.pm 
Log Message:
POD documentation updates

Index: access_user_pref.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/access_user_pref.pm,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- access_user_pref.pm	1 Aug 2007 22:24:36 -0000	1.2
+++ access_user_pref.pm	4 Oct 2007 00:51:34 -0000	1.3
@@ -52,7 +52,7 @@
 
 =item new HASHREF
 
-Creates a new preference.  To add the example to the database, see L<"insert">.
+Creates a new preference.  To add the preference 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<hash> method.

Index: pay_batch.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/pay_batch.pm,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -d -r1.12 -r1.13
--- pay_batch.pm	1 Aug 2007 22:24:37 -0000	1.12
+++ pay_batch.pm	4 Oct 2007 00:51:34 -0000	1.13
@@ -30,8 +30,8 @@
 
 =head1 DESCRIPTION
 
-An FS::pay_batch object represents an example.  FS::pay_batch inherits from
-FS::Record.  The following fields are currently supported:
+An FS::pay_batch object represents an payment batch.  FS::pay_batch inherits
+from FS::Record.  The following fields are currently supported:
 
 =over 4
 
@@ -54,7 +54,7 @@
 
 =item new HASHREF
 
-Creates a new example.  To add the example to the database, see L<"insert">.
+Creates a new batch.  To add the batch 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<hash> method.
@@ -93,7 +93,7 @@
 
 =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 batch.  If there is
 an error, returns the error, otherwise returns false.  Called by the insert
 and replace methods.
 

Index: access_right.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/access_right.pm,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- access_right.pm	14 May 2006 16:47:31 -0000	1.1
+++ access_right.pm	4 Oct 2007 00:51:34 -0000	1.2
@@ -27,8 +27,8 @@
 
 =head1 DESCRIPTION
 
-An FS::access_right object represents an example.  FS::access_right inherits from
-FS::Record.  The following fields are currently supported:
+An FS::access_right object represents a granted access right.  FS::access_right
+inherits from FS::Record.  The following fields are currently supported:
 
 =over 4
 
@@ -49,7 +49,7 @@
 
 =item new HASHREF
 
-Creates a new example.  To add the example to the database, see L<"insert">.
+Creates a new right.  To add the right 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<hash> method.
@@ -88,7 +88,7 @@
 
 =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 right.  If there is
 an error, returns the error, otherwise returns false.  Called by the insert
 and replace methods.
 

Index: access_usergroup.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/access_usergroup.pm,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- access_usergroup.pm	14 May 2006 16:47:31 -0000	1.1
+++ access_usergroup.pm	4 Oct 2007 00:51:34 -0000	1.2
@@ -29,8 +29,9 @@
 
 =head1 DESCRIPTION
 
-An FS::access_usergroup object represents an example.  FS::access_usergroup inherits from
-FS::Record.  The following fields are currently supported:
+An FS::access_usergroup object represents an internal access user's membership
+in a group.  FS::access_usergroup inherits from FS::Record.  The following
+fields are currently supported:
 
 =over 4
 
@@ -49,7 +50,7 @@
 
 =item new HASHREF
 
-Creates a new example.  To add the example to the database, see L<"insert">.
+Creates a new record.  To add the 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<hash> method.
@@ -88,7 +89,7 @@
 
 =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 record.  If there is
 an error, returns the error, otherwise returns false.  Called by the insert
 and replace methods.
 



More information about the freeside-commits mailing list