regenerated perl api docs from embedded pod

[freeside.git] / htdocs / docs / man / part_pkg.txt

diff --git a/htdocs/docs/man/part_pkg.txt b/htdocs/docs/man/part_pkg.txt
index dc1bce4..02aa109 100644 (file)
--- a/htdocs/docs/man/part_pkg.txt
+++ b/htdocs/docs/man/part_pkg.txt
@@ -4,8 +4,10 @@ NAME
 SYNOPSIS
       use FS::part_pkg;
 
-      $record = create FS::part_pkg \%hash
-      $record = create FS::part_pkg { 'column' => 'value' };
+      $record = new FS::part_pkg \%hash
+      $record = new FS::part_pkg { 'column' => 'value' };
+
+      $custom_record = $template_record->clone;
 
       $error = $record->insert;
 
@@ -16,7 +18,7 @@ SYNOPSIS
       $error = $record->check;
 
 DESCRIPTION
-    An FS::part_pkg represents a billing item definition.
+    An FS::part_pkg object represents a billing item definition.
     FS::part_pkg inherits from FS::Record. The following fields are
     currently supported:
 
@@ -31,11 +33,18 @@ DESCRIPTION
     are not yet defined.
 
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new billing item definition. To add the billing
         item definition to the database, see the section on
         "insert".
 
+    clone
+        An alternate constructor. Creates a new billing item
+        definition by duplicating an existing definition. A new
+        pkgpart is assigned and `(CUSTOM) ' is prepended to the
+        comment field. To add the billing item definition to the
+        database, see the section on "insert".
+
     insert
         Adds this billing item definition to the database. If there
         is an error, returns the error, otherwise returns false.
@@ -53,6 +62,9 @@ METHODS
         otherwise returns false. Called by the insert and replace
         methods.
 
+VERSION
+    $Id: part_pkg.txt,v 1.3 1999-04-08 13:39:32 ivan Exp $
+
 BUGS
     It doesn't properly override FS::Record yet.
 
@@ -71,3 +83,11 @@ HISTORY
 
     pod ivan@sisd.com 98-sep-21
 
+    $Log: part_pkg.txt,v $
+    Revision 1.3  1999-04-08 13:39:32  ivan
+    convert from pod for 1.2.0 release
+ Revision 1.5 1998/12/31 01:04:16 ivan doc
+
+    Revision 1.3 1998/11/15 13:00:15 ivan bugfix in clone method,
+    clone method doc clarification
+