Skip to content

Commit 3c9c97e

Browse files
authored
fix colletion methods docblocks (#99)
1 parent 134f1bc commit 3c9c97e

File tree

4 files changed

+35
-0
lines changed

4 files changed

+35
-0
lines changed

src/Collection/GenericList.php

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,13 @@ public function map(callable $mapper): self
7676
return new Cons($mapper($this->head()), $this->tail()->map($mapper));
7777
}
7878

79+
/**
80+
* @template U
81+
*
82+
* @param callable(T): Traversable<U> $mapper
83+
*
84+
* @return GenericList<U>
85+
*/
7986
public function flatMap(callable $mapper)
8087
{
8188
$list = self::empty();
@@ -224,6 +231,9 @@ public function reverse(): self
224231
return $list;
225232
}
226233

234+
/**
235+
* @return GenericList<T>
236+
*/
227237
public function appendAll(Traversable $elements)
228238
{
229239
if ($elements->isEmpty()) {
@@ -233,6 +243,9 @@ public function appendAll(Traversable $elements)
233243
return self::ofAll($elements)->prependAll($this);
234244
}
235245

246+
/**
247+
* @return GenericList<T>
248+
*/
236249
public function prependAll(Traversable $elements)
237250
{
238251
if ($this->isEmpty()) {

src/Collection/Stream.php

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,13 @@ public function map(callable $mapper): self
174174
return new Cons($mapper($this->head()), function () use ($mapper) {return $this->tail()->map($mapper); });
175175
}
176176

177+
/**
178+
* @template U
179+
*
180+
* @param callable(T): Traversable<U> $mapper
181+
*
182+
* @return Stream<U>
183+
*/
177184
public function flatMap(callable $mapper)
178185
{
179186
$stream = self::empty();
@@ -292,6 +299,9 @@ public function prepend($element)
292299
return new Cons($element, function () {return $this; });
293300
}
294301

302+
/**
303+
* @return Stream<T>
304+
*/
295305
public function prependAll(Traversable $elements)
296306
{
297307
if ($elements->isEmpty()) {

src/Collection/Stream/Cons.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,13 +71,19 @@ public function iterator(): Iterator
7171
return new StreamIterator($this);
7272
}
7373

74+
/**
75+
* @return Stream<T>
76+
*/
7477
public function append($element)
7578
{
7679
return new Cons($this->head, function () use ($element) {
7780
return $this->tail()->append($element);
7881
});
7982
}
8083

84+
/**
85+
* @return Stream<T>
86+
*/
8187
public function appendAll(Traversable $elements)
8288
{
8389
if ($elements->isEmpty()) {

src/Collection/Stream/EmptyStream.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,17 @@ public function iterator(): Iterator
5151
return Iterator::empty();
5252
}
5353

54+
/**
55+
* @return Stream<T>
56+
*/
5457
public function append($element)
5558
{
5659
return Stream::of($element);
5760
}
5861

62+
/**
63+
* @return Stream<T>
64+
*/
5965
public function appendAll(Traversable $elements)
6066
{
6167
if ($elements->isEmpty()) {

0 commit comments

Comments
 (0)