INFRA-132 - Fix @static docblock tag

diff --git a/api/api.php b/api/api.php
index cb044c2a8b257351a0d63edd8136ce4d77545290..729f1c766f8f14aa83c11f1e43b5efe23f1b86a8 100644 (file)
--- 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 139b852d3e6754e93ee9caea2d33707ae4e71ecc..b24b7be45b63e86368a02d97cea11c26b4f82dcc 100644 (file)
--- 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 00aeb2b1696289ce9cb545cb1e7f908f6c807d3c..0bdcffdeaf117fe1593b24ed5b635bd566bfb74a 100644 (file)
--- 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 8a0923f9eac55b505ad9aaf200b4590369c1d19e..a95b58601408e8a6c76dde60a4de8702512a88b9 100644 (file)
--- 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 3d598254536c551698bab6a5f996d4a1b6758c6a..499bb054f5321505f5a54340f233c5a0f09df9ca 100644 (file)
--- 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 e617841c6cf96cfd59e366453ac66ac2036f318c..ff44926ad711157edf20add7e21580cb2a03c78b 100644 (file)
--- 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 ffd4c37dcc2d4d250c9d3d791247fbe2ee6cffcb..c6fde4f62e03cdbe32c625014cfdb2776815385a 100644 (file)
--- 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 e8aad30f1e6a02595990f56d671b1b1b315f36f4..84ae06c90fbd969e1916e8b2b148c473c7f4a855 100644 (file)
--- 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 28a6b1a4f2c97600a192c2fc3e76a8b33943265e..74828fd898f9810539b977252b407b2bc87b40e8 100644 (file)
--- 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 0f00e791e2aa8b51c05fb6591776ba51d94f2484..7005dcc3539d32b87c59d730efe8a9fa70169985 100644 (file)
--- 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 a7e2a3ce7ee96ed3800bdc77991726031fba78fb..0b7ecb08dfebe8453d60e60e931b6da45f662319 100644 (file)
--- 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 5a36bc353460109ac5ba4f240a037d723d89fd90..fd29a8db18a3251575a7dae232125386e0c01b82 100644 (file)
--- 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 e7c7d08783e52a62eb7d3f76850c4a766965f676..6d13a07b3d08b087f07d9650bad4d1c5169a702b 100644 (file)
--- 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 c6993b2c1b4f01b25e6afeb98898326c27a1b78e..817c0f98fa253a14742a3092e0bbef6b0d119b1a 100644 (file)
--- 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 a256b6080bdd23b8c2fc6431b09ad25b047c32da..5a7e1d95a770c4698fe380a051239679284e916f 100644 (file)
--- 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 5305bc789188cec58c4a8c86ebe56148d747aa51..087aa74c874d05ff75bac4badbe41d37ae0e510e 100644 (file)
--- 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) {