Skip to content

Commit

Permalink
More doc block corrections.
Browse files Browse the repository at this point in the history
  • Loading branch information
euromark committed Oct 30, 2014
1 parent c364e5e commit d9448e6
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 16 deletions.
22 changes: 11 additions & 11 deletions src/Collection/CollectionInterface.php
Expand Up @@ -30,7 +30,7 @@ interface CollectionInterface extends Iterator, JsonSerializable {
* and passes both the value and key for them on each step.
* Returns the same collection for chaining.
*
* ###Example:
* ### Example:
*
* {{{
* $collection = (new Collection($items))->each(function ($value, $key) {
Expand Down Expand Up @@ -104,7 +104,7 @@ public function reject(callable $c);
* in the current iteration and the key of the element as arguments, in that
* order.
*
* ###Example:
* ### Example:
*
* {{{
* $overTwentyOne = (new Collection([24, 45, 60, 15]))->every(function ($value, $key) {
Expand All @@ -126,7 +126,7 @@ public function every(callable $c);
* in the current iteration and the key of the element as arguments, in that
* order.
*
* ###Example:
* ### Example:
*
* {{{
* $hasYoungPeople = (new Collection([24, 45, 15]))->every(function ($value, $key) {
Expand Down Expand Up @@ -220,7 +220,7 @@ public function extract($matcher);
* Returns the top element in this collection after being sorted by a property.
* Check the sortBy method for information on the callback and $type parameters
*
* ###Examples:
* ### Examples:
*
* {{{
* // For a collection of employees
Expand All @@ -246,7 +246,7 @@ public function max($callback, $type = SORT_NUMERIC);
* Returns the bottom element in this collection after being sorted by a property.
* Check the sortBy method for information on the callback and $type parameters
*
* ###Examples:
* ### Examples:
*
* {{{
* // For a collection of employees
Expand Down Expand Up @@ -279,7 +279,7 @@ public function min($callback, $type = SORT_NUMERIC);
* element. Please note that the callback function could be called more than once
* per element.
*
* ###Example:
* ### Example:
*
* {{{
* $items = $collection->sortBy(function ($user) {
Expand Down Expand Up @@ -315,7 +315,7 @@ public function sortBy($callback, $dir = SORT_DESC, $type = SORT_NUMERIC);
* a dot separated path of properties that should be followed to get the last
* one in the path.
*
* ###Example:
* ### Example:
*
* {{{
* $items = [
Expand Down Expand Up @@ -358,7 +358,7 @@ public function groupBy($callback);
* a dot separated path of properties that should be followed to get the last
* one in the path.
*
* ###Example:
* ### Example:
*
* {{{
* $items = [
Expand Down Expand Up @@ -397,7 +397,7 @@ public function indexBy($callback);
* a dot separated path of properties that should be followed to get the last
* one in the path.
*
* ###Example:
* ### Example:
*
* {{{
* $items = [
Expand Down Expand Up @@ -430,7 +430,7 @@ public function countBy($callback);
* Returns the total sum of all the values extracted with $matcher
* or of this collection.
*
* ###Example:
* ### Example:
*
* {{{
* $items = [
Expand Down Expand Up @@ -483,7 +483,7 @@ public function take($size = 1, $from = 0);
* Looks through each value in the list, returning a Collection of all the
* values that contain all of the key-value pairs listed in $conditions.
*
* ###Example:
* ### Example:
*
* {{{
* $items = [
Expand Down
2 changes: 1 addition & 1 deletion src/Collection/Iterator/SortIterator.php
Expand Up @@ -21,7 +21,7 @@
* An iterator that will return the passed items in order. The order is given by
* the value returned in a callback function that maps each of the elements.
*
* ###Example:
* ### Example:
*
* {{{
* $items = [$user1, $user2, $user3];
Expand Down
2 changes: 1 addition & 1 deletion src/Datasource/QueryTrait.php
Expand Up @@ -339,7 +339,7 @@ public function first() {
* Returns an array with the custom options that were applied to this query
* and that were not already processed by another method in this class.
*
* ###Example:
* ### Example:
*
* {{{
* $query->applyOptions(['doABarrelRoll' => true, 'fields' => ['id', 'name']);
Expand Down
2 changes: 1 addition & 1 deletion src/Datasource/RepositoryInterface.php
Expand Up @@ -41,7 +41,7 @@ public function find($type = 'all', $options = []);
* Returns a single record after finding it by its primary key, if no record is
* found this method throws an exception.
*
* ###Example:
* ### Example:
*
* {{{
* $id = 10;
Expand Down
4 changes: 2 additions & 2 deletions src/ORM/Association/BelongsToMany.php
Expand Up @@ -571,7 +571,7 @@ function () use ($sourceEntity, $targetEntities, $options) {
* By default this method will also unset each of the entity objects stored inside
* the source entity.
*
* ###Example:
* ### Example:
*
* {{{
* $article->tags = [$tag1, $tag2, $tag3, $tag4];
Expand Down Expand Up @@ -653,7 +653,7 @@ function () use ($sourceEntity, $targetEntities) {
* Additional options for new links to be saved can be passed in the third argument,
* check `Table::save()` for information on the accepted options.
*
* ###Example:
* ### Example:
*
* {{{
* $article->tags = [$tag1, $tag2, $tag3, $tag4];
Expand Down

0 comments on commit d9448e6

Please sign in to comment.