Skip to content

Commit 3419c71

Browse files
Merge pull request #993 from magento-frontend/MAGETWO-66403
Story - MAGETWO-66403: API annotations in Theme, Ui and Framework View
2 parents 180d459 + a75f2f6 commit 3419c71

File tree

157 files changed

+538
-41
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

157 files changed

+538
-41
lines changed

app/code/Magento/Theme/Block/Adminhtml/Design/Config/Edit/BackButton.php

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@
99
use Magento\Framework\UrlInterface;
1010
use Magento\Framework\View\Element\UiComponent\Control\ButtonProviderInterface;
1111

12+
/**
13+
* "Back" button data provider
14+
*
15+
* @api
16+
*/
1217
class BackButton implements ButtonProviderInterface
1318
{
1419
/**
@@ -28,7 +33,7 @@ public function __construct(
2833
}
2934

3035
/**
31-
* {@inheritdoc}
36+
* @inheritdoc
3237
*/
3338
public function getButtonData()
3439
{

app/code/Magento/Theme/Block/Adminhtml/Design/Config/Edit/SaveAndContinueButton.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77

88
use Magento\Framework\View\Element\UiComponent\Control\ButtonProviderInterface;
99

10+
/**
11+
* "Save and continue" button data provider
12+
*
13+
* @api
14+
*/
1015
class SaveAndContinueButton implements ButtonProviderInterface
1116
{
1217
/**

app/code/Magento/Theme/Block/Adminhtml/Design/Config/Edit/SaveButton.php

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,15 @@
77

88
use Magento\Framework\View\Element\UiComponent\Control\ButtonProviderInterface;
99

10+
/**
11+
* "Save" button data provider
12+
*
13+
* @api
14+
*/
1015
class SaveButton implements ButtonProviderInterface
1116
{
1217
/**
13-
* {@inheritdoc}
18+
* @inheritdoc
1419
*/
1520
public function getButtonData()
1621
{

app/code/Magento/Theme/Block/Adminhtml/Design/Config/Edit/Scope.php

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@
1010
use Magento\Framework\App\Config\ScopeConfigInterface;
1111
use Magento\Framework\App\ScopeResolverPool;
1212

13+
/**
14+
* Scope information block
15+
*
16+
* @api
17+
*/
1318
class Scope extends Template
1419
{
1520
/**
@@ -49,7 +54,7 @@ public function getScopeTitle()
4954
}
5055

5156
/**
52-
* @inheritDoc
57+
* @inheritdoc
5358
*/
5459
public function toHtml()
5560
{

app/code/Magento/Theme/Block/Html/Breadcrumbs.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111
/**
1212
* Html page breadcrumbs block
13+
*
14+
* @api
1315
*/
1416
class Breadcrumbs extends \Magento\Framework\View\Element\Template
1517
{

app/code/Magento/Theme/Block/Html/Footer.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99

1010
/**
1111
* Html page footer block
12+
*
13+
* @api
1214
*/
1315
class Footer extends \Magento\Framework\View\Element\Template implements \Magento\Framework\DataObject\IdentityInterface
1416
{

app/code/Magento/Theme/Block/Html/Header.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88

99
/**
1010
* Html page header block
11+
*
12+
* @api
1113
*/
1214
class Header extends \Magento\Framework\View\Element\Template
1315
{

app/code/Magento/Theme/Block/Html/Header/Logo.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88

99
/**
1010
* Logo page header block
11+
*
12+
* @api
1113
*/
1214
class Logo extends \Magento\Framework\View\Element\Template
1315
{

app/code/Magento/Theme/Block/Html/Notices.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
/**
99
* Html page notices block
10+
*
11+
* @api
1012
*/
1113
class Notices extends \Magento\Framework\View\Element\Template
1214
{

app/code/Magento/Theme/Block/Html/Pager.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77

88
/**
99
* Html pager block
10+
*
1011
* @SuppressWarnings(PHPMD.ExcessivePublicCount)
12+
* @api
1113
*/
1214
class Pager extends \Magento\Framework\View\Element\Template
1315
{

0 commit comments

Comments
 (0)