Fixed some docs for phpdocumentor (#2577)

OpenMage · Sep 9, 2022 · 811cc5a · 811cc5a
1 parent 7f56d79
commit 811cc5a
Show file tree

Hide file tree

Showing 53 changed files with 164 additions and 106 deletions.
diff --git 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 <core@magentocommerce.com>
  */
 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
@@ -22,7 +22,7 @@
  * Adminhtml HTML select element block
  *
  * @category   Mage
- * @package    Mage_Core
+ * @package    Mage_Adminhtml
  * @author     Magento Core Team <core@magentocommerce.com>
  */
 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
@@ -22,7 +22,7 @@
  * Adminhtml catalog (google) sitemaps block
  *
  * @category   Mage
- * @package    Mage_Sitemap
+ * @package    Mage_Adminhtml
  * @author     Magento Core Team <core@magentocommerce.com>
  */
 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
@@ -22,12 +22,11 @@
  * Sitemap grid link column renderer
  *
  * @category   Mage
- * @package    Mage_Sitemap
+ * @package    Mage_Adminhtml
  * @author     Magento Core Team <core@magentocommerce.com>
  */
 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
@@ -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 <core@magentocommerce.com>
+ */
 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
@@ -1,5 +1,30 @@
 <?php
+/**
+ * OpenMage
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://opensource.org/licenses/osl-3.0.php
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@magento.com so we can send you a copy immediately.
+ *
+ * @category   Mage
+ * @package    Mage_Adminhtml
+ * @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)
+ */
 
+/**
+ * Catalog Search change Search Separator backend model
+ *
+ * @category   Mage
+ * @package    Mage_Adminhtml
+ * @author     Magento Core Team <core@magentocommerce.com>
+ */
 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
@@ -1,5 +1,30 @@
 <?php
+/**
+ * OpenMage
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://opensource.org/licenses/osl-3.0.php
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@magento.com so we can send you a copy immediately.
+ *
+ * @category   Mage
+ * @package    Mage_Adminhtml
+ * @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)
+ */
 
+/**
+ * Catalog search separator
+ *
+ * @category   Mage
+ * @package    Mage_Adminhtml
+ * @author     Magento Core Team <core@magentocommerce.com>
+ */
 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
@@ -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 <core@magentocommerce.com>
+ */
 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
@@ -22,7 +22,7 @@
  * Configuration source model for Wysiwyg toggling
  *
  * @category   Mage
- * @package    Mage_Cms
+ * @package    Mage_Adminhtml
  * @author     Magento Core Team <core@magentocommerce.com>
  */
 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
@@ -1,5 +1,28 @@
 <?php
+/**
+ * OpenMage
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://opensource.org/licenses/osl-3.0.php
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@magento.com so we can send you a copy immediately.
+ *
+ * @category   Mage
+ * @package    Mage_Adminhtml
+ * @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 <core@magentocommerce.com>
+ */
 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
@@ -22,7 +22,7 @@
  * Cms manage pages controller
  *
  * @category   Mage
- * @package    Mage_Cms
+ * @package    Mage_Adminhtml
  * @author     Magento Core Team <core@magentocommerce.com>
  */
 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
@@ -22,7 +22,7 @@
  * Adminhtml Rss Controller
  *
  * @category   Mage
- * @package    Mage_Rss
+ * @package    Mage_Adminhtml
  * @author     Magento Core Team <core@magentocommerce.com>
  */
 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
@@ -22,7 +22,7 @@
  * Customer reviews controller
  *
  * @category   Mage
- * @package    Mage_Rss
+ * @package    Mage_Adminhtml
  * @author     Magento Core Team <core@magentocommerce.com>
  */
 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
@@ -25,7 +25,7 @@
  * @package    Mage_Adminhtml
  * @author     Magento Core Team <core@magentocommerce.com>
  *
- * 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
@@ -22,7 +22,7 @@
  * Google sitemap controller
  *
  * @category   Mage
- * @package    Mage_Sitemap
+ * @package    Mage_Adminhtml
  * @author     Magento Core Team <core@magentocommerce.com>
  */
 class Mage_Adminhtml_SitemapController extends  Mage_Adminhtml_Controller_Action

diff --git a/...ore/Mage/Authorizenet/controllers/Adminhtml/Authorizenet/Directpost/PaymentController.php b/...ore/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 <core@magentocommerce.com>
  */
 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
@@ -22,7 +22,7 @@
  * Sales Order Creditmemo Pdf default items renderer
  *
  * @category   Mage
- * @package    Mage_Sales
+ * @package    Mage_Bundle
  * @author     Magento Core Team <core@magentocommerce.com>
  */
 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
@@ -22,7 +22,7 @@
  * Sales Order Invoice Pdf default items renderer
  *
  * @category   Mage
- * @package    Mage_Sales
+ * @package    Mage_Bundle
  * @author     Magento Core Team <core@magentocommerce.com>
  */
 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
@@ -22,7 +22,7 @@
  * Captcha controller
  *
  * @category   Mage
- * @package    Mage_Core
+ * @package    Mage_Captcha
  * @author     Magento Core Team <core@magentocommerce.com>
  */
 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
@@ -22,7 +22,7 @@
  * Captcha controller
  *
  * @category   Mage
- * @package    Mage_Core
+ * @package    Mage_Captcha
  * @author     Magento Core Team <core@magentocommerce.com>
  */
 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
@@ -22,7 +22,7 @@
  * Html page block
  *
  * @category   Mage
- * @package    Mage_Page
+ * @package    Mage_Catalog
  * @author     Magento Core Team <core@magentocommerce.com>
  * @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
@@ -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
@@ -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 <core@magentocommerce.com>
  */
 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
@@ -22,7 +22,7 @@
  * Product attribute source input types
  *
  * @category   Mage
- * @package    Mage_Eav
+ * @package    Mage_Catalog
  * @author     Magento Core Team <core@magentocommerce.com>
  */
 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -22,7 +22,7 @@
  * Authentication start/redirect form
  *
  * @category   Mage
- * @package    Mage_Centinal
+ * @package    Mage_Centinel
  * @author     Magento Core Team <core@magentocommerce.com>
  */
 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
@@ -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
@@ -929,7 +929,7 @@ protected function _validateFormKey()
      * bar / <default title>
      *
      * @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
@@ -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