From b361ef438ba44245f96303bd6c40472c0adf6651 Mon Sep 17 00:00:00 2001
From: Dennis Eichhorn
Date: Thu, 16 Nov 2017 12:35:34 +0100
Subject: [PATCH] Improve docblocks
---
Math/Matrix/Matrix.php | 64 ++++++------------------------------------
1 file changed, 9 insertions(+), 55 deletions(-)
diff --git a/Math/Matrix/Matrix.php b/Math/Matrix/Matrix.php
index f778370db..adee15425 100644
--- a/Math/Matrix/Matrix.php
+++ b/Math/Matrix/Matrix.php
@@ -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
- * The offset to retrieve.
- *
- * @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
- * An offset to check for.
- *
- * @return boolean true on success or false on failure.
- *
- *
- * 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
- * The offset to assign the value to.
- *
- * @param mixed $value
- * The value to set.
- *
- * @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
- * The offset to unset.
- *
- * @return void
- * @since 5.0.0
+ * {@inheritdoc}
*/
public function offsetUnset($offset)
{