Commit 100fef9d authored by colemanw's avatar colemanw

Cleanup phpdoc comments

parent 1fa961e3
......@@ -47,7 +47,7 @@ class CRM_ACL_API {
CONST ALL = 6;
/**
* given a permission string, check for access requirements
* Given a permission string, check for access requirements
*
* @param string $str the permission to check
* @param int $contactID the contactID for whom the check is made
......@@ -135,7 +135,7 @@ class CRM_ACL_API {
}
/**
* get all the groups the user has access to for the given operation
* Get all the groups the user has access to for the given operation
*
* @param int $type the type of permission needed
* @param int $contactID the contactID for whom the check is made
......@@ -168,10 +168,10 @@ class CRM_ACL_API {
}
/**
* check if the user has access to this group for operation $type
* Check if the user has access to this group for operation $type
*
* @param int $type the type of permission needed
* @param $groupID
* @param int $groupID
* @param int $contactID the contactID for whom the check is made
*
* @param string $tableName
......
......@@ -674,7 +674,7 @@ SELECT $acl.*
}
/**
* update the is_active flag in the db
* Update the is_active flag in the db
*
* @param int $id id of the database record
* @param boolean $is_active value we want to set the is_active field
......@@ -691,7 +691,7 @@ SELECT $acl.*
/**
* @param $str
* @param $contactID
* @param int $contactID
*
* @return bool
*/
......@@ -725,7 +725,7 @@ SELECT count( a.id )
* @param $type
* @param $tables
* @param $whereTables
* @param null $contactID
* @param int $contactID
*
* @return null|string
*/
......@@ -847,7 +847,7 @@ SELECT g.*
/**
* @param int $type
* @param null $contactID
* @param int $contactID
* @param string $tableName
* @param null $allGroups
* @param null $includedGroups
......@@ -963,7 +963,7 @@ ORDER BY a.object_id
}
/**
* delete ACL records
* Delete ACL records
*
* @param int $aclId ID of the ACL record to be deleted.
*
......
......@@ -41,7 +41,7 @@ class CRM_ACL_BAO_Cache extends CRM_ACL_DAO_Cache {
static $_cache = NULL;
/**
* @param $id
* @param int $id
*
* @return mixed
*/
......@@ -67,7 +67,7 @@ class CRM_ACL_BAO_Cache extends CRM_ACL_DAO_Cache {
}
/**
* @param $id
* @param int $id
*
* @return array
*/
......@@ -93,8 +93,8 @@ SELECT acl_id
}
/**
* @param $id
* @param $cache
* @param int $id
* @param array $cache
*/
static function store($id, &$cache) {
foreach ($cache as $aclID => $data) {
......@@ -111,7 +111,7 @@ SELECT acl_id
}
/**
* @param $id
* @param int $id
*/
static function deleteEntry($id) {
if (self::$_cache &&
......@@ -129,7 +129,7 @@ WHERE contact_id = %1
}
/**
* @param $id
* @param int $id
*/
static function updateEntry($id) {
// rebuilds civicrm_acl_cache
......
......@@ -73,7 +73,7 @@ class CRM_ACL_BAO_EntityRole extends CRM_ACL_DAO_EntityRole {
}
/**
* update the is_active flag in the db
* Update the is_active flag in the db
*
* @param int $id id of the database record
* @param boolean $is_active value we want to set the is_active field
......@@ -86,7 +86,7 @@ class CRM_ACL_BAO_EntityRole extends CRM_ACL_DAO_EntityRole {
}
/**
* delete Entity Role records
* Delete Entity Role records
*
* @param int $entityRoleId ID of the EntityRole record to be deleted.
*
......
......@@ -40,7 +40,7 @@
class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
/**
* static field for all the activity information that we can potentially export
* Static field for all the activity information that we can potentially export
*
* @var array
* @static
......@@ -48,7 +48,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
static $_exportableFields = NULL;
/**
* static field for all the activity information that we can potentially import
* Static field for all the activity information that we can potentially import
*
* @var array
* @static
......@@ -76,7 +76,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
* @param array $params (reference ) an assoc array of name/value pairs
* @param array $defaults (reference ) an assoc array to hold the flattened values
*
* @return CRM_Core_BAO_Meeting object
* @return CRM_Activity_DAO_Activity object
* @access public
*/
public static function retrieve(&$params, &$defaults) {
......@@ -140,7 +140,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
}
/**
* delete the activity
* Delete the activity
*
* @param array $params associated array
* @param bool $moveToTrash
......@@ -250,7 +250,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
* Delete activity assignment record
*
* @param int $activityId
* @param null $recordTypeID
* @param int $recordTypeID
*
* @return null
* @access public
......@@ -265,7 +265,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
}
/**
* process the activities
* Process the activities
*
* @param array $params associated array of the submitted values
*
......@@ -643,7 +643,7 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
}
/**
* get the list Activities
* Get the list Activities
*
* @param array $input array of parameters
* Keys include
......@@ -935,7 +935,7 @@ ORDER BY fixed_sort_order
}
/**
* get the activity Count
* Get the activity Count
*
* @param array $input array of parameters
* Keys include
......@@ -971,7 +971,7 @@ LEFT JOIN civicrm_case_activity ON ( civicrm_case_activity.activity_id = tbl.a
}
/**
* function to get the activity sql clause to pick activities
* Get the activity sql clause to pick activities
*
* @param array $input array of parameters
* Keys include
......@@ -1151,7 +1151,7 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND
}
/**
* send the message to all the contacts and also insert a
* Send the message to all the contacts and also insert a
* contact activity in each contacts record
*
* @param array $contactDetails the array of contact details to send the email
......@@ -1355,11 +1355,11 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND
}
/**
* @param $contactDetails
* @param $activityParams
* @param array $contactDetails
* @param array $activityParams
* @param array $smsParams
* @param $contactIds
* @param null $userID
* @param int $userID
*
* @return array
* @throws CRM_Core_Exception
......@@ -1498,14 +1498,14 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND
}
/**
* send the sms message to a specific contact
* Send the sms message to a specific contact
*
* @param int $toID the contact id of the recipient
* @param $tokenText
* @param $tokenHtml
* @param array $smsParams the params used for sending sms
* @param int $activityID the activity ID that tracks the message
* @param null $userID
* @param int $userID
*
* @return mixed true on success or PEAR_Error object
* @access public
......@@ -1573,10 +1573,10 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND