Merge pull request #1022 from doninAtwix/1011-update-docblock-for-code-generator

1011: Updated docblock for code generator

Author: bohdan-harniuk

resources/fileTemplates/internal/Magento CLI Command Class.php.ft

@@ -12,7 +12,7 @@ use Symfony\Component\Console\Output\OutputInterface;
 class ${NAME} extends Command
 {
         /**
-         * @inheritDoc
+         * Initialization of the command.
          */
         protected function configure()
         {
@@ -22,7 +22,7 @@ class ${NAME} extends Command
         }
 
         /**
-         * CLI command description
+         * CLI command description.
          *
          * @param InputInterface $input
          * @param OutputInterface $output

resources/fileTemplates/internal/Magento Collection Class.php.ft

@@ -17,7 +17,7 @@ class ${NAME}#if (${EXTENDS}) extends ${EXTENDS}#end#if (${IMPLEMENTS}) implemen
     protected $_eventPrefix = '${DB_NAME}_collection';
 
     /**
-     * @inheritdoc
+     * Initialize collection model.
      */
     protected function _construct()
     {

resources/fileTemplates/internal/Magento Data Model.php.ft

@@ -19,7 +19,7 @@ class ${NAME} #if (${EXTENDS})extends ${EXTENDS} #end #if (${IMPLEMENTS} && $has
 {
       #if (${PROPERTIES} && !$hasInterface)
             /**
-             * String constants for property names
+             * String constants for property names.
              */
             #set ($properties = ${PROPERTIES})
         #foreach ($property in $properties.split(","))
@@ -41,17 +41,11 @@ class ${NAME} #if (${EXTENDS})extends ${EXTENDS} #end #if (${IMPLEMENTS} && $has
             #if(!($foreach.first))
 
             #end
-            #if ($hasInterface)
-            /**
-             * @inheritDoc
-             */
-            #else
             /**
              * Getter for $propertyUpperCamel.
              *
              * @return $propertyType|null
              */
-            #end
             public function get$propertyUpperCamel(): ?$propertyType
             {
                 #if($propertyType == 'string')
@@ -62,19 +56,13 @@ class ${NAME} #if (${EXTENDS})extends ${EXTENDS} #end #if (${IMPLEMENTS} && $has
                 #end
             }
 
-            #if ($hasInterface)
-            /**
-             * @inheritDoc
-             */
-            #else
             /**
              * Setter for $propertyUpperCamel.
              *
              * @param $propertyType|null $$propertyLowerCamel
              *
              * @return void
              */
-            #end
             public function set$propertyUpperCamel(?$propertyType $$propertyLowerCamel): void
             {
                 $this->setData(self::$propertyUpperSnake, $$propertyLowerCamel);

resources/fileTemplates/internal/Magento Entity Search Results.php.ft

@@ -14,15 +14,21 @@ use $use;
 class ${CLASS_NAME} extends ${PARENT_CLASS_NAME} implements ${INTERFACE_NAME}
 {
     /**
-     * @inheritDoc
+     * Set items list.
+     *
+     * @param array $items
+     *
+     * @return ${INTERFACE_NAME}
      */
     public function setItems(array $items): ${INTERFACE_NAME}
     {
         return parent::setItems($items);
     }
 
     /**
-     * @inheritDoc
+     * Get items list.
+     *
+     * @return array
      */
     public function getItems(): array
     {

resources/fileTemplates/internal/Magento Grid Ui Component Action Column Class.php.ft

@@ -20,11 +20,9 @@ class ${CLASS_NAME} extends ${PARENT_CLASS}
 
     /**
      * Url paths.
-     * #@+
      */
     private const EDIT_URL_PATH = '${EDIT_URL_PATH}';
     private const DELETE_URL_PATH = '${DELETE_URL_PATH}';
-    /** #@- */
 
     /**
      * @var ${URL}
@@ -55,7 +53,11 @@ class ${CLASS_NAME} extends ${PARENT_CLASS}
     }
 
     /**
-     * @inheritDoc
+     * Prepare data source.
+     *
+     * @param array $dataSource
+     *
+     * @return array
      */
     public function prepareDataSource(array $dataSource): array
     {

resources/fileTemplates/internal/Magento Model Class.php.ft

@@ -17,7 +17,9 @@ class ${NAME}#if (${EXTENDS}) extends ${EXTENDS}#end#if (${IMPLEMENTS}) implemen
     protected $_eventPrefix = '${DB_NAME}_model';
 
     /**
-     * @inheritdoc
+     * Initialize magento model.
+     *
+     * @return void
      */
     protected function _construct()
     {

resources/fileTemplates/internal/Magento Resource Model Class.php.ft

@@ -17,7 +17,7 @@ class ${NAME}#if (${EXTENDS}) extends ${EXTENDS}#end#if (${IMPLEMENTS}) implemen
     protected $_eventPrefix = '${DB_NAME}_resource_model';
 
     /**
-     * @inheritdoc
+     * Initialize resource model.
      */
     protected function _construct()
     {

resources/fileTemplates/internal/Magento UI Component Custom Data Provider Class.php.ft

@@ -76,7 +76,9 @@ class ${CLASS_NAME} extends ${EXTENDS}
     }
 
     /**
-     * @inheritDoc
+     * Returns searching result.
+     *
+     * @return ${SEARCH_RESULT_FACTORY}
      */
     public function getSearchResult()
     {
@@ -119,7 +121,9 @@ class ${CLASS_NAME} extends ${EXTENDS}
     }
 #else
     /**
-     * @inheritDoc
+     * Get data.
+     *
+     * @return array
      */
     public function getData()
     {

testData/actions/generation/generator/CLICommandClassGenerator/generateCLICommandClass/TestCLICommandPHPClass.php

@@ -9,7 +9,7 @@
 class TestCLICommandPHPClass extends Command
 {
     /**
-     * @inheritDoc
+     * Initialization of the command.
      */
     protected function configure()
     {
@@ -19,7 +19,7 @@ protected function configure()
     }
 
     /**
-     * CLI command description
+     * CLI command description.
      *
      * @param InputInterface $input
      * @param OutputInterface $output

testData/actions/generation/generator/DataModelGenerator/generateDataModel/Sample.php

@@ -8,7 +8,9 @@
 class Sample extends DataObject implements SampleInterface
 {
     /**
-     * @inheritDoc
+     * Getter for IdProperty.
+     *
+     * @return int|null
      */
     public function getIdProperty(): ?int
     {
@@ -17,23 +19,33 @@ public function getIdProperty(): ?int
     }
 
     /**
-     * @inheritDoc
+     * Setter for IdProperty.
+     *
+     * @param int|null $idProperty
+     *
+     * @return void
      */
     public function setIdProperty(?int $idProperty): void
     {
         $this->setData(self::ID_PROPERTY, $idProperty);
     }
 
     /**
-     * @inheritDoc
+     * Getter for SampleProperty.
+     *
+     * @return string|null
      */
     public function getSampleProperty(): ?string
     {
         return $this->getData(self::SAMPLE_PROPERTY);
     }
 
     /**
-     * @inheritDoc
+     * Setter for SampleProperty.
+     *
+     * @param string|null $sampleProperty
+     *
+     * @return void
      */
     public function setSampleProperty(?string $sampleProperty): void
     {