Fix wrong types in doc comments part 2 (#633)

tmotyl · colinmollenhour · commit 418e9ffbb77d · 2019-04-01T09:50:47.000-04:00
diff --git a/app/code/core/Mage/Adminhtml/Block/Sales/Order/Creditmemo/Create/Adjustments.php b/app/code/core/Mage/Adminhtml/Block/Sales/Order/Creditmemo/Create/Adjustments.php
@@ -27,9 +27,9 @@ class Mage_Adminhtml_Block_Sales_Order_Creditmemo_Create_Adjustments extends Mag
 {
     protected $_source;
     /**
-     * Initialize creditmemo agjustment totals
+     * Initialize creditmemo adjustment totals
      *
-     * @return Mage_Tax_Block_Sales_Order_Tax
+     * @return $this
      */
     public function initTotals()
     {
diff --git a/app/code/core/Mage/Adminhtml/Block/Sales/Order/Totals/Tax.php b/app/code/core/Mage/Adminhtml/Block/Sales/Order/Totals/Tax.php
@@ -64,6 +64,8 @@ protected function _getTaxHelper()
     /**
      * Display tax amount
      *
+     * @param float $amount
+     * @param float $baseAmount
      * @return string
      */
     public function displayAmount($amount, $baseAmount)
diff --git a/app/code/core/Mage/Adminhtml/Model/Giftmessage/Save.php b/app/code/core/Mage/Adminhtml/Model/Giftmessage/Save.php
@@ -244,8 +244,8 @@ public function isGiftMessagesAvailable($item)
     /**
      * Imports quote items for gift messages from products data
      *
-     * @param unknown_type $products
-     * @return unknown
+     * @param array $products
+     * @return $this
      */
     public function importAllowQuoteItemsFromProducts($products)
     {
diff --git a/app/code/core/Mage/Adminhtml/Model/System/Store.php b/app/code/core/Mage/Adminhtml/Model/System/Store.php
@@ -78,7 +78,7 @@ public function __construct()
     /**
      * Load/Reload Website collection
      *
-     * @return array
+     * @return $this
      */
     protected function _loadWebsiteCollection()
     {
@@ -89,7 +89,7 @@ protected function _loadWebsiteCollection()
     /**
      * Load/Reload Group collection
      *
-     * @return array
+     * @return $this
      */
     protected function _loadGroupCollection()
     {
@@ -105,7 +105,7 @@ protected function _loadGroupCollection()
     /**
      * Load/Reload Store collection
      *
-     * @return array
+     * @return $this
      */
     protected function _loadStoreCollection()
     {
diff --git a/app/code/core/Mage/Bundle/Model/Price/Index.php b/app/code/core/Mage/Bundle/Model/Price/Index.php
@@ -28,7 +28,6 @@
 /**
  * Bundle Product Price Index
  *
- * @method Mage_Bundle_Model_Resource_Price_Index _getResource()
  * @method Mage_Bundle_Model_Resource_Price_Index getResource()
  * @method Mage_Bundle_Model_Price_Index setEntityId(int $value)
  * @method int getWebsiteId()
diff --git a/app/code/core/Mage/Catalog/Block/Seo/Sitemap/Product.php b/app/code/core/Mage/Catalog/Block/Seo/Sitemap/Product.php
@@ -37,7 +37,7 @@ class Mage_Catalog_Block_Seo_Sitemap_Product extends Mage_Catalog_Block_Seo_Site
     /**
      * Initialize products collection
      *
-     * @return Mage_Catalog_Block_Seo_Sitemap_Category
+     * @return $this
      */
     protected function _prepareLayout()
     {
diff --git a/app/code/core/Mage/Catalog/Model/Api2/Product/Validator/Product.php b/app/code/core/Mage/Catalog/Model/Api2/Product/Validator/Product.php
@@ -130,7 +130,6 @@ public function isValidData(array $data)
      *
      * @param array $data
      * @param Mage_Eav_Model_Entity_Type $productEntity
-     * @return array
      */
     protected function _validateAttributes($data, $productEntity)
     {
diff --git a/app/code/core/Mage/Catalog/Model/Category.php b/app/code/core/Mage/Catalog/Model/Category.php
@@ -831,7 +831,7 @@ public function getParentCategories()
     }
 
     /**
-     * Retuen children categories of current category
+     * Return children categories of current category
      *
      * @return array
      */
diff --git a/app/code/core/Mage/Catalog/Model/Product/Status.php b/app/code/core/Mage/Catalog/Model/Product/Status.php
@@ -28,7 +28,6 @@
 /**
  * Product status functionality model
  *
- * @method Mage_Catalog_Model_Resource_Product_Status _getResource()
  * @method Mage_Catalog_Model_Resource_Product_Status getResource()
  * @method int getProductId()
  * @method Mage_Catalog_Model_Product_Status setProductId(int $value)
diff --git a/app/code/core/Mage/Catalog/Model/Product/Type/Abstract.php b/app/code/core/Mage/Catalog/Model/Product/Type/Abstract.php
@@ -843,7 +843,7 @@ public function getStoreFilter($product = null)
      * Set store filter for associated products
      *
      * @param $store int|Mage_Core_Model_Store
-     * @return Mage_Catalog_Model_Product_Type_Configurable
+     * @return $this
      */
     public function setStoreFilter($store=null, $product = null)
     {
@@ -853,7 +853,7 @@ public function setStoreFilter($store=null, $product = null)
     }
 
     /**
-     * Allow for updates of chidren qty's
+     * Allow for updates of children qty's
      * (applicable for complicated product types. As default returns false)
      *
      * @return boolean false
diff --git a/app/code/core/Mage/Catalog/Model/Product/Website.php b/app/code/core/Mage/Catalog/Model/Product/Website.php
@@ -28,7 +28,6 @@
 /**
  * Catalog Product Website Model
  *
- * @method Mage_Catalog_Model_Resource_Product_Website _getResource()
  * @method Mage_Catalog_Model_Resource_Product_Website getResource()
  * @method int getWebsiteId()
  * @method Mage_Catalog_Model_Product_Website setWebsiteId(int $value)
diff --git a/app/code/core/Mage/CatalogInventory/Model/Indexer/Stock.php b/app/code/core/Mage/CatalogInventory/Model/Indexer/Stock.php
@@ -28,7 +28,6 @@
 /**
  * CatalogInventory Stock Status Indexer Model
  *
- * @method Mage_CatalogInventory_Model_Resource_Indexer_Stock _getResource()
  * @method Mage_CatalogInventory_Model_Resource_Indexer_Stock getResource()
  * @method int getProductId()
  * @method Mage_CatalogInventory_Model_Indexer_Stock setProductId(int $value)
diff --git a/app/code/core/Mage/CatalogSearch/Model/Advanced.php b/app/code/core/Mage/CatalogSearch/Model/Advanced.php
@@ -27,7 +27,6 @@
 /**
  * Catalog advanced search model
  *
- * @method Mage_CatalogSearch_Model_Resource_Advanced _getResource()
  * @method Mage_CatalogSearch_Model_Resource_Advanced getResource()
  * @method int getEntityTypeId()
  * @method Mage_CatalogSearch_Model_Advanced setEntityTypeId(int $value)
@@ -113,7 +112,7 @@ protected function _getResource()
      */
     public function getAttributes()
     {
-        /* @var $attributes Mage_Catalog_Model_Resource_Eav_Resource_Product_Attribute_Collection */
+        /* @var $attributes Mage_Catalog_Model_Resource_Product_Attribute_Collection */
         $attributes = $this->getData('attributes');
         if (is_null($attributes)) {
             $product = Mage::getModel('catalog/product');
diff --git a/app/code/core/Mage/Checkout/Block/Multishipping/Addresses.php b/app/code/core/Mage/Checkout/Block/Multishipping/Addresses.php
@@ -63,6 +63,7 @@ public function getItems()
      * Retrieve HTML for addresses dropdown
      *
      * @param  $item
+     * @param string $index
      * @return string
      */
     public function getAddressesHtmlSelect($item, $index)
diff --git a/app/code/core/Mage/Core/Controller/Front/Action.php b/app/code/core/Mage/Core/Controller/Front/Action.php
@@ -105,7 +105,7 @@ public function __()
      *                              that case
      * @param string $contentType
      * @param int $contentLength    explicit content length, if strlen($content) isn't applicable
-     * @return Mage_Adminhtml_Controller_Action
+     * @return $this
      */
     protected function _prepareDownloadResponse($fileName, $content, $contentType = 'application/octet-stream',
         $contentLength = null
diff --git a/app/code/core/Mage/Core/Model/Store.php b/app/code/core/Mage/Core/Model/Store.php
@@ -393,7 +393,7 @@ public function getConfig($path)
      *
      * Method provide cache configuration data without loading store config XML
      *
-     * @return Mage_Core_Model_Config
+     * @return $this
      */
     public function initConfigCache()
     {
diff --git a/app/code/core/Mage/Customer/Model/Address/Abstract.php b/app/code/core/Mage/Customer/Model/Address/Abstract.php
@@ -151,10 +151,10 @@ public function setStreetFull($street)
     }
 
     /**
-     * set address street informa
+     * set address street
      *
-     * @param unknown_type $street
-     * @return unknown
+     * @param array|string $street
+     * @return $this
      */
     public function setStreet($street)
     {
diff --git a/app/code/core/Mage/Customer/Model/Resource/Address.php b/app/code/core/Mage/Customer/Model/Resource/Address.php
@@ -90,7 +90,7 @@ public function getCustomerId($object)
      *
      * @param Mage_Customer_Model_Address $object
      * @param int $id
-     * @return Mage_Customer_Model_Address
+     * @return $this
      */
     public function setCustomerId($object, $id)
     {
diff --git a/app/code/core/Mage/Eav/Model/Entity/Abstract.php b/app/code/core/Mage/Eav/Model/Entity/Abstract.php
@@ -504,7 +504,7 @@ public function isPartialSave($flag = null)
     /**
      * Retrieve configuration for all attributes
      *
-     * @return Mage_Eav_Model_Entity_Attribute_Abstract
+     * @return $this
      */
     public function loadAllAttributes($object=null)
     {
@@ -1501,7 +1501,7 @@ protected function _prepareValueForSave($value, Mage_Eav_Model_Entity_Attribute_
      * @param   Varien_Object $object
      * @param   string $table
      * @param   array $info
-     * @return  Varien_Object
+     * @return  $this
      */
     protected function _deleteAttributes($object, $table, $info)
     {
diff --git a/app/code/core/Mage/Eav/Model/Entity/Attribute/Source/Abstract.php b/app/code/core/Mage/Eav/Model/Entity/Attribute/Source/Abstract.php
@@ -53,7 +53,7 @@ abstract class Mage_Eav_Model_Entity_Attribute_Source_Abstract
      * Set attribute instance
      *
      * @param Mage_Eav_Model_Entity_Attribute_Abstract $attribute
-     * @return Mage_Eav_Model_Entity_Attribute_Frontend_Abstract
+     * @return $this
      */
     public function setAttribute($attribute)
     {
diff --git a/app/code/core/Mage/Eav/Model/Entity/Collection/Abstract.php b/app/code/core/Mage/Eav/Model/Entity/Collection/Abstract.php
@@ -177,7 +177,8 @@ protected function _initSelect()
      * Standard resource collection initalization
      *
      * @param string $model
-     * @return Mage_Core_Model_Mysql4_Collection_Abstract
+     * @param null|string $entityModel
+     * @return $this
      */
     protected function _init($model, $entityModel = null)
     {
diff --git a/app/code/core/Mage/Eav/Model/Form/Element.php b/app/code/core/Mage/Eav/Model/Form/Element.php
@@ -28,7 +28,6 @@
 /**
  * Eav Form Element Model
  *
- * @method Mage_Eav_Model_Resource_Form_Element _getResource()
  * @method Mage_Eav_Model_Resource_Form_Element getResource()
  * @method int getTypeId()
  * @method Mage_Eav_Model_Form_Element setTypeId(int $value)
diff --git a/app/code/core/Mage/Eav/Model/Form/Fieldset.php b/app/code/core/Mage/Eav/Model/Form/Fieldset.php
@@ -28,7 +28,6 @@
 /**
  * Eav Form Fieldset Model
  *
- * @method Mage_Eav_Model_Resource_Form_Fieldset _getResource()
  * @method Mage_Eav_Model_Resource_Form_Fieldset getResource()
  * @method int getTypeId()
  * @method Mage_Eav_Model_Form_Fieldset setTypeId(int $value)
diff --git a/app/code/core/Mage/Eav/Model/Form/Type.php b/app/code/core/Mage/Eav/Model/Form/Type.php
@@ -28,7 +28,6 @@
 /**
  * Eav Form Type Model
  *
- * @method Mage_Eav_Model_Resource_Form_Type _getResource()
  * @method Mage_Eav_Model_Resource_Form_Type getResource()
  * @method string getCode()
  * @method Mage_Eav_Model_Form_Type setCode(string $value)
diff --git a/app/code/core/Mage/ImportExport/Model/Export/Entity/Abstract.php b/app/code/core/Mage/ImportExport/Model/Export/Entity/Abstract.php
@@ -328,7 +328,7 @@ protected function _prepareEntityCollection(Mage_Eav_Model_Entity_Collection_Abs
      *
      * @param string $errorCode Error code or simply column name
      * @param int $errorRowNum Row number.
-     * @return Mage_ImportExport_Model_Import_Adapter_Abstract
+     * @return $this
      */
     public function addRowError($errorCode, $errorRowNum)
     {
@@ -344,7 +344,7 @@ public function addRowError($errorCode, $errorRowNum)
      *
      * @param string $errorCode Error code
      * @param string $message Message template
-     * @return Mage_ImportExport_Model_Import_Entity_Abstract
+     * @return $this
      */
     public function addMessageTemplate($errorCode, $message)
     {
diff --git a/app/code/core/Mage/Install/controllers/WizardController.php b/app/code/core/Mage/Install/controllers/WizardController.php
@@ -63,7 +63,7 @@ protected function _getWizard()
     /**
      * Prepare layout
      *
-     * @return unknown
+     * @return $this
      */
     protected function _prepareLayout()
     {
@@ -81,7 +81,7 @@ protected function _prepareLayout()
     /**
      * Checking installation status
      *
-     * @return unknown
+     * @return bool
      */
     protected function _checkIfInstalled()
     {
diff --git a/app/code/core/Mage/Payment/Model/Method/Abstract.php b/app/code/core/Mage/Payment/Model/Method/Abstract.php
@@ -385,7 +385,7 @@ public function getInfoInstance()
     /**
      * Validate payment method information object
      *
-     * @return Mage_Payment_Model_Abstract
+     * @return $this
      */
     public function validate()
     {
@@ -410,7 +410,7 @@ public function validate()
      * @param Varien_Object $payment
      * @param float $amount
      *
-     * @return Mage_Payment_Model_Abstract
+     * @return $this
      */
     public function order(Varien_Object $payment, $amount)
     {
@@ -426,7 +426,7 @@ public function order(Varien_Object $payment, $amount)
      * @param Varien_Object $payment
      * @param float $amount
      *
-     * @return Mage_Payment_Model_Abstract
+     * @return $this
      */
     public function authorize(Varien_Object $payment, $amount)
     {
@@ -442,7 +442,7 @@ public function authorize(Varien_Object $payment, $amount)
      * @param Varien_Object $payment
      * @param float $amount
      *
-     * @return Mage_Payment_Model_Abstract
+     * @return $this
      */
     public function capture(Varien_Object $payment, $amount)
     {
@@ -486,7 +486,7 @@ public function processBeforeRefund($invoice, $payment)
      * @param Varien_Object $payment
      * @param float $amount
      *
-     * @return Mage_Payment_Model_Abstract
+     * @return $this
      */
     public function refund(Varien_Object $payment, $amount)
     {
@@ -516,7 +516,7 @@ public function processCreditmemo($creditmemo, $payment)
      *
      * @param Varien_Object $payment
      *
-     * @return Mage_Payment_Model_Abstract
+     * @return $this
      */
     public function cancel(Varien_Object $payment)
     {
@@ -542,7 +542,7 @@ public function processBeforeVoid($invoice, $payment)
      *
      * @param Varien_Object $payment
      *
-     * @return Mage_Payment_Model_Abstract
+     * @return $this
      */
     public function void(Varien_Object $payment)
     {
@@ -625,7 +625,7 @@ public function getConfigData($field, $storeId = null)
      * Assign data to info model instance
      *
      * @param   mixed $data
-     * @return  Mage_Payment_Model_Info
+     * @return  $this
      */
     public function assignData($data)
     {
@@ -639,9 +639,9 @@ public function assignData($data)
     }
 
    /**
-     * Parepare info instance for save
+     * Prepare info instance for save
      *
-     * @return Mage_Payment_Model_Abstract
+     * @return $this
      */
     public function prepareSave()
     {
@@ -741,7 +741,7 @@ public function isApplicableToQuote($quote, $checksBitMask)
      * @param string $paymentAction
      * @param object $stateObject
      *
-     * @return Mage_Payment_Model_Abstract
+     * @return $this
      */
     public function initialize($paymentAction, $stateObject)
     {
diff --git a/app/code/core/Mage/Sales/Block/Items/Abstract.php b/app/code/core/Mage/Sales/Block/Items/Abstract.php
@@ -58,7 +58,7 @@ protected function _construct()
      * @param   string $type
      * @param   string $block
      * @param   string $template
-     * @return  Mage_Checkout_Block_Cart_Abstract
+     * @return  $this
      */
     public function addItemRender($type, $block, $template)
     {
diff --git a/app/code/core/Mage/Sales/Model/Billing/Agreement.php b/app/code/core/Mage/Sales/Model/Billing/Agreement.php
diff --git a/app/code/core/Mage/Sales/Model/Order/Invoice.php b/app/code/core/Mage/Sales/Model/Order/Invoice.php
diff --git a/app/code/core/Mage/Sales/Model/Quote/Address/Total/Subtotal.php b/app/code/core/Mage/Sales/Model/Quote/Address/Total/Subtotal.php
diff --git a/app/code/core/Mage/SalesRule/Model/Rule.php b/app/code/core/Mage/SalesRule/Model/Rule.php
diff --git a/app/code/core/Mage/Tag/Model/Tag/Relation.php b/app/code/core/Mage/Tag/Model/Tag/Relation.php
diff --git a/app/code/core/Mage/Tax/Model/Sales/Total/Quote/Tax.php b/app/code/core/Mage/Tax/Model/Sales/Total/Quote/Tax.php
diff --git a/app/code/core/Mage/Usa/Model/Shipping/Carrier/Abstract/Backend/Abstract.php b/app/code/core/Mage/Usa/Model/Shipping/Carrier/Abstract/Backend/Abstract.php
diff --git a/app/code/core/Mage/Weee/Model/Attribute/Backend/Weee/Tax.php b/app/code/core/Mage/Weee/Model/Attribute/Backend/Weee/Tax.php
diff --git a/app/code/core/Mage/Widget/Block/Adminhtml/Widget/Instance/Edit/Tab/Main/Layout.php b/app/code/core/Mage/Widget/Block/Adminhtml/Widget/Instance/Edit/Tab/Main/Layout.php
diff --git a/app/code/core/Mage/XmlConnect/Model/Preview/Abstract.php b/app/code/core/Mage/XmlConnect/Model/Preview/Abstract.php

Original file line number	Diff line number	Diff line change
`@@ -27,9 +27,9 @@ class Mage_Adminhtml_Block_Sales_Order_Creditmemo_Create_Adjustments extends Mag`
`27`	`27`	`{`
`28`	`28`	`protected $_source;`
`29`	`29`	`/**`
`30`		`- * Initialize creditmemo agjustment totals`
	`30`	`+ * Initialize creditmemo adjustment totals`
`31`	`31`	`*`
`32`		`- * @return Mage_Tax_Block_Sales_Order_Tax`
	`32`	`+ * @return $this`
`33`	`33`	`*/`
`34`	`34`	`public function initTotals()`
`35`	`35`	`{`
Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,8 @@ protected function _getTaxHelper()`
`64`	`64`	`/**`
`65`	`65`	`* Display tax amount`
`66`	`66`	`*`
	`67`	`+ * @param float $amount`
	`68`	`+ * @param float $baseAmount`
`67`	`69`	`* @return string`
`68`	`70`	`*/`
`69`	`71`	`public function displayAmount($amount, $baseAmount)`
Original file line number	Diff line number	Diff line change
`@@ -244,8 +244,8 @@ public function isGiftMessagesAvailable($item)`
`244`	`244`	`/**`
`245`	`245`	`* Imports quote items for gift messages from products data`
`246`	`246`	`*`
`247`		`- * @param unknown_type $products`
`248`		`- * @return unknown`
	`247`	`+ * @param array $products`
	`248`	`+ * @return $this`
`249`	`249`	`*/`
`250`	`250`	`public function importAllowQuoteItemsFromProducts($products)`
`251`	`251`	`{`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ public function __construct()`
`78`	`78`	`/**`
`79`	`79`	`* Load/Reload Website collection`
`80`	`80`	`*`
`81`		`- * @return array`
	`81`	`+ * @return $this`
`82`	`82`	`*/`
`83`	`83`	`protected function _loadWebsiteCollection()`
`84`	`84`	`{`
`@@ -89,7 +89,7 @@ protected function _loadWebsiteCollection()`
`89`	`89`	`/**`
`90`	`90`	`* Load/Reload Group collection`
`91`	`91`	`*`
`92`		`- * @return array`
	`92`	`+ * @return $this`
`93`	`93`	`*/`
`94`	`94`	`protected function _loadGroupCollection()`
`95`	`95`	`{`
`@@ -105,7 +105,7 @@ protected function _loadGroupCollection()`
`105`	`105`	`/**`
`106`	`106`	`* Load/Reload Store collection`
`107`	`107`	`*`
`108`		`- * @return array`
	`108`	`+ * @return $this`
`109`	`109`	`*/`
`110`	`110`	`protected function _loadStoreCollection()`
`111`	`111`	`{`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,6 @@`
`28`	`28`	`/**`
`29`	`29`	`* Bundle Product Price Index`
`30`	`30`	`*`
`31`		`- * @method Mage_Bundle_Model_Resource_Price_Index _getResource()`
`32`	`31`	`* @method Mage_Bundle_Model_Resource_Price_Index getResource()`
`33`	`32`	`* @method Mage_Bundle_Model_Price_Index setEntityId(int $value)`
`34`	`33`	`* @method int getWebsiteId()`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ class Mage_Catalog_Block_Seo_Sitemap_Product extends Mage_Catalog_Block_Seo_Site`
`37`	`37`	`/**`
`38`	`38`	`* Initialize products collection`
`39`	`39`	`*`
`40`		`- * @return Mage_Catalog_Block_Seo_Sitemap_Category`
	`40`	`+ * @return $this`
`41`	`41`	`*/`
`42`	`42`	`protected function _prepareLayout()`
`43`	`43`	`{`
Original file line number	Diff line number	Diff line change
`@@ -130,7 +130,6 @@ public function isValidData(array $data)`
`130`	`130`	`*`
`131`	`131`	`* @param array $data`
`132`	`132`	`* @param Mage_Eav_Model_Entity_Type $productEntity`
`133`		`- * @return array`
`134`	`133`	`*/`
`135`	`134`	`protected function _validateAttributes($data, $productEntity)`
`136`	`135`	`{`
Original file line number	Diff line number	Diff line change
`@@ -831,7 +831,7 @@ public function getParentCategories()`
`831`	`831`	`}`
`832`	`832`
`833`	`833`	`/**`
`834`		`- * Retuen children categories of current category`
	`834`	`+ * Return children categories of current category`
`835`	`835`	`*`
`836`	`836`	`* @return array`
`837`	`837`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -843,7 +843,7 @@ public function getStoreFilter($product = null)`
`843`	`843`	`* Set store filter for associated products`
`844`	`844`	`*`
`845`	`845`	`* @param $store int\|Mage_Core_Model_Store`
`846`		`- * @return Mage_Catalog_Model_Product_Type_Configurable`
	`846`	`+ * @return $this`
`847`	`847`	`*/`
`848`	`848`	`public function setStoreFilter($store=null, $product = null)`
`849`	`849`	`{`
`@@ -853,7 +853,7 @@ public function setStoreFilter($store=null, $product = null)`
`853`	`853`	`}`
`854`	`854`
`855`	`855`	`/**`
`856`		`- * Allow for updates of chidren qty's`
	`856`	`+ * Allow for updates of children qty's`
`857`	`857`	`* (applicable for complicated product types. As default returns false)`
`858`	`858`	`*`
`859`	`859`	`* @return boolean false`