From 5f53b1c171d164470d6bbf6002841cdd17c55912 Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Mon, 12 Jan 2015 10:18:17 -0500 Subject: [PATCH] INFRA-132 - Fix @static docblock tag --- api/api.php | 2 +- api/v3/CaseType.php | 2 +- api/v3/Contact.php | 6 +++--- api/v3/Contribution.php | 12 ++++++------ api/v3/Extension.php | 16 ++++++++-------- api/v3/Job.php | 18 +++++++++--------- api/v3/MailingContact.php | 4 ++-- api/v3/Note.php | 2 +- api/v3/PaymentProcessorType.php | 2 +- api/v3/Pledge.php | 2 +- api/v3/PledgePayment.php | 6 +++--- api/v3/Relationship.php | 4 ++-- api/v3/RelationshipType.php | 2 +- api/v3/SurveyRespondant.php | 2 +- api/v3/System.php | 2 +- api/v3/utils.php | 4 ++-- 16 files changed, 43 insertions(+), 43 deletions(-) diff --git a/api/api.php b/api/api.php index cb044c2a8b..729f1c766f 100644 --- a/api/api.php +++ b/api/api.php @@ -91,7 +91,7 @@ function _civicrm_api3_api_getfields(&$apiRequest) { * * @return boolean * true if error, false otherwise - * @static void + * @static * @access public */ function civicrm_error($result) { diff --git a/api/v3/CaseType.php b/api/v3/CaseType.php index 139b852d3e..b24b7be45b 100644 --- a/api/v3/CaseType.php +++ b/api/v3/CaseType.php @@ -48,7 +48,7 @@ * @return array * API result array * - * @static void + * @static * @access public */ function civicrm_api3_case_type_create($params) { diff --git a/api/v3/Contact.php b/api/v3/Contact.php index 00aeb2b169..0bdcffdeaf 100644 --- a/api/v3/Contact.php +++ b/api/v3/Contact.php @@ -53,7 +53,7 @@ * @return array * API Result Array * - * @static void + * @static * @access public */ function civicrm_api3_contact_create($params) { @@ -148,7 +148,7 @@ function _civicrm_api3_contact_create_spec(&$params) { * @return array * API Result Array * (@getfields contact_get} - * @static void + * @static * @access public * * @example ContactGet.php Standard GET example @@ -879,7 +879,7 @@ function _civicrm_api3_contact_deprecation() { * @return array * API Result Array * - * @static void + * @static * @access public */ function civicrm_api3_contact_merge($params) { diff --git a/api/v3/Contribution.php b/api/v3/Contribution.php index 8a0923f9ea..a95b586014 100644 --- a/api/v3/Contribution.php +++ b/api/v3/Contribution.php @@ -46,7 +46,7 @@ * @throws API_Exception * @return array * Api result array - * @static void + * @static * @access public * @example ContributionCreate.php * {@getfields Contribution_create} @@ -179,7 +179,7 @@ function _civicrm_api3_contribution_create_legacy_support_45(&$params) { * * @return boolean * true if success, else false - * @static void + * @static * @access public * {@getfields Contribution_delete} * @example ContributionDelete.php @@ -210,7 +210,7 @@ function _civicrm_api3_contribution_delete_spec(&$params) { * * @return array * Array of contributions, if error an array with an error id and error message - * @static void + * @static * @access public * {@getfields Contribution_get} * @example ContributionGet.php @@ -307,7 +307,7 @@ function _civicrm_api3_contribution_transact_spec(&$params) { * * @return array * (reference ) contribution of created or updated record (or a civicrm error) - * @static void + * @static * @access public * */ @@ -362,7 +362,7 @@ function civicrm_api3_contribution_transact($params) { * @throws Exception * @return array * Api result array - * @static void + * @static * @access public */ function civicrm_api3_contribution_sendconfirmation($params) { @@ -420,7 +420,7 @@ function _civicrm_api3_contribution_sendconfirmation_spec(&$params) { * @throws API_Exception * @return array * Api result array - * @static void + * @static * @access public */ function civicrm_api3_contribution_completetransaction(&$params) { diff --git a/api/v3/Extension.php b/api/v3/Extension.php index 3d59825453..499bb054f5 100644 --- a/api/v3/Extension.php +++ b/api/v3/Extension.php @@ -50,7 +50,7 @@ define('API_V3_EXTENSION_DELIMITER', ','); * * @return array * API result - * @static void + * @static * @access public * @example ExtensionInstall.php * @@ -76,7 +76,7 @@ function civicrm_api3_extension_install($params) { * * @return array * API result - * @static void + * @static * @access public * */ @@ -115,7 +115,7 @@ function civicrm_api3_extension_upgrade() { * * @return array * API result - * @static void + * @static * @access public * @example ExtensionEnable.php * @@ -141,7 +141,7 @@ function civicrm_api3_extension_enable($params) { * * @return array * API result - * @static void + * @static * @access public * @example ExtensionDisable.php * @@ -168,7 +168,7 @@ function civicrm_api3_extension_disable($params) { * * @return array * API result - * @static void + * @static * @access public * @example ExtensionUninstall.php * @@ -195,7 +195,7 @@ function civicrm_api3_extension_uninstall($params) { * @throws API_Exception * @return array * API result - * @static void + * @static * @access public * @example ExtensionDownload.php */ @@ -247,7 +247,7 @@ function civicrm_api3_extension_download($params) { * * @return array * API result - * @static void + * @static * @access public * @example ExtensionRefresh.php * @@ -280,7 +280,7 @@ function civicrm_api3_extension_refresh($params) { * * @return array * API result - * @static void + * @static * @access public * @example ExtensionGet.php */ diff --git a/api/v3/Job.php b/api/v3/Job.php index e617841c6c..ff44926ad7 100644 --- a/api/v3/Job.php +++ b/api/v3/Job.php @@ -91,7 +91,7 @@ function civicrm_api3_job_get($params) { * @return array * API Result Array * {@getfields Job_delete} - * @static void + * @static * @access public */ function civicrm_api3_job_delete($params) { @@ -108,7 +108,7 @@ function civicrm_api3_job_delete($params) { * @return array * API Result Array * - * @static void + * @static * @access public * */ @@ -139,7 +139,7 @@ function _civicrm_api3_job_execute_spec(&$params) { * API Result Array * {@getfields contact_geocode} * - * @static void + * @static * @access public * * @@ -181,7 +181,7 @@ function _civicrm_api3_job_geocode_spec(&$params) { * * @return boolean * true if success, else false - * @static void + * @static * @access public * */ @@ -232,7 +232,7 @@ function _civicrm_api3_job_send_reminder(&$params) { * * @return boolean * true if success, else false - * @static void + * @static * @access public * */ @@ -455,7 +455,7 @@ function civicrm_api3_job_process_participant($params) { * * @return boolean * true if success, else false - * @static void + * @static * @access public */ function civicrm_api3_job_process_membership($params) { @@ -483,7 +483,7 @@ function civicrm_api3_job_process_membership($params) { * * @return boolean * true if success, else false - * @static void + * @static * @access public */ function civicrm_api3_job_process_respondent($params) { @@ -513,7 +513,7 @@ function civicrm_api3_job_process_respondent($params) { * @return array * API Result Array * - * @static void + * @static * @access public */ function civicrm_api3_job_process_batch_merge($params) { @@ -577,7 +577,7 @@ function civicrm_api3_job_run_payment_cron($params) { * * @return boolean * true if success, else false - * @static void + * @static * @access public */ function civicrm_api3_job_cleanup($params) { diff --git a/api/v3/MailingContact.php b/api/v3/MailingContact.php index ffd4c37dcc..c6fde4f62e 100644 --- a/api/v3/MailingContact.php +++ b/api/v3/MailingContact.php @@ -44,7 +44,7 @@ * * @return array * API result - * @static void + * @static * @access public * */ @@ -280,7 +280,7 @@ INNER JOIN civicrm_mailing_event_bounce meb ON meb.event_queue_id = meq.id * * @return array * API result - * @static void + * @static * @access public * @example CRM/Mailing/BAO/Mailing.php * diff --git a/api/v3/Note.php b/api/v3/Note.php index e8aad30f1e..84ae06c90f 100644 --- a/api/v3/Note.php +++ b/api/v3/Note.php @@ -100,7 +100,7 @@ function civicrm_api3_note_delete($params) { * array of properties, * if error an array with an error id and error message * {@getfields note_get} - * @static void + * @static * @access public */ function civicrm_api3_note_get($params) { diff --git a/api/v3/PaymentProcessorType.php b/api/v3/PaymentProcessorType.php index 28a6b1a4f2..74828fd898 100644 --- a/api/v3/PaymentProcessorType.php +++ b/api/v3/PaymentProcessorType.php @@ -104,7 +104,7 @@ function civicrm_api3_payment_processor_type_get($params) { * @return array * API Result Array * {@getfields PaymentProcessorType_delete} - * @static void + * @static * @access public */ function civicrm_api3_payment_processor_type_delete($params) { diff --git a/api/v3/Pledge.php b/api/v3/Pledge.php index 0f00e791e2..7005dcc353 100644 --- a/api/v3/Pledge.php +++ b/api/v3/Pledge.php @@ -71,7 +71,7 @@ function civicrm_api3_pledge_create($params) { * * @return boolean * true if success, else false - * @static void + * @static * {@getfields pledge_delete} * @example PledgeDelete.php * @access public diff --git a/api/v3/PledgePayment.php b/api/v3/PledgePayment.php index a7e2a3ce7e..0b7ecb08df 100644 --- a/api/v3/PledgePayment.php +++ b/api/v3/PledgePayment.php @@ -52,7 +52,7 @@ * * @return array * API Result - * @static void + * @static * @access public */ function civicrm_api3_pledge_payment_create($params) { @@ -102,7 +102,7 @@ function _civicrm_api3_pledge_payment_create_spec(&$params) { * * @return array * API result - * @static void + * @static * @access public */ function civicrm_api3_pledge_payment_delete($params) { @@ -125,7 +125,7 @@ function civicrm_api3_pledge_payment_delete($params) { * * @return array * (reference ) array of pledges, if error an array with an error id and error message - * @static void + * @static * @access public */ function civicrm_api3_pledge_payment_get($params) { diff --git a/api/v3/Relationship.php b/api/v3/Relationship.php index 5a36bc3534..fd29a8db18 100644 --- a/api/v3/Relationship.php +++ b/api/v3/Relationship.php @@ -49,7 +49,7 @@ * @return array * API Result Array * {@getfields relationship_create} - * @static void + * @static * @access public */ function civicrm_api3_relationship_create($params) { @@ -80,7 +80,7 @@ function _civicrm_api3_relationship_create_spec(&$params) { * {@getfields relationship_delete} * @example RelationshipDelete.php Delete Example * - * @static void + * @static * @access public */ function civicrm_api3_relationship_delete($params) { diff --git a/api/v3/RelationshipType.php b/api/v3/RelationshipType.php index e7c7d08783..6d13a07b3d 100644 --- a/api/v3/RelationshipType.php +++ b/api/v3/RelationshipType.php @@ -111,7 +111,7 @@ function civicrm_api3_relationship_type_get($params) { * @return array * API Result Array * {@getfields RelationshipType_delete} - * @static void + * @static * @access public */ function civicrm_api3_relationship_type_delete($params) { diff --git a/api/v3/SurveyRespondant.php b/api/v3/SurveyRespondant.php index c6993b2c1b..817c0f98fa 100644 --- a/api/v3/SurveyRespondant.php +++ b/api/v3/SurveyRespondant.php @@ -50,7 +50,7 @@ function _civicrm_api3_survey_respondant_deprecation() { * * @return array * (reference ) contribution_id of created or updated record - * @static void + * @static * @access public * @deprecated - api currently not supported */ diff --git a/api/v3/System.php b/api/v3/System.php index a256b6080b..5a7e1d95a7 100644 --- a/api/v3/System.php +++ b/api/v3/System.php @@ -47,7 +47,7 @@ * * @return boolean * true if success, else false - * @static void + * @static * @access public * @example SystemFlush.php * diff --git a/api/v3/utils.php b/api/v3/utils.php index 5305bc7891..087aa74c87 100644 --- a/api/v3/utils.php +++ b/api/v3/utils.php @@ -870,7 +870,7 @@ function _civicrm_api3_get_unique_name_array(&$bao) { * * @return array * - * @static void + * @static * @access public */ function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, $entity = "", $autoFind = TRUE) { @@ -943,7 +943,7 @@ function _civicrm_api3_custom_fields_are_required($entity, $params) { * @param array|bool $uniqueFields * * @return array - * @static void + * @static * @access public */ function _civicrm_api3_object_to_array(&$dao, &$values, $uniqueFields = FALSE) { -- 2.25.1