updated docs on permit method
authorerickson <erickson@dcc99617-32d9-48b4-a31d-7c20da2025e4>
Fri, 20 Jan 2006 22:25:32 +0000 (22:25 +0000)
committererickson <erickson@dcc99617-32d9-48b4-a31d-7c20da2025e4>
Fri, 20 Jan 2006 22:25:32 +0000 (22:25 +0000)
git-svn-id: svn://svn.open-ils.org/ILS/trunk@2781 dcc99617-32d9-48b4-a31d-7c20da2025e4

Open-ILS/src/perlmods/OpenILS/Application/Circ/Circulate.pm

index a14de16..1fe5b70 100644 (file)
@@ -224,11 +224,16 @@ sub _add_script_runner_methods {
 __PACKAGE__->register_method(
        method  => "permit_circ",
        api_name        => "open-ils.circ.permit_checkout_",
-       notes           => <<"  NOTES");
+       notes           => q/
                Determines if the given checkout can occur
-               PARAMS( authtoken, barcode => bc, patron => pid, renew => t/f )
-               Returns an event
-       NOTES
+               @param authtoken The login session key
+               @param params A trailing list of named params including 
+                       barcode : The copy barcode, 
+                       patron : The patron the checkout is occurring for, 
+                       renew : true or false - whether or not this is a renewal
+               @return The event that occurred during the permit check.  
+                       If all is well, the SUCCESS event is returned
+       /);
 
 sub permit_circ {
        my( $self, $client, $authtoken, %params ) = @_;