Consolidate documentation

This commit is contained in:
Sebastian Meyer 2023-11-18 16:53:42 +01:00
parent 9266905a2b
commit 5f45256d23
6 changed files with 12 additions and 12 deletions

View File

@ -73,7 +73,7 @@ class StrictList extends SplDoublyLinkedList
*
* @return void
*
* @throws \InvalidArgumentException
* @throws InvalidArgumentException
*/
public function add(int $index, mixed $item): void
{
@ -90,7 +90,7 @@ class StrictList extends SplDoublyLinkedList
*
* @return void
*
* @throws \InvalidArgumentException
* @throws InvalidArgumentException
*/
public function append(mixed ...$items): void
{
@ -159,7 +159,7 @@ class StrictList extends SplDoublyLinkedList
*
* @return void
*
* @throws \InvalidArgumentException
* @throws InvalidArgumentException
*/
public function offsetSet(mixed $index, mixed $item): void
{
@ -176,7 +176,7 @@ class StrictList extends SplDoublyLinkedList
*
* @return void
*
* @throws \InvalidArgumentException
* @throws InvalidArgumentException
*/
public function prepend(mixed ...$items): void
{
@ -198,7 +198,7 @@ class StrictList extends SplDoublyLinkedList
*
* @return void
*
* @throws \InvalidArgumentException
* @throws InvalidArgumentException
*/
public function push(mixed $item): void
{
@ -240,7 +240,7 @@ class StrictList extends SplDoublyLinkedList
*
* @return void
*
* @throws \InvalidArgumentException
* @throws InvalidArgumentException
*/
public function unshift(mixed $item): void
{
@ -256,7 +256,7 @@ class StrictList extends SplDoublyLinkedList
* @param iterable $items Initial set of items
* @param string[] $allowedTypes Allowed types of items (optional)
*
* @throws \InvalidArgumentException
* @throws InvalidArgumentException
*/
public function __construct(iterable $items = [], array $allowedTypes = [])
{

View File

@ -45,7 +45,7 @@ class StrictQueue extends StrictList
*
* @return int The set of flags and modes of iteration
*
* @throws \RuntimeException
* @throws RuntimeException
*/
final public function setIteratorMode(int $mode): int
{

View File

@ -45,7 +45,7 @@ class StrictStack extends StrictList
*
* @return int The set of flags and modes of iteration
*
* @throws \RuntimeException
* @throws RuntimeException
*/
final public function setIteratorMode(int $mode): int
{

View File

@ -39,7 +39,7 @@ use ErrorException;
*
* @return bool Always returns FALSE when not throwing an exception
*
* @throws \ErrorException
* @throws ErrorException
*/
function throwErrorException(int $severity = E_ALL, string $message = '', ?string $file = null, ?int $line = null): bool
{

View File

@ -43,7 +43,7 @@ trait IteratorAggregate /* implements \IteratorAggregate */
* Retrieve an external iterator.
* @see \IteratorAggregate::getIterator()
*
* @return \ArrayIterator
* @return ArrayIterator
*/
public function getIterator(): ArrayIterator
{

View File

@ -62,7 +62,7 @@ trait Singleton
/**
* This is a singleton class, thus cloning is prohibited.
*
* @throws \LogicException
* @throws LogicException
*/
final public function __clone(): void
{