Cleanup docblocks, especially removing unnecessary return definitions in constructors

frankmayer · frankmayer · commit 47e072ba97d2 · 2016-10-07T13:52:24.000+03:00
diff --git a/lib/triagens/ArangoDb/AqlUserFunction.php b/lib/triagens/ArangoDb/AqlUserFunction.php
@@ -97,7 +97,6 @@ class AqlUserFunction
      * @param Connection $connection - the connection to be used
      * @param array $attributesArray - user function initialization data
      *
-     * @return \triagens\ArangoDb\AqlUserFunction
      */
     public function __construct(Connection $connection, array $attributesArray = null)
     {
diff --git a/lib/triagens/ArangoDb/BatchPart.php b/lib/triagens/ArangoDb/BatchPart.php
@@ -83,7 +83,6 @@ class BatchPart
      * @param mixed $response The response string
      * @param mixed $options optional, options like sanitize, that can be passed to the request/response handler.
      *
-     * @return BatchPart
      */
 
     public function __construct($batch, $id, $type, $request, $response, $options)
diff --git a/lib/triagens/ArangoDb/Collection.php b/lib/triagens/ArangoDb/Collection.php
@@ -197,7 +197,6 @@ class Collection
      *
      * @param string $name - name for the collection
      *
-     * @return Collection
      */
     public function __construct($name = null)
     {
diff --git a/lib/triagens/ArangoDb/Connection.php b/lib/triagens/ArangoDb/Connection.php
@@ -106,7 +106,6 @@ class Connection
 	 *
 	 * @param array $options - initial connection options
 	 *
-	 * @return Connection
 	 */
 	public function __construct(array $options)
 	{
diff --git a/lib/triagens/ArangoDb/ConnectionOptions.php b/lib/triagens/ArangoDb/ConnectionOptions.php
@@ -199,7 +199,6 @@ class ConnectionOptions implements
 	 *
 	 * @param array $options - initial options
 	 *
-	 * @return \triagens\ArangoDb\ConnectionOptions
 	 */
 	public function __construct(array $options)
 	{
diff --git a/lib/triagens/ArangoDb/Cursor.php b/lib/triagens/ArangoDb/Cursor.php
@@ -172,7 +172,6 @@ class Cursor implements
      * @param array $data - initial result data as returned by the server
      * @param array $options - cursor options
      *
-     * @return Cursor
      */
     public function __construct(Connection $connection, array $data, array $options)
     {
diff --git a/lib/triagens/ArangoDb/Document.php b/lib/triagens/ArangoDb/Document.php
@@ -139,8 +139,7 @@ class Document
      *                                 <li>'hiddenAttributes'  - Deprecated, please use '_hiddenAttributes'.</li>
      *                                 <li>'_ignoreHiddenAttributes' - true to show hidden attributes. Defaults to false</li>
      *                                 <p>
-     *     *
-     * @return Document
+     *
      */
     public function __construct(array $options = null)
     {
diff --git a/lib/triagens/ArangoDb/EdgeDefinition.php b/lib/triagens/ArangoDb/EdgeDefinition.php
@@ -52,7 +52,7 @@ class EdgeDefinition
      * @param array $fromCollections - a list of collections providing the edges start vertices.
      * @param array $toCollections - a list of collections providing the edges end vertices.
      * @since     2.2
-     * @return EdgeDefinition
+     *
      */
     public function __construct($relation = null, $fromCollections = [], $toCollections = [])
     {
diff --git a/lib/triagens/ArangoDb/Endpoint.php b/lib/triagens/ArangoDb/Endpoint.php
@@ -84,7 +84,7 @@ class Endpoint
      * @param string $value - endpoint specification
      *
      * @throws ClientException
-     * @return \triagens\ArangoDb\Endpoint
+     *
      */
     public function __construct($value)
     {
diff --git a/lib/triagens/ArangoDb/ExportCursor.php b/lib/triagens/ArangoDb/ExportCursor.php
@@ -107,7 +107,6 @@ class ExportCursor
      * @param array $data - initial result data as returned by the server
      * @param array $options - cursor options
      *
-     * @return ExportCursor
      */
     public function __construct(Connection $connection, array $data, array $options)
     {
diff --git a/lib/triagens/ArangoDb/Graph.php b/lib/triagens/ArangoDb/Graph.php
@@ -71,7 +71,7 @@ class Graph extends
      * @param array $name - optional, initial name for graph
      * @param array $options - optional, initial options for graph
      * @since     1.2
-     * @return Graph
+     *
      */
     public function __construct($name = null, array $options = [])
     {
diff --git a/lib/triagens/ArangoDb/Handler.php b/lib/triagens/ArangoDb/Handler.php
@@ -31,7 +31,6 @@ abstract class Handler
      *
      * @param Connection $connection - connection to be used
      *
-     * @return Handler
      */
     public function __construct(Connection $connection)
     {
diff --git a/lib/triagens/ArangoDb/Transaction.php b/lib/triagens/ArangoDb/Transaction.php
@@ -132,7 +132,6 @@ class Transaction
      * @param Connection $connection - the connection to be used
      * @param array $transactionArray - transaction initialization data
      *
-     * @return \triagens\ArangoDb\Transaction
      */
     public function __construct(Connection $connection, array $transactionArray = null)
     {
diff --git a/lib/triagens/ArangoDb/Traversal.php b/lib/triagens/ArangoDb/Traversal.php
@@ -67,7 +67,6 @@ class Traversal
      * @param string $edgeCollection - user function initialization data
      * @param array $options
      *
-     * @return \triagens\ArangoDb\Traversal
      */
     public function __construct(Connection $connection, $startVertex, $edgeCollection, array $options = null)
     {

Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,6 @@ class AqlUserFunction`
`97`	`97`	`* @param Connection $connection - the connection to be used`
`98`	`98`	`* @param array $attributesArray - user function initialization data`
`99`	`99`	`*`
`100`		`- * @return \triagens\ArangoDb\AqlUserFunction`
`101`	`100`	`*/`
`102`	`101`	`public function __construct(Connection $connection, array $attributesArray = null)`
`103`	`102`	`{`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,6 @@ class BatchPart`
`83`	`83`	`* @param mixed $response The response string`
`84`	`84`	`* @param mixed $options optional, options like sanitize, that can be passed to the request/response handler.`
`85`	`85`	`*`
`86`		`- * @return BatchPart`
`87`	`86`	`*/`
`88`	`87`
`89`	`88`	`public function __construct($batch, $id, $type, $request, $response, $options)`
Original file line number	Diff line number	Diff line change
`@@ -197,7 +197,6 @@ class Collection`
`197`	`197`	`*`
`198`	`198`	`* @param string $name - name for the collection`
`199`	`199`	`*`
`200`		`- * @return Collection`
`201`	`200`	`*/`
`202`	`201`	`public function __construct($name = null)`
`203`	`202`	`{`
Original file line number	Diff line number	Diff line change
`@@ -106,7 +106,6 @@ class Connection`
`106`	`106`	`*`
`107`	`107`	`* @param array $options - initial connection options`
`108`	`108`	`*`
`109`		`- * @return Connection`
`110`	`109`	`*/`
`111`	`110`	`public function __construct(array $options)`
`112`	`111`	`{`
Original file line number	Diff line number	Diff line change
`@@ -199,7 +199,6 @@ class ConnectionOptions implements`
`199`	`199`	`*`
`200`	`200`	`* @param array $options - initial options`
`201`	`201`	`*`
`202`		`- * @return \triagens\ArangoDb\ConnectionOptions`
`203`	`202`	`*/`
`204`	`203`	`public function __construct(array $options)`
`205`	`204`	`{`
Original file line number	Diff line number	Diff line change
`@@ -172,7 +172,6 @@ class Cursor implements`
`172`	`172`	`* @param array $data - initial result data as returned by the server`
`173`	`173`	`* @param array $options - cursor options`
`174`	`174`	`*`
`175`		`- * @return Cursor`
`176`	`175`	`*/`
`177`	`176`	`public function __construct(Connection $connection, array $data, array $options)`
`178`	`177`	`{`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ class EdgeDefinition`
`52`	`52`	`* @param array $fromCollections - a list of collections providing the edges start vertices.`
`53`	`53`	`* @param array $toCollections - a list of collections providing the edges end vertices.`
`54`	`54`	`* @since 2.2`
`55`		`- * @return EdgeDefinition`
	`55`	`+ *`
`56`	`56`	`*/`
`57`	`57`	`public function __construct($relation = null, $fromCollections = [], $toCollections = [])`
`58`	`58`	`{`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ class Endpoint`
`84`	`84`	`* @param string $value - endpoint specification`
`85`	`85`	`*`
`86`	`86`	`* @throws ClientException`
`87`		`- * @return \triagens\ArangoDb\Endpoint`
	`87`	`+ *`
`88`	`88`	`*/`
`89`	`89`	`public function __construct($value)`
`90`	`90`	`{`
Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,6 @@ class ExportCursor`
`107`	`107`	`* @param array $data - initial result data as returned by the server`
`108`	`108`	`* @param array $options - cursor options`
`109`	`109`	`*`
`110`		`- * @return ExportCursor`
`111`	`110`	`*/`
`112`	`111`	`public function __construct(Connection $connection, array $data, array $options)`
`113`	`112`	`{`