From 92fe0e791158a6c304692aaa5dbfaef9a6b45fd6 Mon Sep 17 00:00:00 2001
From: Jose Lorenzo Rodriguez <jose.zap@gmail.com>
Date: Thu, 13 Mar 2014 23:30:40 +0100
Subject: [PATCH] Adding doc blocks for recent paginator changes

---
 src/Controller/Component/PaginatorComponent.php | 9 +++++++++
 src/Controller/Controller.php                   | 3 ++-
 2 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/src/Controller/Component/PaginatorComponent.php b/src/Controller/Component/PaginatorComponent.php
index 6040a46c8b8..7993ab83d26 100644
--- a/src/Controller/Component/PaginatorComponent.php
+++ b/src/Controller/Component/PaginatorComponent.php
@@ -128,6 +128,15 @@ class PaginatorComponent extends Component {
  *
  * Would paginate using the `find('popular')` method.
  *
+ * You can also pass an already created instance of a query to this method:
+ *
+ * {{{
+ * $query = $this->Articles->find('popular')->matching('Tags', function($q) {
+ *	return $q->where(['name' => 'CakePHP'])
+ * });
+ * $results = $paginator->paginate($query);
+ * }}}
+ *
  * @param Cake\Datasource\RepositoryInterface|Cake\ORM\Query $object The table or query to paginate.
  * @param array $settings The settings/configuration used for pagination.
  * @return array Query results
diff --git a/src/Controller/Controller.php b/src/Controller/Controller.php
index 106ff615eb6..2b15d688472 100644
--- a/src/Controller/Controller.php
+++ b/src/Controller/Controller.php
@@ -656,7 +656,8 @@ public function referer($default = null, $local = false) {
  *
  * This method will also make the PaginatorHelper available in the view.
  *
- * @param Table|string $object Table to paginate (e.g: Table instance, or 'Model')
+ * @param Table|string|Query $object Table to paginate
+ * (e.g: Table instance, 'TableName' or a Query object)
  * @return ORM\ResultSet Query results
  * @link http://book.cakephp.org/3.0/en/controllers.html#Controller::paginate
  */