Skip to content

Commit 358f342

Browse files
committed
1011: Updated docblock for code generator
1 parent effbf30 commit 358f342

File tree

9 files changed

+27
-26
lines changed

9 files changed

+27
-26
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ use Symfony\Component\Console\Output\OutputInterface;
1212
class ${NAME} extends Command
1313
{
1414
/**
15-
* @inheritDoc
15+
* Initialization of the command
1616
*/
1717
protected function configure()
1818
{

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class ${NAME}#if (${EXTENDS}) extends ${EXTENDS}#end#if (${IMPLEMENTS}) implemen
1717
protected $_eventPrefix = '${DB_NAME}_collection';
1818

1919
/**
20-
* @inheritdoc
20+
* Initialize resource model
2121
*/
2222
protected function _construct()
2323
{

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

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,11 @@ class ${NAME} #if (${EXTENDS})extends ${EXTENDS} #end #if (${IMPLEMENTS} && $has
4141
#if(!($foreach.first))
4242

4343
#end
44-
#if ($hasInterface)
45-
/**
46-
* @inheritDoc
47-
*/
48-
#else
4944
/**
5045
* Getter for $propertyUpperCamel.
5146
*
5247
* @return $propertyType|null
5348
*/
54-
#end
5549
public function get$propertyUpperCamel(): ?$propertyType
5650
{
5751
#if($propertyType == 'string')
@@ -62,19 +56,13 @@ class ${NAME} #if (${EXTENDS})extends ${EXTENDS} #end #if (${IMPLEMENTS} && $has
6256
#end
6357
}
6458

65-
#if ($hasInterface)
66-
/**
67-
* @inheritDoc
68-
*/
69-
#else
7059
/**
7160
* Setter for $propertyUpperCamel.
7261
*
7362
* @param $propertyType|null $$propertyLowerCamel
7463
*
7564
* @return void
7665
*/
77-
#end
7866
public function set$propertyUpperCamel(?$propertyType $$propertyLowerCamel): void
7967
{
8068
$this->setData(self::$propertyUpperSnake, $$propertyLowerCamel);

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,20 @@ use $use;
1414
class ${CLASS_NAME} extends ${PARENT_CLASS_NAME} implements ${INTERFACE_NAME}
1515
{
1616
/**
17-
* @inheritDoc
17+
* Set items list.
18+
*
19+
* @param array $items
20+
* @return ${INTERFACE_NAME}
1821
*/
1922
public function setItems(array $items): ${INTERFACE_NAME}
2023
{
2124
return parent::setItems($items);
2225
}
2326

2427
/**
25-
* @inheritDoc
28+
* Get items list.
29+
*
30+
* @return array
2631
*/
2732
public function getItems(): array
2833
{

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,9 @@ class ${CLASS_NAME} extends ${PARENT_CLASS}
2020

2121
/**
2222
* Url paths.
23-
* #@+
2423
*/
2524
private const EDIT_URL_PATH = '${EDIT_URL_PATH}';
2625
private const DELETE_URL_PATH = '${DELETE_URL_PATH}';
27-
/** #@- */
2826

2927
/**
3028
* @var ${URL}
@@ -55,7 +53,10 @@ class ${CLASS_NAME} extends ${PARENT_CLASS}
5553
}
5654

5755
/**
58-
* @inheritDoc
56+
* Prepare Data Source
57+
*
58+
* @param array $dataSource
59+
* @return array
5960
*/
6061
public function prepareDataSource(array $dataSource): array
6162
{

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ class ${NAME}#if (${EXTENDS}) extends ${EXTENDS}#end#if (${IMPLEMENTS}) implemen
1717
protected $_eventPrefix = '${DB_NAME}_model';
1818

1919
/**
20-
* @inheritdoc
20+
* Initialize resource
21+
*
22+
* @return void
2123
*/
2224
protected function _construct()
2325
{

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class ${NAME}#if (${EXTENDS}) extends ${EXTENDS}#end#if (${IMPLEMENTS}) implemen
1717
protected $_eventPrefix = '${DB_NAME}_resource_model';
1818

1919
/**
20-
* @inheritdoc
20+
* Init resource model
2121
*/
2222
protected function _construct()
2323
{

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,9 @@ class ${CLASS_NAME} extends ${EXTENDS}
7676
}
7777

7878
/**
79-
* @inheritDoc
79+
* Returns Search result
80+
*
81+
* @return ${SEARCH_RESULT_FACTORY}
8082
*/
8183
public function getSearchResult()
8284
{
@@ -119,7 +121,9 @@ class ${CLASS_NAME} extends ${EXTENDS}
119121
}
120122
#else
121123
/**
122-
* @inheritDoc
124+
* Get data.
125+
*
126+
* @return array
123127
*/
124128
public function getData()
125129
{

testData/actions/generation/generator/GridActionColumnFileGenerator/generateGridActionColumnFile/BookBlockActions.php

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,9 @@ class BookBlockActions extends Column
2020

2121
/**
2222
* Url paths.
23-
* #@+
2423
*/
2524
private const EDIT_URL_PATH = 'book_book_edit';
2625
private const DELETE_URL_PATH = 'book_book_delete';
27-
/** #@- */
2826

2927
/**
3028
* @var UrlInterface
@@ -56,7 +54,10 @@ public function __construct(
5654
}
5755

5856
/**
59-
* @inheritDoc
57+
* Prepare Data Source
58+
*
59+
* @param array $dataSource
60+
* @return array
6061
*/
6162
public function prepareDataSource(array $dataSource): array
6263
{

0 commit comments

Comments
 (0)