Commit ed5a0ff7 authored by colemanw's avatar colemanw

INFRA-132 - Remove extra newlines from the bottom of docblocks

parent a6c01b45
......@@ -106,7 +106,6 @@ class CRM_ACL_Page_ACL extends CRM_Core_Page_Basic {
* Finally it calls the parent's run method.
*
* @return void
*
*/
public function run() {
// get the requested action
......
......@@ -94,7 +94,6 @@ class CRM_ACL_Page_ACLBasic extends CRM_Core_Page_Basic {
* Finally it calls the parent's run method.
*
* @return void
*
*/
public function run() {
// get the requested action
......
......@@ -106,7 +106,6 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic {
* Finally it calls the parent's run method.
*
* @return void
*
*/
public function run() {
// get the requested action
......
......@@ -2070,7 +2070,6 @@ AND cl.modified_id = c.id
* @param array $params
*
* @return $this|null|object
*
*/
public static function createFollowupActivity($activityId, $params) {
if (!$activityId) {
......@@ -2144,7 +2143,6 @@ AND cl.modified_id = c.id
* Associated array.
*
* @return void
*
*/
public static function restoreActivity(&$params) {
$activity = new CRM_Activity_DAO_Activity();
......
......@@ -72,7 +72,6 @@ class CRM_Activity_BAO_ActivityAssignment extends CRM_Activity_DAO_ActivityConta
* @param int $activity_id
*
* @return array
*
*/
public static function retrieveAssigneeIdsByActivityId($activity_id) {
$assigneeArray = array();
......@@ -110,8 +109,6 @@ AND civicrm_contact.is_deleted = 0
* If false returns all details of assignee contact.
*
* @return array
*
*
*/
public static function getAssigneeNames($activityIDs, $isDisplayName = FALSE, $skipDetails = TRUE) {
$assigneeNames = array();
......
......@@ -54,7 +54,6 @@ class CRM_Activity_BAO_ActivityContact extends CRM_Activity_DAO_ActivityContact
*
* @return object
* activity_contact object
*
*/
public static function create(&$params) {
$activityContact = new CRM_Activity_DAO_ActivityContact();
......@@ -74,7 +73,6 @@ class CRM_Activity_BAO_ActivityContact extends CRM_Activity_DAO_ActivityContact
* @param bool $alsoIDs
*
* @return array
*
*/
public static function getNames($activityID, $recordTypeID, $alsoIDs = FALSE) {
$names = array();
......@@ -113,7 +111,6 @@ AND contact_a.is_deleted = 0
* @param int $recordTypeID
*
* @return mixed
*
*/
public static function retrieveContactIdsByActivityId($activityID, $recordTypeID) {
$activityContact = array();
......
......@@ -70,7 +70,6 @@ class CRM_Activity_BAO_ActivityTarget extends CRM_Activity_DAO_ActivityContact {
* @param int $activity_id
*
* @return mixed
*
*/
public static function retrieveTargetIdsByActivityId($activity_id) {
$targetArray = array();
......@@ -102,7 +101,6 @@ AND civicrm_contact.is_deleted = 0
* @param int $activityID
*
* @return array
*
*/
public static function getTargetNames($activityID) {
$targetNames = array();
......
......@@ -125,7 +125,6 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task {
/**
* The _fields var can be used by sub class to set/unset/edit the
* form fields based on their requirement
*
*/
public function setFields() {
$this->_fields = array(
......@@ -1138,7 +1137,6 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task {
/**
* Shorthand for getting id by display name (makes code more readable)
*
*/
protected function _getIdByDisplayName($displayName) {
return CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
......@@ -1150,7 +1148,6 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task {
/**
* Shorthand for getting display name by id (makes code more readable)
*
*/
protected function _getDisplayNameById($id) {
return CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
......
......@@ -56,7 +56,6 @@ class CRM_Activity_Form_ActivityFilter extends CRM_Core_Form {
*
* @return array
* reference to the array of default values
*
*/
/**
* This virtual function is used to set the default values of
......@@ -66,7 +65,6 @@ class CRM_Activity_Form_ActivityFilter extends CRM_Core_Form {
*
* @return array
* reference to the array of default values
*
*/
/**
* @return array
......
......@@ -64,7 +64,6 @@ class CRM_Activity_Form_Search extends CRM_Core_Form_Search {
/**
* Prefix for the controller
*
*/
protected $_prefix = "activity_";
......
......@@ -47,13 +47,11 @@ class CRM_Activity_Form_Task_Batch extends CRM_Activity_Form_Task {
/**
* Maximum profile fields that will be displayed
*
*/
protected $_maxFields = 9;
/**
* Variable to store redirect path
*
*/
protected $_userContext;
......
......@@ -47,13 +47,11 @@ class CRM_Activity_Form_Task_FileOnCase extends CRM_Activity_Form_Task {
/**
* Variable to store redirect path
*
*/
protected $_userContext;
/**
* Variable to store contact Ids
*
*/
public $_contacts;
......
......@@ -47,19 +47,16 @@ class CRM_Activity_Form_Task_PickOption extends CRM_Activity_Form_Task {
/**
* Maximum Activities that should be allowed to update
*
*/
protected $_maxActivities = 100;
/**
* Variable to store redirect path
*
*/
protected $_userContext;
/**
* Variable to store contact Ids
*
*/
public $_contacts;
......
......@@ -47,13 +47,11 @@ class CRM_Activity_Form_Task_PickProfile extends CRM_Activity_Form_Task {
/**
* Maximum Activities that should be allowed to update
*
*/
protected $_maxActivities = 100;
/**
* Variable to store redirect path
*
*/
protected $_userContext;
......
......@@ -43,7 +43,6 @@ class CRM_Activity_Page_Tab extends CRM_Core_Page {
* Browse all activities for a particular contact
*
* @return void
*
*/
public function browse() {
$this->assign('admin', FALSE);
......@@ -121,7 +120,6 @@ class CRM_Activity_Page_Tab extends CRM_Core_Page {
* the contact and calls the appropriate type of page to view.
*
* @return void
*
*/
public function preProcess() {
$this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
......@@ -162,7 +160,6 @@ class CRM_Activity_Page_Tab extends CRM_Core_Page {
* Perform actions and display for activities.
*
* @return void
*
*/
public function run() {
$context = CRM_Utils_Request::retrieve('context', 'String', $this);
......
......@@ -288,7 +288,6 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C
*
* @param $action
* @param array $params
*
*/
public function getPagerParams($action, &$params) {
$params['status'] = ts('Activities %%StatusMessage%%');
......
......@@ -194,7 +194,6 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM
*
* @param $action
* @param array $params
*
*/
public function getPagerParams($action, &$params) {
$params['status'] = ts('Activities %%StatusMessage%%');
......
......@@ -46,7 +46,6 @@ class CRM_Admin_Page_CMSUser extends CRM_Core_Page {
* Finally it calls the parent's run method.
*
* @return void
*
*/
public function run() {
//if javascript is enabled
......
......@@ -51,7 +51,6 @@ class CRM_Admin_Page_Extensions extends CRM_Core_Page_Basic {
* Obtains the group name from url and sets the title.
*
* @return void
*
*/
public function preProcess() {
CRM_Utils_System::setTitle(ts('CiviCRM Extensions'));
......
......@@ -112,7 +112,6 @@ class CRM_Admin_Page_Job extends CRM_Core_Page_Basic {
* Finally it calls the parent's run method.
*
* @return void
*
*/
public function run() {
// set title and breadcrumb
......
......@@ -74,7 +74,6 @@ class CRM_Admin_Page_JobLog extends CRM_Core_Page_Basic {
* Finally it calls the parent's run method.
*
* @return void
*
*/
public function run() {
// set title and breadcrumb
......
......@@ -85,7 +85,6 @@ class CRM_Admin_Page_Options extends CRM_Core_Page_Basic {
* Sets the title.
*
* @return void
*
*/
public function preProcess() {
if (!self::$_gName && !empty($this->urlPath[3])) {
......
......@@ -100,7 +100,6 @@ class CRM_Admin_Page_PaymentProcessor extends CRM_Core_Page_Basic {
* Finally it calls the parent's run method.
*
* @return void
*
*/
public function run() {
// set title and breadcrumb
......
......@@ -84,7 +84,6 @@ class CRM_Admin_Page_PreferencesDate extends CRM_Core_Page_Basic {
* Finally it calls the parent's run method.
*
* @return void
*
*/
public function run() {
// set title and breadcrumb
......
......@@ -40,7 +40,6 @@ class CRM_Batch_Form_Entry extends CRM_Core_Form {
/**
* Maximum profile fields that will be displayed
*
*/
protected $_rowCount = 1;
......
......@@ -235,7 +235,6 @@ Order By camp.title";
/**
* Wrapper to self::getCampaigns( )
* w/ permissions and component check.
*
*/
public static function getPermissionedCampaigns(
$includeId = NULL,
......@@ -543,7 +542,6 @@ INNER JOIN civicrm_group grp ON ( grp.id = campgrp.entity_id )
/*
* Add select element for campaign
* and assign needful info to templates.
*
*/
/**
* @param CRM_Core_Form $form
......
......@@ -34,7 +34,6 @@
*/
class CRM_Campaign_BAO_Petition extends CRM_Campaign_BAO_Survey {
/**
*
*/
public function __construct() {
parent::__construct();
......
......@@ -48,7 +48,6 @@ class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey {
* (reference ) an assoc array of name/value pairs.
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
*/
/**
......@@ -403,7 +402,6 @@ SELECT survey.id as id,
*
* @return mixed|null
* @static
*
*/
public static function del($id) {
if (!$id) {
......@@ -885,7 +883,6 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a
/**
* Retrieve survey associated profile id.
*
*/
public static function getSurveyProfileId($surveyId) {
if (!$surveyId) {
......@@ -932,7 +929,6 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a
/**
* Decides the contact type for given survey.
*
*/
public static function getSurveyContactType($surveyId) {
$contactType = NULL;
......@@ -951,7 +947,6 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a
/**
* Get survey supportable profile types
*
*/
public static function surveyProfileTypes() {
static $profileTypes;
......
......@@ -253,7 +253,6 @@ class CRM_Campaign_Form_Petition extends CRM_Core_Form {
/**
* Global validation rules for the form
*
*/
public static function formRule($fields, $files, $form) {
$errors = array();
......
......@@ -137,7 +137,6 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form {
protected $_defaults = NULL;
/**
*
*/
public function __construct() {
parent::__construct();
......
......@@ -63,7 +63,6 @@ class CRM_Campaign_Form_Search extends CRM_Core_Form_Search {
/**
* Prefix for the controller
*
*/
protected $_prefix = "survey_";
......
......@@ -208,7 +208,6 @@ class CRM_Campaign_Form_Survey_Results extends CRM_Campaign_Form_Survey {
/**
* Global validation rules for the form
*
*/
public static function formRule($fields, $files, $form) {
$errors = array();
......
......@@ -47,7 +47,6 @@ class CRM_Campaign_Form_Task_Interview extends CRM_Campaign_Form_Task {
/**
* Variable to store redirect path
*
*/
private $_userContext;
......
......@@ -51,7 +51,6 @@ class CRM_Campaign_Page_Campaign extends CRM_Core_Page {
* Get the action links for this page.
*
* @return array
*
*/
public function &actionLinks() {
// check if variable _actionsLinks is populated
......
......@@ -51,7 +51,6 @@ class CRM_Campaign_Page_DashBoard extends CRM_Core_Page {
* Get the action links for this page.
*
* @return array
*
*/
public function &campaignActionLinks() {
// check if variable _actionsLinks is populated
......
......@@ -76,7 +76,6 @@ class CRM_Campaign_Page_SurveyType extends CRM_Core_Page_Basic {
* Obtains the group name from url and sets the title.
*
* @return void
*
*/
public function preProcess() {
$this->_gName = 'activity_type';
......
......@@ -103,7 +103,6 @@ class CRM_Campaign_PseudoConstant extends CRM_Core_PseudoConstant {
*
* @return array
* array reference of all campaign types.
*
*/
public static function &campaignType() {
if (!self::$campaignType) {
......@@ -123,7 +122,6 @@ class CRM_Campaign_PseudoConstant extends CRM_Core_PseudoConstant {
*
* @return array
* array reference of all campaign status.
*
*/
public static function &campaignStatus() {
if (!self::$campaignStatus) {
......
......@@ -186,7 +186,6 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM
* - Edit
*
* @return array
*
*/
static
public function &links() {
......@@ -198,7 +197,6 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM
*
* @param $action
* @param array $params
*
*/
public function getPagerParams($action, &$params) {
$params['csvString'] = NULL;
......
......@@ -182,7 +182,6 @@ class CRM_Case_Audit_Audit {
*
* This is intended to be called as a sort callback function, returning whether an activity's date is earlier or later than another's.
* The type of date to use is specified in the config.
*
*/
/**
......
......@@ -48,7 +48,6 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case {
static $_exportableFields = NULL;
/**
*
*/
public function __construct() {
parent::__construct();
......@@ -479,8 +478,6 @@ WHERE civicrm_case.id = %1";
* ID of the case.
*
* @return array
*
*
*/
public static function getContactNames($caseId) {
$contactNames = array();
......@@ -526,7 +523,6 @@ WHERE civicrm_case.id = %1";
* @param null $caseType
*
* @return array
*
*/
public static function retrieveCaseIdsByContactId($contactID, $includeDeleted = FALSE, $caseType = NULL) {
$query = "
......@@ -730,7 +726,6 @@ LEFT JOIN civicrm_option_group aog ON aog.name='activity_type'
*
* @return array
* Array of Cases
*
*/
public static function getCases($allCases = TRUE, $userID = NULL, $type = 'upcoming', $context = 'dashboard') {
$condition = NULL;
......@@ -1577,8 +1572,6 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
* ID of the activity type.
*
* @return array
*
*
*/
public static function getCaseActivityCount($caseId, $activityTypeId) {
$queryParam = array(
......@@ -2195,7 +2188,6 @@ LEFT JOIN civicrm_case_contact ON ( civicrm_case.id = civicrm_case_contact.case
* Do not include deleted cases.
*
* @return an array of cases.
*
*/
public static function getContactCases($contactId, $excludeDeleted = TRUE) {
$cases = array();
......@@ -2239,7 +2231,6 @@ INNER JOIN civicrm_case_contact ON ( civicrm_case.id = civicrm_case_contact.cas
* Do not include deleted cases.
*
* @return an array of related cases.
*
*/
public static function getRelatedCases($mainCaseId, $contactId, $excludeDeleted = TRUE) {
//FIXME : do check for permissions.
......
......@@ -72,8 +72,6 @@ class CRM_Case_Form_CustomData extends CRM_Core_Form {
* @param
*
* @return void
*
*
*/
public function preProcess() {
$this->_groupID = CRM_Utils_Request::retrieve('groupID', 'Positive', $this, TRUE);
......
......@@ -61,7 +61,6 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search {
/**
* Prefix for the controller
*
*/
protected $_prefix = 'case_';
......
......@@ -45,7 +45,6 @@ class CRM_Case_Page_DashBoard extends CRM_Core_Page {
* the contact and calls the appropriate type of page to view.
*
* @return void
*
*/
public function preProcess() {
//check for civicase access.
......
......@@ -250,7 +250,6 @@ class CRM_Case_Selector_Search extends CRM_Core_Selector_Base {
*
* @param $action
* @param array $params
*
*/
public function getPagerParams($action, &$params) {
$params['status'] = ts('Case') . ' %%StatusMessage%%';
......
......@@ -105,7 +105,6 @@ class CRM_Case_StateMachine_Search extends CRM_Core_StateMachine {
/**
* Since this is a state machine for search and we want to come back to the same state
* we dont want to issue a reset of the state session when we are done processing a task
*
*/
public function shouldReset() {
return FALSE;
......
......@@ -42,7 +42,6 @@ class CRM_Case_XMLProcessor_Report extends CRM_Case_XMLProcessor {
protected $_isRedact;
/**
*
*/
public function __construct() {