From 364c80f14cb47ff46a55fcf5d541eef501293012 Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Fri, 30 Jan 2015 16:34:18 -0500 Subject: [PATCH] INFRA-132 - Comment cleanup - remove @access tag --- CRM/Contact/BAO/Contact.php | 2 +- CRM/Contact/BAO/GroupNesting.php | 14 +++++++------- CRM/Mailing/BAO/Mailing.php | 3 +-- CRM/Price/Form/DeleteSet.php | 1 - api/v3/Relationship.php | 1 - api/v3/RelationshipType.php | 1 - 6 files changed, 9 insertions(+), 13 deletions(-) diff --git a/CRM/Contact/BAO/Contact.php b/CRM/Contact/BAO/Contact.php index f6b59effc6..c7fb985713 100644 --- a/CRM/Contact/BAO/Contact.php +++ b/CRM/Contact/BAO/Contact.php @@ -1108,7 +1108,7 @@ WHERE id={$id}; "; * @param int $id * Id of the contact whose contact sub type is needed. * - * @param null $implodeDelimiter + * @param string $implodeDelimiter * * @return string * contact_sub_type if $id found else null "" diff --git a/CRM/Contact/BAO/GroupNesting.php b/CRM/Contact/BAO/GroupNesting.php index b065d4a172..732e9d35e5 100644 --- a/CRM/Contact/BAO/GroupNesting.php +++ b/CRM/Contact/BAO/GroupNesting.php @@ -549,7 +549,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * @param bool $includeSelf * * @return array - * List of groupIds that represent the requested group and its ancestors@access public + * List of groupIds that represent the requested group and its ancestors */ public static function getAncestorGroupIds($groupIds, $includeSelf = TRUE) { if (!is_array($groupIds)) { @@ -586,7 +586,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * * @param bool $includeSelf * @return array - * List of ancestor groups@access public + * List of ancestor groups */ public static function getAncestorGroups($groupIds, $includeSelf = TRUE) { $groupIds = self::getAncestorGroupIds($groupIds, $includeSelf); @@ -601,7 +601,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * An array of valid group ids (passed by reference). * * @return array - * List of groupIds that represent the requested group and its children@access public + * List of groupIds that represent the requested group and its children */ public static function getChildGroupIds($groupIds) { if (!is_array($groupIds)) { @@ -624,7 +624,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * An array of valid group ids (passed by reference). * * @return array - * List of groupIds that represent the requested group and its parents@access public + * List of groupIds that represent the requested group and its parents */ public static function getParentGroupIds($groupIds) { if (!is_array($groupIds)) { @@ -648,7 +648,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * * @param bool $includeSelf * @return array - * List of groupIds that represent the requested group and its descendents@access public + * List of groupIds that represent the requested group and its descendents */ public static function getDescendentGroupIds($groupIds, $includeSelf = TRUE) { if (!is_array($groupIds)) { @@ -683,7 +683,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * * @param bool $includeSelf * @return array - * List of descendent groups@access public + * List of descendent groups */ public static function getDescendentGroups($groupIds, $includeSelf = TRUE) { $groupIds = self::getDescendentGroupIds($groupIds, $includeSelf); @@ -698,7 +698,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * The group id to get valid potential children for. * * @return array - * List of groupIds that represent the valid potential children of the group@access public + * List of groupIds that represent the valid potential children of the group */ public static function getPotentialChildGroupIds($groupId) { $groups = CRM_Contact_BAO_Group::getGroups(); diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php index b14cc5218a..15709cf017 100644 --- a/CRM/Mailing/BAO/Mailing.php +++ b/CRM/Mailing/BAO/Mailing.php @@ -1061,8 +1061,7 @@ ORDER BY civicrm_email.is_bulkmail DESC * @param bool $isForward * * @return array - * (reference) array array ref that hold array refs to the verp info, urls, and headers - * @access private + * array ref that hold array refs to the verp info, urls, and headers */ private function getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email, $isForward = FALSE) { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Price/Form/DeleteSet.php b/CRM/Price/Form/DeleteSet.php index cbfad144f8..34d6fc5801 100644 --- a/CRM/Price/Form/DeleteSet.php +++ b/CRM/Price/Form/DeleteSet.php @@ -56,7 +56,6 @@ class CRM_Price_Form_DeleteSet extends CRM_Core_Form { * Set up variables to build the form * * @return void - * @access protected */ public function preProcess() { $this->_sid = $this->get('sid'); diff --git a/api/v3/Relationship.php b/api/v3/Relationship.php index 3c199adf3d..cd45bcf037 100644 --- a/api/v3/Relationship.php +++ b/api/v3/Relationship.php @@ -108,7 +108,6 @@ function civicrm_api3_relationship_delete($params) { * API Result Array * {@getfields relationship_get} * @example RelationshipGet.php - * @access public */ function civicrm_api3_relationship_get($params) { $options = _civicrm_api3_get_options_from_params($params); diff --git a/api/v3/RelationshipType.php b/api/v3/RelationshipType.php index bb04607350..a256a822cf 100644 --- a/api/v3/RelationshipType.php +++ b/api/v3/RelationshipType.php @@ -91,7 +91,6 @@ function _civicrm_api3_relationship_type_create_spec(&$params) { /** * get all relationship type * retruns An array of Relationship_type - * @access public * {@getfields RelationshipType_get} * @example RelationshipTypeGet.php * @param array $params -- 2.25.1