From c28e17683c9a697a035d17c26f337c2229275673 Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Thu, 5 Feb 2015 14:09:30 -0500 Subject: [PATCH] Cleanup api3 docblocks --- api/v3/Acl.php | 2 +- api/v3/AclRole.php | 2 +- api/v3/ActionSchedule.php | 1 - api/v3/Activity.php | 10 +++----- api/v3/ActivityContact.php | 4 +--- api/v3/ActivityType.php | 5 ++-- api/v3/Address.php | 4 +--- api/v3/Attachment.php | 2 -- api/v3/Batch.php | 2 +- api/v3/Campaign.php | 3 +-- api/v3/Case.php | 3 +-- api/v3/CaseType.php | 4 +--- api/v3/Constant.php | 3 +-- api/v3/Contact.php | 13 ++++++----- api/v3/ContactType.php | 13 ++++------- api/v3/Contribution.php | 4 +--- api/v3/ContributionPage.php | 3 +-- api/v3/ContributionRecur.php | 6 ++--- api/v3/ContributionSoft.php | 4 +--- api/v3/Country.php | 6 +---- api/v3/CustomField.php | 6 ++--- api/v3/CustomGroup.php | 4 +--- api/v3/CustomSearch.php | 33 ++++++++++++++++++++++++++ api/v3/CustomValue.php | 13 +++++------ api/v3/Dashboard.php | 6 +---- api/v3/DashboardContact.php | 3 +-- api/v3/Domain.php | 4 +--- api/v3/Email.php | 4 +--- api/v3/Entity.php | 2 -- api/v3/EntityTag.php | 4 +--- api/v3/Event.php | 4 +--- api/v3/Extension.php | 10 ++++---- api/v3/File.php | 15 ++++++------ api/v3/FinancialAccount.php | 2 +- api/v3/FinancialType.php | 2 +- api/v3/Generic/Update.php | 2 ++ api/v3/Grant.php | 7 +++--- api/v3/Group.php | 10 +++----- api/v3/GroupContact.php | 6 +---- api/v3/GroupNesting.php | 4 +--- api/v3/GroupOrganization.php | 4 +--- api/v3/Im.php | 3 +-- api/v3/Job.php | 7 +----- api/v3/LineItem.php | 3 +-- api/v3/LocBlock.php | 6 ++--- api/v3/LocationType.php | 4 +--- api/v3/MailSettings.php | 14 ++++------- api/v3/Mailing.php | 2 -- api/v3/MailingAB.php | 2 -- api/v3/MailingComponent.php | 2 +- api/v3/MailingContact.php | 4 +--- api/v3/MailingEventConfirm.php | 5 +--- api/v3/MailingEventQueue.php | 2 -- api/v3/MailingEventResubscribe.php | 2 -- api/v3/MailingEventSubscribe.php | 2 -- api/v3/MailingEventUnsubscribe.php | 2 -- api/v3/MailingGroup.php | 4 +--- api/v3/MailingJob.php | 5 +--- api/v3/MailingRecipients.php | 5 +--- api/v3/Membership.php | 4 +--- api/v3/MembershipBlock.php | 18 +++++++-------- api/v3/MembershipPayment.php | 4 +--- api/v3/MembershipStatus.php | 4 +--- api/v3/MembershipType.php | 4 +--- api/v3/MessageTemplate.php | 2 +- api/v3/Note.php | 4 +--- api/v3/OptionGroup.php | 37 ++++++++++++++++++++++++++++-- api/v3/OptionValue.php | 34 +++++++++++++++++++++++++++ api/v3/Participant.php | 4 +--- api/v3/ParticipantPayment.php | 6 ++--- api/v3/ParticipantStatusType.php | 9 +++----- api/v3/PaymentProcessor.php | 3 +-- api/v3/PaymentProcessorType.php | 5 +--- api/v3/Phone.php | 4 +--- api/v3/Pledge.php | 4 +--- api/v3/PledgePayment.php | 10 ++++---- api/v3/Premium.php | 2 +- api/v3/PriceField.php | 6 ++--- api/v3/PriceFieldValue.php | 6 ++--- api/v3/PriceSet.php | 6 ++--- api/v3/PrintLabel.php | 2 +- api/v3/Product.php | 2 +- api/v3/Profile.php | 4 +--- api/v3/Relationship.php | 4 +--- api/v3/RelationshipType.php | 5 +--- api/v3/ReportInstance.php | 32 ++++++++++++++++++++++++++ api/v3/ReportTemplate.php | 32 ++++++++++++++++++++++++++ api/v3/Setting.php | 4 +--- api/v3/SmsProvider.php | 2 +- api/v3/Survey.php | 6 ++--- api/v3/SurveyRespondant.php | 2 +- api/v3/System.php | 8 +++---- api/v3/SystemLog.php | 4 +--- api/v3/Tag.php | 4 +--- api/v3/UFField.php | 4 +--- api/v3/UFGroup.php | 4 +--- api/v3/UFJoin.php | 4 +--- api/v3/UFMatch.php | 4 +--- api/v3/Website.php | 4 +--- api/v3/WordReplacement.php | 4 +--- api/v3/utils.php | 2 -- 101 files changed, 310 insertions(+), 316 deletions(-) diff --git a/api/v3/Acl.php b/api/v3/Acl.php index 5e6018b72e..d1ee882ee9 100644 --- a/api/v3/Acl.php +++ b/api/v3/Acl.php @@ -26,7 +26,7 @@ */ /** - * File for the CiviCRM APIv3 acl functions + * This api exposes CiviCRM acl. * * @package CiviCRM_APIv3 * @subpackage API_acl diff --git a/api/v3/AclRole.php b/api/v3/AclRole.php index 31775ea8c0..33d6c6fcaa 100644 --- a/api/v3/AclRole.php +++ b/api/v3/AclRole.php @@ -26,7 +26,7 @@ */ /** - * File for the CiviCRM APIv3 acl_role functions + * This api exposes CiviCRM acl_role. * * @package CiviCRM_APIv3 * @subpackage API_acl_role diff --git a/api/v3/ActionSchedule.php b/api/v3/ActionSchedule.php index ed0c42605c..946318deb4 100644 --- a/api/v3/ActionSchedule.php +++ b/api/v3/ActionSchedule.php @@ -31,7 +31,6 @@ * @package CiviCRM_APIv3 * @subpackage API_ActionSchedule * - * @copyright CiviCRM LLC (c) 2004-2014 */ /** diff --git a/api/v3/Activity.php b/api/v3/Activity.php index d140f2d94a..f4521ea219 100644 --- a/api/v3/Activity.php +++ b/api/v3/Activity.php @@ -1,6 +1,4 @@ value pairs. If $params is set - * as null, all contact_types will be returned + * One or more valid property_name=>value pairs. + * If $params is set as null, all contact_types will be returned * * @return array * Array of matching contact_types @@ -85,8 +83,7 @@ function civicrm_api3_contact_type_get($params) { * to be deleted is required field in $params array * * @param array $params - * Array containing id of the group. - * to be deleted + * [id] * * @return array * API Result Array diff --git a/api/v3/Contribution.php b/api/v3/Contribution.php index 5c696661f5..3de323215a 100644 --- a/api/v3/Contribution.php +++ b/api/v3/Contribution.php @@ -26,13 +26,11 @@ */ /** - * File for the CiviCRM APIv3 Contribution functions + * This api exposes CiviCRM Contribution. * * @package CiviCRM_APIv3 * @subpackage API_Contribute * - * @copyright CiviCRM LLC (c) 2004-2014 - * @version $Id: Contribution.php 30486 2010-11-02 16:12:09Z shot $ */ /** diff --git a/api/v3/ContributionPage.php b/api/v3/ContributionPage.php index 5c68330cb5..dd3f62571e 100644 --- a/api/v3/ContributionPage.php +++ b/api/v3/ContributionPage.php @@ -27,11 +27,10 @@ /** - * File for the CiviCRM APIv3 group functions + * This api exposes CiviCRM contribution pages. * * @package CiviCRM_APIv3 * @subpackage API_ContributionPage - * @copyright CiviCRM LLC (c) 20042012 */ /** diff --git a/api/v3/ContributionRecur.php b/api/v3/ContributionRecur.php index 41e8bbaf06..fa1c6b8c49 100644 --- a/api/v3/ContributionRecur.php +++ b/api/v3/ContributionRecur.php @@ -26,11 +26,10 @@ */ /** - * File for the CiviCRM APIv3 group functions + * This api exposes CiviCRM recurring contributions. * * @package CiviCRM_APIv3 * @subpackage API_ContributionRecur - * @copyright CiviCRM LLC (c) 2004-2014 */ /** @@ -97,8 +96,7 @@ function civicrm_api3_contribution_recur_cancel($params) { * to be deleted is required field in $params array * * @param array $params - * Array containing id of the group. - * to be deleted + * [id] * * @return array * API result array diff --git a/api/v3/ContributionSoft.php b/api/v3/ContributionSoft.php index 8d6187cf7c..a54e364942 100644 --- a/api/v3/ContributionSoft.php +++ b/api/v3/ContributionSoft.php @@ -26,13 +26,11 @@ */ /** - * File for the CiviCRM APIv3 soft credit functions. + * This api exposes CiviCRM soft credit. * * @package CiviCRM_APIv3 * @subpackage API_ContributionSoft * - * @copyright CiviCRM LLC (c) 2004-2014 - * @version $Id: ContributionSoft.php 2013-05-01 Jon Goldberg $ */ /** diff --git a/api/v3/Country.php b/api/v3/Country.php index 5683691ebf..649d679feb 100644 --- a/api/v3/Country.php +++ b/api/v3/Country.php @@ -1,6 +1,4 @@ 123, * // (omitting :id) inserts or updates a field in a single-valued group @@ -56,10 +55,10 @@ * // inserts another new record in multi-valued group * 'custom_33:-2' => value, * // you can use group_name:field_name instead of ID - * 'custom_some_group:my_field => 'myinfo', + * 'custom_some_group:my_field' => 'myinfo', * // updates record ID 8 in my_other_field in multi-valued some_big_group - * 'custom_some_big_group:my_other_field:8 => 'myinfo', - * + * 'custom_some_big_group:my_other_field:8' => 'myinfo', + * @endcode * * @throws Exception * @return array diff --git a/api/v3/Dashboard.php b/api/v3/Dashboard.php index 706d28e77f..08dbfa2c8c 100644 --- a/api/v3/Dashboard.php +++ b/api/v3/Dashboard.php @@ -1,6 +1,4 @@ value pairs. If $params is set - * as null, all mail_settings will be returned + * Array of one or more property_name=>value pairs. + * If $params is set as null, all mail_settings will be returned * * @return array * API result array. @@ -78,8 +75,7 @@ function civicrm_api3_mail_settings_get($params) { * Delete an existing mail_settings. * * @param array $params - * Array containing id of the group. - * to be deleted + * [id] * * @return array * API result array. diff --git a/api/v3/Mailing.php b/api/v3/Mailing.php index 7e36d2a7cb..c0ca279948 100755 --- a/api/v3/Mailing.php +++ b/api/v3/Mailing.php @@ -31,8 +31,6 @@ * * @package CiviCRM_APIv3 * @subpackage API_Mailing - * @copyright CiviCRM LLC (c) 2004-2014 - * $Id$ */ /** diff --git a/api/v3/MailingAB.php b/api/v3/MailingAB.php index 8685246a11..8b73975ebb 100755 --- a/api/v3/MailingAB.php +++ b/api/v3/MailingAB.php @@ -31,8 +31,6 @@ * * @package CiviCRM_APIv3 * @subpackage API_MailingAB - * @copyright CiviCRM LLC (c) 2004-2014 - * $Id$ */ /** diff --git a/api/v3/MailingComponent.php b/api/v3/MailingComponent.php index 6e8744a477..93bfddab0e 100644 --- a/api/v3/MailingComponent.php +++ b/api/v3/MailingComponent.php @@ -26,7 +26,7 @@ */ /** - * File for the CiviCRM APIv3 mailing_component functions + * This api exposes CiviCRM mailing_component. * * @package CiviCRM_APIv3 * @subpackage API_mailing_component diff --git a/api/v3/MailingContact.php b/api/v3/MailingContact.php index cc8d00841d..dd7fe72a94 100644 --- a/api/v3/MailingContact.php +++ b/api/v3/MailingContact.php @@ -26,13 +26,11 @@ */ /** - * File for the CiviCRM APIv3 contact and mailing functions + * This api exposes CiviCRM contact and mailing. * * @package CiviCRM_APIv3 * @subpackage API_MailingContact * - * @copyright CiviCRM LLC (c) 2004-2014 - * @version $Id$ */ /** diff --git a/api/v3/MailingEventConfirm.php b/api/v3/MailingEventConfirm.php index 039741a2fe..9864bb9cd1 100644 --- a/api/v3/MailingEventConfirm.php +++ b/api/v3/MailingEventConfirm.php @@ -31,16 +31,13 @@ * * @package CiviCRM_APIv3 * @subpackage API_MailerGroup - * @copyright CiviCRM LLC (c) 2004-2014 - * $Id$ */ /** * Handle a confirm event. * * @param array $params - * Associative array of property. - * name/value pairs to insert in new 'survey' + * name/value pairs to insert in new 'survey' * * @throws Exception * @return array diff --git a/api/v3/MailingEventQueue.php b/api/v3/MailingEventQueue.php index ac3bb377fe..6e15045df8 100644 --- a/api/v3/MailingEventQueue.php +++ b/api/v3/MailingEventQueue.php @@ -30,8 +30,6 @@ * * @package CiviCRM_APIv3 * @subpackage API_MailerGroup - * @copyright CiviCRM LLC (c) 2004-2014 - * $Id$ */ /** diff --git a/api/v3/MailingEventResubscribe.php b/api/v3/MailingEventResubscribe.php index a8e06ba0b9..64a3659db6 100644 --- a/api/v3/MailingEventResubscribe.php +++ b/api/v3/MailingEventResubscribe.php @@ -31,8 +31,6 @@ * * @package CiviCRM_APIv3 * @subpackage API_MailerGroup - * @copyright CiviCRM LLC (c) 2004-2014 - * $Id$ */ /** diff --git a/api/v3/MailingEventSubscribe.php b/api/v3/MailingEventSubscribe.php index ea3c57326d..564ecb3376 100644 --- a/api/v3/MailingEventSubscribe.php +++ b/api/v3/MailingEventSubscribe.php @@ -31,8 +31,6 @@ * * @package CiviCRM_APIv3 * @subpackage API_MailerGroup - * @copyright CiviCRM LLC (c) 2004-2014 - * $Id$ */ /** diff --git a/api/v3/MailingEventUnsubscribe.php b/api/v3/MailingEventUnsubscribe.php index 2a0172f0ef..f6667587e5 100644 --- a/api/v3/MailingEventUnsubscribe.php +++ b/api/v3/MailingEventUnsubscribe.php @@ -31,8 +31,6 @@ * * @package CiviCRM_APIv3 * @subpackage API_MailerGroup - * @copyright CiviCRM LLC (c) 2004-2014 - * $Id$ */ /** diff --git a/api/v3/MailingGroup.php b/api/v3/MailingGroup.php index 51f64bb4ae..beb3f1374b 100644 --- a/api/v3/MailingGroup.php +++ b/api/v3/MailingGroup.php @@ -26,13 +26,11 @@ */ /** - * * APIv3 functions for registering/processing mailing group events. * + * @deprecated * @package CiviCRM_APIv3 * @subpackage API_MailerGroup - * @copyright CiviCRM LLC (c) 2004-2014 - * $Id$ */ /** diff --git a/api/v3/MailingJob.php b/api/v3/MailingJob.php index a8604a3efb..649c311387 100644 --- a/api/v3/MailingJob.php +++ b/api/v3/MailingJob.php @@ -27,12 +27,10 @@ /** * - * APIv3 functions for registering/processing mailing events. + * APIv3 functions for registering/processing mailing jobs. * * @package CiviCRM_APIv3 * @subpackage API_Mailing - * @copyright CiviCRM LLC (c) 2004-2014 - * $Id$ */ /** @@ -65,7 +63,6 @@ function _civicrm_api3_mailing_job_create_spec(&$params) { * Returns array of Mailing Jobs matching a set of one or more group properties. * * @param array $params - * Array of one or more valid. * * @return array * API return Array of matching mailing jobs. diff --git a/api/v3/MailingRecipients.php b/api/v3/MailingRecipients.php index f745f20388..6b39269b05 100644 --- a/api/v3/MailingRecipients.php +++ b/api/v3/MailingRecipients.php @@ -26,13 +26,10 @@ */ /** - * - * APIv3 functions for registering/processing mailing events. + * APIv3 functions for registering/processing mailing recipients. * * @package CiviCRM_APIv3 * @subpackage API_Mailing - * @copyright CiviCRM LLC (c) 2004-2014 - * $Id$ */ diff --git a/api/v3/Membership.php b/api/v3/Membership.php index 9e99405acd..3951239c31 100644 --- a/api/v3/Membership.php +++ b/api/v3/Membership.php @@ -27,13 +27,11 @@ /** * - * File for the CiviCRM APIv3 membership contact functions + * This api exposes CiviCRM membership contact. * * @package CiviCRM_APIv3 * @subpackage API_Membership * - * @copyright CiviCRM LLC (c) 2004-2014 - * @version $Id: MembershipContact.php 30171 2010-10-14 09:11:27Z mover $ */ /** diff --git a/api/v3/MembershipBlock.php b/api/v3/MembershipBlock.php index a5d200512d..77cade9fdf 100644 --- a/api/v3/MembershipBlock.php +++ b/api/v3/MembershipBlock.php @@ -26,23 +26,21 @@ */ /** - * File for the CiviCRM APIv3 membership type functions + * This api exposes CiviCRM membership block. * * @package CiviCRM_APIv3 * @subpackage API_Membership * - * @copyright CiviCRM LLC (c) 2004-2014 - * @version $Id: MembershipBlock.php 30171 2010-10-14 09:11:27Z mover $ */ /** - * API to Create or update a Membership Type. + * API to Create or update a Membership Block. * * @param array $params * An associative array of name/value property values of civicrm_membership_block. * * @return array - * newly created or updated membership type property values. + * newly created or updated membership block property values. */ function civicrm_api3_membership_block_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -63,9 +61,9 @@ function _civicrm_api3_membership_block_create_spec(&$params) { } /** - * Get a Membership Type. + * Get a Membership Block. * - * This api is used for finding an existing membership type. + * This api is used for finding an existing membership block. * * @param array $params * An associative array of name/value property values of civicrm_membership_block. @@ -79,10 +77,10 @@ function civicrm_api3_membership_block_get($params) { } /** - * Deletes an existing membership type. + * Deletes an existing membership block. * - * This API is used for deleting a membership type - * Required parameters : id of a membership type + * This API is used for deleting a membership block + * Required parameters : id of a membership block * * @param array $params * diff --git a/api/v3/MembershipPayment.php b/api/v3/MembershipPayment.php index 2f2e8c0f94..3eb49d0421 100644 --- a/api/v3/MembershipPayment.php +++ b/api/v3/MembershipPayment.php @@ -26,13 +26,11 @@ */ /** - * File for the CiviCRM APIv3 membership contribution link functions + * This api exposes CiviCRM membership contribution link. * * @package CiviCRM_APIv3 * @subpackage API_Membership * @todo delete function doesn't exist - * @copyright CiviCRM LLC (c) 2004-2014 - * @version $Id: MembershipContributionLink.php 30171 2010-10-14 09:11:27Z mover $ */ /** diff --git a/api/v3/MembershipStatus.php b/api/v3/MembershipStatus.php index 3e8a7d2e7d..42c5172d44 100644 --- a/api/v3/MembershipStatus.php +++ b/api/v3/MembershipStatus.php @@ -26,13 +26,11 @@ */ /** - * File for the CiviCRM APIv3 membership status functions + * This api exposes CiviCRM membership status. * * @package CiviCRM_APIv3 * @subpackage API_Membership * - * @copyright CiviCRM LLC (c) 2004-2014 - * @version $Id: MembershipStatus.php 30171 2010-10-14 09:11:27Z mover $ */ /** diff --git a/api/v3/MembershipType.php b/api/v3/MembershipType.php index e5f102197f..5442b5610c 100644 --- a/api/v3/MembershipType.php +++ b/api/v3/MembershipType.php @@ -26,13 +26,11 @@ */ /** - * File for the CiviCRM APIv3 membership type functions + * This api exposes CiviCRM membership type. * * @package CiviCRM_APIv3 * @subpackage API_Membership * - * @copyright CiviCRM LLC (c) 2004-2014 - * @version $Id: MembershipType.php 30171 2010-10-14 09:11:27Z mover $ */ /** diff --git a/api/v3/MessageTemplate.php b/api/v3/MessageTemplate.php index 1a330542c6..26c4805fcb 100644 --- a/api/v3/MessageTemplate.php +++ b/api/v3/MessageTemplate.php @@ -25,7 +25,7 @@ */ /** - * File for the CiviCRM APIv3 message_template functions + * This api exposes CiviCRM message_template. * * @package CiviCRM_SEPA */ diff --git a/api/v3/Note.php b/api/v3/Note.php index 0322f11079..86fe2ee0bc 100644 --- a/api/v3/Note.php +++ b/api/v3/Note.php @@ -26,13 +26,11 @@ */ /** - * File for the CiviCRM APIv3 note functions + * This api exposes CiviCRM note. * * @package CiviCRM_APIv3 * @subpackage API_Note * - * @copyright CiviCRM LLC (c) 2004-2014 - * @version $Id: Note.php 30879 2010-11-22 15:45:55Z shot $ */ /** diff --git a/api/v3/OptionGroup.php b/api/v3/OptionGroup.php index d3a5f495bd..c65ffee5e3 100644 --- a/api/v3/OptionGroup.php +++ b/api/v3/OptionGroup.php @@ -1,4 +1,38 @@