Merge pull request #177 from alenkacz/JavaDocImprovement

mauricio · mauricio · commit 773a28db1cb3 · 2016-04-18T12:01:07.000-04:00
Time unit as a part of javadoc
diff --git a/db-async-common/src/main/scala/com/github/mauricio/async/db/pool/PoolConfiguration.scala b/db-async-common/src/main/scala/com/github/mauricio/async/db/pool/PoolConfiguration.scala
@@ -25,7 +25,7 @@ object PoolConfiguration {
  * Defines specific pieces of a pool's behavior.
  *
  * @param maxObjects how many objects this pool will hold
- * @param maxIdle how long are objects going to be kept as idle (not in use by clients of the pool)
+ * @param maxIdle number of milliseconds for which the objects are going to be kept as idle (not in use by clients of the pool)
  * @param maxQueueSize when there are no more objects, the pool can queue up requests to serve later then there
  *                     are objects available, this is the maximum number of enqueued requests
  * @param validationInterval pools will use this value as the timer period to validate idle objects.

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ object PoolConfiguration {`
`25`	`25`	`* Defines specific pieces of a pool's behavior.`
`26`	`26`	`*`
`27`	`27`	`* @param maxObjects how many objects this pool will hold`
`28`		`- * @param maxIdle how long are objects going to be kept as idle (not in use by clients of the pool)`
	`28`	`+ * @param maxIdle number of milliseconds for which the objects are going to be kept as idle (not in use by clients of the pool)`
`29`	`29`	`* @param maxQueueSize when there are no more objects, the pool can queue up requests to serve later then there`
`30`	`30`	`* are objects available, this is the maximum number of enqueued requests`
`31`	`31`	`* @param validationInterval pools will use this value as the timer period to validate idle objects.`