From 7642b102aa4359fffcd5df1e3b64cccde56cfa29 Mon Sep 17 00:00:00 2001
From: erickson <erickson@dcc99617-32d9-48b4-a31d-7c20da2025e4>
Date: Thu, 25 Mar 2010 21:27:05 +0000
Subject: [PATCH] Cleanup generally sound method reg. docs
git-svn-id: svn://svn.open-ils.org/ILS/trunk@15997 dcc99617-32d9-48b4-a31d-7c20da2025e4
---
Open-ILS/src/perlmods/OpenILS/Application/Actor.pm | 36 ++++++++++------------
1 file changed, 16 insertions(+), 20 deletions(-)
diff --git a/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm b/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm
index 27678d1717..4da8c5d143 100644
--- a/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm
+++ b/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm
@@ -265,17 +265,16 @@ sub ranged_ou_settings {
__PACKAGE__->register_method(
- api_name => 'open-ils.actor.ou_setting.ancestor_default',
- method => 'ou_ancestor_setting',
+ api_name => 'open-ils.actor.ou_setting.ancestor_default',
+ method => 'ou_ancestor_setting',
signature => {
- desc => q/Get an org unit setting value as seen from your org unit. IF AND ONLY IF
- you provide an authentication token, this method will make sure that the given
- user has permission to view that setting, if there is a permission associated
- with the setting./,
+ desc => 'Get the org unit setting value associated with the setting name as seen from the specified org unit. ' .
+ 'IF AND ONLY IF an authentication token is provided, this method will make sure that the given ' .
+ 'user has permission to view that setting, if there is a permission associated with the setting.' ,
params => [
- {desc => 'org unit id', type => 'number'},
- {desc => 'setting name', type => 'string'},
- {desc => '(optional) authtoken', type => 'string'},
+ { desc => 'org unit id', type => 'number' },
+ { desc => 'setting name', type => 'string' },
+ { desc => 'authtoken (optional)', type => 'string' }
],
return => {desc => 'A value for the org unit setting, or undef'}
}
@@ -294,17 +293,16 @@ sub ou_ancestor_setting {
}
__PACKAGE__->register_method(
- api_name => 'open-ils.actor.ou_setting.ancestor_default.batch',
- method => 'ou_ancestor_setting_batch',
+ api_name => 'open-ils.actor.ou_setting.ancestor_default.batch',
+ method => 'ou_ancestor_setting_batch',
signature => {
- desc => q/Get org unit setting name => value pairs as seen from the specified org unit.
- IF AND ONLY IF you provide an authentication token, this method will make sure
- that the given user has permission to view that setting, if there is a
- permission associated with the setting./,
+ desc => 'Get org unit setting name => value pairs for a list of names, as seen from the specified org unit. ' .
+ 'IF AND ONLY IF an authentication token is provided, this method will make sure that the given ' .
+ 'user has permission to view that setting, if there is a permission associated with the setting.' ,
params => [
- {desc => 'org unit id', type => 'number'},
- {desc => 'setting name list', type => 'array'},
- {desc => '(optional) authtoken', type => 'string'},
+ { desc => 'org unit id', type => 'number' },
+ { desc => 'setting name list', type => 'array' },
+ { desc => 'authtoken (optional)', type => 'string' }
],
return => {desc => 'A hash with name => value pairs for the org unit settings'}
}
@@ -318,8 +316,6 @@ sub ou_ancestor_setting_batch {
-
-
__PACKAGE__->register_method(
method => "update_patron",
api_name => "open-ils.actor.patron.update",);
--
2.11.0