Skip to content

Commit 613e4ea

Browse files
author
Joan He
committed
MAGETWO-35005: Investigate and Annotate @api to classes and/or methods
1 parent 7e25478 commit 613e4ea

File tree

4 files changed

+9
-108
lines changed

4 files changed

+9
-108
lines changed

‎lib/internal/Magento/Framework/App/Resource.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@ public function __construct(
8686
*
8787
* @param string $resourceName
8888
* @return \Magento\Framework\DB\Adapter\AdapterInterface|false
89-
* @api
9089
*/
9190
public function getConnection($resourceName)
9291
{

‎lib/internal/Magento/Framework/DB/Adapter/AdapterInterface.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
* Magento Database Adapter Interface
1212
*
1313
* @author Magento Core Team <core@magentocommerce.com>
14-
* @api
1514
*/
1615
interface AdapterInterface
1716
{

‎lib/internal/Magento/Framework/DB/Ddl/Table.php

Lines changed: 9 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -16,147 +16,68 @@
1616
class Table
1717
{
1818
/**
19-
* Column type boolean
20-
* @api
19+
* Types of columns
2120
*/
2221
const TYPE_BOOLEAN = 'boolean';
2322

24-
/**
25-
* Column type smallint
26-
* @api
27-
*/
2823
const TYPE_SMALLINT = 'smallint';
2924

30-
/**
31-
* Column type integer
32-
* @api
33-
*/
3425
const TYPE_INTEGER = 'integer';
3526

36-
/**
37-
* Column type bigint
38-
* @api
39-
*/
4027
const TYPE_BIGINT = 'bigint';
4128

42-
/**
43-
* Column type float
44-
* @api
45-
*/
4629
const TYPE_FLOAT = 'float';
4730

48-
/**
49-
* Column type numeric
50-
* @api
51-
*/
5231
const TYPE_NUMERIC = 'numeric';
5332

54-
/**
55-
* Column type decimal
56-
* @api
57-
*/
5833
const TYPE_DECIMAL = 'decimal';
5934

60-
/**
61-
* Column type date
62-
* @api
63-
*/
6435
const TYPE_DATE = 'date';
6536

66-
/**
67-
* Column type timestamp
68-
* @api
69-
*/
7037
const TYPE_TIMESTAMP = 'timestamp';
7138

72-
/**
73-
* Column type datetime, capable to support date-time from 1970 + auto-triggers in some RDBMS
74-
* @api
75-
*/
39+
// Capable to support date-time from 1970 + auto-triggers in some RDBMS
7640
const TYPE_DATETIME = 'datetime';
7741

78-
/**
79-
* Column type text, capable to support long date-time before 1970
80-
* @api
81-
*/
42+
// Capable to support long date-time before 1970
8243
const TYPE_TEXT = 'text';
8344

84-
/**
85-
* Column type blob
86-
* @api
87-
*/
8845
const TYPE_BLOB = 'blob';
8946

90-
/**
91-
* Column type varbinary, used for back compatibility, when query param can't use statement options
92-
* @api
93-
*/
47+
// Used for back compatibility, when query param can't use statement options
9448
const TYPE_VARBINARY = 'varbinary';
9549

50+
// A real blob, stored as binary inside DB
51+
9652
/**
97-
* Default TEXT columns sizes
98-
* @api
53+
* Default and maximal TEXT and BLOB columns sizes we can support for different DB systems.
9954
*/
10055
const DEFAULT_TEXT_SIZE = 1024;
10156

102-
/**
103-
* Maximal TEXT columns sizes
104-
* @api
105-
*/
10657
const MAX_TEXT_SIZE = 2147483648;
10758

108-
/**
109-
* Maximal BLOB columns sizes
110-
* @api
111-
*/
11259
const MAX_VARBINARY_SIZE = 2147483648;
11360

11461
/**
115-
* Default value for timestamps - fill with current timestamp on inserting record, on changing and both cases
116-
* @api
62+
* Default values for timestampses - fill with current timestamp on inserting record, on changing and both cases
11763
*/
11864
const TIMESTAMP_INIT_UPDATE = 'TIMESTAMP_INIT_UPDATE';
11965

120-
/**
121-
* Default value for timestamps - fill with current timestamp only on inserting record
122-
* @api
123-
*/
12466
const TIMESTAMP_INIT = 'TIMESTAMP_INIT';
12567

126-
/**
127-
* Default value for timestamps - fill with current timestamp only on changing record
128-
* @api
129-
*/
13068
const TIMESTAMP_UPDATE = 'TIMESTAMP_UPDATE';
13169

13270
/**
133-
* Cascade action used for foreign keys
134-
* @api
71+
* Actions used for foreign keys
13572
*/
13673
const ACTION_CASCADE = 'CASCADE';
13774

138-
/**
139-
* Set null action used for foreign keys
140-
* @api
141-
*/
14275
const ACTION_SET_NULL = 'SET NULL';
14376

144-
/**
145-
* No action action used for foreign keys
146-
* @api
147-
*/
14877
const ACTION_NO_ACTION = 'NO ACTION';
14978

150-
/**
151-
* Restrict action used for foreign keys
152-
* @api
153-
*/
15479
const ACTION_RESTRICT = 'RESTRICT';
15580

156-
/**
157-
* Set default action used for foreign keys
158-
* @api
159-
*/
16081
const ACTION_SET_DEFAULT = 'SET DEFAULT';
16182

16283
/**
@@ -261,7 +182,6 @@ class Table
261182
*
262183
* @param string $name
263184
* @return $this
264-
* @api
265185
*/
266186
public function setName($name)
267187
{
@@ -277,7 +197,6 @@ public function setName($name)
277197
*
278198
* @param string $name
279199
* @return $this
280-
* @api
281200
*/
282201
public function setSchema($name)
283202
{
@@ -290,7 +209,6 @@ public function setSchema($name)
290209
*
291210
* @param string $comment
292211
* @return $this
293-
* @api
294212
*/
295213
public function setComment($comment)
296214
{
@@ -303,7 +221,6 @@ public function setComment($comment)
303221
*
304222
* @return string
305223
* @throws \Zend_Db_Exception
306-
* @api
307224
*/
308225
public function getName()
309226
{
@@ -317,7 +234,6 @@ public function getName()
317234
* Get schema name
318235
*
319236
* @return string|null
320-
* @api
321237
*/
322238
public function getSchema()
323239
{
@@ -328,7 +244,6 @@ public function getSchema()
328244
* Return comment for table
329245
*
330246
* @return string
331-
* @api
332247
*/
333248
public function getComment()
334249
{
@@ -358,7 +273,6 @@ public function getComment()
358273
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
359274
* @SuppressWarnings(PHPMD.NPathComplexity)
360275
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
361-
* @api
362276
*/
363277
public function addColumn($name, $type, $size = null, $options = [], $comment = null)
364278
{
@@ -495,7 +409,6 @@ public function addColumn($name, $type, $size = null, $options = [], $comment =
495409
* @return $this
496410
* @throws \Zend_Db_Exception
497411
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
498-
* @api
499412
*/
500413
public function addForeignKey($fkName, $column, $refTable, $refColumn, $onDelete = null, $onUpdate = null)
501414
{
@@ -547,7 +460,6 @@ public function addForeignKey($fkName, $column, $refTable, $refColumn, $onDelete
547460
* @return $this
548461
* @throws \Zend_Db_Exception
549462
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
550-
* @api
551463
*/
552464
public function addIndex($indexName, $fields, $options = [])
553465
{
@@ -615,7 +527,6 @@ public function addIndex($indexName, $fields, $options = [])
615527
* @param bool $normalized
616528
* @see $this->_columns
617529
* @return array
618-
* @api
619530
*/
620531
public function getColumns($normalized = true)
621532
{
@@ -631,7 +542,6 @@ public function getColumns($normalized = true)
631542
* @param array $column
632543
* @see $this->_columns
633544
* @return $this
634-
* @api
635545
*/
636546
public function setColumn($column)
637547
{
@@ -645,7 +555,6 @@ public function setColumn($column)
645555
*
646556
* @see $this->_indexes
647557
* @return array
648-
* @api
649558
*/
650559
public function getIndexes()
651560
{
@@ -657,7 +566,6 @@ public function getIndexes()
657566
*
658567
* @see $this->_foreignKeys
659568
* @return array
660-
* @api
661569
*/
662570
public function getForeignKeys()
663571
{
@@ -670,7 +578,6 @@ public function getForeignKeys()
670578
* @param string $key
671579
* @param string $value
672580
* @return $this
673-
* @api
674581
*/
675582
public function setOption($key, $value)
676583
{
@@ -684,7 +591,6 @@ public function setOption($key, $value)
684591
*
685592
* @param string $key
686593
* @return null|string
687-
* @api
688594
*/
689595
public function getOption($key)
690596
{
@@ -698,7 +604,6 @@ public function getOption($key)
698604
* Retrieve array of table options
699605
*
700606
* @return array
701-
* @api
702607
*/
703608
public function getOptions()
704609
{

‎lib/internal/Magento/Framework/Model/Resource/AbstractResource.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,13 @@ abstract protected function _construct();
4747
* Retrieve connection for read data
4848
*
4949
* @return \Magento\Framework\DB\Adapter\AdapterInterface
50-
* @api
5150
*/
5251
abstract protected function _getReadAdapter();
5352

5453
/**
5554
* Retrieve connection for write data
5655
*
5756
* @return \Magento\Framework\DB\Adapter\AdapterInterface
58-
* @api
5957
*/
6058
abstract protected function _getWriteAdapter();
6159

0 commit comments

Comments
 (0)