Skip to content

Commit 5dcecdd

Browse files
author
Hwashiang Yu
committed
MC-5810: Improve naming of the critical variables/parameters in the code and configuration
- Resolved static test failures for lack of docblocks
1 parent 9c8ad8c commit 5dcecdd

File tree

5 files changed

+20
-0
lines changed

5 files changed

+20
-0
lines changed

app/code/Magento/PageBuilder/Model/Config.php

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

1111
use Magento\Framework\App\Config\ScopeConfigInterface;
1212

13+
/**
14+
* Represents PageBuilder loaded and cached configuration data
15+
*/
1316
class Config extends \Magento\Framework\Config\Data implements \Magento\PageBuilder\Model\ConfigInterface
1417
{
1518
const IS_PAGEBUILDER_ENABLED = 'cms/pagebuilder/enabled';
@@ -36,6 +39,8 @@ public function __construct(
3639
}
3740

3841
/**
42+
* Return all menu sections
43+
*
3944
* @return array
4045
*/
4146
public function getMenuSections() : array

app/code/Magento/PageBuilder/Model/Config/MenuSection/Converter.php

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

99
namespace Magento\PageBuilder\Model\Config\MenuSection;
1010

11+
/**
12+
* Converter for menu section in configuration
13+
*/
1114
class Converter implements \Magento\Framework\Config\ConverterInterface
1215
{
1316
/**

app/code/Magento/PageBuilder/Model/Config/MenuSection/Reader.php

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

99
namespace Magento\PageBuilder\Model\Config\MenuSection;
1010

11+
/**
12+
* Reader for menu section in configuration
13+
*/
1114
class Reader extends \Magento\Framework\Config\Reader\Filesystem
1215
{
1316
/**

app/code/Magento/PageBuilder/Model/Config/MenuSection/SchemaLocator.php

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

99
namespace Magento\PageBuilder\Model\Config\MenuSection;
1010

11+
/**
12+
* Schema locator for menu section in configuration
13+
*/
1114
class SchemaLocator implements \Magento\Framework\Config\SchemaLocatorInterface
1215
{
1316
/**

app/code/Magento/PageBuilder/Model/ConfigInterface.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,22 @@
1515
interface ConfigInterface
1616
{
1717
/**
18+
* Gets all the menu sections
19+
*
1820
* @return array
1921
*/
2022
public function getMenuSections() : array;
2123

2224
/**
25+
* Gets all the content types
26+
*
2327
* @return array
2428
*/
2529
public function getContentTypes() : array;
2630

2731
/**
32+
* Get if PageBuilder is enabled
33+
*
2834
* @return bool
2935
*/
3036
public function isEnabled() : bool;

0 commit comments

Comments
 (0)