Update Var delcartion to be standard in CRM folder

diff --git a/CRM/Activity/BAO/ICalendar.php b/CRM/Activity/BAO/ICalendar.php
index 8874bd6ebebc2c47e05fdc6f689282afdc280c95..88b7676e1d4f876d28dbf6a4774561793685d332 100644 (file)
--- a/CRM/Activity/BAO/ICalendar.php
+++ b/CRM/Activity/BAO/ICalendar.php
@@ -21,7 +21,8 @@
 class CRM_Activity_BAO_ICalendar {
 
   /**
-   * @var object The activity for which we're generating ical.
+   * @var \CRM_Activity_BAO_ICalendar
+   * The activity for which we're generating ical.
    */
   protected $activity;
 

diff --git a/CRM/Campaign/Form/Petition/Signature.php b/CRM/Campaign/Form/Petition/Signature.php
index a910973f08bc2829973e3e1d149dd7fecd0eff63..4e72b62cf9bc6fcebf4cf2de1e5338adfe567fd9 100644 (file)
--- a/CRM/Campaign/Form/Petition/Signature.php
+++ b/CRM/Campaign/Form/Petition/Signature.php
@@ -40,7 +40,8 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form {
   /**
    * The contact type
    *
-   * @var string ("Individual"/"Household"/"Organization"). Never been tested for something else than Individual
+   * @var string
+   * ("Individual"/"Household"/"Organization"). Never been tested for something else than Individual
    */
   protected $_ctype = 'Individual';
 

diff --git a/CRM/Case/XMLRepository.php b/CRM/Case/XMLRepository.php
index 61006f1699c9243b59e2c3fdcfa1f861e4dcdc2d..19ed92f2d0f55a9abc8e5accded9f1dabc68757d 100644 (file)
--- a/CRM/Case/XMLRepository.php
+++ b/CRM/Case/XMLRepository.php
@@ -22,7 +22,8 @@ class CRM_Case_XMLRepository {
   private static $singleton;
 
   /**
-   * @var array<String,SimpleXMLElement>
+   * @var array
+   * <String,SimpleXMLElement>
    */
   protected $xml = [];
 

diff --git a/CRM/Contact/Form/Search/Custom/Group.php b/CRM/Contact/Form/Search/Custom/Group.php
index 6069b1672203d3f1169e5e131c0975b06b95d707..4dcb40dceb2bb33f1a4b137b6caabf2bae2f3f2b 100644 (file)
--- a/CRM/Contact/Form/Search/Custom/Group.php
+++ b/CRM/Contact/Form/Search/Custom/Group.php
@@ -19,42 +19,46 @@ class CRM_Contact_Form_Search_Custom_Group extends CRM_Contact_Form_Search_Custo
   protected $_formValues;
 
   /**
-   * @var CRM_Utils_SQL_TemTable Object
+   * @var \CRM_Utils_SQL_TemTable
    */
   protected $_xGTable = NULL;
 
   /**
-   * @var CRM_Utils_SQL_TempTable object
+   * @var \CRM_Utils_SQL_TempTable
    */
   protected $_iGTable = NULL;
 
   /**
-   * @var string Table Name for xclude Groups
+   * @var string
+   * Table Name for xclude Groups
    */
   protected $_xGTableName = NULL;
 
   /**
-   * @var string Table Name for Inclue Groups
+   * @var string
+   * Table Name for Inclue Groups
    */
   protected $_iGTableName = NULL;
 
   /**
-   * @var CRM_Utils_SQL_TemTable Object
+   * @var \CRM_Utils_SQL_TempTable
    */
   protected $_xTTable = NULL;
 
   /**
-   * @var CRM_Utils_SQL_TempTable object
+   * @var \CRM_Utils_SQL_TempTable
    */
   protected $_iTTable = NULL;
 
   /**
-   * @var string Table Name for xclude Groups
+   * @var string
+   * Table Name for xclude Groups
    */
   protected $_xTTableName = NULL;
 
   /**
-   * @var string Table Name for Inclue Groups
+   * @var string
+   * Table Name for Inclue Groups
    */
   protected $_iTTableName = NULL;
 

diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php
index 21198fd7520574edd821b6f456b6077485db218f..437bbfc190422dbf2a660ba0f45830f1fb9ee02e 100644 (file)
--- a/CRM/Contribute/BAO/Contribution.php
+++ b/CRM/Contribute/BAO/Contribution.php
@@ -50,7 +50,8 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution {
    * This is used for composing messages because they have dependency on the
    * contribution_page or event page - although over time we may eliminate that
    *
-   * @var "contribution"\"event"
+   * @var string
+   * "contribution"\"event"
    */
   public $_component = NULL;
 

diff --git a/CRM/Extension/Container/Basic.php b/CRM/Extension/Container/Basic.php
index 69123ac94a6fc34aef9d4d9f3eb3ec572e47986c..0588c5eeb172bcd5fb24041fbaf90ace708768f4 100644 (file)
--- a/CRM/Extension/Container/Basic.php
+++ b/CRM/Extension/Container/Basic.php
@@ -35,28 +35,31 @@ class CRM_Extension_Container_Basic implements CRM_Extension_Container_Interface
   public $baseUrl;
 
   /**
-   * @var CRM_Utils_Cache_Interface|NULL
+   * @var CRM_Utils_Cache_Interface|null
    *
    * Note: Treat as private. This is only public to facilitate debugging.
    */
   public $cache;
 
   /**
-   * @var string the cache key used for any data stored by this container
+   * @var string
+   * The cache key used for any data stored by this container
    *
    * Note: Treat as private. This is only public to facilitate debugging.
    */
   public $cacheKey;
 
   /**
-   * @var array($key => $relPath)
+   * @var array
+   * ($key => $relPath)
    *
    * Note: Treat as private. This is only public to facilitate debugging.
    */
   public $relPaths = FALSE;
 
   /**
-   * @var array($key => $relUrl)
+   * @var array
+   * ($key => $relUrl)
    *
    * Derived from $relPaths. On Unix systems (where file-paths and
    * URL-paths both use '/' separator), this isn't necessary. On Windows

diff --git a/CRM/Extension/Downloader.php b/CRM/Extension/Downloader.php
index a092a88e46d02f746c43222578e7f257b392b624..cc43c8be6ee4c0efa0ff193f3f95cf8b0361ff53 100644 (file)
--- a/CRM/Extension/Downloader.php
+++ b/CRM/Extension/Downloader.php
@@ -17,12 +17,14 @@
  */
 class CRM_Extension_Downloader {
   /**
-   * @var CRM_Extension_Container_Basic the place where downloaded extensions are ultimately stored
+   * @var CRM_Extension_Container_Basic
+   * The place where downloaded extensions are ultimately stored
    */
   public $container;
 
   /**
-   * @var string local path to a temporary data directory
+   * @var string
+   * Local path to a temporary data directory
    */
   public $tmpDir;
 

diff --git a/CRM/Extension/Mapper.php b/CRM/Extension/Mapper.php
index 3078e0eb391ea5667a8bde6f619434bdbfafdab9..a21af4d43b7e2c7458014fd216043fac14abbc5c 100644 (file)
--- a/CRM/Extension/Mapper.php
+++ b/CRM/Extension/Mapper.php
@@ -45,7 +45,8 @@ class CRM_Extension_Mapper {
   protected $container;
 
   /**
-   * @var array (key => CRM_Extension_Info)
+   * @var \CRM_Extension_Info[]
+   * (key => CRM_Extension_Info)
    */
   protected $infos = [];
 

diff --git a/CRM/Profile/Form.php b/CRM/Profile/Form.php
index 4ab59bf8084ea7e327a93340e3ab594e4a21b13d..bbd5210e37350f38e0c4b75926567ad898d49141 100644 (file)
--- a/CRM/Profile/Form.php
+++ b/CRM/Profile/Form.php
@@ -50,7 +50,8 @@ class CRM_Profile_Form extends CRM_Core_Form {
   protected $_gid;
 
   /**
-   * @var array details of the UFGroup used on this page
+   * @var array
+   * Details of the UFGroup used on this page
    */
   protected $_ufGroup = ['name' => 'unknown'];
 

diff --git a/CRM/Queue/Runner.php b/CRM/Queue/Runner.php
index c4db418766b3e464e5f35f9513c1efae91a558c9..d44a073b5232126b175229ea585596c013a3c0b2 100644 (file)
--- a/CRM/Queue/Runner.php
+++ b/CRM/Queue/Runner.php
@@ -50,7 +50,8 @@ class CRM_Queue_Runner {
   public $qrid;
 
   /**
-   * @var array whether to display buttons, eg ('retry' => TRUE, 'skip' => FALSE)
+   * @var array
+   * Whether to display buttons, eg ('retry' => TRUE, 'skip' => FALSE)
    */
   public $buttons;
 

diff --git a/CRM/Queue/Task.php b/CRM/Queue/Task.php
index 11fc6797f426409c4744bccb819822b95a88fa90..b2d74b393ad71aa7773e6b84b9c680addef99297 100644 (file)
--- a/CRM/Queue/Task.php
+++ b/CRM/Queue/Task.php
@@ -25,17 +25,19 @@ class CRM_Queue_Task {
   const TASK_FAIL = 2;
 
   /**
-   * @var mixed, serializable
+   * @var mixed
+   * serializable
    */
   public $callback;
 
   /**
-   * @var array, serializable
+   * @var array
+   * serializable
    */
   public $arguments;
 
   /**
-   * @var string, NULL-able
+   * @var string|null
    */
   public $title;
 

diff --git a/CRM/Report/BAO/Hook.php b/CRM/Report/BAO/Hook.php
index 829d4f8e4dce6ab36d1c07ccb0d5fc64fcf46b58..b2be39e2c69909ca3427f7ef64ead8fa0d4d2024 100644 (file)
--- a/CRM/Report/BAO/Hook.php
+++ b/CRM/Report/BAO/Hook.php
@@ -24,7 +24,7 @@
 class CRM_Report_BAO_Hook {
 
   /**
-   * @var array of CRM_Report_BAO_HookInterface objects
+   * @var \CRM_Report_BAO_HookInterface[]
    */
   protected $_queryObjects = NULL;
 

diff --git a/CRM/Upgrade/Incremental/php/FiveTwenty.php b/CRM/Upgrade/Incremental/php/FiveTwenty.php
index c5f384ed788c6455460442ae3f9d646661eef366..4087b441359d402169e21804c14e5e253700f37f 100644 (file)
--- a/CRM/Upgrade/Incremental/php/FiveTwenty.php
+++ b/CRM/Upgrade/Incremental/php/FiveTwenty.php
@@ -14,7 +14,7 @@
 class CRM_Upgrade_Incremental_php_FiveTwenty extends CRM_Upgrade_Incremental_Base {
 
   /**
-   * @var $relationshipTypes array
+   * @var array
    *   api call result keyed on relationship_type.id
    */
   protected static $relationshipTypes;

diff --git a/CRM/Utils/Cache/Memcache.php b/CRM/Utils/Cache/Memcache.php
index aa8917d3e192b53559e6740aab5053d46af830e3..415eca989f72143654e8c3b09278d2b751a32763 100644 (file)
--- a/CRM/Utils/Cache/Memcache.php
+++ b/CRM/Utils/Cache/Memcache.php
@@ -69,7 +69,7 @@ class CRM_Utils_Cache_Memcache implements CRM_Utils_Cache_Interface {
   protected $_cache;
 
   /**
-   * @var NULL|array
+   * @var null|array
    *
    * This is the effective prefix. It may be bumped up whenever the dataset is flushed.
    *

diff --git a/CRM/Utils/Cache/Memcached.php b/CRM/Utils/Cache/Memcached.php
index dd9482090c3fb62b68b325759331e093235b6b4e..53bfd3928124e36b91a93a4f9d396f64148aec9a 100644 (file)
--- a/CRM/Utils/Cache/Memcached.php
+++ b/CRM/Utils/Cache/Memcached.php
@@ -70,7 +70,7 @@ class CRM_Utils_Cache_Memcached implements CRM_Utils_Cache_Interface {
   protected $_cache;
 
   /**
-   * @var NULL|array
+   * @var null|array
    *
    * This is the effective prefix. It may be bumped up whenever the dataset is flushed.
    *

diff --git a/CRM/Utils/Check/Component/Case.php b/CRM/Utils/Check/Component/Case.php
index aedeba3a6f4ea1cf7423a679401b69ffbc2f873f..4931f9f37ff7a40db69385bab88098723995ed81 100644 (file)
--- a/CRM/Utils/Check/Component/Case.php
+++ b/CRM/Utils/Check/Component/Case.php
@@ -24,7 +24,7 @@ class CRM_Utils_Check_Component_Case extends CRM_Utils_Check_Component {
   protected $xmlRepo;
 
   /**
-   * @var array<string>
+   * @var string[]
    */
   protected $caseTypeNames;
 

diff --git a/CRM/Utils/Wrapper.php b/CRM/Utils/Wrapper.php
index f1e864c5c5e179b416c2b2505bc3d1085e419792..4c3a41c6809221bb0385592cad51aca0c3b35fe0 100644 (file)
--- a/CRM/Utils/Wrapper.php
+++ b/CRM/Utils/Wrapper.php
@@ -25,7 +25,7 @@ class CRM_Utils_Wrapper {
    * Simple Controller.
    *
    * The controller which will handle the display and processing of this page.
-   * @var \CRM_Core_Controller_Simple object
+   * @var \CRM_Core_Controller_Simple
    */
   protected $_controller;