Skip to content

Commit eaf18e2

Browse files
committed
Normalize docblocks
- Move class metadata annotations to the class docblock, not an arbitrary docblock at the start of the file - Remove inconsistent docblocks before the namespace declaration. File metadata is better retrieved via `git blame`
1 parent 5c304a2 commit eaf18e2

File tree

171 files changed

+60
-919
lines changed

Some content is hidden

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

171 files changed

+60
-919
lines changed

benchmarks/Elasticsearch/Benchmarks/AsyncVsSyncIndexingEvent.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
<?php
2-
/**
3-
* User: zach
4-
* Date: 6/14/13
5-
* Time: 11:13 AM
6-
*/
72

83
namespace Elasticsearch\Benchmarks;
94

benchmarks/Elasticsearch/Benchmarks/SequentialIndexingEvent.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
<?php
2-
/**
3-
* User: zach
4-
* Date: 6/14/13
5-
* Time: 11:13 AM
6-
*/
72

83
namespace Elasticsearch\Benchmarks;
94

src/Elasticsearch/Client.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
<?php
2-
/**
3-
* User: zach
4-
* Date: 5/1/13
5-
* Time: 11:41 AM
6-
*/
72

83
namespace Elasticsearch;
94

src/Elasticsearch/Common/EmptyLogger.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
<?php
2-
/**
3-
* User: zach
4-
* Date: 11/11/13
5-
* Time: 3:32 PM
6-
*/
72

83
namespace Elasticsearch\Common;
94

src/Elasticsearch/Common/Exceptions/AlreadyExpiredException.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
<?php
2-
/**
3-
* User: zach
4-
* Date: 7/23/13
5-
* Time: 2:32 PM
6-
*/
72

83
namespace Elasticsearch\Common\Exceptions;
94

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
<?php
2+
3+
namespace Elasticsearch\Common\Exceptions;
4+
25
/**
3-
* User: zach
4-
* Date: 5/1/13
5-
* Time: 12:16 PM
6+
* BadMethodCallException
7+
*
8+
* Denote problems with a method call (e.g. incorrect number of arguments)
69
*
710
* @category Elasticsearch
811
* @package Elasticsearch\Common\Exceptions
912
* @author Zachary Tong <[email protected]>
1013
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache2
1114
* @link http://elasticsearch.org
1215
*/
13-
namespace Elasticsearch\Common\Exceptions;
14-
15-
/**
16-
* BadMethodCallException
17-
* Denote problems with a method call (e.g. incorrect number of arguments)
18-
*/
1916
class BadMethodCallException extends \BadMethodCallException implements ElasticsearchException
2017
{
2118
}

src/Elasticsearch/Common/Exceptions/ClientErrorResponseException.php

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,15 @@
11
<?php
2+
3+
namespace Elasticsearch\Common\Exceptions;
4+
25
/**
3-
* User: zach
4-
* Date: 5/7/13
5-
* Time: 3:04 PM
6-
*
6+
* Class ClientErrorResponseException
7+
*
78
* @category Elasticsearch
89
* @package Elasticsearch\Common\Exceptions
910
* @author Zachary Tong <[email protected]>
1011
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache2
11-
* @link http://elasticsearch.org
12-
*/
13-
namespace Elasticsearch\Common\Exceptions;
14-
15-
/**
16-
* Class ClientErrorResponseException
17-
* @package Elasticsearch\Common\Exceptions
12+
* @link http://elasticsearch.org
1813
*/
1914
class ClientErrorResponseException extends TransportException implements ElasticsearchException
2015
{

src/Elasticsearch/Common/Exceptions/Curl/CouldNotConnectToHost.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
<?php
2-
/**
3-
* User: zach
4-
* Date: 6/17/13
5-
* Time: 3:14 PM
6-
*/
72

83
namespace Elasticsearch\Common\Exceptions\Curl;
94

src/Elasticsearch/Common/Exceptions/Curl/CouldNotResolveHostException.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
<?php
2-
/**
3-
* User: zach
4-
* Date: 6/17/13
5-
* Time: 2:46 PM
6-
*/
72

83
namespace Elasticsearch\Common\Exceptions\Curl;
94

src/Elasticsearch/Common/Exceptions/Curl/OperationTimeoutException.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
<?php
2-
/**
3-
* User: zach
4-
* Date: 9/19/13
5-
* Time: 3:53 PM
6-
*/
72

83
namespace Elasticsearch\Common\Exceptions\Curl;
94

src/Elasticsearch/Common/Exceptions/ElasticsearchException.php

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,4 @@
11
<?php
2-
/**
3-
* User: zach
4-
* Date: 5/1/13
5-
* Time: 12:16 PM
6-
*
7-
* @category Elasticsearch
8-
* @package Elasticsearch\Common\Exceptions
9-
* @author Zachary Tong <[email protected]>
10-
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache2
11-
* @link http://elasticsearch.org
12-
*/
132

143
namespace Elasticsearch\Common\Exceptions;
154

src/Elasticsearch/Common/Exceptions/Forbidden403Exception.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
11
<?php
2-
/**
3-
* User: zach
4-
* Date: 9/25/13
5-
* Time: 4:23 PM
6-
*
7-
*/
82

93
namespace Elasticsearch\Common\Exceptions;
104

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
<?php
2+
3+
namespace Elasticsearch\Common\Exceptions;
4+
25
/**
3-
* User: zach
4-
* Date: 5/1/13
5-
* Time: 12:16 PM
6+
* InvalidArgumentException
7+
*
8+
* Denote invalid or incorrect argument values
69
*
710
* @category Elasticsearch
811
* @package Elasticsearch\Common\Exceptions
912
* @author Zachary Tong <[email protected]>
1013
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache2
1114
* @link http://elasticsearch.org
1215
*/
13-
namespace Elasticsearch\Common\Exceptions;
14-
15-
/**
16-
* InvalidArgumentException
17-
* Denote invalid or incorrect argument values
18-
*/
1916
class InvalidArgumentException extends \InvalidArgumentException implements ElasticsearchException
2017
{
2118
}
Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
<?php
2+
3+
namespace Elasticsearch\Common\Exceptions;
4+
25
/**
3-
* User: zach
4-
* Date: 5/6/13
5-
* Time: 4:48 PM
6+
* BadMethodCallException
7+
*
8+
* Denote problems with a method call (e.g. incorrect number of arguments)
69
*
710
* @category Elasticsearch
811
* @package Elasticsearch\Common\Exceptions
912
* @author Zachary Tong <[email protected]>
1013
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache2
1114
* @link http://elasticsearch.org
1215
*/
13-
namespace Elasticsearch\Common\Exceptions;
14-
15-
/**
16-
* BadMethodCallException
17-
* Denote problems with a method call (e.g. incorrect number of arguments)
18-
*/
1916
class MaxRetriesException extends \Exception implements ElasticsearchException
2017
{
2118
}

src/Elasticsearch/Common/Exceptions/Missing404Exception.php

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,4 @@
11
<?php
2-
/**
3-
* User: zach
4-
* Date: 5/1/13
5-
* Time: 12:16 PM
6-
*
7-
* @category Elasticsearch
8-
* @package Elasticsearch\Common\Exceptions
9-
* @author Zachary Tong <[email protected]>
10-
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache2
11-
* @link http://elasticsearch.org
12-
*/
132

143
namespace Elasticsearch\Common\Exceptions;
154

src/Elasticsearch/Common/Exceptions/NoDocumentsToGetException.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
11
<?php
2-
/**
3-
* User: zach
4-
* Date: 7/23/13
5-
* Time: 5:05 PM
6-
*/
7-
82

93
namespace Elasticsearch\Common\Exceptions;
104

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,16 @@
11
<?php
2+
3+
namespace Elasticsearch\Common\Exceptions;
4+
25
/**
3-
* User: zach
4-
* Date: 9/19/13
5-
* Time: 9:27 AM
6+
* NoNodesAvailableException
7+
*
68
* @category Elasticsearch
79
* @package Elasticsearch\Common\Exceptions
810
* @author Zachary Tong <[email protected]>
911
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache2
1012
* @link http://elasticsearch.org
1113
*/
12-
namespace Elasticsearch\Common\Exceptions;
13-
14-
/**
15-
* NoNodesAvailableException
16-
*/
1714
class NoNodesAvailableException extends \Exception implements ElasticsearchException
1815
{
1916
}

src/Elasticsearch/Common/Exceptions/NoShardAvailableException.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
<?php
2-
/**
3-
* User: zach
4-
* Date: 7/25/13
5-
* Time: 2:15 PM
6-
*/
72

83
namespace Elasticsearch\Common\Exceptions;
94

src/Elasticsearch/Common/Exceptions/RoutingMissingException.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
<?php
2-
/**
3-
* User: zach
4-
* Date: 7/23/13
5-
* Time: 1:05 PM
6-
*/
72

83
namespace Elasticsearch\Common\Exceptions;
94

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,16 @@
11
<?php
2-
/**
3-
* User: zach
4-
* Date: 5/7/13
5-
* Time: 11:51 AM
6-
*/
2+
3+
namespace Elasticsearch\Common\Exceptions;
74

85
/**
6+
* RuntimeException
7+
*
98
* @category Elasticsearch
109
* @package Elasticsearch\Common\Exceptions
1110
* @author Zachary Tong <[email protected]>
1211
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache2
1312
* @link http://elasticsearch.org
1413
*/
15-
namespace Elasticsearch\Common\Exceptions;
16-
17-
/**
18-
* RuntimeException
19-
*/
2014
class RuntimeException extends \RuntimeException implements ElasticsearchException
2115
{
2216
}

src/Elasticsearch/Common/Exceptions/ScriptLangNotSupportedException.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
11
<?php
2-
/**
3-
* User: zach
4-
* Date: 7/25/13
5-
* Time: 2:51 PM
6-
*/
7-
82

93
namespace Elasticsearch\Common\Exceptions;
104

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
11
<?php
2+
3+
namespace Elasticsearch\Common\Exceptions;
4+
25
/**
3-
* User: zach
4-
* Date: 5/7/13
5-
* Time: 3:04 PM
6+
* ServerErrorResponseException
67
*
78
* @category Elasticsearch
89
* @package Elasticsearch\Common\Exceptions
910
* @author Zachary Tong <[email protected]>
1011
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache2
1112
* @link http://elasticsearch.org
1213
*/
13-
namespace Elasticsearch\Common\Exceptions;
14-
15-
/**
16-
* ServerErrorResponseException
17-
*/
1814
class ServerErrorResponseException extends TransportException implements ElasticsearchException
1915
{
2016
}
Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
<?php
2+
3+
namespace Elasticsearch\Common\Exceptions;
4+
25
/**
3-
* User: zach
4-
* Date: 5/6/13
5-
* Time: 4:48 PM
6+
* BadMethodCallException
7+
*
8+
* Denote problems with a method call (e.g. incorrect number of arguments)
69
*
710
* @category Elasticsearch
811
* @package Elasticsearch\Common\Exceptions
912
* @author Zachary Tong <[email protected]>
1013
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache2
1114
* @link http://elasticsearch.org
1215
*/
13-
namespace Elasticsearch\Common\Exceptions;
14-
15-
/**
16-
* BadMethodCallException
17-
* Denote problems with a method call (e.g. incorrect number of arguments)
18-
*/
1916
class TransportException extends \Exception implements ElasticsearchException
2017
{
2118
}

0 commit comments

Comments
 (0)