From 3b2e6de9b12139d262a6e408a6107cce02a12f08 Mon Sep 17 00:00:00 2001
From: "Nek (Maxime Veber)" <nek.dev@gmail.com>
Date: Fri, 2 Jan 2015 14:18:44 +0100
Subject: [PATCH] Added documentation about the feature

Doc update
---
 README.md                                     | 22 ++++++++++++++++++-
 .../Adapter/DoctrineORMNativeQueryAdapter.php |  1 +
 2 files changed, 22 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 507f5571..24df34c9 100644
--- a/README.md
+++ b/README.md
@@ -186,7 +186,7 @@ To paginate [DoctrineORM](http://www.doctrine-project.org/projects/orm) query ob
 ```php
 <?php
 
-use Pagerfanta\Adapter\DoctrineORMAdapter;
+use  Pagerfanta\Adapter\DoctrineORMAdapter;
 
 $queryBuilder = $entityManager->createQueryBuilder()
     ->select('u')
@@ -194,6 +194,26 @@ $queryBuilder = $entityManager->createQueryBuilder()
 $adapter = new DoctrineORMAdapter($queryBuilder);
 ```
 
+### DoctrineORMNativeQueryAdapter
+
+To paginate [Doctrine native queries](http://doctrine-orm.readthedocs.org/en/latest/reference/native-sql.html) objects.
+
+```php
+<?php
+
+use Pagerfanta\Adapter\DoctrineORMNativeQueryAdapter;
+use Doctrine\ORM\Query\ResultSetMappingBuilder;
+
+$query = 'SELECT * FROM article';
+
+$rsm = new ResultSetMappingBuilder($entityManager);
+$rsm->addRootEntityFromClassMetadata('Pagerfanta\Tests\Adapter\DoctrineORM\User', 'u');
+
+$adapter = new DoctrineORMNativeQueryAdapter($nq);
+```
+
+> The adapter accept 2 callable that should modify a given (as parameter) native query to respectively: make a count query / make a slice query
+
 ### DoctrineODMMongoDBAdapter
 
 To paginate [DoctrineODMMongoDB](http://www.doctrine-project.org/docs/mongodb_odm/1.0/en/) query builders.
diff --git a/src/Pagerfanta/Adapter/DoctrineORMNativeQueryAdapter.php b/src/Pagerfanta/Adapter/DoctrineORMNativeQueryAdapter.php
index 5c10dbe5..a661742f 100644
--- a/src/Pagerfanta/Adapter/DoctrineORMNativeQueryAdapter.php
+++ b/src/Pagerfanta/Adapter/DoctrineORMNativeQueryAdapter.php
@@ -38,6 +38,7 @@ class DoctrineORMNativeQueryAdapter implements AdapterInterface
     /**
      * @param NativeQuery  $query                     A DBAL query builder.
      * @param callable     $countQueryBuilderModifier A callable to modify the query to count.
+     * @param callable     $sliceQueryBuilderModifier A callable to modify the query to slice it (the default should do the job most part of the time).
      * @throws InvalidArgumentException
      */
     public function __construct(NativeQuery $query, $countQueryBuilderModifier = null, $sliceQueryBuilderModifier = null)