Skip to content

Correct Scaladoc references to methods and classes. #1463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ case class AggregateObservable[TResult](private val wrapped: AggregatePublisher[
/**
* Sets the timeoutMode for the cursor.
*
* Requires the `timeout` to be set, either in the [[com.mongodb.MongoClientSettings]],
* Requires the `timeout` to be set, either in the [[MongoClientSettings]],
* via [[MongoDatabase]] or via [[MongoCollection]]
*
* If the `timeout` is set then:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ case class DistinctObservable[TResult](private val wrapped: DistinctPublisher[TR
/**
* Sets the timeoutMode for the cursor.
*
* Requires the `timeout` to be set, either in the [[com.mongodb.MongoClientSettings]],
* Requires the `timeout` to be set, either in the [[MongoClientSettings]],
* via [[MongoDatabase]] or via [[MongoCollection]]
*
* @param timeoutMode the timeout mode
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ case class FindObservable[TResult](private val wrapped: FindPublisher[TResult])
/**
* Sets the timeoutMode for the cursor.
*
* Requires the `timeout` to be set, either in the [[com.mongodb.MongoClientSettings]],
* Requires the `timeout` to be set, either in the [[MongoClientSettings]],
* via [[MongoDatabase]] or via [[MongoCollection]]
*
* If the `timeout` is set then:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ case class ListCollectionsObservable[TResult](wrapped: ListCollectionsPublisher[
/**
* Sets the timeoutMode for the cursor.
*
* Requires the `timeout` to be set, either in the [[com.mongodb.MongoClientSettings]],
* Requires the `timeout` to be set, either in the [[MongoClientSettings]],
* via [[MongoDatabase]] or via [[MongoCollection]]
*
* @param timeoutMode the timeout mode
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ case class ListDatabasesObservable[TResult](wrapped: ListDatabasesPublisher[TRes
/**
* Sets the timeoutMode for the cursor.
*
* Requires the `timeout` to be set, either in the [[com.mongodb.MongoClientSettings]],
* Requires the `timeout` to be set, either in the [[MongoClientSettings]],
* via [[MongoDatabase]] or via [[MongoCollection]]
*
* @param timeoutMode the timeout mode
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ case class ListIndexesObservable[TResult](wrapped: ListIndexesPublisher[TResult]
/**
* Sets the timeoutMode for the cursor.
*
* Requires the `timeout` to be set, either in the [[com.mongodb.MongoClientSettings]],
* Requires the `timeout` to be set, either in the [[MongoClientSettings]],
* via [[MongoDatabase]] or via [[MongoCollection]]
*
* @param timeoutMode the timeout mode
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ case class ListSearchIndexesObservable[TResult](wrapped: ListSearchIndexesPublis
/**
* Sets the timeoutMode for the cursor.
*
* Requires the `timeout` to be set, either in the [[com.mongodb.MongoClientSettings]],
* Requires the `timeout` to be set, either in the [[MongoClientSettings]],
* via [[MongoDatabase]] or via [[MongoCollection]]
*
* If the `timeout` is set then:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ case class MapReduceObservable[TResult](wrapped: MapReducePublisher[TResult]) ex
/**
* Sets the timeoutMode for the cursor.
*
* Requires the `timeout` to be set, either in the [[com.mongodb.MongoClientSettings]],
* Requires the `timeout` to be set, either in the [[MongoClientSettings]],
* via [[MongoDatabase]] or via [[MongoCollection]]
*
* @param timeoutMode the timeout mode
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ case class GridFSBucket(private val wrapped: JGridFSBucket) {
* chunks have been uploaded, it creates a files collection document for `filename` in the files collection.
*
* Note: When this [[GridFSBucket]] is set with a operation timeout (via timeout inherited from [[MongoDatabase]]
* settings or [[GridFSBucket#withTimeout()]]), timeout breaches may occur due to the [[Observable]]
* settings or [[withTimeout]]), timeout breaches may occur due to the [[Observable]]
* lacking inherent read timeout support, which might extend the operation beyond the specified timeout limit.
*
* @param filename the filename for the stream
Expand All @@ -201,7 +201,7 @@ case class GridFSBucket(private val wrapped: JGridFSBucket) {
* chunks have been uploaded, it creates a files collection document for `filename` in the files collection.
*
* Note: When this [[GridFSBucket]] is set with a operation timeout (via timeout inherited from [[MongoDatabase]]
* settings or [[GridFSBucket#withTimeout()]]), timeout breaches may occur due to the [[Observable]]
* settings or [[withTimeout]]), timeout breaches may occur due to the [[Observable]]
* lacking inherent read timeout support, which might extend the operation beyond the specified timeout limit.
*
* @param filename the filename for the stream
Expand All @@ -224,7 +224,7 @@ case class GridFSBucket(private val wrapped: JGridFSBucket) {
* chunks have been uploaded, it creates a files collection document for `filename` in the files collection.
*
* Note: When this [[GridFSBucket]] is set with a operation timeout (via timeout inherited from [[MongoDatabase]]
* settings or [[GridFSBucket#withTimeout()]]), timeout breaches may occur due to the [[Observable]]
* settings or [[withTimeout]]), timeout breaches may occur due to the [[Observable]]
* lacking inherent read timeout support, which might extend the operation beyond the specified timeout limit.
*
* @param id the custom id value of the file
Expand All @@ -247,7 +247,7 @@ case class GridFSBucket(private val wrapped: JGridFSBucket) {
* chunks have been uploaded, it creates a files collection document for `filename` in the files collection.
*
* Note: When this [[GridFSBucket]] is set with a operation timeout (via timeout inherited from [[MongoDatabase]]
* settings or [[GridFSBucket#withTimeout()]]), timeout breaches may occur due to the [[Observable]]
* settings or [[withTimeout]]), timeout breaches may occur due to the [[Observable]]
* lacking inherent read timeout support, which might extend the operation beyond the specified timeout limit.
*
* @param id the custom id value of the file
Expand All @@ -272,7 +272,7 @@ case class GridFSBucket(private val wrapped: JGridFSBucket) {
* chunks have been uploaded, it creates a files collection document for `filename` in the files collection.
*
* Note: When this [[GridFSBucket]] is set with a operation timeout (via timeout inherited from [[MongoDatabase]]
* settings or [[GridFSBucket#withTimeout()]]), timeout breaches may occur due to the [[Observable]]
* settings or [[withTimeout]]), timeout breaches may occur due to the [[Observable]]
* lacking inherent read timeout support, which might extend the operation beyond the specified timeout limit.
*
* @param clientSession the client session with which to associate this operation
Expand All @@ -296,7 +296,7 @@ case class GridFSBucket(private val wrapped: JGridFSBucket) {
* chunks have been uploaded, it creates a files collection document for `filename` in the files collection.
*
* Note: When this [[GridFSBucket]] is set with a operation timeout (via timeout inherited from [[MongoDatabase]]
* settings or [[GridFSBucket#withTimeout()]]), timeout breaches may occur due to the [[Observable]]
* settings or [[withTimeout]]), timeout breaches may occur due to the [[Observable]]
* lacking inherent read timeout support, which might extend the operation beyond the specified timeout limit.
*
* @param clientSession the client session with which to associate this operation
Expand All @@ -322,7 +322,7 @@ case class GridFSBucket(private val wrapped: JGridFSBucket) {
* chunks have been uploaded, it creates a files collection document for `filename` in the files collection.
*
* Note: When this [[GridFSBucket]] is set with a operation timeout (via timeout inherited from [[MongoDatabase]]
* settings or [[GridFSBucket#withTimeout()]]), timeout breaches may occur due to the [[Observable]]
* settings or [[withTimeout]]), timeout breaches may occur due to the [[Observable]]
* lacking inherent read timeout support, which might extend the operation beyond the specified timeout limit.
*
* @param clientSession the client session with which to associate this operation
Expand All @@ -348,7 +348,7 @@ case class GridFSBucket(private val wrapped: JGridFSBucket) {
* chunks have been uploaded, it creates a files collection document for `filename` in the files collection.
*
* Note: When this [[GridFSBucket]] is set with a operation timeout (via timeout inherited from [[MongoDatabase]]
* settings or [[GridFSBucket#withTimeout()]]), timeout breaches may occur due to the [[Observable]]
* settings or [[withTimeout]]), timeout breaches may occur due to the [[Observable]]
* lacking inherent read timeout support, which might extend the operation beyond the specified timeout limit.
*
* @param clientSession the client session with which to associate this operation
Expand Down