Scaladoc - fix warnings

neerajbhatt · Feb 20, 2023 · 08dc4be · 08dc4be
1 parent 2fac077
commit 08dc4be
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/driver-scala/src/main/scala/org/mongodb/scala/FindObservable.scala b/driver-scala/src/main/scala/org/mongodb/scala/FindObservable.scala
@@ -39,7 +39,7 @@ case class FindObservable[TResult](private val wrapped: FindPublisher[TResult])
   /**
    * Helper to return a Observable limited to just the first result the query.
    *
-   * **Note:** Sets limit in the background so only returns 1.
+   * '''Note:''' Sets limit in the background so only returns 1.
    *
    * @return a Observable which will return the first item
    */

diff --git a/driver-scala/src/main/scala/org/mongodb/scala/vault/ClientEncryption.scala b/driver-scala/src/main/scala/org/mongodb/scala/vault/ClientEncryption.scala
@@ -73,14 +73,15 @@ case class ClientEncryption(private val wrapped: JClientEncryption) extends Clos
    * The expression is expected to be in one of the following forms:
    *
    * - A Match Expression of this form:
-   *   {{{ {$and: [{<field>: {$gt: <value1>}}, {<field>: {$lt: <value2> }}]}} }}}
+   *   {{{ {\$and: [{<field>: {\$gt: <value1>}}, {<field>: {\$lt: <value2> }}]}} }}}
    * - An Aggregate Expression of this form:
-   *   {{{ {$and: [{$gt: [<fieldpath>, <value1>]}, {$lt: [<fieldpath>, <value2>]}] }} }}}
+   *   {{{ {\$and: [{\$gt: [<fieldpath>, <value1>]}, {\$lt: [<fieldpath>, <value2>]}] }} }}}
    *
-   * `$gt` may also be `$gte`. `$lt` may also be `$lte`.
+   * `\$gt` may also be `\$gte`. `\$lt` may also be `\$lte`.
    *
    * Only supported when queryType is "rangePreview" and algorithm is "RangePreview".
-   * **Note:** The Range algorithm is experimental only. It is not intended for public use. It is subject to breaking changes.
+   *
+   * '''Note:''' The Range algorithm is experimental only. It is not intended for public use. It is subject to breaking changes.
    *
    * [[https://www.mongodb.com/docs/manual/core/queryable-encryption/ queryable encryption]]
    *
@@ -119,9 +120,8 @@ case class ClientEncryption(private val wrapped: JClientEncryption) extends Clos
    * @return A publisher of the (potentially updated) `encryptedFields` configuration that was used to create the collection.
    * A user may use this document to configure `com.mongodb.AutoEncryptionSettings.getEncryptedFieldsMap`.
    *
-   * Produces [[com.mongodb.MongoUpdatedEncryptedFieldsException]]
-   * if an exception happens after creating at least one data key. This exception makes the updated `encryptedFields`
-   * available to the caller.
+   * Produces MongoUpdatedEncryptedFieldsException` if an exception happens after creating at least one data key.
+   * This exception makes the updated `encryptedFields` available to the caller.
    * @since 4.9
    * @note Requires MongoDB 6.0 or greater.
    * @see [[https://www.mongodb.com/docs/manual/reference/command/create/ Create Command]]