From 811cc5a0ebbe3add67cb0959196368a9107f04d9 Mon Sep 17 00:00:00 2001 From: sv3n Date: Fri, 9 Sep 2022 15:28:36 +0200 Subject: [PATCH] Fixed some docs for phpdocumentor (#2577) --- .../core/Mage/Adminhtml/Block/Html/Date.php | 2 +- .../core/Mage/Adminhtml/Block/Html/Select.php | 2 +- .../core/Mage/Adminhtml/Block/Sitemap.php | 2 +- .../Block/Sitemap/Grid/Renderer/Time.php | 4 +- .../Block/System/Design/Edit/Tab/General.php | 6 +++ .../Backend/Catalog/Search/Separator.php | 25 ++++++++++ .../Source/Catalog/Search/Separator.php | 25 ++++++++++ .../Model/System/Config/Source/Cms/Page.php | 6 +++ .../Config/Source/Cms/Wysiwyg/Enabled.php | 2 +- .../System/Config/Source/Cookie/Samesite.php | 23 +++++++++ .../controllers/Cms/PageController.php | 2 +- .../controllers/Rss/CatalogController.php | 2 +- .../controllers/Rss/OrderController.php | 2 +- .../Sales/Recurring/ProfileController.php | 2 +- .../controllers/SitemapController.php | 2 +- .../Directpost/PaymentController.php | 2 +- .../Sales/Order/Pdf/Items/Creditmemo.php | 2 +- .../Model/Sales/Order/Pdf/Items/Invoice.php | 2 +- .../Adminhtml/RefreshController.php | 2 +- .../Captcha/controllers/RefreshController.php | 2 +- .../Catalog/Block/Seo/Sitemap/Tree/Pager.php | 2 +- app/code/core/Mage/Catalog/Model/Category.php | 4 +- .../Attribute/Design/Options/Container.php | 2 +- .../Product/Attribute/Source/Inputtype.php | 2 +- .../Mage/Catalog/Model/Resource/Product.php | 4 +- .../Model/Resource/Product/Collection.php | 2 +- app/code/core/Mage/Catalog/Model/Url.php | 4 +- .../Model/Resource/Helper/Mysql4.php | 2 +- .../Centinel/Block/Authentication/Start.php | 2 +- app/code/core/Mage/Centinel/Model/Api.php | 2 +- .../Mage/Core/Controller/Varien/Action.php | 2 +- app/code/core/Mage/Core/Model/App.php | 2 +- .../Mage/Customer/Model/Address/Abstract.php | 2 +- .../Eav/Model/Entity/Increment/Abstract.php | 6 --- .../Eav/Model/Entity/Increment/Alphanum.php | 8 +-- .../Eav/Model/Entity/Increment/Numeric.php | 8 +-- .../Mage/Eav/Model/Resource/Form/Type.php | 2 +- .../Model/Resource/Helper/Mysql4.php | 2 +- .../Index/Model/Lock/Storage/Interface.php | 2 +- .../Model/Resource/Helper/Lock/Interface.php | 2 +- app/code/core/Mage/Page/Block/Switch.php | 2 +- .../Mage/Page/Block/Template/Container.php | 2 +- .../core/Mage/Page/Block/Template/Links.php | 2 +- .../Mage/Page/Block/Template/Links/Block.php | 2 +- .../Model/Quote/Address/Total/Collector.php | 2 +- .../Mage/SalesRule/Model/Rule/Product.php | 2 +- .../Mage/Shipping/Model/Carrier/Interface.php | 2 +- .../core/Mage/Shipping/Model/Rate/Result.php | 2 +- .../Mage/Uploader/Model/Config/Abstract.php | 1 - .../Uploader/Model/Config/Browsebutton.php | 8 +-- .../core/Mage/Uploader/Model/Config/Misc.php | 12 ++--- .../Mage/Uploader/Model/Config/Uploader.php | 50 +++++++++---------- .../Shipping/Carrier/Dhl/International.php | 4 +- 53 files changed, 164 insertions(+), 106 deletions(-) diff --git a/app/code/core/Mage/Adminhtml/Block/Html/Date.php b/app/code/core/Mage/Adminhtml/Block/Html/Date.php index 1420735c95b..8a46f06d632 100644 --- a/app/code/core/Mage/Adminhtml/Block/Html/Date.php +++ b/app/code/core/Mage/Adminhtml/Block/Html/Date.php @@ -22,7 +22,7 @@ * Adminhtml HTML select element block * * @category Mage - * @package Mage_Core + * @package Mage_Adminhtml * @author Magento Core Team */ class Mage_Adminhtml_Block_Html_Date extends Mage_Core_Block_Html_Date diff --git a/app/code/core/Mage/Adminhtml/Block/Html/Select.php b/app/code/core/Mage/Adminhtml/Block/Html/Select.php index 0c39f7d553e..4cf9ed916c0 100644 --- a/app/code/core/Mage/Adminhtml/Block/Html/Select.php +++ b/app/code/core/Mage/Adminhtml/Block/Html/Select.php @@ -22,7 +22,7 @@ * Adminhtml HTML select element block * * @category Mage - * @package Mage_Core + * @package Mage_Adminhtml * @author Magento Core Team */ class Mage_Adminhtml_Block_Html_Select extends Mage_Core_Block_Html_Select diff --git a/app/code/core/Mage/Adminhtml/Block/Sitemap.php b/app/code/core/Mage/Adminhtml/Block/Sitemap.php index a5738a4c397..dab037d4f61 100644 --- a/app/code/core/Mage/Adminhtml/Block/Sitemap.php +++ b/app/code/core/Mage/Adminhtml/Block/Sitemap.php @@ -22,7 +22,7 @@ * Adminhtml catalog (google) sitemaps block * * @category Mage - * @package Mage_Sitemap + * @package Mage_Adminhtml * @author Magento Core Team */ class Mage_Adminhtml_Block_Sitemap extends Mage_Adminhtml_Block_Widget_Grid_Container diff --git a/app/code/core/Mage/Adminhtml/Block/Sitemap/Grid/Renderer/Time.php b/app/code/core/Mage/Adminhtml/Block/Sitemap/Grid/Renderer/Time.php index 1a353a8d533..1234f379680 100644 --- a/app/code/core/Mage/Adminhtml/Block/Sitemap/Grid/Renderer/Time.php +++ b/app/code/core/Mage/Adminhtml/Block/Sitemap/Grid/Renderer/Time.php @@ -22,12 +22,11 @@ * Sitemap grid link column renderer * * @category Mage - * @package Mage_Sitemap + * @package Mage_Adminhtml * @author Magento Core Team */ class Mage_Adminhtml_Block_Sitemap_Grid_Renderer_Time extends Mage_Adminhtml_Block_Widget_Grid_Column_Renderer_Abstract { - /** * Prepare link to display in grid * @@ -38,5 +37,4 @@ public function render(Varien_Object $row) { return date('Y-m-d H:i:s', strtotime($row->getSitemapTime()) + Mage::getSingleton('core/date')->getGmtOffset()); } - } diff --git a/app/code/core/Mage/Adminhtml/Block/System/Design/Edit/Tab/General.php b/app/code/core/Mage/Adminhtml/Block/System/Design/Edit/Tab/General.php index d62f4533cde..b18016234dd 100644 --- a/app/code/core/Mage/Adminhtml/Block/System/Design/Edit/Tab/General.php +++ b/app/code/core/Mage/Adminhtml/Block/System/Design/Edit/Tab/General.php @@ -17,6 +17,12 @@ * @copyright Copyright (c) 2006-2020 Magento, Inc. (http://www.magento.com) * @license https://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0) */ + +/** + * @category Mage + * @package Mage_Adminhtml + * @author Magento Core Team + */ class Mage_Adminhtml_Block_System_Design_Edit_Tab_General extends Mage_Adminhtml_Block_Widget_Form { protected function _prepareForm() diff --git a/app/code/core/Mage/Adminhtml/Model/System/Config/Backend/Catalog/Search/Separator.php b/app/code/core/Mage/Adminhtml/Model/System/Config/Backend/Catalog/Search/Separator.php index 269892b396e..8fada95fd6c 100644 --- a/app/code/core/Mage/Adminhtml/Model/System/Config/Backend/Catalog/Search/Separator.php +++ b/app/code/core/Mage/Adminhtml/Model/System/Config/Backend/Catalog/Search/Separator.php @@ -1,5 +1,30 @@ + */ class Mage_Adminhtml_Model_System_Config_Backend_Catalog_Search_Separator extends Mage_Core_Model_Config_Data { /** diff --git a/app/code/core/Mage/Adminhtml/Model/System/Config/Source/Catalog/Search/Separator.php b/app/code/core/Mage/Adminhtml/Model/System/Config/Source/Catalog/Search/Separator.php index 7c149587fef..11291849843 100644 --- a/app/code/core/Mage/Adminhtml/Model/System/Config/Source/Catalog/Search/Separator.php +++ b/app/code/core/Mage/Adminhtml/Model/System/Config/Source/Catalog/Search/Separator.php @@ -1,5 +1,30 @@ + */ class Mage_Adminhtml_Model_System_Config_Source_Catalog_Search_Separator { /** diff --git a/app/code/core/Mage/Adminhtml/Model/System/Config/Source/Cms/Page.php b/app/code/core/Mage/Adminhtml/Model/System/Config/Source/Cms/Page.php index b904d871a06..dabda55d06b 100644 --- a/app/code/core/Mage/Adminhtml/Model/System/Config/Source/Cms/Page.php +++ b/app/code/core/Mage/Adminhtml/Model/System/Config/Source/Cms/Page.php @@ -17,6 +17,12 @@ * @copyright Copyright (c) 2006-2020 Magento, Inc. (http://www.magento.com) * @license https://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0) */ + +/** + * @category Mage + * @package Mage_Adminhtml + * @author Magento Core Team + */ class Mage_Adminhtml_Model_System_Config_Source_Cms_Page { protected $_options; diff --git a/app/code/core/Mage/Adminhtml/Model/System/Config/Source/Cms/Wysiwyg/Enabled.php b/app/code/core/Mage/Adminhtml/Model/System/Config/Source/Cms/Wysiwyg/Enabled.php index 93538927937..924708ee075 100644 --- a/app/code/core/Mage/Adminhtml/Model/System/Config/Source/Cms/Wysiwyg/Enabled.php +++ b/app/code/core/Mage/Adminhtml/Model/System/Config/Source/Cms/Wysiwyg/Enabled.php @@ -22,7 +22,7 @@ * Configuration source model for Wysiwyg toggling * * @category Mage - * @package Mage_Cms + * @package Mage_Adminhtml * @author Magento Core Team */ class Mage_Adminhtml_Model_System_Config_Source_Cms_Wysiwyg_Enabled diff --git a/app/code/core/Mage/Adminhtml/Model/System/Config/Source/Cookie/Samesite.php b/app/code/core/Mage/Adminhtml/Model/System/Config/Source/Cookie/Samesite.php index c462bd7610c..1f1eb257385 100644 --- a/app/code/core/Mage/Adminhtml/Model/System/Config/Source/Cookie/Samesite.php +++ b/app/code/core/Mage/Adminhtml/Model/System/Config/Source/Cookie/Samesite.php @@ -1,5 +1,28 @@ + */ class Mage_Adminhtml_Model_System_Config_Source_Cookie_Samesite { /** diff --git a/app/code/core/Mage/Adminhtml/controllers/Cms/PageController.php b/app/code/core/Mage/Adminhtml/controllers/Cms/PageController.php index c694e806648..9a579d816cb 100644 --- a/app/code/core/Mage/Adminhtml/controllers/Cms/PageController.php +++ b/app/code/core/Mage/Adminhtml/controllers/Cms/PageController.php @@ -22,7 +22,7 @@ * Cms manage pages controller * * @category Mage - * @package Mage_Cms + * @package Mage_Adminhtml * @author Magento Core Team */ class Mage_Adminhtml_Cms_PageController extends Mage_Adminhtml_Controller_Action diff --git a/app/code/core/Mage/Adminhtml/controllers/Rss/CatalogController.php b/app/code/core/Mage/Adminhtml/controllers/Rss/CatalogController.php index d422a76b520..4d5b7328877 100644 --- a/app/code/core/Mage/Adminhtml/controllers/Rss/CatalogController.php +++ b/app/code/core/Mage/Adminhtml/controllers/Rss/CatalogController.php @@ -22,7 +22,7 @@ * Adminhtml Rss Controller * * @category Mage - * @package Mage_Rss + * @package Mage_Adminhtml * @author Magento Core Team */ class Mage_Adminhtml_Rss_CatalogController extends Mage_Adminhtml_Controller_Rss_Abstract diff --git a/app/code/core/Mage/Adminhtml/controllers/Rss/OrderController.php b/app/code/core/Mage/Adminhtml/controllers/Rss/OrderController.php index 798ebd6a9a2..5c2b8a752ae 100644 --- a/app/code/core/Mage/Adminhtml/controllers/Rss/OrderController.php +++ b/app/code/core/Mage/Adminhtml/controllers/Rss/OrderController.php @@ -22,7 +22,7 @@ * Customer reviews controller * * @category Mage - * @package Mage_Rss + * @package Mage_Adminhtml * @author Magento Core Team */ class Mage_Adminhtml_Rss_OrderController extends Mage_Adminhtml_Controller_Rss_Abstract diff --git a/app/code/core/Mage/Adminhtml/controllers/Sales/Recurring/ProfileController.php b/app/code/core/Mage/Adminhtml/controllers/Sales/Recurring/ProfileController.php index e998810c088..2841d06d7f7 100644 --- a/app/code/core/Mage/Adminhtml/controllers/Sales/Recurring/ProfileController.php +++ b/app/code/core/Mage/Adminhtml/controllers/Sales/Recurring/ProfileController.php @@ -25,7 +25,7 @@ * @package Mage_Adminhtml * @author Magento Core Team * - * TODO: implement ACL restrictions + * @TODO: implement ACL restrictions */ class Mage_Adminhtml_Sales_Recurring_ProfileController extends Mage_Adminhtml_Controller_Action { diff --git a/app/code/core/Mage/Adminhtml/controllers/SitemapController.php b/app/code/core/Mage/Adminhtml/controllers/SitemapController.php index 6778d65520a..4d1b603d2b0 100644 --- a/app/code/core/Mage/Adminhtml/controllers/SitemapController.php +++ b/app/code/core/Mage/Adminhtml/controllers/SitemapController.php @@ -22,7 +22,7 @@ * Google sitemap controller * * @category Mage - * @package Mage_Sitemap + * @package Mage_Adminhtml * @author Magento Core Team */ class Mage_Adminhtml_SitemapController extends Mage_Adminhtml_Controller_Action diff --git a/app/code/core/Mage/Authorizenet/controllers/Adminhtml/Authorizenet/Directpost/PaymentController.php b/app/code/core/Mage/Authorizenet/controllers/Adminhtml/Authorizenet/Directpost/PaymentController.php index ce5b4cf4525..fe85fd2980f 100644 --- a/app/code/core/Mage/Authorizenet/controllers/Adminhtml/Authorizenet/Directpost/PaymentController.php +++ b/app/code/core/Mage/Authorizenet/controllers/Adminhtml/Authorizenet/Directpost/PaymentController.php @@ -23,7 +23,7 @@ * Admihtml DirtectPost Payment Controller * * @category Mage - * @package Mage_DirtectPost + * @package Mage_Authorizenet * @author Magento Core Team */ class Mage_Authorizenet_Adminhtml_Authorizenet_Directpost_PaymentController diff --git a/app/code/core/Mage/Bundle/Model/Sales/Order/Pdf/Items/Creditmemo.php b/app/code/core/Mage/Bundle/Model/Sales/Order/Pdf/Items/Creditmemo.php index 3f9cdba320f..2c091cd4486 100644 --- a/app/code/core/Mage/Bundle/Model/Sales/Order/Pdf/Items/Creditmemo.php +++ b/app/code/core/Mage/Bundle/Model/Sales/Order/Pdf/Items/Creditmemo.php @@ -22,7 +22,7 @@ * Sales Order Creditmemo Pdf default items renderer * * @category Mage - * @package Mage_Sales + * @package Mage_Bundle * @author Magento Core Team */ class Mage_Bundle_Model_Sales_Order_Pdf_Items_Creditmemo extends Mage_Bundle_Model_Sales_Order_Pdf_Items_Abstract diff --git a/app/code/core/Mage/Bundle/Model/Sales/Order/Pdf/Items/Invoice.php b/app/code/core/Mage/Bundle/Model/Sales/Order/Pdf/Items/Invoice.php index bb231de5f64..248835a4018 100644 --- a/app/code/core/Mage/Bundle/Model/Sales/Order/Pdf/Items/Invoice.php +++ b/app/code/core/Mage/Bundle/Model/Sales/Order/Pdf/Items/Invoice.php @@ -22,7 +22,7 @@ * Sales Order Invoice Pdf default items renderer * * @category Mage - * @package Mage_Sales + * @package Mage_Bundle * @author Magento Core Team */ class Mage_Bundle_Model_Sales_Order_Pdf_Items_Invoice extends Mage_Bundle_Model_Sales_Order_Pdf_Items_Abstract diff --git a/app/code/core/Mage/Captcha/controllers/Adminhtml/RefreshController.php b/app/code/core/Mage/Captcha/controllers/Adminhtml/RefreshController.php index 2c7e1d769c5..47975b8c744 100644 --- a/app/code/core/Mage/Captcha/controllers/Adminhtml/RefreshController.php +++ b/app/code/core/Mage/Captcha/controllers/Adminhtml/RefreshController.php @@ -22,7 +22,7 @@ * Captcha controller * * @category Mage - * @package Mage_Core + * @package Mage_Captcha * @author Magento Core Team */ class Mage_Captcha_Adminhtml_RefreshController extends Mage_Adminhtml_Controller_Action diff --git a/app/code/core/Mage/Captcha/controllers/RefreshController.php b/app/code/core/Mage/Captcha/controllers/RefreshController.php index 7b8d13c5ed9..f26768f236b 100644 --- a/app/code/core/Mage/Captcha/controllers/RefreshController.php +++ b/app/code/core/Mage/Captcha/controllers/RefreshController.php @@ -22,7 +22,7 @@ * Captcha controller * * @category Mage - * @package Mage_Core + * @package Mage_Captcha * @author Magento Core Team */ class Mage_Captcha_RefreshController extends Mage_Core_Controller_Front_Action diff --git a/app/code/core/Mage/Catalog/Block/Seo/Sitemap/Tree/Pager.php b/app/code/core/Mage/Catalog/Block/Seo/Sitemap/Tree/Pager.php index cbb4fc58c59..f06747bf2db 100644 --- a/app/code/core/Mage/Catalog/Block/Seo/Sitemap/Tree/Pager.php +++ b/app/code/core/Mage/Catalog/Block/Seo/Sitemap/Tree/Pager.php @@ -22,7 +22,7 @@ * Html page block * * @category Mage - * @package Mage_Page + * @package Mage_Catalog * @author Magento Core Team * @todo Separate order, mode and pager */ diff --git a/app/code/core/Mage/Catalog/Model/Category.php b/app/code/core/Mage/Catalog/Model/Category.php index f6174196f28..5236ec5697b 100644 --- a/app/code/core/Mage/Catalog/Model/Category.php +++ b/app/code/core/Mage/Catalog/Model/Category.php @@ -156,7 +156,7 @@ class Mage_Catalog_Model_Category extends Mage_Catalog_Model_Abstract /** * Category tree model * - * @var Mage_Catalog_Model_Resource_Category_Tree. + * @var Mage_Catalog_Model_Resource_Category_Tree */ protected $_treeModel = null; @@ -222,7 +222,7 @@ public function getTreeModel() } /** - * @return Mage_Catalog_Model_Resource_Category_Tree. + * @return Mage_Catalog_Model_Resource_Category_Tree */ public function getTreeModelInstance() { diff --git a/app/code/core/Mage/Catalog/Model/Entity/Product/Attribute/Design/Options/Container.php b/app/code/core/Mage/Catalog/Model/Entity/Product/Attribute/Design/Options/Container.php index 05be3d7341e..ebe7a23ba2c 100644 --- a/app/code/core/Mage/Catalog/Model/Entity/Product/Attribute/Design/Options/Container.php +++ b/app/code/core/Mage/Catalog/Model/Entity/Product/Attribute/Design/Options/Container.php @@ -22,7 +22,7 @@ * Entity/Attribute/Model - select product design options container from config * * @category Mage - * @package Mage_Eav + * @package Mage_Catalog * @author Magento Core Team */ class Mage_Catalog_Model_Entity_Product_Attribute_Design_Options_Container extends Mage_Eav_Model_Entity_Attribute_Source_Config diff --git a/app/code/core/Mage/Catalog/Model/Product/Attribute/Source/Inputtype.php b/app/code/core/Mage/Catalog/Model/Product/Attribute/Source/Inputtype.php index ca2a1fbbfe3..d76919e16cf 100644 --- a/app/code/core/Mage/Catalog/Model/Product/Attribute/Source/Inputtype.php +++ b/app/code/core/Mage/Catalog/Model/Product/Attribute/Source/Inputtype.php @@ -22,7 +22,7 @@ * Product attribute source input types * * @category Mage - * @package Mage_Eav + * @package Mage_Catalog * @author Magento Core Team */ class Mage_Catalog_Model_Product_Attribute_Source_Inputtype extends Mage_Eav_Model_Adminhtml_System_Config_Source_Inputtype diff --git a/app/code/core/Mage/Catalog/Model/Resource/Product.php b/app/code/core/Mage/Catalog/Model/Resource/Product.php index c5a82509ee5..c28dc3e7fe8 100644 --- a/app/code/core/Mage/Catalog/Model/Resource/Product.php +++ b/app/code/core/Mage/Catalog/Model/Resource/Product.php @@ -628,9 +628,9 @@ public function getProductsSku(array $productIds) } /** - * @param Mage_Catalog_Model_Product$object + * @param Mage_Catalog_Model_Product $object * @return array - *@deprecated after 1.4.2.0 + * @deprecated after 1.4.2.0 */ public function getParentProductIds($object) { diff --git a/app/code/core/Mage/Catalog/Model/Resource/Product/Collection.php b/app/code/core/Mage/Catalog/Model/Resource/Product/Collection.php index 0589288a608..764deeaa908 100644 --- a/app/code/core/Mage/Catalog/Model/Resource/Product/Collection.php +++ b/app/code/core/Mage/Catalog/Model/Resource/Product/Collection.php @@ -803,7 +803,7 @@ public function getAttributeValueCountByRange($attribute, $range) * Retrieve product count by some value of attribute * * @param string $attribute - * @return array($value=>$count) + * @return array ($value=>$count) */ public function getAttributeValueCount($attribute) { diff --git a/app/code/core/Mage/Catalog/Model/Url.php b/app/code/core/Mage/Catalog/Model/Url.php index cbe587b895b..0287894df3c 100644 --- a/app/code/core/Mage/Catalog/Model/Url.php +++ b/app/code/core/Mage/Catalog/Model/Url.php @@ -45,7 +45,7 @@ class Mage_Catalog_Model_Url /** * Resource model * - * @var Mage_Catalog_Model_Resource_Url. + * @var Mage_Catalog_Model_Resource_Url */ protected $_resourceModel; @@ -151,7 +151,7 @@ public function getStores($storeId = null) /** * Retrieve resource model * - * @return Mage_Catalog_Model_Resource_Url. + * @return Mage_Catalog_Model_Resource_Url */ public function getResource() { diff --git a/app/code/core/Mage/CatalogSearch/Model/Resource/Helper/Mysql4.php b/app/code/core/Mage/CatalogSearch/Model/Resource/Helper/Mysql4.php index 1f17016224d..9d931db7c6b 100644 --- a/app/code/core/Mage/CatalogSearch/Model/Resource/Helper/Mysql4.php +++ b/app/code/core/Mage/CatalogSearch/Model/Resource/Helper/Mysql4.php @@ -47,7 +47,7 @@ public function chooseFulltext($table, $alias, $select) * * @param string $str The source string * @param int $maxWordLength - * @return array(0=>words, 1=>terms) + * @return array (0=>words, 1=>terms) */ public function prepareTerms($str, $maxWordLength = 0) { diff --git a/app/code/core/Mage/Centinel/Block/Authentication/Start.php b/app/code/core/Mage/Centinel/Block/Authentication/Start.php index a2a0f9b5acd..9d24e60d289 100644 --- a/app/code/core/Mage/Centinel/Block/Authentication/Start.php +++ b/app/code/core/Mage/Centinel/Block/Authentication/Start.php @@ -22,7 +22,7 @@ * Authentication start/redirect form * * @category Mage - * @package Mage_Centinal + * @package Mage_Centinel * @author Magento Core Team */ class Mage_Centinel_Block_Authentication_Start extends Mage_Core_Block_Template diff --git a/app/code/core/Mage/Centinel/Model/Api.php b/app/code/core/Mage/Centinel/Model/Api.php index 62832b38ff1..d6f3c380fe4 100644 --- a/app/code/core/Mage/Centinel/Model/Api.php +++ b/app/code/core/Mage/Centinel/Model/Api.php @@ -96,7 +96,7 @@ protected function _getVersion() /** * Return transaction type. according centinel documetation it should be "C" * - * @return "C" + * @return string "C" */ protected function _getTransactionType() { diff --git a/app/code/core/Mage/Core/Controller/Varien/Action.php b/app/code/core/Mage/Core/Controller/Varien/Action.php index 5d1a8f47f35..0b77a93420d 100644 --- a/app/code/core/Mage/Core/Controller/Varien/Action.php +++ b/app/code/core/Mage/Core/Controller/Varien/Action.php @@ -929,7 +929,7 @@ protected function _validateFormKey() * bar / * * @see self::_renderTitles() - * @param string|false|-1|null $text + * @param string|false|int|null $text * @param bool $resetIfExists * @return $this */ diff --git a/app/code/core/Mage/Core/Model/App.php b/app/code/core/Mage/Core/Model/App.php index 494ad35bcf6..11b934a333c 100644 --- a/app/code/core/Mage/Core/Model/App.php +++ b/app/code/core/Mage/Core/Model/App.php @@ -316,7 +316,7 @@ public function baseInit($options) /** * Run light version of application with specified modules support * - * @see Mage_Core_Model_App->run() + * @see Mage_Core_Model_App::run() * * @param string|array $scopeCode * @param string $scopeType diff --git a/app/code/core/Mage/Customer/Model/Address/Abstract.php b/app/code/core/Mage/Customer/Model/Address/Abstract.php index 8faeb6be82f..a17edfe4ce2 100644 --- a/app/code/core/Mage/Customer/Model/Address/Abstract.php +++ b/app/code/core/Mage/Customer/Model/Address/Abstract.php @@ -22,7 +22,7 @@ * Address abstract model * * @category Mage - * @package Mage_Core + * @package Mage_Customer * @author Magento Core Team * * @method string getCustomerId() diff --git a/app/code/core/Mage/Eav/Model/Entity/Increment/Abstract.php b/app/code/core/Mage/Eav/Model/Entity/Increment/Abstract.php index 69544b6a84e..d50bf3097a6 100644 --- a/app/code/core/Mage/Eav/Model/Entity/Increment/Abstract.php +++ b/app/code/core/Mage/Eav/Model/Entity/Increment/Abstract.php @@ -23,12 +23,6 @@ * @package Mage_Eav * @author Magento Core Team * - * Properties: - * - prefix - * - pad_length - * - pad_char - * - last_id - * * @method string getLastId() * @method string getPrefix() */ diff --git a/app/code/core/Mage/Eav/Model/Entity/Increment/Alphanum.php b/app/code/core/Mage/Eav/Model/Entity/Increment/Alphanum.php index eb2c735d8f0..44f7571a0ed 100644 --- a/app/code/core/Mage/Eav/Model/Entity/Increment/Alphanum.php +++ b/app/code/core/Mage/Eav/Model/Entity/Increment/Alphanum.php @@ -22,12 +22,6 @@ * @category Mage * @package Mage_Eav * @author Magento Core Team - * - * Properties: - * - prefix - * - pad_length - * - pad_char - * - last_id */ class Mage_Eav_Model_Entity_Increment_Alphanum extends Mage_Eav_Model_Entity_Increment_Abstract { @@ -47,7 +41,7 @@ public function getNextId() { $lastId = $this->getLastId(); - if (strpos($lastId, $this->getPrefix())===0) { + if (strpos($lastId, $this->getPrefix()) === 0) { $lastId = substr($lastId, strlen($this->getPrefix())); } diff --git a/app/code/core/Mage/Eav/Model/Entity/Increment/Numeric.php b/app/code/core/Mage/Eav/Model/Entity/Increment/Numeric.php index 67a3978b91f..78b5b926c36 100644 --- a/app/code/core/Mage/Eav/Model/Entity/Increment/Numeric.php +++ b/app/code/core/Mage/Eav/Model/Entity/Increment/Numeric.php @@ -22,12 +22,6 @@ * @category Mage * @package Mage_Eav * @author Magento Core Team - * - * Properties: - * - prefix - * - pad_length - * - pad_char - * - last_id */ class Mage_Eav_Model_Entity_Increment_Numeric extends Mage_Eav_Model_Entity_Increment_Abstract { @@ -40,7 +34,7 @@ public function getNextId() if (empty($last)) { $last = 0; - } else if (!empty($prefix = (string)$this->getPrefix()) && strpos($last, $prefix) === 0) { + } elseif (!empty($prefix = (string)$this->getPrefix()) && strpos($last, $prefix) === 0) { $last = (int)substr($last, strlen($prefix)); } else { $last = (int)$last; diff --git a/app/code/core/Mage/Eav/Model/Resource/Form/Type.php b/app/code/core/Mage/Eav/Model/Resource/Form/Type.php index ba8377495e6..82f988fdc32 100644 --- a/app/code/core/Mage/Eav/Model/Resource/Form/Type.php +++ b/app/code/core/Mage/Eav/Model/Resource/Form/Type.php @@ -76,7 +76,7 @@ public function getEntityTypes($object) /** * Save entity types after save form type * - * @see Mage_Core_Model_Resource_Db_Abstract#_afterSave($object) + * @see Mage_Core_Model_Resource_Db_Abstract::_afterSave() * * @param Mage_Eav_Model_Resource_Form_Type $object * @inheritDoc diff --git a/app/code/core/Mage/ImportExport/Model/Resource/Helper/Mysql4.php b/app/code/core/Mage/ImportExport/Model/Resource/Helper/Mysql4.php index 9141ab8d3c8..4e73960f28e 100644 --- a/app/code/core/Mage/ImportExport/Model/Resource/Helper/Mysql4.php +++ b/app/code/core/Mage/ImportExport/Model/Resource/Helper/Mysql4.php @@ -22,7 +22,7 @@ * ImportExport MySQL resource helper model * * @category Mage - * @package Mage_Sales + * @package Mage_ImportExport * @author Magento Core Team */ class Mage_ImportExport_Model_Resource_Helper_Mysql4 extends Mage_Core_Model_Resource_Helper_Mysql4 diff --git a/app/code/core/Mage/Index/Model/Lock/Storage/Interface.php b/app/code/core/Mage/Index/Model/Lock/Storage/Interface.php index be2535c70ce..6ca5a392fda 100644 --- a/app/code/core/Mage/Index/Model/Lock/Storage/Interface.php +++ b/app/code/core/Mage/Index/Model/Lock/Storage/Interface.php @@ -22,7 +22,7 @@ * Abstract lock storage * * @category Mage - * @package Mage_Core + * @package Mage_Index * @author Magento Core Team */ interface Mage_Index_Model_Lock_Storage_Interface diff --git a/app/code/core/Mage/Index/Model/Resource/Helper/Lock/Interface.php b/app/code/core/Mage/Index/Model/Resource/Helper/Lock/Interface.php index 090c10a6c63..e1ba10630b5 100644 --- a/app/code/core/Mage/Index/Model/Resource/Helper/Lock/Interface.php +++ b/app/code/core/Mage/Index/Model/Resource/Helper/Lock/Interface.php @@ -22,7 +22,7 @@ * Abstract lock helper * * @category Mage - * @package Mage_Core + * @package Mage_Index * @author Magento Core Team */ interface Mage_Index_Model_Resource_Helper_Lock_Interface diff --git a/app/code/core/Mage/Page/Block/Switch.php b/app/code/core/Mage/Page/Block/Switch.php index 1e432f7d011..b3991fb2f64 100644 --- a/app/code/core/Mage/Page/Block/Switch.php +++ b/app/code/core/Mage/Page/Block/Switch.php @@ -22,7 +22,7 @@ * Store and language switcher block * * @category Mage - * @package Mage_Core + * @package Mage_Page * @author Magento Core Team */ class Mage_Page_Block_Switch extends Mage_Core_Block_Template diff --git a/app/code/core/Mage/Page/Block/Template/Container.php b/app/code/core/Mage/Page/Block/Template/Container.php index 661d7b142c4..2b4f36c11e3 100644 --- a/app/code/core/Mage/Page/Block/Template/Container.php +++ b/app/code/core/Mage/Page/Block/Template/Container.php @@ -22,7 +22,7 @@ * Abstract container block with header * * @category Mage - * @package Mage_Core + * @package Mage_Page * @author Magento Core Team */ class Mage_Page_Block_Template_Container extends Mage_Core_Block_Template diff --git a/app/code/core/Mage/Page/Block/Template/Links.php b/app/code/core/Mage/Page/Block/Template/Links.php index 2b67d153c53..f958ff0d04f 100644 --- a/app/code/core/Mage/Page/Block/Template/Links.php +++ b/app/code/core/Mage/Page/Block/Template/Links.php @@ -22,7 +22,7 @@ * Simple links list block * * @category Mage - * @package Mage_Core + * @package Mage_Page * @author Magento Core Team */ class Mage_Page_Block_Template_Links extends Mage_Core_Block_Template diff --git a/app/code/core/Mage/Page/Block/Template/Links/Block.php b/app/code/core/Mage/Page/Block/Template/Links/Block.php index 3af27bcae77..fd23fc42082 100644 --- a/app/code/core/Mage/Page/Block/Template/Links/Block.php +++ b/app/code/core/Mage/Page/Block/Template/Links/Block.php @@ -22,7 +22,7 @@ * Simple links list block * * @category Mage - * @package Mage_Core + * @package Mage_Page * @author Magento Core Team */ class Mage_Page_Block_Template_Links_Block extends Mage_Core_Block_Template diff --git a/app/code/core/Mage/Sales/Model/Quote/Address/Total/Collector.php b/app/code/core/Mage/Sales/Model/Quote/Address/Total/Collector.php index 9278fd033d0..a0943116eb4 100644 --- a/app/code/core/Mage/Sales/Model/Quote/Address/Total/Collector.php +++ b/app/code/core/Mage/Sales/Model/Quote/Address/Total/Collector.php @@ -22,7 +22,7 @@ * Address Total Collector model * * @category Mage - * @package Mage_Core + * @package Mage_Sales * @author Magento Core Team */ class Mage_Sales_Model_Quote_Address_Total_Collector extends Mage_Sales_Model_Config_Ordered diff --git a/app/code/core/Mage/SalesRule/Model/Rule/Product.php b/app/code/core/Mage/SalesRule/Model/Rule/Product.php index 871660f936b..e58a37bfbbb 100644 --- a/app/code/core/Mage/SalesRule/Model/Rule/Product.php +++ b/app/code/core/Mage/SalesRule/Model/Rule/Product.php @@ -21,7 +21,7 @@ /** * @category Mage * @package Mage_SalesRule - * @author Magento Core Team * + * @author Magento Core Team */ class Mage_SalesRule_Model_Rule_Product extends Mage_Core_Model_Abstract { diff --git a/app/code/core/Mage/Shipping/Model/Carrier/Interface.php b/app/code/core/Mage/Shipping/Model/Carrier/Interface.php index 367a5c0f71c..c0321b6d12a 100644 --- a/app/code/core/Mage/Shipping/Model/Carrier/Interface.php +++ b/app/code/core/Mage/Shipping/Model/Carrier/Interface.php @@ -21,7 +21,7 @@ /** * @category Mage * @package Mage_Shipping - * @author Magento Core Team * + * @author Magento Core Team */ interface Mage_Shipping_Model_Carrier_Interface { diff --git a/app/code/core/Mage/Shipping/Model/Rate/Result.php b/app/code/core/Mage/Shipping/Model/Rate/Result.php index b2efef5a5cd..b6989607e53 100644 --- a/app/code/core/Mage/Shipping/Model/Rate/Result.php +++ b/app/code/core/Mage/Shipping/Model/Rate/Result.php @@ -63,7 +63,7 @@ public function setError($error) /** * Get Error * - * @return null|bool; + * @return null|bool */ public function getError() { diff --git a/app/code/core/Mage/Uploader/Model/Config/Abstract.php b/app/code/core/Mage/Uploader/Model/Config/Abstract.php index a81d6a2c703..5e528dc828a 100644 --- a/app/code/core/Mage/Uploader/Model/Config/Abstract.php +++ b/app/code/core/Mage/Uploader/Model/Config/Abstract.php @@ -25,7 +25,6 @@ * @package Mage_Uploader * @author Magento Core Team */ - abstract class Mage_Uploader_Model_Config_Abstract extends Varien_Object { /** diff --git a/app/code/core/Mage/Uploader/Model/Config/Browsebutton.php b/app/code/core/Mage/Uploader/Model/Config/Browsebutton.php index fcce1122133..28e6d7bab4a 100644 --- a/app/code/core/Mage/Uploader/Model/Config/Browsebutton.php +++ b/app/code/core/Mage/Uploader/Model/Config/Browsebutton.php @@ -23,14 +23,14 @@ * @package Mage_Uploader * @author Magento Core Team * - * @method Mage_Uploader_Model_Config_Browsebutton setDomNodes(array $domNodesIds) + * @method $this setDomNodes(array $domNodesIds) * Array of element browse buttons ids - * @method Mage_Uploader_Model_Config_Browsebutton setIsDirectory(bool $isDirectory) + * @method $this setIsDirectory(bool $isDirectory) * Pass in true to allow directories to be selected (Google Chrome only) - * @method Mage_Uploader_Model_Config_Browsebutton setSingleFile(bool $isSingleFile) + * @method $this setSingleFile(bool $isSingleFile) * To prevent multiple file uploads set this to true. * Also look at config parameter singleFile (Mage_Uploader_Model_Config_Uploader setSingleFile()) - * @method Mage_Uploader_Model_Config_Browsebutton setAttributes(array $attributes) + * @method $this setAttributes(array $attributes) * Pass object of keys and values to set custom attributes on input fields. * @see http://www.w3.org/TR/html-markup/input.file.html#input.file-attributes */ diff --git a/app/code/core/Mage/Uploader/Model/Config/Misc.php b/app/code/core/Mage/Uploader/Model/Config/Misc.php index 99d0426e95e..6bfc076ed76 100644 --- a/app/code/core/Mage/Uploader/Model/Config/Misc.php +++ b/app/code/core/Mage/Uploader/Model/Config/Misc.php @@ -24,15 +24,11 @@ * @category Mage * @package Mage_Uploader * @author Magento Core Team - */ - -/** - * @method Mage_Uploader_Model_Config_Misc setMaxSizePlural (string $sizePlural) Set plural info about max upload size - * @method Mage_Uploader_Model_Config_Misc setMaxSizeInBytes (int $sizeInBytes) Set max upload size in bytes - * @method Mage_Uploader_Model_Config_Misc setReplaceBrowseWithRemove (bool $replaceBrowseWithRemove) - * Replace browse button with remove * - * Class Mage_Uploader_Model_Config_Misc + * @method $this setMaxSizePlural (string $sizePlural) Set plural info about max upload size + * @method $this setMaxSizeInBytes (int $sizeInBytes) Set max upload size in bytes + * @method $this setReplaceBrowseWithRemove (bool $replaceBrowseWithRemove) + * Replace browse button with remove */ class Mage_Uploader_Model_Config_Misc extends Mage_Uploader_Model_Config_Abstract { diff --git a/app/code/core/Mage/Uploader/Model/Config/Uploader.php b/app/code/core/Mage/Uploader/Model/Config/Uploader.php index 54618e78f37..fc1ee783463 100644 --- a/app/code/core/Mage/Uploader/Model/Config/Uploader.php +++ b/app/code/core/Mage/Uploader/Model/Config/Uploader.php @@ -25,52 +25,52 @@ * @package Mage_Uploader * @author Magento Core Team * - * @method Mage_Uploader_Model_Config_Uploader setTarget(string $url) + * @method $this setTarget(string $url) * The target URL for the multipart POST request. - * @method Mage_Uploader_Model_Config_Uploader setSingleFile(bool $isSingleFile) + * @method $this setSingleFile(bool $isSingleFile) * Enable single file upload. * Once one file is uploaded, second file will overtake existing one, first one will be canceled. - * @method Mage_Uploader_Model_Config_Uploader setChunkSize(int $chunkSize) The size in bytes of each uploaded chunk of data. - * @method Mage_Uploader_Model_Config_Uploader setForceChunkSize(bool $forceChunkSize) + * @method $this setChunkSize(int $chunkSize) The size in bytes of each uploaded chunk of data. + * @method $this setForceChunkSize(bool $forceChunkSize) * Force all chunks to be less or equal than chunkSize. - * @method Mage_Uploader_Model_Config_Uploader setSimultaneousUploads(int $amountOfSimultaneousUploads) - * @method Mage_Uploader_Model_Config_Uploader setFileParameterName(string $fileUploadParam) - * @method Mage_Uploader_Model_Config_Uploader setQuery(array $additionalQuery) - * @method Mage_Uploader_Model_Config_Uploader setHeaders(array $headers) + * @method $this setSimultaneousUploads(int $amountOfSimultaneousUploads) + * @method $this setFileParameterName(string $fileUploadParam) + * @method $this setQuery(array $additionalQuery) + * @method $this setHeaders(array $headers) * Extra headers to include in the multipart POST with data. - * @method Mage_Uploader_Model_Config_Uploader setWithCredentials(bool $isCORS) + * @method $this setWithCredentials(bool $isCORS) * Standard CORS requests do not send or set any cookies by default. * In order to include cookies as part of the request, you need to set the withCredentials property to true. - * @method Mage_Uploader_Model_Config_Uploader setMethod(string $sendMethod) + * @method $this setMethod(string $sendMethod) * Method to use when POSTing chunks to the server. Defaults to "multipart" - * @method Mage_Uploader_Model_Config_Uploader setTestMethod(string $testMethod) Defaults to "GET" - * @method Mage_Uploader_Model_Config_Uploader setUploadMethod(string $uploadMethod) Defaults to "POST" - * @method Mage_Uploader_Model_Config_Uploader setAllowDuplicateUploads(bool $allowDuplicateUploads) + * @method $this setTestMethod(string $testMethod) Defaults to "GET" + * @method $this setUploadMethod(string $uploadMethod) Defaults to "POST" + * @method $this setAllowDuplicateUploads(bool $allowDuplicateUploads) * Once a file is uploaded, allow reupload of the same file. By default, if a file is already uploaded, * it will be skipped unless the file is removed from the existing Flow object. - * @method Mage_Uploader_Model_Config_Uploader setPrioritizeFirstAndLastChunk(bool $prioritizeFirstAndLastChunk) + * @method $this setPrioritizeFirstAndLastChunk(bool $prioritizeFirstAndLastChunk) * This can be handy if you can determine if a file is valid for your service from only the first or last chunk. - * @method Mage_Uploader_Model_Config_Uploader setTestChunks(bool $prioritizeFirstAndLastChunk) + * @method $this setTestChunks(bool $prioritizeFirstAndLastChunk) * Make a GET request to the server for each chunks to see if it already exists. - * @method Mage_Uploader_Model_Config_Uploader setPreprocess(bool $prioritizeFirstAndLastChunk) + * @method $this setPreprocess(bool $prioritizeFirstAndLastChunk) * Optional function to process each chunk before testing & sending. - * @method Mage_Uploader_Model_Config_Uploader setInitFileFn(string $function) + * @method $this setInitFileFn(string $function) * Optional function to initialize the fileObject (js). - * @method Mage_Uploader_Model_Config_Uploader setReadFileFn(string $function) + * @method $this setReadFileFn(string $function) * Optional function wrapping reading operation from the original file. - * @method Mage_Uploader_Model_Config_Uploader setGenerateUniqueIdentifier(string $function) + * @method $this setGenerateUniqueIdentifier(string $function) * Override the function that generates unique identifiers for each file. Defaults to "null" - * @method Mage_Uploader_Model_Config_Uploader setMaxChunkRetries(int $maxChunkRetries) Defaults to 0 - * @method Mage_Uploader_Model_Config_Uploader setChunkRetryInterval(int $chunkRetryInterval) Defaults to "undefined" - * @method Mage_Uploader_Model_Config_Uploader setProgressCallbacksInterval(int $progressCallbacksInterval) - * @method Mage_Uploader_Model_Config_Uploader setSpeedSmoothingFactor(int $speedSmoothingFactor) + * @method $this setMaxChunkRetries(int $maxChunkRetries) Defaults to 0 + * @method $this setChunkRetryInterval(int $chunkRetryInterval) Defaults to "undefined" + * @method $this setProgressCallbacksInterval(int $progressCallbacksInterval) + * @method $this setSpeedSmoothingFactor(int $speedSmoothingFactor) * Used for calculating average upload speed. Number from 1 to 0. * Set to 1 and average upload speed wil be equal to current upload speed. * For longer file uploads it is better set this number to 0.02, * because time remaining estimation will be more accurate. - * @method Mage_Uploader_Model_Config_Uploader setSuccessStatuses(array $successStatuses) + * @method $this setSuccessStatuses(array $successStatuses) * Response is success if response status is in this list - * @method Mage_Uploader_Model_Config_Uploader setPermanentErrors(array $permanentErrors) + * @method $this setPermanentErrors(array $permanentErrors) * Response fails if response status is in this list */ class Mage_Uploader_Model_Config_Uploader extends Mage_Uploader_Model_Config_Abstract diff --git a/app/code/core/Mage/Usa/Model/Shipping/Carrier/Dhl/International.php b/app/code/core/Mage/Usa/Model/Shipping/Carrier/Dhl/International.php index 924107457e3..33e39f5e81b 100644 --- a/app/code/core/Mage/Usa/Model/Shipping/Carrier/Dhl/International.php +++ b/app/code/core/Mage/Usa/Model/Shipping/Carrier/Dhl/International.php @@ -1097,10 +1097,8 @@ protected function _getWeightUnit() /** * Get Country Params by Country Code * - * @param string $countryCode + * @param string $countryCode ISO 3166 Codes (Countries) A2 * @return Varien_Object - * - * @see $countryCode ISO 3166 Codes (Countries) A2 */ protected function getCountryParams($countryCode) {