From e7c15cb6da472a57e376bd370ebaad7c3446f825 Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Sun, 11 Jan 2015 20:07:35 -0500 Subject: [PATCH] INFRA-132 - Standardize @inheritDoc tag use --- CRM/Campaign/Info.php | 16 ++++++++------ CRM/Case/Info.php | 22 ++++++++++--------- .../Form/Search/Custom/FullText/Activity.php | 2 +- .../Form/Search/Custom/FullText/Case.php | 2 +- .../Form/Search/Custom/FullText/Contact.php | 2 +- .../Search/Custom/FullText/Contribution.php | 2 +- .../Search/Custom/FullText/Membership.php | 2 +- .../Search/Custom/FullText/Participant.php | 2 +- CRM/Contribute/Info.php | 16 ++++++++------ CRM/Core/Permission/Drupal.php | 4 ++-- CRM/Core/Permission/Drupal6.php | 4 ++-- CRM/Core/Permission/DrupalBase.php | 4 ++-- CRM/Core/Permission/WordPress.php | 4 ++-- CRM/Event/Info.php | 16 ++++++++------ CRM/Extension/Container/Basic.php | 10 ++++----- CRM/Extension/Container/Collection.php | 10 ++++----- CRM/Extension/Container/Default.php | 2 +- CRM/Extension/Container/Static.php | 12 +++++----- CRM/Extension/Manager/Base.php | 22 +++++++++---------- CRM/Extension/Manager/Payment.php | 12 +++++----- CRM/Grant/Info.php | 18 ++++++++------- CRM/Mailing/Info.php | 16 ++++++++------ CRM/Member/Info.php | 16 ++++++++------ CRM/Pledge/Info.php | 14 +++++++----- CRM/Report/Info.php | 16 ++++++++------ CRM/Utils/API/AbstractFieldCoder.php | 4 ++-- CRM/Utils/API/MatchOption.php | 4 ++-- CRM/Utils/API/NullOutputCoder.php | 2 +- CRM/Utils/API/ReloadOption.php | 4 ++-- .../Contact/SearchbyDateFilterTest.php | 2 +- tests/phpunit/api/v3/APIWrapperTest.php | 4 ++-- 31 files changed, 142 insertions(+), 124 deletions(-) diff --git a/CRM/Campaign/Info.php b/CRM/Campaign/Info.php index dd54957eb9..9bffa5d59a 100644 --- a/CRM/Campaign/Info.php +++ b/CRM/Campaign/Info.php @@ -37,11 +37,13 @@ */ class CRM_Campaign_Info extends CRM_Core_Component_Info { - // docs inherited from interface + /** + * @inheritDoc + */ protected $keyword = 'campaign'; /** - * docs inherited from interface + * @inheritDoc * @return array */ public function getInfo() { @@ -56,7 +58,7 @@ class CRM_Campaign_Info extends CRM_Core_Component_Info { /** - * docs inherited from interface + * @inheritDoc * @param bool $getAllUnconditionally * * @return array @@ -75,7 +77,7 @@ class CRM_Campaign_Info extends CRM_Core_Component_Info { /** - * docs inherited from interface + * @inheritDoc * @return null */ public function getUserDashboardElement() { @@ -92,7 +94,7 @@ class CRM_Campaign_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return null */ public function registerTab() { @@ -101,7 +103,7 @@ class CRM_Campaign_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return null */ public function registerAdvancedSearchPane() { @@ -110,7 +112,7 @@ class CRM_Campaign_Info extends CRM_Core_Component_Info { } /** - * @inheritdoc + * @inheritDoc */ public function getActivityTypes() { return NULL; diff --git a/CRM/Case/Info.php b/CRM/Case/Info.php index 86193fe143..ce9be2e1a6 100644 --- a/CRM/Case/Info.php +++ b/CRM/Case/Info.php @@ -38,11 +38,13 @@ class CRM_Case_Info extends CRM_Core_Component_Info { - // docs inherited from interface + /** + * @inheritDoc + */ protected $keyword = 'case'; /** - * docs inherited from interface + * @inheritDoc * @return array */ public function getInfo() { @@ -56,7 +58,7 @@ class CRM_Case_Info extends CRM_Core_Component_Info { } /** - * {@inheritDoc} + * @inheritDoc */ public function getAngularModules() { $result = array(); @@ -75,7 +77,7 @@ class CRM_Case_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return array * @throws CRM_Core_Exception */ @@ -89,7 +91,7 @@ class CRM_Case_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @param bool $getAllUnconditionally * * @return array @@ -105,7 +107,7 @@ class CRM_Case_Info extends CRM_Core_Component_Info { } /** - * {@inheritdoc} + * @inheritDoc */ public function getReferenceCounts($dao) { $result = array(); @@ -140,7 +142,7 @@ class CRM_Case_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return array */ public function getUserDashboardElement() { @@ -148,7 +150,7 @@ class CRM_Case_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return array */ public function registerTab() { @@ -160,7 +162,7 @@ class CRM_Case_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return array */ public function registerAdvancedSearchPane() { @@ -171,7 +173,7 @@ class CRM_Case_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return null */ public function getActivityTypes() { diff --git a/CRM/Contact/Form/Search/Custom/FullText/Activity.php b/CRM/Contact/Form/Search/Custom/FullText/Activity.php index b191a24265..8db1fe4b39 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Activity.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Activity.php @@ -43,7 +43,7 @@ class CRM_Contact_Form_Search_Custom_FullText_Activity extends CRM_Contact_Form_ } /** - * {@inheritdoc} + * @inheritDoc */ public function fillTempTable($queryText, $entityIDTableName, $toTable, $queryLimit, $detailLimit) { $queries = $this->prepareQueries($queryText, $entityIDTableName); diff --git a/CRM/Contact/Form/Search/Custom/FullText/Case.php b/CRM/Contact/Form/Search/Custom/FullText/Case.php index 8237368b90..cd56cd3899 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Case.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Case.php @@ -44,7 +44,7 @@ class CRM_Contact_Form_Search_Custom_FullText_Case extends CRM_Contact_Form_Sear } /** - * {@inheritdoc} + * @inheritDoc */ public function fillTempTable($queryText, $entityIDTableName, $toTable, $queryLimit, $detailLimit) { $queries = $this->prepareQueries($queryText, $entityIDTableName); diff --git a/CRM/Contact/Form/Search/Custom/FullText/Contact.php b/CRM/Contact/Form/Search/Custom/FullText/Contact.php index 16cb175662..c1a77aaca3 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Contact.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Contact.php @@ -43,7 +43,7 @@ class CRM_Contact_Form_Search_Custom_FullText_Contact extends CRM_Contact_Form_S } /** - * {@inheritdoc} + * @inheritDoc */ public function fillTempTable($queryText, $entityIDTableName, $toTable, $queryLimit, $detailLimit) { $queries = $this->prepareQueries($queryText, $entityIDTableName); diff --git a/CRM/Contact/Form/Search/Custom/FullText/Contribution.php b/CRM/Contact/Form/Search/Custom/FullText/Contribution.php index 20a27eafe4..7c76bbfebd 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Contribution.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Contribution.php @@ -45,7 +45,7 @@ class CRM_Contact_Form_Search_Custom_FullText_Contribution extends CRM_Contact_F } /** - * {@inheritdoc} + * @inheritDoc */ public function fillTempTable($queryText, $entityIDTableName, $toTable, $queryLimit, $detailLimit) { $queries = $this->prepareQueries($queryText, $entityIDTableName); diff --git a/CRM/Contact/Form/Search/Custom/FullText/Membership.php b/CRM/Contact/Form/Search/Custom/FullText/Membership.php index 5c3298cf5f..d677843b0f 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Membership.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Membership.php @@ -45,7 +45,7 @@ class CRM_Contact_Form_Search_Custom_FullText_Membership extends CRM_Contact_For } /** - * {@inheritdoc} + * @inheritDoc */ public function fillTempTable($queryText, $entityIDTableName, $toTable, $queryLimit, $detailLimit) { $queries = $this->prepareQueries($queryText, $entityIDTableName); diff --git a/CRM/Contact/Form/Search/Custom/FullText/Participant.php b/CRM/Contact/Form/Search/Custom/FullText/Participant.php index 8ceebbd915..9aa24e5bbc 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Participant.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Participant.php @@ -45,7 +45,7 @@ class CRM_Contact_Form_Search_Custom_FullText_Participant extends CRM_Contact_Fo } /** - * {@inheritdoc} + * @inheritDoc */ public function fillTempTable($queryText, $entityIDTableName, $toTable, $queryLimit, $detailLimit) { $queries = $this->prepareQueries($queryText, $entityIDTableName); diff --git a/CRM/Contribute/Info.php b/CRM/Contribute/Info.php index ff71b916f7..93bf330612 100644 --- a/CRM/Contribute/Info.php +++ b/CRM/Contribute/Info.php @@ -38,11 +38,13 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { - // docs inherited from interface + /** + * @inheritDoc + */ protected $keyword = 'contribute'; /** - * docs inherited from interface + * @inheritDoc * Provides base information about the component. * Needs to be implemented in component's information * class. @@ -64,7 +66,7 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * Provides permissions that are used by component. * Needs to be implemented in component's information * class. @@ -108,7 +110,7 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * Provides information about user dashboard element * offered by this component. * @@ -129,7 +131,7 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * Provides information about user dashboard element * offered by this component. * @@ -149,7 +151,7 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * Provides information about advanced search pane * offered by this component. * @@ -168,7 +170,7 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * Provides potential activity types that this * component might want to register in activity history. * Needs to be implemented in component's information diff --git a/CRM/Core/Permission/Drupal.php b/CRM/Core/Permission/Drupal.php index 85f1e91763..c36036be0d 100644 --- a/CRM/Core/Permission/Drupal.php +++ b/CRM/Core/Permission/Drupal.php @@ -113,14 +113,14 @@ class CRM_Core_Permission_Drupal extends CRM_Core_Permission_DrupalBase { } /** - * {@inheritDoc} + * @inheritDoc */ public function isModulePermissionSupported() { return TRUE; } /** - * {@inheritdoc} + * @inheritDoc */ public function upgradePermissions($permissions) { if (empty($permissions)) { diff --git a/CRM/Core/Permission/Drupal6.php b/CRM/Core/Permission/Drupal6.php index 396d195ade..c9569fc5a0 100644 --- a/CRM/Core/Permission/Drupal6.php +++ b/CRM/Core/Permission/Drupal6.php @@ -183,14 +183,14 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { } /** - * {@inheritDoc} + * @inheritDoc */ public function isModulePermissionSupported() { return TRUE; } /** - * {@inheritdoc} + * @inheritDoc * * Does nothing in Drupal 6. */ diff --git a/CRM/Core/Permission/DrupalBase.php b/CRM/Core/Permission/DrupalBase.php index eedf271ac8..18dfbff834 100644 --- a/CRM/Core/Permission/DrupalBase.php +++ b/CRM/Core/Permission/DrupalBase.php @@ -276,7 +276,7 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { } /** - * {@inheritDoc} + * @inheritDoc */ public function isModulePermissionSupported() { return TRUE; @@ -320,7 +320,7 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { } /** - * {@inheritdoc} + * @inheritDoc */ public function upgradePermissions($permissions) { if (empty($permissions)) { diff --git a/CRM/Core/Permission/WordPress.php b/CRM/Core/Permission/WordPress.php index 354dda8af4..da8dbd75fc 100644 --- a/CRM/Core/Permission/WordPress.php +++ b/CRM/Core/Permission/WordPress.php @@ -92,14 +92,14 @@ class CRM_Core_Permission_WordPress extends CRM_Core_Permission_Base { } /** - * {@inheritDoc} + * @inheritDoc */ public function isModulePermissionSupported() { return TRUE; } /** - * {@inheritdoc} + * @inheritDoc */ public function upgradePermissions($permissions) { return; diff --git a/CRM/Event/Info.php b/CRM/Event/Info.php index 9399c0a63c..a9d55cc48a 100644 --- a/CRM/Event/Info.php +++ b/CRM/Event/Info.php @@ -37,11 +37,13 @@ */ class CRM_Event_Info extends CRM_Core_Component_Info { - // docs inherited from interface + /** + * @inheritDoc + */ protected $keyword = 'event'; /** - * docs inherited from interface + * @inheritDoc * @return array */ public function getInfo() { @@ -55,7 +57,7 @@ class CRM_Event_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @param bool $getAllUnconditionally * * @return array @@ -82,7 +84,7 @@ class CRM_Event_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return array */ public function getUserDashboardElement() { @@ -95,7 +97,7 @@ class CRM_Event_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return array */ public function registerTab() { @@ -108,7 +110,7 @@ class CRM_Event_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return array */ public function registerAdvancedSearchPane() { @@ -119,7 +121,7 @@ class CRM_Event_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return array */ public function getActivityTypes() { diff --git a/CRM/Extension/Container/Basic.php b/CRM/Extension/Container/Basic.php index f09753cb96..ce58165ecc 100644 --- a/CRM/Extension/Container/Basic.php +++ b/CRM/Extension/Container/Basic.php @@ -101,7 +101,7 @@ class CRM_Extension_Container_Basic implements CRM_Extension_Container_Interface } /** - * {@inheritdoc} + * @inheritDoc */ public function checkRequirements() { $errors = array(); @@ -123,21 +123,21 @@ class CRM_Extension_Container_Basic implements CRM_Extension_Container_Interface } /** - * {@inheritdoc} + * @inheritDoc */ public function getKeys() { return array_keys($this->getRelPaths()); } /** - * {@inheritdoc} + * @inheritDoc */ public function getPath($key) { return $this->baseDir . $this->getRelPath($key); } /** - * {@inheritdoc} + * @inheritDoc */ public function getResUrl($key) { if (!$this->baseUrl) { @@ -154,7 +154,7 @@ class CRM_Extension_Container_Basic implements CRM_Extension_Container_Interface } /** - * {@inheritdoc} + * @inheritDoc */ public function refresh() { $this->relPaths = NULL; diff --git a/CRM/Extension/Container/Collection.php b/CRM/Extension/Container/Collection.php index e3652f70fd..a5aad8e511 100644 --- a/CRM/Extension/Container/Collection.php +++ b/CRM/Extension/Container/Collection.php @@ -81,7 +81,7 @@ class CRM_Extension_Container_Collection implements CRM_Extension_Container_Inte } /** - * {@inheritdoc} + * @inheritDoc */ public function checkRequirements() { $errors = array(); @@ -92,7 +92,7 @@ class CRM_Extension_Container_Collection implements CRM_Extension_Container_Inte } /** - * {@inheritdoc} + * @inheritDoc */ public function getKeys() { $k2c = $this->getKeysToContainer(); @@ -100,21 +100,21 @@ class CRM_Extension_Container_Collection implements CRM_Extension_Container_Inte } /** - * {@inheritdoc} + * @inheritDoc */ public function getPath($key) { return $this->getContainer($key)->getPath($key); } /** - * {@inheritdoc} + * @inheritDoc */ public function getResUrl($key) { return $this->getContainer($key)->getResUrl($key); } /** - * {@inheritdoc} + * @inheritDoc */ public function refresh() { if ($this->cache) { diff --git a/CRM/Extension/Container/Default.php b/CRM/Extension/Container/Default.php index ac620bbc39..c64a5f729f 100644 --- a/CRM/Extension/Container/Default.php +++ b/CRM/Extension/Container/Default.php @@ -7,7 +7,7 @@ class CRM_Extension_Container_Default extends CRM_Extension_Container_Basic { /** - * {@inheritdoc} + * @inheritDoc */ public function checkRequirements() { $errors = array(); diff --git a/CRM/Extension/Container/Static.php b/CRM/Extension/Container/Static.php index 82cfb64d48..d0b37f03c0 100644 --- a/CRM/Extension/Container/Static.php +++ b/CRM/Extension/Container/Static.php @@ -45,28 +45,28 @@ class CRM_Extension_Container_Static implements CRM_Extension_Container_Interfac } /** - * {@inheritdoc} + * @inheritDoc */ public function checkRequirements() { return array(); } /** - * {@inheritdoc} + * @inheritDoc */ public function getName() { return $this->name; } /** - * {@inheritdoc} + * @inheritDoc */ public function getKeys() { return array_keys($this->exts); } /** - * {@inheritdoc} + * @inheritDoc */ public function getPath($key) { $e = $this->getExt($key); @@ -74,7 +74,7 @@ class CRM_Extension_Container_Static implements CRM_Extension_Container_Interfac } /** - * {@inheritdoc} + * @inheritDoc */ public function getResUrl($key) { $e = $this->getExt($key); @@ -82,7 +82,7 @@ class CRM_Extension_Container_Static implements CRM_Extension_Container_Interfac } /** - * {@inheritdoc} + * @inheritDoc */ public function refresh() { } diff --git a/CRM/Extension/Manager/Base.php b/CRM/Extension/Manager/Base.php index b584001f3f..f17e26f799 100644 --- a/CRM/Extension/Manager/Base.php +++ b/CRM/Extension/Manager/Base.php @@ -50,61 +50,61 @@ class CRM_Extension_Manager_Base implements CRM_Extension_Manager_Interface { } /** - * {@inheritdoc} + * @inheritDoc */ public function onPreInstall(CRM_Extension_Info $info) { } /** - * {@inheritdoc} + * @inheritDoc */ public function onPostInstall(CRM_Extension_Info $info) { } /** - * {@inheritdoc} + * @inheritDoc */ public function onPostPostInstall(CRM_Extension_Info $info) { } /** - * {@inheritdoc} + * @inheritDoc */ public function onPreEnable(CRM_Extension_Info $info) { } /** - * {@inheritdoc} + * @inheritDoc */ public function onPostEnable(CRM_Extension_Info $info) { } /** - * {@inheritdoc} + * @inheritDoc */ public function onPreDisable(CRM_Extension_Info $info) { } /** - * {@inheritdoc} + * @inheritDoc */ public function onPostDisable(CRM_Extension_Info $info) { } /** - * {@inheritdoc} + * @inheritDoc */ public function onPreUninstall(CRM_Extension_Info $info) { } /** - * {@inheritdoc} + * @inheritDoc */ public function onPostUninstall(CRM_Extension_Info $info) { } /** - * {@inheritdoc} + * @inheritDoc */ public function onPreReplace(CRM_Extension_Info $oldInfo, CRM_Extension_Info $newInfo) { if ($this->autoReplace) { @@ -114,7 +114,7 @@ class CRM_Extension_Manager_Base implements CRM_Extension_Manager_Interface { } /** - * {@inheritdoc} + * @inheritDoc */ public function onPostReplace(CRM_Extension_Info $oldInfo, CRM_Extension_Info $newInfo) { if ($this->autoReplace) { diff --git a/CRM/Extension/Manager/Payment.php b/CRM/Extension/Manager/Payment.php index 51c57cfe98..e48267dd10 100644 --- a/CRM/Extension/Manager/Payment.php +++ b/CRM/Extension/Manager/Payment.php @@ -49,7 +49,7 @@ class CRM_Extension_Manager_Payment extends CRM_Extension_Manager_Base { } /** - * {@inheritdoc} + * @inheritDoc */ public function onPreInstall(CRM_Extension_Info $info) { $paymentProcessorTypes = $this->_getAllPaymentProcessorTypes('class_name'); @@ -108,14 +108,14 @@ class CRM_Extension_Manager_Payment extends CRM_Extension_Manager_Base { } /** - * {@inheritdoc} + * @inheritDoc */ public function onPostInstall(CRM_Extension_Info $info) { $this->_runPaymentHook($info, 'install'); } /** - * {@inheritdoc} + * @inheritDoc */ public function onPreUninstall(CRM_Extension_Info $info) { $paymentProcessorTypes = $this->_getAllPaymentProcessorTypes('class_name'); @@ -135,7 +135,7 @@ class CRM_Extension_Manager_Payment extends CRM_Extension_Manager_Base { } /** - * {@inheritdoc} + * @inheritDoc */ public function onPreDisable(CRM_Extension_Info $info) { // HMM? // if ($this->type == 'payment' && $this->status != 'missing') { @@ -146,7 +146,7 @@ class CRM_Extension_Manager_Payment extends CRM_Extension_Manager_Base { } /** - * {@inheritdoc} + * @inheritDoc */ public function onPreEnable(CRM_Extension_Info $info) { $paymentProcessorTypes = $this->_getAllPaymentProcessorTypes('class_name'); @@ -154,7 +154,7 @@ class CRM_Extension_Manager_Payment extends CRM_Extension_Manager_Base { } /** - * {@inheritdoc} + * @inheritDoc */ public function onPostEnable(CRM_Extension_Info $info) { // HMM? // if ($this->type == 'payment' && $this->status != 'missing') { diff --git a/CRM/Grant/Info.php b/CRM/Grant/Info.php index 5a8a4620ac..a569c7fcb7 100644 --- a/CRM/Grant/Info.php +++ b/CRM/Grant/Info.php @@ -37,11 +37,13 @@ */ class CRM_Grant_Info extends CRM_Core_Component_Info { - // docs inherited from interface + /** + * @inheritDoc + */ protected $keyword = 'grant'; /** - * docs inherited from interface + * @inheritDoc * @return array */ public function getInfo() { @@ -57,7 +59,7 @@ class CRM_Grant_Info extends CRM_Core_Component_Info { /** - * docs inherited from interface + * @inheritDoc * @param bool $getAllUnconditionally * * @return array @@ -71,7 +73,7 @@ class CRM_Grant_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return null */ public function getUserDashboardElement() { @@ -80,7 +82,7 @@ class CRM_Grant_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return null */ public function getUserDashboardObject() { @@ -89,7 +91,7 @@ class CRM_Grant_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return array */ public function registerTab() { @@ -101,7 +103,7 @@ class CRM_Grant_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return array */ public function registerAdvancedSearchPane() { @@ -112,7 +114,7 @@ class CRM_Grant_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return null */ public function getActivityTypes() { diff --git a/CRM/Mailing/Info.php b/CRM/Mailing/Info.php index 03196ea84d..2c3384e309 100644 --- a/CRM/Mailing/Info.php +++ b/CRM/Mailing/Info.php @@ -37,12 +37,14 @@ */ class CRM_Mailing_Info extends CRM_Core_Component_Info { - // docs inherited from interface + /** + * @inheritDoc + */ protected $keyword = 'mailing'; /** - * docs inherited from interface + * @inheritDoc * @return array */ public function getInfo() { @@ -178,7 +180,7 @@ class CRM_Mailing_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @param bool $getAllUnconditionally * * @return array @@ -202,7 +204,7 @@ class CRM_Mailing_Info extends CRM_Core_Component_Info { /** - * docs inherited from interface + * @inheritDoc * @return null */ public function getUserDashboardElement() { @@ -219,7 +221,7 @@ class CRM_Mailing_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return array */ public function registerTab() { @@ -232,7 +234,7 @@ class CRM_Mailing_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return array */ public function registerAdvancedSearchPane() { @@ -243,7 +245,7 @@ class CRM_Mailing_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * @return null */ public function getActivityTypes() { diff --git a/CRM/Member/Info.php b/CRM/Member/Info.php index b362c4ecd3..e80fe52a7e 100644 --- a/CRM/Member/Info.php +++ b/CRM/Member/Info.php @@ -37,11 +37,13 @@ */ class CRM_Member_Info extends CRM_Core_Component_Info { - // docs inherited from interface + /** + * @inheritDoc + */ protected $keyword = 'member'; /** - * docs inherited from interface + * @inheritDoc * Provides base information about the component. * Needs to be implemented in component's information * class. @@ -64,7 +66,7 @@ class CRM_Member_Info extends CRM_Core_Component_Info { /** - * docs inherited from interface + * @inheritDoc * Provides permissions that are used by component. * Needs to be implemented in component's information * class. @@ -91,7 +93,7 @@ class CRM_Member_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * Provides information about user dashboard element * offered by this component. * @@ -115,7 +117,7 @@ class CRM_Member_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * Provides information about user dashboard element * offered by this component. * @@ -135,7 +137,7 @@ class CRM_Member_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * Provides information about advanced search pane * offered by this component. * @@ -154,7 +156,7 @@ class CRM_Member_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * Provides potential activity types that this * component might want to register in activity history. * Needs to be implemented in component's information diff --git a/CRM/Pledge/Info.php b/CRM/Pledge/Info.php index caa5f44941..8f5f3c2db5 100644 --- a/CRM/Pledge/Info.php +++ b/CRM/Pledge/Info.php @@ -37,7 +37,9 @@ */ class CRM_Pledge_Info extends CRM_Core_Component_Info { - // docs inherited from interface + /** + * @inheritDoc + */ protected $keyword = 'pledge'; /** @@ -60,7 +62,7 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info { /** - * docs inherited from interface + * @inheritDoc * Provides permissions that are used by component. * Needs to be implemented in component's information * class. @@ -87,7 +89,7 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * Provides information about user dashboard element * offered by this component. * @@ -109,7 +111,7 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * Provides information about user dashboard element * offered by this component. * @@ -129,7 +131,7 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * Provides information about advanced search pane * offered by this component. * @@ -148,7 +150,7 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * Provides potential activity types that this * component might want to register in activity history. * Needs to be implemented in component's information diff --git a/CRM/Report/Info.php b/CRM/Report/Info.php index 9354f5e82f..8ed743cd3b 100644 --- a/CRM/Report/Info.php +++ b/CRM/Report/Info.php @@ -37,11 +37,13 @@ */ class CRM_Report_Info extends CRM_Core_Component_Info { - // docs inherited from interface + /** + * @inheritDoc + */ protected $keyword = 'report'; /** - * docs inherited from interface + * @inheritDoc * Provides base information about the component. * Needs to be implemented in component's information * class. @@ -64,7 +66,7 @@ class CRM_Report_Info extends CRM_Core_Component_Info { /** - * docs inherited from interface + * @inheritDoc * Provides permissions that are used by component. * Needs to be implemented in component's information * class. @@ -88,7 +90,7 @@ class CRM_Report_Info extends CRM_Core_Component_Info { /** - * docs inherited from interface + * @inheritDoc * Provides information about user dashboard element * offered by this component. * @@ -119,7 +121,7 @@ class CRM_Report_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * Provides information about user dashboard element * offered by this component. * @@ -136,7 +138,7 @@ class CRM_Report_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * Provides information about advanced search pane * offered by this component. * @@ -153,7 +155,7 @@ class CRM_Report_Info extends CRM_Core_Component_Info { } /** - * docs inherited from interface + * @inheritDoc * Provides potential activity types that this * component might want to register in activity history. * Needs to be implemented in component's information diff --git a/CRM/Utils/API/AbstractFieldCoder.php b/CRM/Utils/API/AbstractFieldCoder.php index 112f80a82d..87bbfefca0 100644 --- a/CRM/Utils/API/AbstractFieldCoder.php +++ b/CRM/Utils/API/AbstractFieldCoder.php @@ -94,7 +94,7 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper { public abstract function decodeOutput(&$values); /** - * {@inheritDoc} + * @inheritDoc */ public function fromApiInput($apiRequest) { $lowerAction = strtolower($apiRequest['action']); @@ -119,7 +119,7 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper { } /** - * {@inheritDoc} + * @inheritDoc */ public function toApiOutput($apiRequest, $result) { $lowerAction = strtolower($apiRequest['action']); diff --git a/CRM/Utils/API/MatchOption.php b/CRM/Utils/API/MatchOption.php index 983f723634..dcdc487930 100644 --- a/CRM/Utils/API/MatchOption.php +++ b/CRM/Utils/API/MatchOption.php @@ -76,7 +76,7 @@ class CRM_Utils_API_MatchOption implements API_Wrapper { } /** - * {@inheritDoc} + * @inheritDoc */ public function fromApiInput($apiRequest) { // Parse options.match or options.match-mandatory @@ -163,7 +163,7 @@ class CRM_Utils_API_MatchOption implements API_Wrapper { } /** - * {@inheritDoc} + * @inheritDoc */ public function toApiOutput($apiRequest, $result) { return $result; diff --git a/CRM/Utils/API/NullOutputCoder.php b/CRM/Utils/API/NullOutputCoder.php index d7287ea1d0..3fa7956a69 100644 --- a/CRM/Utils/API/NullOutputCoder.php +++ b/CRM/Utils/API/NullOutputCoder.php @@ -86,7 +86,7 @@ class CRM_Utils_API_NullOutputCoder extends CRM_Utils_API_AbstractFieldCoder { } /** - * {@inheritDoc} + * @inheritDoc */ /** * @param $apiRequest diff --git a/CRM/Utils/API/ReloadOption.php b/CRM/Utils/API/ReloadOption.php index 5280bef63d..0dd6fdf7c8 100644 --- a/CRM/Utils/API/ReloadOption.php +++ b/CRM/Utils/API/ReloadOption.php @@ -65,14 +65,14 @@ class CRM_Utils_API_ReloadOption implements API_Wrapper { } /** - * {@inheritDoc} + * @inheritDoc */ public function fromApiInput($apiRequest) { return $apiRequest; } /** - * {@inheritDoc} + * @inheritDoc */ public function toApiOutput($apiRequest, $result) { $reloadMode = NULL; diff --git a/tests/phpunit/WebTest/Contact/SearchbyDateFilterTest.php b/tests/phpunit/WebTest/Contact/SearchbyDateFilterTest.php index 51ed9d68e2..cd5f91382e 100644 --- a/tests/phpunit/WebTest/Contact/SearchbyDateFilterTest.php +++ b/tests/phpunit/WebTest/Contact/SearchbyDateFilterTest.php @@ -32,7 +32,7 @@ require_once 'CiviTest/CiviSeleniumTestCase.php'; class WebTest_Contact_SearchbyDateFilterTest extends CiviSeleniumTestCase { /** - * {@inheritDoc} + * @inheritDoc */ protected function setUp() { parent::setUp(); diff --git a/tests/phpunit/api/v3/APIWrapperTest.php b/tests/phpunit/api/v3/APIWrapperTest.php index d1f27390cf..a017a43bf9 100644 --- a/tests/phpunit/api/v3/APIWrapperTest.php +++ b/tests/phpunit/api/v3/APIWrapperTest.php @@ -90,7 +90,7 @@ class api_v3_APIWrapperTest extends CiviUnitTestCase { */ class api_v3_APIWrapperTest_Impl implements API_Wrapper { /** - * {@inheritDoc} + * @inheritDoc */ public function fromApiInput($apiRequest) { if ($apiRequest['entity'] == 'contact' && $apiRequest['action'] == 'create') { @@ -102,7 +102,7 @@ class api_v3_APIWrapperTest_Impl implements API_Wrapper { } /** - * {@inheritDoc} + * @inheritDoc */ public function toApiOutput($apiRequest, $result) { if ($apiRequest['entity'] == 'contact' && $apiRequest['action'] == 'create') { -- 2.25.1