From d9448e603b453b84ae68cadd098998f1a1523c34 Mon Sep 17 00:00:00 2001 From: euromark Date: Thu, 30 Oct 2014 14:45:37 +0100 Subject: [PATCH] More doc block corrections. --- src/Collection/CollectionInterface.php | 22 +++++++++++----------- src/Collection/Iterator/SortIterator.php | 2 +- src/Datasource/QueryTrait.php | 2 +- src/Datasource/RepositoryInterface.php | 2 +- src/ORM/Association/BelongsToMany.php | 4 ++-- 5 files changed, 16 insertions(+), 16 deletions(-) diff --git a/src/Collection/CollectionInterface.php b/src/Collection/CollectionInterface.php index c3f3e4de10c..cc7638443d1 100644 --- a/src/Collection/CollectionInterface.php +++ b/src/Collection/CollectionInterface.php @@ -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) { @@ -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) { @@ -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) { @@ -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 @@ -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 @@ -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) { @@ -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 = [ @@ -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 = [ @@ -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 = [ @@ -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 = [ @@ -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 = [ diff --git a/src/Collection/Iterator/SortIterator.php b/src/Collection/Iterator/SortIterator.php index 82285cb91a7..6356a8769aa 100644 --- a/src/Collection/Iterator/SortIterator.php +++ b/src/Collection/Iterator/SortIterator.php @@ -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]; diff --git a/src/Datasource/QueryTrait.php b/src/Datasource/QueryTrait.php index 3d2d92c0ee3..74d5a02f257 100644 --- a/src/Datasource/QueryTrait.php +++ b/src/Datasource/QueryTrait.php @@ -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']); diff --git a/src/Datasource/RepositoryInterface.php b/src/Datasource/RepositoryInterface.php index 911d3978cd8..2521d042e9f 100644 --- a/src/Datasource/RepositoryInterface.php +++ b/src/Datasource/RepositoryInterface.php @@ -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; diff --git a/src/ORM/Association/BelongsToMany.php b/src/ORM/Association/BelongsToMany.php index e692ed7b4d6..aa370b7af2c 100644 --- a/src/ORM/Association/BelongsToMany.php +++ b/src/ORM/Association/BelongsToMany.php @@ -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]; @@ -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];