Improve docblocks

This commit is contained in:
Dennis Eichhorn 2017-11-16 12:35:34 +01:00
parent ff9f1dbaea
commit b361ef438b

View File

@ -679,10 +679,7 @@ class Matrix implements \ArrayAccess, \Iterator
}
/**
* Return the current element
* @link http://php.net/manual/en/iterator.current.php
* @return mixed Can return any type.
* @since 5.0.0
* {@inheritdoc}
*/
public function current()
{
@ -690,13 +687,7 @@ class Matrix implements \ArrayAccess, \Iterator
}
/**
* Offset to retrieve
* @link http://php.net/manual/en/arrayaccess.offsetget.php
* @param mixed $offset <p>
* The offset to retrieve.
* </p>
* @return mixed Can return all value types.
* @since 5.0.0
* {@inheritdoc}
*/
public function offsetGet($offset)
{
@ -706,10 +697,7 @@ class Matrix implements \ArrayAccess, \Iterator
}
/**
* Move forward to next element
* @link http://php.net/manual/en/iterator.next.php
* @return void Any returned value is ignored.
* @since 5.0.0
* {@inheritdoc}
*/
public function next()
{
@ -717,10 +705,7 @@ class Matrix implements \ArrayAccess, \Iterator
}
/**
* Return the key of the current element
* @link http://php.net/manual/en/iterator.key.php
* @return mixed scalar on success, or null on failure.
* @since 5.0.0
* {@inheritdoc}
*/
public function key()
{
@ -728,11 +713,7 @@ class Matrix implements \ArrayAccess, \Iterator
}
/**
* Checks if current position is valid
* @link http://php.net/manual/en/iterator.valid.php
* @return boolean The return value will be casted to boolean and then evaluated.
* Returns true on success or false on failure.
* @since 5.0.0
* {@inheritdoc}
*/
public function valid()
{
@ -740,16 +721,7 @@ class Matrix implements \ArrayAccess, \Iterator
}
/**
* Whether a offset exists
* @link http://php.net/manual/en/arrayaccess.offsetexists.php
* @param mixed $offset <p>
* An offset to check for.
* </p>
* @return boolean true on success or false on failure.
* </p>
* <p>
* The return value will be casted to boolean if non-boolean was returned.
* @since 5.0.0
* {@inheritdoc}
*/
public function offsetExists($offset)
{
@ -759,10 +731,7 @@ class Matrix implements \ArrayAccess, \Iterator
}
/**
* Rewind the Iterator to the first element
* @link http://php.net/manual/en/iterator.rewind.php
* @return void Any returned value is ignored.
* @since 5.0.0
* {@inheritdoc}
*/
public function rewind()
{
@ -770,16 +739,7 @@ class Matrix implements \ArrayAccess, \Iterator
}
/**
* Offset to set
* @link http://php.net/manual/en/arrayaccess.offsetset.php
* @param mixed $offset <p>
* The offset to assign the value to.
* </p>
* @param mixed $value <p>
* The value to set.
* </p>
* @return void
* @since 5.0.0
* {@inheritdoc}
*/
public function offsetSet($offset, $value)
{
@ -788,13 +748,7 @@ class Matrix implements \ArrayAccess, \Iterator
}
/**
* Offset to unset
* @link http://php.net/manual/en/arrayaccess.offsetunset.php
* @param mixed $offset <p>
* The offset to unset.
* </p>
* @return void
* @since 5.0.0
* {@inheritdoc}
*/
public function offsetUnset($offset)
{