From: eileenmcnaugton Date: Mon, 31 Aug 2015 11:21:38 +0000 (+1200) Subject: more comment fixes X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=df371444e65dba73fc16f137ab37ecf08140b650;p=civicrm-core.git more comment fixes --- diff --git a/CRM/Bridge/OG/CiviCRM.php b/CRM/Bridge/OG/CiviCRM.php index 1f64a02d1d..ddaf959d82 100644 --- a/CRM/Bridge/OG/CiviCRM.php +++ b/CRM/Bridge/OG/CiviCRM.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Bridge_OG_CiviCRM { diff --git a/CRM/Bridge/OG/Drupal.php b/CRM/Bridge/OG/Drupal.php index a0a16755af..e5557a8626 100644 --- a/CRM/Bridge/OG/Drupal.php +++ b/CRM/Bridge/OG/Drupal.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** diff --git a/CRM/Bridge/OG/Utils.php b/CRM/Bridge/OG/Utils.php index db5912771b..123efc15cb 100644 --- a/CRM/Bridge/OG/Utils.php +++ b/CRM/Bridge/OG/Utils.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Bridge_OG_Utils { const aclEnabled = 1, syncFromCiviCRM = 1; diff --git a/CRM/Campaign/BAO/Campaign.php b/CRM/Campaign/BAO/Campaign.php index 20932af7f2..dd793c9b50 100644 --- a/CRM/Campaign/BAO/Campaign.php +++ b/CRM/Campaign/BAO/Campaign.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { diff --git a/CRM/Campaign/BAO/Survey.php b/CRM/Campaign/BAO/Survey.php index f554c52816..a7097e7041 100644 --- a/CRM/Campaign/BAO/Survey.php +++ b/CRM/Campaign/BAO/Survey.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ -require_once 'CRM/Campaign/DAO/Survey.php'; /** - * Class CRM_Campaign_BAO_Survey + * Class CRM_Campaign_BAO_Survey. */ class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey { diff --git a/CRM/Campaign/Config.php b/CRM/Campaign/Config.php index 14f23f13d4..eee02200ac 100644 --- a/CRM/Campaign/Config.php +++ b/CRM/Campaign/Config.php @@ -32,8 +32,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Campaign_Config extends CRM_Core_Component_Config { } diff --git a/CRM/Campaign/Controller/Search.php b/CRM/Campaign/Controller/Search.php index f77413a3ae..a12cd942c0 100755 --- a/CRM/Campaign/Controller/Search.php +++ b/CRM/Campaign/Controller/Search.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** diff --git a/CRM/Campaign/Form/Gotv.php b/CRM/Campaign/Form/Gotv.php index e7b3e1d650..f6c4c93656 100755 --- a/CRM/Campaign/Form/Gotv.php +++ b/CRM/Campaign/Form/Gotv.php @@ -29,7 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ /** diff --git a/CRM/Campaign/Form/Petition.php b/CRM/Campaign/Form/Petition.php index 59c7cad45f..6931a7917f 100644 --- a/CRM/Campaign/Form/Petition.php +++ b/CRM/Campaign/Form/Petition.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for adding a petition - * + * This class generates form components for adding a petition. */ class CRM_Campaign_Form_Petition extends CRM_Core_Form { diff --git a/CRM/Campaign/Form/Survey/TabHeader.php b/CRM/Campaign/Form/Survey/TabHeader.php index 9b4d90ffd7..2e1bc7b3cc 100644 --- a/CRM/Campaign/Form/Survey/TabHeader.php +++ b/CRM/Campaign/Form/Survey/TabHeader.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -39,6 +37,8 @@ class CRM_Campaign_Form_Survey_TabHeader { /** + * Build tab header. + * * @param CRM_Core_Form $form * * @return array diff --git a/CRM/Campaign/Info.php b/CRM/Campaign/Info.php index 08fb4eeb86..8f3c74f0eb 100644 --- a/CRM/Campaign/Info.php +++ b/CRM/Campaign/Info.php @@ -32,8 +32,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Campaign_Info extends CRM_Core_Component_Info { diff --git a/CRM/Campaign/Page/DashBoard.php b/CRM/Campaign/Page/DashBoard.php index 1a4835842a..d455035c11 100644 --- a/CRM/Campaign/Page/DashBoard.php +++ b/CRM/Campaign/Page/DashBoard.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying Campaigns + * Page for displaying Campaigns. */ class CRM_Campaign_Page_DashBoard extends CRM_Core_Page { diff --git a/CRM/Campaign/Page/Petition.php b/CRM/Campaign/Page/Petition.php index f6465c5ae7..55d316c8cd 100644 --- a/CRM/Campaign/Page/Petition.php +++ b/CRM/Campaign/Page/Petition.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Page for displaying Petition Signatures + * Page for displaying Petition Signatures. */ class CRM_Campaign_Page_Petition extends CRM_Core_Page { public function browse() { diff --git a/CRM/Campaign/PseudoConstant.php b/CRM/Campaign/PseudoConstant.php index b19360165b..31b20f7dc0 100755 --- a/CRM/Campaign/PseudoConstant.php +++ b/CRM/Campaign/PseudoConstant.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** diff --git a/CRM/Campaign/StateMachine/Search.php b/CRM/Campaign/StateMachine/Search.php index e1fc69438d..a544c9ade1 100755 --- a/CRM/Campaign/StateMachine/Search.php +++ b/CRM/Campaign/StateMachine/Search.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Campaign_StateMachine_Search extends CRM_Core_StateMachine { diff --git a/CRM/Campaign/Task.php b/CRM/Campaign/Task.php index dff92989e8..914c2df17f 100755 --- a/CRM/Campaign/Task.php +++ b/CRM/Campaign/Task.php @@ -29,15 +29,12 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * class to represent the actions that can be performed on a - * group of voters. - * used by the search forms + * class to represent the actions that can be performed on a group of voters. * + * Used by the search forms. */ class CRM_Campaign_Task { const INTERVIEW = 1, RESERVE = 2, RELEASE = 3, PRINT_VOTERS = 4; diff --git a/CRM/Case/Form/Activity/LinkCases.php b/CRM/Case/Form/Activity/LinkCases.php index 598bd4637d..25880a8f15 100644 --- a/CRM/Case/Form/Activity/LinkCases.php +++ b/CRM/Case/Form/Activity/LinkCases.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for OpenCase Activity - * + * This class generates form components for OpenCase Activity. */ class CRM_Case_Form_Activity_LinkCases { /** @@ -70,13 +67,11 @@ class CRM_Case_Form_Activity_LinkCases { } /** - * Set default values for the form. For edit/view mode - * the default values are retrieved from the database - * + * Set default values for the form. * * @param CRM_Core_Form $form * - * @return void + * @return array */ public static function setDefaultValues(&$form) { return $defaults = array(); @@ -125,8 +120,6 @@ class CRM_Case_Form_Activity_LinkCases { * * @param CRM_Core_Form $form * @param array $params - * - * @return void */ public static function beginPostProcess(&$form, &$params) { } @@ -137,9 +130,7 @@ class CRM_Case_Form_Activity_LinkCases { * * @param CRM_Core_Form $form * @param array $params - * @param $activity - * - * @return void + * @param CRM_Activity_BAO_Activity $activity */ public static function endPostProcess(&$form, &$params, &$activity) { $activityId = $activity->id; diff --git a/CRM/Case/Form/Activity/OpenCase.php b/CRM/Case/Form/Activity/OpenCase.php index b6145248e3..d78d32617e 100644 --- a/CRM/Case/Form/Activity/OpenCase.php +++ b/CRM/Case/Form/Activity/OpenCase.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for OpenCase Activity - * + * This class generates form components for OpenCase Activity. */ class CRM_Case_Form_Activity_OpenCase { @@ -94,8 +91,6 @@ class CRM_Case_Form_Activity_OpenCase { * * * @param CRM_Core_Form $form - * - * @return void */ public static function setDefaultValues(&$form) { $defaults = array(); @@ -216,8 +211,6 @@ class CRM_Case_Form_Activity_OpenCase { * * @param CRM_Core_Form $form * @param array $params - * - * @return void */ public static function beginPostProcess(&$form, &$params) { if ($form->_context == 'caseActivity') { @@ -272,11 +265,8 @@ class CRM_Case_Form_Activity_OpenCase { /** * Process the form submission. * - * - * @param $form + * @param CRM_Core_Form $form * @param array $params - * - * @return void */ public static function endPostProcess(&$form, &$params) { if ($form->_context == 'caseActivity') { diff --git a/CRM/Case/Form/ActivityToCase.php b/CRM/Case/Form/ActivityToCase.php index ca074845c5..5ce068eff3 100644 --- a/CRM/Case/Form/ActivityToCase.php +++ b/CRM/Case/Form/ActivityToCase.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for building activity to a case - * + * This class generates form components for building activity to a case. */ class CRM_Case_Form_ActivityToCase extends CRM_Core_Form { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { $this->_activityId = CRM_Utils_Request::retrieve('activityId', 'Positive', CRM_Core_DAO::$_nullObject); @@ -90,8 +85,6 @@ class CRM_Case_Form_ActivityToCase extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->add('text', 'file_on_case_unclosed_case_id', ts('Select Case'), array('class' => 'huge'), TRUE); diff --git a/CRM/Case/Form/ActivityView.php b/CRM/Case/Form/ActivityView.php index c63eb154bc..c8aff71e14 100644 --- a/CRM/Case/Form/ActivityView.php +++ b/CRM/Case/Form/ActivityView.php @@ -29,21 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class does pre processing for viewing an activity or their revisions - * + * This class does pre processing for viewing an activity or their revisions. */ class CRM_Case_Form_ActivityView extends CRM_Core_Form { /** * Process the view. - * - * - * @return void */ public function preProcess() { $contactID = CRM_Utils_Request::retrieve('cid', 'Integer', $this, TRUE); diff --git a/CRM/Case/Form/Case.php b/CRM/Case/Form/Case.php index 44399b0f0a..22b9875ebc 100644 --- a/CRM/Case/Form/Case.php +++ b/CRM/Case/Form/Case.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for case activity - * + * This class generates form components for case activity. */ class CRM_Case_Form_Case extends CRM_Core_Form { @@ -88,8 +85,6 @@ class CRM_Case_Form_Case extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function preProcess() { @@ -196,11 +191,7 @@ class CRM_Case_Form_Case extends CRM_Core_Form { } /** - * Set default values for the form. For edit/view mode - * the default values are retrieved from the database - * - * - * @return void + * Set default values for the form. */ public function setDefaultValues() { if ($this->_action & CRM_Core_Action::DELETE || $this->_action & CRM_Core_Action::RENEW) { @@ -289,8 +280,7 @@ class CRM_Case_Form_Case extends CRM_Core_Form { /** * Add local and global form rules. * - * - * @return void + * @return bool */ public function addRules() { if ($this->_action & CRM_Core_Action::DELETE || $this->_action & CRM_Core_Action::RENEW) { @@ -319,9 +309,6 @@ class CRM_Case_Form_Case extends CRM_Core_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { $transaction = new CRM_Core_Transaction(); diff --git a/CRM/Case/Form/CustomData.php b/CRM/Case/Form/CustomData.php index f108562e5f..83eaabb988 100644 --- a/CRM/Case/Form/CustomData.php +++ b/CRM/Case/Form/CustomData.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -39,7 +37,6 @@ * It delegates the work to lower level subclasses and integrates the changes * back in. It also uses a lot of functionality with the CRM API's, so any change * made here could potentially affect the API etc. Be careful, be aware, use unit tests. - * */ class CRM_Case_Form_CustomData extends CRM_Core_Form { @@ -68,10 +65,6 @@ class CRM_Case_Form_CustomData extends CRM_Core_Form { * Pre processing work done here. * * gets session variables for table name, id of entity in table, type of entity and stores them. - * - * @param - * - * @return void */ public function preProcess() { $this->_groupID = CRM_Utils_Request::retrieve('groupID', 'Positive', $this, TRUE); @@ -108,8 +101,6 @@ class CRM_Case_Form_CustomData extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { // make this form an upload since we dont know if the custom data injected dynamically @@ -130,9 +121,6 @@ class CRM_Case_Form_CustomData extends CRM_Core_Form { /** * Process the user submitted custom data values. - * - * - * @return void */ public function postProcess() { $params = $this->controller->exportValues($this->_name); diff --git a/CRM/Case/Form/EditClient.php b/CRM/Case/Form/EditClient.php index 07d110036d..650d3d6b3c 100644 --- a/CRM/Case/Form/EditClient.php +++ b/CRM/Case/Form/EditClient.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class assigns the current case to another client - * + * This class assigns the current case to another client. */ class CRM_Case_Form_EditClient extends CRM_Core_Form { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE); @@ -78,8 +73,6 @@ class CRM_Case_Form_EditClient extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->addEntityRef('reassign_contact_id', ts('Select Contact'), array('create' => TRUE), TRUE); @@ -120,8 +113,6 @@ class CRM_Case_Form_EditClient extends CRM_Core_Form { /** * Process the form. - * - * @return void */ public function postProcess() { $params = $this->controller->exportValues($this->_name); diff --git a/CRM/Case/Form/Report.php b/CRM/Case/Form/Report.php index 3ed4790ee4..7bfe64f2f1 100644 --- a/CRM/Case/Form/Report.php +++ b/CRM/Case/Form/Report.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for case report - * + * This class generates form components for case report. */ class CRM_Case_Form_Report extends CRM_Core_Form { @@ -58,8 +55,6 @@ class CRM_Case_Form_Report extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function preProcess() { $this->_caseID = CRM_Utils_Request::retrieve('caseid', 'Integer', $this, TRUE); @@ -120,9 +115,6 @@ class CRM_Case_Form_Report extends CRM_Core_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { // store the submitted values in an array diff --git a/CRM/Case/Form/Search.php b/CRM/Case/Form/Search.php index 3f24334595..50450942b8 100644 --- a/CRM/Case/Form/Search.php +++ b/CRM/Case/Form/Search.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This file is for Case search + * This file is for Case search. */ class CRM_Case_Form_Search extends CRM_Core_Form_Search { @@ -66,8 +64,6 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { /** * Processing needed for buildForm and later. - * - * @return void */ public function preProcess() { $this->set('searchFormName', 'Search'); @@ -165,9 +161,6 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -212,10 +205,6 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { * done. * The processing consists of using a Selector / Controller framework for getting the * search results. - * - * @param - * - * @return void */ public function postProcess() { if ($this->_done) { @@ -308,10 +297,10 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { } /** - * add the rules (mainly global rules) for form. + * Add the rules (mainly global rules) for form. + * * All local rules are added near the element * - * @return void * @see valid_date */ public function addRules() { @@ -324,7 +313,7 @@ class CRM_Case_Form_Search extends CRM_Core_Form_Search { * @param array $fields * Posted values of the form. * - * @return void + * @return array|bool */ public static function formRule($fields) { $errors = array(); diff --git a/CRM/Case/Form/Task.php b/CRM/Case/Form/Task.php index e8c2a7adbc..71570e5838 100644 --- a/CRM/Case/Form/Task.php +++ b/CRM/Case/Form/Task.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates task actions for CiviEvent - * + * This class generates task actions for CiviEvent. */ class CRM_Case_Form_Task extends CRM_Core_Form { @@ -69,10 +66,6 @@ class CRM_Case_Form_Task extends CRM_Core_Form { /** * Build all the data structures needed to build the form. - * - * @param - * - * @return void */ public function preProcess() { self::preProcessCommon($this); @@ -158,8 +151,6 @@ class CRM_Case_Form_Task extends CRM_Core_Form { * Button type for the form after processing. * @param string $backType * @param bool $submitOnce - * - * @return void */ public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) { $this->addButtons(array( diff --git a/CRM/Case/Form/Task/Delete.php b/CRM/Case/Form/Task/Delete.php index 5d79638836..e517db79a3 100644 --- a/CRM/Case/Form/Task/Delete.php +++ b/CRM/Case/Form/Task/Delete.php @@ -29,14 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality to delete a group of - * case records. This class provides functionality for the actual - * deletion. + * This class provides the functionality to delete a group of case records. */ class CRM_Case_Form_Task_Delete extends CRM_Case_Form_Task { @@ -67,8 +63,6 @@ class CRM_Case_Form_Task_Delete extends CRM_Case_Form_Task { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->addDefaultButtons(ts('Delete Cases'), 'done'); @@ -76,8 +70,6 @@ class CRM_Case_Form_Task_Delete extends CRM_Case_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * @return void */ public function postProcess() { $deleted = $failed = 0; diff --git a/CRM/Case/Form/Task/Print.php b/CRM/Case/Form/Task/Print.php index 57926f5480..1477e5ffd6 100644 --- a/CRM/Case/Form/Task/Print.php +++ b/CRM/Case/Form/Task/Print.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -41,8 +39,6 @@ class CRM_Case_Form_Task_Print extends CRM_Case_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { parent::preprocess(); @@ -67,12 +63,11 @@ class CRM_Case_Form_Task_Print extends CRM_Case_Form_Task { } /** - * Build the form object - it consists of + * Build the form object. + * + * It consists of * - displaying the QILL (query in local language) * - displaying elements for saving the search - * - * - * @return void */ public function buildQuickForm() { // @@ -95,9 +90,6 @@ class CRM_Case_Form_Task_Print extends CRM_Case_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { // redirect to the main search page after printing is over diff --git a/CRM/Case/Form/Task/Restore.php b/CRM/Case/Form/Task/Restore.php index dfbb74a40d..ec3e5a632e 100644 --- a/CRM/Case/Form/Task/Restore.php +++ b/CRM/Case/Form/Task/Restore.php @@ -29,14 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality to restore a group of - * participations. This class provides functionality for the actual - * deletion. + * This class provides the functionality to restore a group of participations. */ class CRM_Case_Form_Task_Restore extends CRM_Case_Form_Task { @@ -50,8 +46,6 @@ class CRM_Case_Form_Task_Restore extends CRM_Case_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { parent::preProcess(); @@ -59,9 +53,6 @@ class CRM_Case_Form_Task_Restore extends CRM_Case_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $this->addDefaultButtons(ts('Restore Cases'), 'done'); @@ -69,9 +60,6 @@ class CRM_Case_Form_Task_Restore extends CRM_Case_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { $restoredCases = $failed = 0;