NFC - Expand CRM-* comments with full @see annotations

civicrm · Jul 24, 2020 · 0e48063 · 0e48063
1 parent 02b3ba9
commit 0e48063
Show file tree

Hide file tree

Showing 57 changed files with 71 additions and 99 deletions.
diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php
@@ -612,7 +612,7 @@ public function initialize($apiEntity = NULL) {
    *
    * this code is primarily for search builder use case where different clauses can specify if they want deleted.
    *
-   * CRM-11971
+   * @see https://issues.civicrm.org/jira/browse/CRM-11971
    */
   public function buildParamsLookup() {
     $trashParamExists = FALSE;
@@ -4789,7 +4789,7 @@ public static function isAlreadyProcessedForQueryFormat($values) {
    * Country is implicit from the state, but including both results in
    * a poor query as there is no combined index on state AND country.
    *
-   * CRM-18125
+   * @see https://issues.civicrm.org/jira/browse/CRM-18125
    *
    * @param array $formValues
    */

diff --git a/CRM/Contact/Form/Task.php b/CRM/Contact/Form/Task.php
@@ -334,7 +334,7 @@ public function addDefaultButtons($title, $nextType = 'next', $backType = 'back'
   /**
    * Replace ids of household members in $this->_contactIds with the id of their household.
    *
-   * CRM-8338
+   * @see https://issues.civicrm.org/jira/browse/CRM-8338
    */
   public function mergeContactIdsByHousehold() {
     if (empty($this->_contactIds)) {

diff --git a/CRM/Contact/Import/Parser/Contact.php b/CRM/Contact/Import/Parser/Contact.php
@@ -1955,7 +1955,7 @@ public static function getSubtypes($contactType) {
    * 1) the chosen dedupe rule falling back to
    * 2) a check for the external ID.
    *
-   * CRM-17275
+   * @see https://issues.civicrm.org/jira/browse/CRM-17275
    *
    * @param array $params
    *

diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php
@@ -3939,7 +3939,7 @@ public static function checkStatusValidation($values, &$fields, &$errors) {
   /**
    * Delete contribution of contact.
    *
-   * CRM-12155
+   * @see https://issues.civicrm.org/jira/browse/CRM-12155
    *
    * @param int $contactId
    *   Contact id.
@@ -4004,7 +4004,7 @@ public static function buildOptions($fieldName, $context = NULL, $props = []) {
   /**
    * Validate financial type.
    *
-   * CRM-13231
+   * @see https://issues.civicrm.org/jira/browse/CRM-13231
    *
    * @param int $financialTypeId
    *   Financial Type id.

diff --git a/CRM/Contribute/BAO/Contribution/Utils.php b/CRM/Contribute/BAO/Contribution/Utils.php
@@ -485,7 +485,7 @@ public static function calculateTaxAmount($amount, $taxRate) {
 
   /**
    * Format monetary amount: round and return to desired decimal place
-   * CRM-20145
+   * @see https://issues.civicrm.org/jira/browse/CRM-20145
    *
    * @param float $amount
    *   Monetary amount

diff --git a/CRM/Contribute/Form/Contribution.php b/CRM/Contribute/Form/Contribution.php
@@ -1737,7 +1737,7 @@ protected function invoicingPostProcessHook($submittedValues, $action, $lineItem
   /**
    * Calculate non deductible amount.
    *
-   * CRM-11956
+   * @see https://issues.civicrm.org/jira/browse/CRM-11956
    * if non_deductible_amount exists i.e. Additional Details field set was opened [and staff typed something] -
    * if non_deductible_amount does NOT exist - then calculate it depending on:
    * $financialType->is_deductible and whether there is a product (premium).

diff --git a/CRM/Contribute/Form/Contribution/Confirm.php b/CRM/Contribute/Form/Contribution/Confirm.php
@@ -201,7 +201,7 @@ public static function getContributionParams(
    *
    * This is a bit too much about wierd form interpretation to be this deep.
    *
-   * CRM-11885
+   * @see https://issues.civicrm.org/jira/browse/CRM-11885
    *  if non_deductible_amount exists i.e. Additional Details fieldset was opened [and staff typed something] -> keep
    * it.
    *

diff --git a/CRM/Core/BAO/Block.php b/CRM/Core/BAO/Block.php
@@ -439,7 +439,7 @@ public static function handlePrimary(&$params, $class) {
       /*
        * If the only existing email is the one we are editing then we must set
        * is_primary to 1
-       * CRM-10451
+       * @see https://issues.civicrm.org/jira/browse/CRM-10451
        */
       if ($existingEntities->N == 1 && $existingEntities->id == CRM_Utils_Array::value('id', $params)) {
         $params['is_primary'] = 1;

diff --git a/CRM/Core/BAO/Job.php b/CRM/Core/BAO/Job.php
@@ -109,7 +109,7 @@ public static function del($jobID) {
   /**
    * Trim job table on a regular basis to keep it at a good size.
    *
-   * CRM-10513
+   * @see https://issues.civicrm.org/jira/browse/CRM-10513
    *
    * @param int $maxEntriesToKeep
    * @param int $minDaysToKeep

diff --git a/CRM/Core/Config.php b/CRM/Core/Config.php
@@ -271,7 +271,7 @@ public static function environment($env = NULL, $reset = FALSE) {
 
   /**
    * Do general cleanup of caches, temp directories and temp tables
-   * CRM-8739
+   * @see https://issues.civicrm.org/jira/browse/CRM-8739
    *
    * @param bool $sessionReset
    */

diff --git a/CRM/Event/BAO/Participant.php b/CRM/Event/BAO/Participant.php
@@ -1769,7 +1769,7 @@ public static function createDiscountTrxn($eventID, $contributionParams, $feeLev
   /**
    * Delete participants of contact.
    *
-   * CRM-12155
+   * @see https://issues.civicrm.org/jira/browse/CRM-12155
    *
    * @param int $contactId
    *   Contact id.

diff --git a/CRM/Event/Form/Registration/ParticipantConfirm.php b/CRM/Event/Form/Registration/ParticipantConfirm.php
@@ -21,10 +21,11 @@
  *
  */
 class CRM_Event_Form_Registration_ParticipantConfirm extends CRM_Event_Form_Registration {
-  // optional credit card return status code
+
   /**
-   * CRM-6060
+   * Optional credit card return status code
    * @var string
+   * @see https://issues.civicrm.org/jira/browse/CRM-6060
    */
   protected $_cc = NULL;
 

diff --git a/CRM/Event/Form/Registration/Register.php b/CRM/Event/Form/Registration/Register.php
@@ -45,9 +45,9 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration {
    * Skip duplicate check.
    *
    * This can be set using hook_civicrm_buildForm() to override the registration dupe check.
-   * CRM-7604
    *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-7604
    */
   public $_skipDupeRegistrationCheck = FALSE;
 

diff --git a/CRM/Financial/BAO/FinancialItem.php b/CRM/Financial/BAO/FinancialItem.php
@@ -221,7 +221,7 @@ public static function retrieveEntityFinancialTrxn($params, $maxId = FALSE) {
   /**
    * Check if contact is present in financial_item table.
    *
-   * CRM-12929
+   * @see https://issues.civicrm.org/jira/browse/CRM-12929
    *
    * @param array $contactIds
    *   An array contact id's.

diff --git a/CRM/Financial/BAO/FinancialTypeAccount.php b/CRM/Financial/BAO/FinancialTypeAccount.php
@@ -164,7 +164,7 @@ public static function getInstrumentFinancialAccount($paymentInstrumentValue) {
   /**
    * Create default entity financial accounts
    * for financial type
-   * CRM-12470
+   * @see https://issues.civicrm.org/jira/browse/CRM-12470
    *
    * @param $financialType
    *

diff --git a/CRM/Mailing/Event/BAO/Opened.php b/CRM/Mailing/Event/BAO/Opened.php
@@ -112,7 +112,7 @@ public static function getTotalCount(
   }
 
   /**
-   * CRM-12814
+   * @see https://issues.civicrm.org/jira/browse/CRM-12814
    * Get opened count for each mailing for a given set of mailing IDs
    *
    * @param $mailingIDs

diff --git a/CRM/Mailing/Event/BAO/TrackableURLOpen.php b/CRM/Mailing/Event/BAO/TrackableURLOpen.php
@@ -169,7 +169,7 @@ public static function getTotalCount(
   /**
    * Get tracked url count for each mailing for a given set of mailing IDs.
    *
-   * CRM-12814
+   * @see https://issues.civicrm.org/jira/browse/CRM-12814
    *
    * @param array $mailingIDs
    *

diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php
@@ -153,9 +153,8 @@ class CRM_Report_Form extends CRM_Core_Form {
    * separately marked every class with a groupFilter in the hope that will trigger
    * people to fix them as they touch them.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = TRUE;
 

diff --git a/CRM/Report/Form/Activity.php b/CRM/Report/Form/Activity.php
@@ -28,9 +28,8 @@ class CRM_Report_Form_Activity extends CRM_Report_Form {
    * all reports have been adjusted to take care of it. This report has not
    * and will run an inefficient query until fixed.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = TRUE;
 

diff --git a/CRM/Report/Form/ActivitySummary.php b/CRM/Report/Form/ActivitySummary.php
@@ -28,9 +28,8 @@ class CRM_Report_Form_ActivitySummary extends CRM_Report_Form {
    * all reports have been adjusted to take care of it. This report has not
    * and will run an inefficient query until fixed.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = TRUE;
 

diff --git a/CRM/Report/Form/Case/Demographics.php b/CRM/Report/Form/Case/Demographics.php
@@ -28,9 +28,8 @@ class CRM_Report_Form_Case_Demographics extends CRM_Report_Form {
    * all reports have been adjusted to take care of it. This report has not
    * and will run an inefficient query until fixed.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = TRUE;
 

diff --git a/CRM/Report/Form/Contact/CurrentEmployer.php b/CRM/Report/Form/Contact/CurrentEmployer.php
@@ -23,9 +23,8 @@ class CRM_Report_Form_Contact_CurrentEmployer extends CRM_Report_Form {
    * all reports have been adjusted to take care of it. This report has not
    * and will run an inefficient query until fixed.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = TRUE;
 

diff --git a/CRM/Report/Form/Contact/Detail.php b/CRM/Report/Form/Contact/Detail.php
@@ -33,9 +33,8 @@ class CRM_Report_Form_Contact_Detail extends CRM_Report_Form {
    * all reports have been adjusted to take care of it. This report has not
    * and will run an inefficient query until fixed.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = TRUE;
 

diff --git a/CRM/Report/Form/Contact/Relationship.php b/CRM/Report/Form/Contact/Relationship.php
@@ -33,9 +33,8 @@ class CRM_Report_Form_Contact_Relationship extends CRM_Report_Form {
    * all reports have been adjusted to take care of it. This report has not
    * and will run an inefficient query until fixed.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = TRUE;
 

diff --git a/CRM/Report/Form/Contact/Summary.php b/CRM/Report/Form/Contact/Summary.php
@@ -38,9 +38,8 @@ class CRM_Report_Form_Contact_Summary extends CRM_Report_Form {
    * all reports have been adjusted to take care of it. This report has not
    * and will run an inefficient query until fixed.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = TRUE;
 

diff --git a/CRM/Report/Form/Contribute/Bookkeeping.php b/CRM/Report/Form/Contribute/Bookkeeping.php
@@ -32,9 +32,8 @@ class CRM_Report_Form_Contribute_Bookkeeping extends CRM_Report_Form {
    * all reports have been adjusted to take care of it. This report has not
    * and will run an inefficient query until fixed.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = TRUE;
 

diff --git a/CRM/Report/Form/Contribute/Detail.php b/CRM/Report/Form/Contribute/Detail.php
@@ -59,9 +59,8 @@ class CRM_Report_Form_Contribute_Detail extends CRM_Report_Form {
   /**
    * This report has been optimised for group filtering.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = FALSE;
 

diff --git a/CRM/Report/Form/Contribute/Lybunt.php b/CRM/Report/Form/Contribute/Lybunt.php
@@ -51,9 +51,8 @@ class CRM_Report_Form_Contribute_Lybunt extends CRM_Report_Form {
   /**
    * This report has been optimised for group filtering.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = FALSE;
 

diff --git a/CRM/Report/Form/Contribute/Recur.php b/CRM/Report/Form/Contribute/Recur.php
@@ -23,9 +23,8 @@ class CRM_Report_Form_Contribute_Recur extends CRM_Report_Form {
    * all reports have been adjusted to take care of it. This report has not
    * and will run an inefficient query until fixed.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = TRUE;
 

diff --git a/CRM/Report/Form/Contribute/Repeat.php b/CRM/Report/Form/Contribute/Repeat.php
@@ -69,9 +69,8 @@ class CRM_Report_Form_Contribute_Repeat extends CRM_Report_Form {
   /**
    * This report has been optimised for group filtering.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = FALSE;
 

diff --git a/CRM/Report/Form/Contribute/SoftCredit.php b/CRM/Report/Form/Contribute/SoftCredit.php
@@ -41,9 +41,8 @@ class CRM_Report_Form_Contribute_SoftCredit extends CRM_Report_Form {
    * all reports have been adjusted to take care of it. This report has not
    * and will run an inefficient query until fixed.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = TRUE;
 

diff --git a/CRM/Report/Form/Contribute/Summary.php b/CRM/Report/Form/Contribute/Summary.php
@@ -43,9 +43,8 @@ class CRM_Report_Form_Contribute_Summary extends CRM_Report_Form {
   /**
    * This report has been optimised for group filtering.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = FALSE;
 

diff --git a/CRM/Report/Form/Contribute/Sybunt.php b/CRM/Report/Form/Contribute/Sybunt.php
@@ -33,9 +33,8 @@ class CRM_Report_Form_Contribute_Sybunt extends CRM_Report_Form {
   /**
    * This report has been optimised for group filtering.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = FALSE;
 

diff --git a/CRM/Report/Form/Contribute/TopDonor.php b/CRM/Report/Form/Contribute/TopDonor.php
@@ -30,9 +30,8 @@ class CRM_Report_Form_Contribute_TopDonor extends CRM_Report_Form {
    * all reports have been adjusted to take care of it. This report has not
    * and will run an inefficient query until fixed.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = TRUE;
 

diff --git a/CRM/Report/Form/Event/ParticipantListCount.php b/CRM/Report/Form/Event/ParticipantListCount.php
@@ -30,9 +30,8 @@ class CRM_Report_Form_Event_ParticipantListCount extends CRM_Report_Form {
    * all reports have been adjusted to take care of it. This report has not
    * and will run an inefficient query until fixed.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = TRUE;
 

diff --git a/CRM/Report/Form/Mailing/Bounce.php b/CRM/Report/Form/Mailing/Bounce.php
@@ -42,9 +42,8 @@ class CRM_Report_Form_Mailing_Bounce extends CRM_Report_Form {
    * all reports have been adjusted to take care of it. This report has not
    * and will run an inefficient query until fixed.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = TRUE;
 

diff --git a/CRM/Report/Form/Mailing/Clicks.php b/CRM/Report/Form/Mailing/Clicks.php
@@ -42,9 +42,8 @@ class CRM_Report_Form_Mailing_Clicks extends CRM_Report_Form {
    * all reports have been adjusted to take care of it. This report has not
    * and will run an inefficient query until fixed.
    *
-   * CRM-19170
-   *
    * @var bool
+   * @see https://issues.civicrm.org/jira/browse/CRM-19170
    */
   protected $groupFilterNotOptimised = TRUE;