ENGCOM-3866: Small PHPDocs fixes [Backend module] #20308

Author: sidolov

app/code/Magento/Backend/Block/Template/Context.php

@@ -19,6 +19,7 @@
  * @api
  * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
  * @since 100.0.2
  */
 class Context extends \Magento\Framework\View\Element\Template\Context
@@ -174,7 +175,7 @@ public function getAuthorization()
     }
 
     /**
-     * Get Backend Session
+     * Get backend session instance.
      *
      * @return \Magento\Backend\Model\Session
      */
@@ -184,7 +185,7 @@ public function getBackendSession()
     }
 
     /**
-     * Get Math Random
+     * Get math random instance.
      *
      * @return \Magento\Framework\Math\Random
      */
@@ -194,7 +195,7 @@ public function getMathRandom()
     }
 
     /**
-     * Get Form Key
+     * Get form key instance.
      *
      * @return \Magento\Framework\Data\Form\FormKey
      */
@@ -204,7 +205,7 @@ public function getFormKey()
     }
 
     /**
-     * Get Class Name Builder
+     * Get name builder instance.
      *
      * @return \Magento\Framework\Code\NameBuilder
      */

app/code/Magento/Backend/Block/Widget/Grid/Column/Renderer/AbstractRenderer.php

@@ -28,6 +28,8 @@ abstract class AbstractRenderer extends \Magento\Backend\Block\AbstractBlock imp
     protected $_column;
 
     /**
+     * Set column for renderer.
+     *
      * @param Column $column
      * @return $this
      */
@@ -38,6 +40,8 @@ public function setColumn($column)
     }
 
     /**
+     * Returns row associated with the renderer.
+     *
      * @return Column
      */
     public function getColumn()
@@ -48,7 +52,7 @@ public function getColumn()
     /**
      * Renders grid column
      *
-     * @param   Object $row
+     * @param DataObject $row
      * @return  string
      */
     public function render(DataObject $row)
@@ -66,7 +70,7 @@ public function render(DataObject $row)
     /**
      * Render column for export
      *
-     * @param Object $row
+     * @param DataObject $row
      * @return string
      */
     public function renderExport(DataObject $row)
@@ -75,7 +79,9 @@ public function renderExport(DataObject $row)
     }
 
     /**
-     * @param Object $row
+     * Returns value of the row.
+     *
+     * @param DataObject $row
      * @return mixed
      */
     protected function _getValue(DataObject $row)
@@ -92,7 +98,9 @@ protected function _getValue(DataObject $row)
     }
 
     /**
-     * @param Object $row
+     * Get pre-rendered input element.
+     *
+     * @param DataObject $row
      * @return string
      */
     public function _getInputValueElement(DataObject $row)
@@ -108,7 +116,9 @@ public function _getInputValueElement(DataObject $row)
     }
 
     /**
-     * @param Object $row
+     * Get input value by row.
+     *
+     * @param DataObject $row
      * @return mixed
      */
     protected function _getInputValue(DataObject $row)
@@ -117,6 +127,8 @@ protected function _getInputValue(DataObject $row)
     }
 
     /**
+     * Renders header of the column,
+     *
      * @return string
      */
     public function renderHeader()
@@ -148,6 +160,8 @@ public function renderHeader()
     }
 
     /**
+     * Render HTML properties.
+     *
      * @return string
      */
     public function renderProperty()
@@ -172,6 +186,8 @@ public function renderProperty()
     }
 
     /**
+     * Returns HTML for CSS.
+     *
      * @return string
      */
     public function renderCss()

app/code/Magento/Backend/Controller/Adminhtml/Dashboard/ProductsViewed.php

@@ -6,12 +6,17 @@
  */
 namespace Magento\Backend\Controller\Adminhtml\Dashboard;
 
-class ProductsViewed extends AjaxBlock
+use Magento\Framework\App\Action\HttpGetActionInterface;
+
+/**
+ * Get most viewed products controller.
+ */
+class ProductsViewed extends AjaxBlock implements HttpGetActionInterface
 {
     /**
      * Gets most viewed products list
      *
-     * @return \Magento\Backend\Model\View\Result\Page
+     * @return \Magento\Framework\Controller\Result\Raw
      */
     public function execute()
     {

lib/internal/Magento/Framework/Code/NameBuilder.php

@@ -6,7 +6,7 @@
 namespace Magento\Framework\Code;
 
 /**
- * Name builder.
+ * Builds namespace with classname out of the parts.
  *
  * @api
  */