Permalink
Browse files

[reactivemongo] Fix scaladoc

  • Loading branch information...
cchantep
cchantep committed Sep 25, 2014
1 parent b663965 commit 8fe2ef491a7601ab1916838c92c5277b983db62c
View
@@ -1,3 +1,9 @@
## 1.0.26
([646c8f57fccf605d97e2318adebb4b2540d5514b](https://github.com/cchantep/acolyte/commit/646c8f57fccf605d97e2318adebb4b2540d5514b) @ [reactivemongo](https://github.com/cchantep/acolyte/tree/master/reactivemongo)) Refactor DSL and better support for Count command.
([cb826da6c11d9eac28a9e7a392423fc28aae5a2b](https://github.com/cchantep/acolyte/commit/cb826da6c11d9eac28a9e7a392423fc28aae5a2b) @ [reactivemongo](https://github.com/cchantep/acolyte/tree/master/reactivemongo)) Count response.
## 1.0.25
([919d248bff3afd5549e240e4d871b86a32d6f3db](https://github.com/cchantep/acolyte/commit/919d248bff3afd5549e240e4d871b86a32d6f3db) @ [reactivemongo](https://github.com/cchantep/acolyte/tree/master/reactive-mongo)) Fix doc
View
@@ -1,6 +1,6 @@
#! /bin/sh
LIMIT="9c5d5806bf90bdf8760da0a1c93222b685ce716a"
LIMIT="646c8f57fccf605d97e2318adebb4b2540d5514b"
echo "## $1\n"
View
@@ -266,6 +266,10 @@ val queryHandler = QueryHandler { queryRequest =>
case CountRequest(colName, ("email", "em@il.net") :: Nil) =>
// Matching on count query
resultK
case RequestBody("col1", ("$in", ValueList(bsonA, bsonB)) :: Nil) =>
// Matching BSONArray using with $in operator
resultL
}
}
```
@@ -56,7 +56,7 @@ object Request {
/**
* Extractor of properties for a document used a BSON value
* (when operator is used, e.g. `{ 'age': { '$gt': 10 } }`).
* (when operator is used, e.g. `{ 'age': { '\$gt': 10 } }`).
*
* @see RequestBody
* @see Property
@@ -101,10 +101,10 @@ object ValueList {
* resultD
*
* case RequestBody(_, ("age": ValueDocument(
* ("$gt", BSONInteger(minAge)) :: Nil))) =>
* ("\$gt", BSONInteger(minAge)) :: Nil))) =>
* // Request on any collection, with an "age" document as property,
* // itself with exactly one integer "$gt" property
* // e.g. `{ 'age': { '$gt', 10 } }`
* // itself with exactly one integer "\$gt" property
* // e.g. `{ 'age': { '\$gt', 10 } }`
* resultE
* }
* }}}
@@ -185,10 +185,10 @@ object & {
*
* case RequestBody(colName,
* ~(Property("age"), ValueDocument(
* ~(Property("$gt"), BSONInteger(minAge)))) &
* ~(Property("\$gt"), BSONInteger(minAge)))) &
* ~(Property("email"), BSONString("demo@applicius.fr"))) =>
* // Request on any collection, with an "age" property with itself
* // a operator property "$gt" having an integer value, and an "email"
* // a operator property "\$gt" having an integer value, and an "email"
* // property (at the same level as age), without order constraint.
* resultE
*
@@ -27,7 +27,7 @@ trait WithCollection { withDB: WithDB ⇒
* "Result"
* }
* }}}
* @see [[AcolyteDSL.withFlatDB]]
* @see AcolyteDSL.withFlatDB[A,B]
*/
def withCollection[A, B](driverParam: A, name: String)(f: BSONCollection B)(implicit m: DriverManager[A], c: ExecutionContext): Future[B] =
withFlatDB(driverParam) { db Future(f(db(name))) }
@@ -51,7 +51,7 @@ trait WithCollection { withDB: WithDB ⇒
* }
* }
* }}}
* @see [[WithDriver.withFlatDB]]
* @see WithDriver.withFlatDB[T]
*/
def withCollection[T](con: MongoConnection, name: String)(f: BSONCollection T)(implicit c: ExecutionContext): Future[T] = withFlatDB(con) { db Future(f(db(name))) }
@@ -98,7 +98,7 @@ trait WithCollection { withDB: WithDB ⇒
* Future(1 + 2)
* }
* }}}
* @see [[AcolyteDSL.withFlatDB]]
* @see AcolyteDSL.withFlatDB[A,B]
*/
def withFlatCollection[A, B](driverParam: A, name: String)(f: BSONCollection Future[B])(implicit m: DriverManager[A], c: ExecutionContext): Future[B] =
withFlatDB(driverParam) { db f(db(name)) }
@@ -122,7 +122,7 @@ trait WithCollection { withDB: WithDB ⇒
* }
* }
* }}}
* @see [[WithDriver.withFlatDB]]
* @see WithDriver.withFlatDB[T]
*/
def withFlatCollection[T](con: MongoConnection, name: String)(f: BSONCollection Future[T])(implicit c: ExecutionContext): Future[T] = withFlatDB(con) { db f(db(name)) }
@@ -25,8 +25,8 @@ trait WithDB { withDriver: WithDriver =>
* "Result"
* }
* }}}
* @see [[AcolyteDSL.withConnection]]
* @see [[withFlatDB]]
* @see AcolyteDSL.withConnection
* @see withFlatDB[A,B]
*/
def withDB[A, B](driverParam: A)(f: DB B)(implicit m: DriverManager[A], c: ExecutionContext): Future[B] = withConnection(driverParam) {
con f(con("acolyte"))
@@ -52,8 +52,8 @@ trait WithDB { withDriver: WithDriver =>
* }
* }
* }}}
* @see [[AcolyteDSL.withConnection]]
* @see [[withFlatDB]]
* @see AcolyteDSL.withConnection
* @see withFlatDB[T]
*/
def withDB[T](con: MongoConnection)(f: DB T)(implicit c: ExecutionContext): Future[T] = Future(f(con("acolyte")))
@@ -75,8 +75,8 @@ trait WithDB { withDriver: WithDriver =>
* Future.successful("Result")
* }
* }}}
* @see [[AcolyteDSL.withFlatConnection]]
* @see [[withDB]]
* @see AcolyteDSL.withFlatConnection
* @see withDB[A,B]
*/
def withFlatDB[A, B](driverParam: A)(f: DB Future[B])(implicit m: DriverManager[A], c: ExecutionContext): Future[B] = withFlatConnection(driverParam) {
con f(con("acolyte"))
@@ -102,8 +102,8 @@ trait WithDB { withDriver: WithDriver =>
* }
* }
* }}}
* @see [[AcolyteDSL.withConnection]]
* @see [[withFlatDB]]
* @see AcolyteDSL.withConnection
* @see withFlatDB[T]
*/
def withFlatDB[T](con: MongoConnection)(f: DB Future[T])(implicit c: ExecutionContext): Future[T] = f(con("acolyte"))
@@ -69,7 +69,7 @@ trait WithHandler { up: WithDriver ⇒
*
* @see [[AcolyteDSL.withDriver]]
* @see [[AcolyteDSL.handleWrite]]
* @see [[AcolyteDSL.withWriteResult]
* @see [[AcolyteDSL.withWriteResult]]
*/
def withWriteHandler[T](handler: (WriteOp, Request) PreparedResponse)(f: MongoDriver T)(implicit m: DriverManager[ConnectionHandler], c: ExecutionContext): Future[T] = withDriver(AcolyteDSL handleWrite handler)(f)
@@ -91,7 +91,7 @@ trait WithHandler { up: WithDriver ⇒
*
* @see [[AcolyteDSL.withFlatDriver]]
* @see [[AcolyteDSL.handleWrite]]
* @see [[AcolyteDSL.withFlatWriteResult]
* @see [[AcolyteDSL.withFlatWriteResult]]
*/
def withFlatWriteHandler[T](handler: (WriteOp, Request) PreparedResponse)(f: MongoDriver Future[T])(implicit m: DriverManager[ConnectionHandler], c: ExecutionContext): Future[T] = withFlatDriver(AcolyteDSL handleWrite handler)(f)
View
@@ -58,6 +58,10 @@
<copy todir="${project.build.directory}/site/scaladocs">
<fileset dir="${basedir}/jdbc-scala/target/scala-2.10/api" />
</copy>
<copy todir="${project.build.directory}/site/reactivemongo-scaladoc">
<fileset dir="${basedir}/reactive-mongo/target/scala-2.10/api" />
</copy>
<copy file="${basedir}/readme.md"
tofile="${generatedSite}/markdown/index.md" />

0 comments on commit 8fe2ef4

Please sign in to comment.