Skip to content

Commit

Permalink
PHPdoc formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
Smoren committed Mar 17, 2024
1 parent db36d26 commit fcaaa70
Show file tree
Hide file tree
Showing 7 changed files with 6 additions and 16 deletions.
1 change: 0 additions & 1 deletion src/Selectors/IndexListSelector.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
/**
* Represents an index list selector that selects elements based on the provided array of indexes.
*
* ##### Example
* ```php
* $originalArray = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
* $view = ArrayView::toView($originalArray);
Expand Down
1 change: 0 additions & 1 deletion src/Selectors/MaskSelector.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
/**
* Represents a mask selector that selects elements based on the provided array of boolean mask values.
*
* ##### Example
* ```php
* $originalArray = [1, 2, 3, 4, 5];
* $view = ArrayView::toView($originalArray);
Expand Down
1 change: 0 additions & 1 deletion src/Selectors/PipeSelector.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
/**
* Represents a selector that applies a series of selectors sequentially to a source array view.
*
* ##### Example
* ```php
* $originalArray = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
* $selector = new PipeSelector([
Expand Down
1 change: 0 additions & 1 deletion src/Selectors/SliceSelector.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
/**
* Represents a slice selector that selects elements based on the provided slice parameters.
*
* ##### Example
* ```php
* $originalArray = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
* $view = ArrayView::toView($originalArray);
Expand Down
6 changes: 2 additions & 4 deletions src/Views/ArrayIndexListView.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,11 @@
*
* Each element in the view is based on the specified indexes.
*
* <pre>
*
* ```php
* $source = [1, 2, 3, 4, 5];
* $view = ArrayView::toView($source)->subview(new IndexListSelector([0, 2, 4]));
* $view->toArray(); // [1, 3, 5]
*
* </pre>
* ```
*
* @template T Type of array source elements.
*
Expand Down
6 changes: 2 additions & 4 deletions src/Views/ArrayMaskView.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,11 @@
*
* Each element in the view is included or excluded based on the specified boolean mask.
*
* <pre>
*
* ```php
* $source = [1, 2, 3, 4, 5];
* $view = ArrayView::toView($source)->subview(new MaskSelector([true, false, true, false, true]));
* $view->toArray(); // [1, 3, 5]
*
* </pre>
* ```
*
* @template T Type of array source elements.
*
Expand Down
6 changes: 2 additions & 4 deletions src/Views/ArraySliceView.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,11 @@
* Class representing a slice-based view of an array or another ArrayView
* for accessing elements within a specified slice range.
*
* <pre>
*
* ```php
* $source = [1, 2, 3, 4, 5];
* $view = ArrayView::toView($source)->subview(new SliceSelector('::2'));
* $view->toArray(); // [1, 3, 5]
*
* </pre>
* ```
*
* @template T Type of array source elements.
*
Expand Down

0 comments on commit fcaaa70

Please sign in to comment.