Skip to content

Commit 3419c71

Browse files
VladimirZaetsVladimirZaets
authored
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
{

‎app/code/Magento/Theme/Block/Html/Title.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@
1414
* @method $this setTitleClass($titleClass)
1515
* @method string getTitleId()
1616
* @method string getTitleClass()
17+
* @api
1718
*/
18-
class Title extends \Magento\Framework\View\Element\Template
19+
class Title extends Template
1920
{
2021
/**
2122
* Own page title to display on the page

‎app/code/Magento/Theme/Block/Html/Topmenu.php

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

1414
/**
1515
* Html page top menu block
16+
*
17+
* @api
1618
*/
1719
class Topmenu extends Template implements IdentityInterface
1820
{
@@ -30,15 +32,6 @@ class Topmenu extends Template implements IdentityInterface
3032
*/
3133
protected $_menu;
3234

33-
/**
34-
* Core registry
35-
*
36-
* @var Registry
37-
*
38-
* @deprecated The property can be removed in a future release.
39-
*/
40-
protected $registry;
41-
4235
/**
4336
* @var NodeFactory
4437
*/

‎app/code/Magento/Theme/Block/Html/Welcome.php

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,14 @@
55
*/
66
namespace Magento\Theme\Block\Html;
77

8+
use Magento\Framework\View\Element\Template;
9+
810
/**
911
* Html page welcome block
12+
*
13+
* @api
1014
*/
11-
class Welcome extends \Magento\Framework\View\Element\Template
15+
class Welcome extends Template
1216
{
1317
/**
1418
* Get block message

‎app/code/Magento/Theme/Controller/Adminhtml/Design/Config/Edit.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
use Magento\Framework\View\Result\PageFactory as ResultPageFactory;
1515
use Magento\Framework\App\ScopeResolverPool;
1616

17+
/**
18+
* Edit action controller
19+
*/
1720
class Edit extends Action
1821
{
1922
/**

‎app/code/Magento/Theme/Controller/Adminhtml/Design/Config/FileUploader/Save.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@
1010
use Magento\Framework\Controller\ResultFactory;
1111
use Magento\Theme\Model\Design\Config\FileUploader\FileProcessor;
1212

13+
/**
14+
* File Uploads Action Controller
15+
*
16+
* @api
17+
*/
1318
class Save extends Action
1419
{
1520
/**

‎app/code/Magento/Theme/Controller/Adminhtml/Design/Config/Index.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99
use Magento\Backend\App\Action\Context;
1010
use Magento\Framework\View\Result\PageFactory;
1111

12+
/**
13+
* Design Config Settings index page action controller
14+
*/
1215
class Index extends Action
1316
{
1417
/**

‎app/code/Magento/Theme/Controller/Adminhtml/Design/Config/Save.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212
use Magento\Framework\Exception\LocalizedException;
1313
use Magento\Theme\Model\Data\Design\ConfigFactory;
1414

15+
/**
16+
* Save action controller
17+
*/
1518
class Save extends Action
1619
{
1720
/**

‎app/code/Magento/Theme/Controller/Adminhtml/System/Design/Theme/Delete.php

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

99
use Magento\Framework\Controller\ResultFactory;
1010

11+
/**
12+
* Class Delete
13+
* @deprecated
14+
*/
1115
class Delete extends \Magento\Theme\Controller\Adminhtml\System\Design\Theme
1216
{
1317
/**

‎app/code/Magento/Theme/Controller/Adminhtml/System/Design/Theme/DownloadCss.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
use Magento\Framework\App\ResponseInterface;
1010
use Magento\Framework\App\Filesystem\DirectoryList;
1111

12+
/**
13+
* Class DownloadCss
14+
* @deprecated
15+
*/
1216
class DownloadCss extends \Magento\Theme\Controller\Adminhtml\System\Design\Theme
1317
{
1418
/**

‎app/code/Magento/Theme/Controller/Adminhtml/System/Design/Theme/DownloadCustomCss.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
use Magento\Framework\App\ResponseInterface;
1010
use Magento\Framework\App\Filesystem\DirectoryList;
1111

12+
/**
13+
* Class DownloadCustomCss
14+
* @deprecated
15+
*/
1216
class DownloadCustomCss extends \Magento\Theme\Controller\Adminhtml\System\Design\Theme
1317
{
1418
/**

‎app/code/Magento/Theme/Controller/Adminhtml/System/Design/Theme/Edit.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
*/
77
namespace Magento\Theme\Controller\Adminhtml\System\Design\Theme;
88

9+
/**
10+
* Class Edit
11+
* @deprecated
12+
*/
913
class Edit extends \Magento\Theme\Controller\Adminhtml\System\Design\Theme
1014
{
1115
/**

‎app/code/Magento/Theme/Controller/Adminhtml/System/Design/Theme/Grid.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
*/
77
namespace Magento\Theme\Controller\Adminhtml\System\Design\Theme;
88

9+
/**
10+
* Class Grid
11+
* @deprecated
12+
*/
913
class Grid extends \Magento\Theme\Controller\Adminhtml\System\Design\Theme
1014
{
1115
/**

‎app/code/Magento/Theme/Controller/Adminhtml/System/Design/Theme/Index.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
*/
77
namespace Magento\Theme\Controller\Adminhtml\System\Design\Theme;
88

9+
/**
10+
* Class Index
11+
* @deprecated
12+
*/
913
class Index extends \Magento\Theme\Controller\Adminhtml\System\Design\Theme
1014
{
1115
/**

‎app/code/Magento/Theme/Controller/Adminhtml/System/Design/Theme/NewAction.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
*/
77
namespace Magento\Theme\Controller\Adminhtml\System\Design\Theme;
88

9+
/**
10+
* Class NewAction
11+
* @deprecated
12+
*/
913
class NewAction extends \Magento\Theme\Controller\Adminhtml\System\Design\Theme
1014
{
1115
/**

‎app/code/Magento/Theme/Controller/Adminhtml/System/Design/Theme/Save.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
*/
77
namespace Magento\Theme\Controller\Adminhtml\System\Design\Theme;
88

9+
/**
10+
* Class Save
11+
* @deprecated
12+
*/
913
class Save extends \Magento\Theme\Controller\Adminhtml\System\Design\Theme
1014
{
1115
/**

‎app/code/Magento/Theme/Controller/Adminhtml/System/Design/Theme/UploadCss.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
*/
77
namespace Magento\Theme\Controller\Adminhtml\System\Design\Theme;
88

9+
/**
10+
* Class UploadCss
11+
* @deprecated
12+
*/
913
class UploadCss extends \Magento\Theme\Controller\Adminhtml\System\Design\Theme
1014
{
1115
/**

‎app/code/Magento/Theme/Controller/Adminhtml/System/Design/Theme/UploadJs.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
*/
77
namespace Magento\Theme\Controller\Adminhtml\System\Design\Theme;
88

9+
/**
10+
* Class UploadJs
11+
* @depecated
12+
*/
913
class UploadJs extends \Magento\Theme\Controller\Adminhtml\System\Design\Theme
1014
{
1115
/**

‎app/code/Magento/Theme/CustomerData/Messages.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ class Messages implements SectionSourceInterface
1818
{
1919
/**
2020
* Manager messages
21+
*
2122
* @var MessageManager
2223
*/
2324
protected $messageManager;
@@ -29,6 +30,7 @@ class Messages implements SectionSourceInterface
2930

3031
/**
3132
* Constructor
33+
*
3234
* @param MessageManager $messageManager
3335
* @param InterpretationStrategyInterface $interpretationStrategy
3436
*/
@@ -41,7 +43,7 @@ public function __construct(
4143
}
4244

4345
/**
44-
* {@inheritdoc}
46+
* @inheritdoc
4547
*/
4648
public function getSectionData()
4749
{

‎app/code/Magento/Theme/Model/ResourceModel/Design.php

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,7 @@
99
use Magento\Framework\Stdlib\DateTime;
1010

1111
/**
12-
* Core Design Resource Model
13-
*
14-
* @author Magento Core Team <[email protected]>
12+
* Design Change Resource Model
1513
*/
1614
class Design extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
1715
{

‎app/code/Magento/Theme/Ui/Component/Design/Config/DataProvider.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@
1111
use Magento\Framework\App\RequestInterface;
1212
use Magento\Store\Model\StoreManagerInterface;
1313

14+
/**
15+
* Data Provider for 'design_config_form' and 'design_config_listing' components
16+
*
17+
* @api
18+
*/
1419
class DataProvider extends \Magento\Framework\View\Element\UiComponent\DataProvider\DataProvider
1520
{
1621
/**

0 commit comments

Comments
 (0)