From b081365f52508bfd1fb0d3d15f3a0d48f5e9df12 Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Thu, 5 Feb 2015 21:19:24 -0500 Subject: [PATCH] Api docblock cleanup. --- api/Exception.php | 1 - api/api.php | 7 +--- api/v3/Acl.php | 4 -- api/v3/AclRole.php | 1 - api/v3/ActionSchedule.php | 9 ++--- api/v3/Activity.php | 3 +- api/v3/ActivityContact.php | 4 +- api/v3/ActivityType.php | 7 ++-- api/v3/Address.php | 6 +-- api/v3/Attachment.php | 1 - api/v3/Batch.php | 3 +- api/v3/Campaign.php | 7 ++-- api/v3/Case.php | 17 +++------ api/v3/CaseType.php | 1 - api/v3/Constant.php | 3 +- api/v3/Contact.php | 20 ++++------ api/v3/ContactType.php | 7 +++- api/v3/Contribution.php | 12 +++--- api/v3/ContributionPage.php | 1 - api/v3/ContributionRecur.php | 7 +--- api/v3/ContributionSoft.php | 4 +- api/v3/Country.php | 4 +- api/v3/CustomField.php | 4 +- api/v3/CustomGroup.php | 4 +- api/v3/CustomSearch.php | 4 +- api/v3/CustomValue.php | 6 +-- api/v3/Dashboard.php | 1 - api/v3/DashboardContact.php | 4 +- api/v3/Domain.php | 6 +-- api/v3/Email.php | 4 +- api/v3/EntityTag.php | 4 +- api/v3/Event.php | 6 +-- api/v3/Extension.php | 3 -- api/v3/File.php | 6 +-- api/v3/FinancialAccount.php | 1 - api/v3/FinancialType.php | 1 - api/v3/Generic.php | 29 +++++++++++++++ api/v3/Generic/Getactions.php | 48 +++++++++++++----------- api/v3/Generic/Getlist.php | 49 +++++++++++++----------- api/v3/Generic/Setvalue.php | 30 +++++++++++++++ api/v3/Generic/Update.php | 4 ++ api/v3/Grant.php | 14 +++---- api/v3/Group.php | 12 +++--- api/v3/GroupContact.php | 60 +++++++++++++++++------------- api/v3/GroupNesting.php | 8 ++-- api/v3/GroupOrganization.php | 4 +- api/v3/Im.php | 4 +- api/v3/Job.php | 9 ++--- api/v3/LineItem.php | 6 +-- api/v3/LocBlock.php | 1 - api/v3/LocationType.php | 4 +- api/v3/MailSettings.php | 3 +- api/v3/Mailing.php | 11 +++--- api/v3/MailingAB.php | 5 +-- api/v3/MailingComponent.php | 1 - api/v3/MailingContact.php | 4 +- api/v3/MailingEventConfirm.php | 3 +- api/v3/MailingEventQueue.php | 3 +- api/v3/MailingEventResubscribe.php | 3 +- api/v3/MailingEventSubscribe.php | 3 +- api/v3/MailingEventUnsubscribe.php | 3 +- api/v3/MailingGroup.php | 1 - api/v3/MailingJob.php | 3 +- api/v3/MailingRecipients.php | 1 - api/v3/Membership.php | 6 +-- api/v3/MembershipBlock.php | 4 +- api/v3/MembershipPayment.php | 3 +- api/v3/MembershipStatus.php | 5 +-- api/v3/MembershipType.php | 4 +- api/v3/MessageTemplate.php | 6 +-- api/v3/Note.php | 7 +--- api/v3/OptionGroup.php | 4 +- api/v3/OptionValue.php | 4 +- api/v3/Participant.php | 6 +-- api/v3/ParticipantPayment.php | 4 +- api/v3/ParticipantStatusType.php | 5 +-- api/v3/PaymentProcessor.php | 4 +- api/v3/PaymentProcessorType.php | 3 +- api/v3/Phone.php | 5 +-- api/v3/Phone/Get.php | 29 +++++++++++++++ api/v3/Pledge.php | 4 -- api/v3/PledgePayment.php | 4 +- api/v3/Premium.php | 1 - api/v3/PriceField.php | 6 +-- api/v3/PriceFieldValue.php | 6 +-- api/v3/PriceSet.php | 6 +-- api/v3/PrintLabel.php | 1 - api/v3/Product.php | 1 - api/v3/Profile.php | 1 - api/v3/Relationship.php | 4 +- api/v3/RelationshipType.php | 3 +- api/v3/ReportInstance.php | 5 +-- api/v3/ReportTemplate.php | 5 +-- api/v3/Setting.php | 3 +- api/v3/SmsProvider.php | 3 +- api/v3/Survey.php | 13 ++++--- api/v3/SurveyRespondant.php | 3 +- api/v3/System.php | 10 ++--- api/v3/SystemLog.php | 2 - api/v3/Tag.php | 11 ++++-- api/v3/UFField.php | 2 - api/v3/UFGroup.php | 6 +-- api/v3/UFJoin.php | 4 +- api/v3/UFMatch.php | 4 +- api/v3/Website.php | 6 +-- api/v3/WordReplacement.php | 7 ++-- api/v3/utils.php | 6 +-- 107 files changed, 346 insertions(+), 389 deletions(-) diff --git a/api/Exception.php b/api/Exception.php index 2bb9dcdd76..812bb603c0 100644 --- a/api/Exception.php +++ b/api/Exception.php @@ -4,7 +4,6 @@ * File for the CiviCRM APIv3 API wrapper * * @package CiviCRM_APIv3 - * @subpackage API * * @copyright CiviCRM LLC (c) 2004-2014 */ diff --git a/api/api.php b/api/api.php index 6c263513e8..1ba09c7b3b 100644 --- a/api/api.php +++ b/api/api.php @@ -1,14 +1,9 @@ int OR * 'case_type' => str (provide one or the other) @@ -52,6 +52,7 @@ * 'start_date' => str datestamp // defaults to: date('YmdHis') * 'duration' => int // in minutes * 'details' => str // html format + * @endcode * * @throws API_Exception * @return array @@ -141,7 +142,7 @@ function _civicrm_api3_case_get_spec(&$params) { * Adjust Metadata for Create Action. * * @param array $params - * Array or parameters determined by getfields. + * Array of parameters determined by getfields. */ function _civicrm_api3_case_create_spec(&$params) { $params['contact_id']['api.aliases'] = array('client_id'); @@ -163,7 +164,7 @@ function _civicrm_api3_case_create_spec(&$params) { * Adjust Metadata for Update action. * * @param array $params - * Array or parameters determined by getfields. + * Array of parameters determined by getfields. */ function _civicrm_api3_case_update_spec(&$params) { $params['id']['api.required'] = 1; @@ -173,7 +174,7 @@ function _civicrm_api3_case_update_spec(&$params) { * Adjust Metadata for Delete action. * * @param array $params - * Array or parameters determined by getfields. + * Array of parameters determined by getfields. */ function _civicrm_api3_case_delete_spec(&$params) { $params['id']['api.required'] = 1; @@ -387,12 +388,6 @@ function civicrm_api3_case_delete($params) { } } -/***********************************/ -/* */ -/* INTERNAL FUNCTIONS */ -/* */ -/***********************************/ - /** * Internal function to retrieve a case. * diff --git a/api/v3/CaseType.php b/api/v3/CaseType.php index 74f5b4d2fe..bd556ec65a 100644 --- a/api/v3/CaseType.php +++ b/api/v3/CaseType.php @@ -29,7 +29,6 @@ * This api exposes CiviCRM Case. * * @package CiviCRM_APIv3 - * @subpackage API_Case */ /** diff --git a/api/v3/Constant.php b/api/v3/Constant.php index d11571f745..cdcf39eb5f 100644 --- a/api/v3/Constant.php +++ b/api/v3/Constant.php @@ -31,7 +31,6 @@ * @deprecated * The constant api is deprecated as of CiviCRM 4.4. Please use the getoptions api action instead. * @package CiviCRM_APIv3 - * @subpackage API_Constant */ /** @@ -53,7 +52,7 @@ function _civicrm_api3_constant_deprecation() { * * @param array $params * Name of a public static method of - * CRM_Core_PseudoConstant: one of + * CRM_Core_PseudoConstant: one of *