Add @see annotation, MD & CS fixes

Author: sambolek

app/code/Magento/Sitemap/Model/ResourceModel/Catalog/Product.php

@@ -3,6 +3,9 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
+// @codingStandardsIgnoreFile
+
 namespace Magento\Sitemap\Model\ResourceModel\Catalog;
 
 use Magento\CatalogUrlRewrite\Model\ProductUrlRewriteGenerator;
@@ -14,6 +17,9 @@
  *
  * @author      Magento Core Team <core@magentocommerce.com>
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings(PHPMD.LongVariable)
+ * @SuppressWarnings(PHPMD.CamelCasePropertyName)
+ * @SuppressWarnings(PHPMD.CamelCaseMethodName)
  */
 class Product extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
 {
@@ -72,6 +78,7 @@ class Product extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
 
     /**
      * @var \Magento\Catalog\Model\Product\Media\Config
+     * @deprecated unused
      */
     protected $_mediaConfig;
 
@@ -397,6 +404,7 @@ protected function _getAllProductImages($product, $storeId)
      *
      * @return \Magento\Catalog\Model\Product\Media\Config
      * @deprecated No longer used, as we're getting full image URL from getProductImageUrl method
+     * @see getProductImageUrl()
      */
     protected function _getMediaConfig()
     {

app/code/Magento/Sitemap/Model/Sitemap.php

@@ -27,6 +27,9 @@
  * @method \Magento\Sitemap\Model\Sitemap setStoreId(int $value)
  * @SuppressWarnings(PHPMD.TooManyFields)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
+ * @SuppressWarnings(PHPMD.CamelCasePropertyName)
+ * @SuppressWarnings(PHPMD.CamelCaseMethodName)
  */
 class Sitemap extends \Magento\Framework\Model\AbstractModel
 {
@@ -448,7 +451,7 @@ protected function _isSplitRequired($row)
      * @param null|string $lastmod
      * @param null|string $changefreq
      * @param null|string $priority
-     * @param null|array $images
+     * @param null|array|\Magento\Framework\DataObject $images
      * @return string
      * Sitemap images
      * @see http://support.google.com/webmasters/bin/answer.py?hl=en&answer=178636
@@ -473,7 +476,7 @@ protected function _getSitemapRow($url, $lastmod = null, $changefreq = null, $pr
             // Add Images to sitemap
             foreach ($images->getCollection() as $image) {
                 $row .= '<image:image>';
-                $row .= '<image:loc>' . htmlspecialchars($this->_getMediaUrl($image->getUrl())) . '</image:loc>';
+                $row .= '<image:loc>' . htmlspecialchars($image->getUrl()) . '</image:loc>';
                 $row .= '<image:title>' . htmlspecialchars($images->getTitle()) . '</image:title>';
                 if ($image->getCaption()) {
                     $row .= '<image:caption>' . htmlspecialchars($image->getCaption()) . '</image:caption>';
@@ -483,9 +486,7 @@ protected function _getSitemapRow($url, $lastmod = null, $changefreq = null, $pr
             // Add PageMap image for Google web search
             $row .= '<PageMap xmlns="http://www.google.com/schemas/sitemap-pagemap/1.0"><DataObject type="thumbnail">';
             $row .= '<Attribute name="name" value="' . htmlspecialchars($images->getTitle()) . '"/>';
-            $row .= '<Attribute name="src" value="' . htmlspecialchars(
-                $this->_getMediaUrl($images->getThumbnail())
-            ) . '"/>';
+            $row .= '<Attribute name="src" value="' . htmlspecialchars($images->getThumbnail()) . '"/>';
             $row .= '</DataObject></PageMap>';
         }
 
@@ -591,6 +592,7 @@ protected function _getBaseDir()
      */
     protected function _getStoreBaseUrl($type = \Magento\Framework\UrlInterface::URL_TYPE_LINK)
     {
+        /** @var \Magento\Store\Model\Store $store */
         $store = $this->_storeManager->getStore($this->getStoreId());
         $isSecure = $store->isUrlSecure();
         return rtrim($store->getBaseUrl($type, $isSecure), '/') . '/';
@@ -612,12 +614,13 @@ protected function _getUrl($url, $type = \Magento\Framework\UrlInterface::URL_TY
      * Get media url
      *
      * @param string $url
-     * @return string $url
+     * @return string
      * @deprecated No longer used, as we're generating product image URLs inside collection instead
+     * @see \Magento\Sitemap\Model\ResourceModel\Catalog\Product::_loadProductImages()
      */
     protected function _getMediaUrl($url)
     {
-        return $url;
+        return $this->_getUrl($url, \Magento\Framework\UrlInterface::URL_TYPE_MEDIA);
     }
 
     /**