fixes #190 Nullable args in documentation

Litote · Mar 28, 2020 · a1305f7 · a1305f7
1 parent 9d301ed
commit a1305f7
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 10 deletions.
diff --git a/...-coroutine-core/src/main/kotlin/org/litote/kmongo/coroutine/CoroutineDistinctPublisher.kt b/...-coroutine-core/src/main/kotlin/org/litote/kmongo/coroutine/CoroutineDistinctPublisher.kt
@@ -39,7 +39,7 @@ class CoroutineDistinctPublisher<T>(override val publisher: DistinctPublisher<T>
     /**
      * Sets the query filter to apply to the query.
      *
-     * @param filter the filter, which may be null.
+     * @param filter the filter
      * @return this
      * @mongodb.driver.manual reference/method/db.collection.find/ Filter
      */

diff --git a/kmongo-coroutine-core/src/main/kotlin/org/litote/kmongo/coroutine/CoroutineFindPublisher.kt b/kmongo-coroutine-core/src/main/kotlin/org/litote/kmongo/coroutine/CoroutineFindPublisher.kt
@@ -47,7 +47,7 @@ class CoroutineFindPublisher<T>(override val publisher: FindPublisher<T>) :
     /**
      * Sets the query filter to apply to the query.
      *
-     * @param filter the filter, which may be null.
+     * @param filter the filter.
      * @return this
      * @mongodb.driver.manual reference/method/db.collection.find/ Filter
      */
@@ -56,7 +56,7 @@ class CoroutineFindPublisher<T>(override val publisher: FindPublisher<T>) :
     /**
      * Sets the limit to apply.
      *
-     * @param limit the limit, which may be null
+     * @param limit the limit
      * @return this
      * @mongodb.driver.manual reference/method/cursor.limit/#cursor.limit Limit
      */
@@ -75,7 +75,7 @@ class CoroutineFindPublisher<T>(override val publisher: FindPublisher<T>) :
      * Sets the maximum execution time on the server for this operation.
      *
      * @param maxTime  the max time
-     * @param timeUnit the time unit, which may not be null
+     * @param timeUnit the time unit
      * @return this
      * @mongodb.driver.manual reference/method/cursor.maxTimeMS/#cursor.maxTimeMS Max Time
      */
@@ -106,7 +106,7 @@ class CoroutineFindPublisher<T>(override val publisher: FindPublisher<T>) :
     /**
      * Sets a document describing the fields to return for all matching documents.
      *
-     * @param projection the project document, which may be null.
+     * @param projection the project document.
      * @return this
      * @mongodb.driver.manual reference/method/db.collection.find/ Projection
      */
@@ -115,7 +115,7 @@ class CoroutineFindPublisher<T>(override val publisher: FindPublisher<T>) :
     /**
      * Sets the sort criteria to apply to the query.
      *
-     * @param sort the sort criteria, which may be null.
+     * @param sort the sort criteria.
      * @return this
      * @mongodb.driver.manual reference/method/cursor.sort/ Sort
      */

diff --git a/...ine-core/src/main/kotlin/org/litote/kmongo/coroutine/CoroutineListCollectionsPublisher.kt b/...ine-core/src/main/kotlin/org/litote/kmongo/coroutine/CoroutineListCollectionsPublisher.kt
@@ -37,7 +37,7 @@ class CoroutineListCollectionsPublisher<TResult>(override val publisher: ListCol
     /**
      * Sets the query filter to apply to the query.
      *
-     * @param filter the filter, which may be null.
+     * @param filter the filter
      * @return this
      * @mongodb.driver.manual reference/method/db.collection.find/ Filter
      */

diff --git a/...routine-core/src/main/kotlin/org/litote/kmongo/coroutine/CoroutineListIndexesPublisher.kt b/...routine-core/src/main/kotlin/org/litote/kmongo/coroutine/CoroutineListIndexesPublisher.kt
@@ -37,7 +37,7 @@ class CoroutineListIndexesPublisher<T>(override val publisher: ListIndexesPublis
      * Sets the maximum execution time on the server for this operation.
      *
      * @param maxTime  the max time
-     * @param timeUnit the time unit, which may not be null
+     * @param timeUnit the time unit
      * @return this
      * @mongodb.driver.manual reference/operator/meta/maxTimeMS/ Max Time
      */

diff --git a/...coroutine-core/src/main/kotlin/org/litote/kmongo/coroutine/CoroutineMapReducePublisher.kt b/...coroutine-core/src/main/kotlin/org/litote/kmongo/coroutine/CoroutineMapReducePublisher.kt
@@ -71,7 +71,7 @@ class CoroutineMapReducePublisher<T>(override val publisher: MapReducePublisher<
     /**
      * Sets the sort criteria to apply to the query.
      *
-     * @param sort the sort criteria, which may be null.
+     * @param sort the sort criteria
      * @return this
      * @mongodb.driver.manual reference/method/cursor.sort/ Sort
      */
@@ -89,7 +89,7 @@ class CoroutineMapReducePublisher<T>(override val publisher: MapReducePublisher<
     /**
      * Sets the limit to apply.
      *
-     * @param limit the limit, which may be null
+     * @param limit the limit
      * @return this
      * @mongodb.driver.manual reference/method/cursor.limit/#cursor.limit Limit
      */