Skip to content

Commit b5779a5

Browse files
author
Dale Sikkema
committed
MAGETWO-35004: Investigate and Annotate @api to classes and/or methods
1 parent 7f31d2d commit b5779a5

File tree

4 files changed

+13
-19
lines changed

4 files changed

+13
-19
lines changed

lib/internal/Magento/Framework/App/Config/Data.php

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,7 @@ public function getSource()
4242
}
4343

4444
/**
45-
* Retrieve configuration value by path
46-
*
47-
* @param null|string $path
48-
* @return array|string
45+
* @inheritdoc
4946
*/
5047
public function getValue($path = null)
5148
{
@@ -65,11 +62,7 @@ public function getValue($path = null)
6562
}
6663

6764
/**
68-
* Set configuration value
69-
*
70-
* @param string $path
71-
* @param mixed $value
72-
* @return void
65+
* @inheritdoc
7366
*/
7467
public function setValue($path, $value)
7568
{

lib/internal/Magento/Framework/App/Config/DataInterface.php

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,23 @@
66
namespace Magento\Framework\App\Config;
77

88
/**
9+
* Configuration data storage
10+
*
911
* @api
1012
*/
1113
interface DataInterface
1214
{
1315
/**
16+
* Retrieve configuration value by path
17+
*
1418
* @param string|null $path
15-
* @return string|array
19+
* @return mixed
1620
*/
1721
public function getValue($path);
1822

1923
/**
24+
* Set configuration value by path
25+
*
2026
* @param string $path
2127
* @param mixed $value
2228
* @return void

lib/internal/Magento/Framework/Locale/Currency.php

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,20 +49,15 @@ public function __construct(
4949
}
5050

5151
/**
52-
* Retrieve currency code
53-
*
54-
* @return string
52+
* @inheritdoc
5553
*/
5654
public function getDefaultCurrency()
5755
{
5856
return self::DEFAULT_CURRENCY;
5957
}
6058

6159
/**
62-
* Create \Zend_Currency object for current locale
63-
*
64-
* @param string $currency
65-
* @return \Magento\Framework\Currency
60+
* @inheritdoc
6661
*/
6762
public function getCurrency($currency)
6863
{

lib/internal/Magento/Framework/Locale/CurrencyInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@
1313
interface CurrencyInterface
1414
{
1515
/**
16-
* Retrieve currency code
16+
* Retrieve default currency code
1717
*
1818
* @return string
1919
*/
2020
public function getDefaultCurrency();
2121

2222
/**
23-
* Create \Magento\Framework\Currency object for current locale
23+
* Create Currency object for current locale
2424
*
2525
* @param string $currency
2626
* @return \Magento\Framework\Currency

0 commit comments

Comments
 (0)