diff --git a/modules/core/src/main/scala/doobie/syntax/string.scala b/modules/core/src/main/scala/doobie/syntax/string.scala index 95b2fb242..c692fc1ef 100644 --- a/modules/core/src/main/scala/doobie/syntax/string.scala +++ b/modules/core/src/main/scala/doobie/syntax/string.scala @@ -12,7 +12,7 @@ import doobie.util.fragment.{Elem, Fragment} import doobie.util.pos.Pos /** String interpolator for SQL literals. An expression of the form `sql".. \$a ... \$b ..."` with interpolated values - * of type `A` and `B` (which must have instances of `Put`) yields a value of type `[[Fragment]]`. + * of type `A` and `B` (which must have instances of `Put`) yields a value of type [[Fragment]]. */ final class SqlInterpolator(private val sc: StringContext) extends AnyVal { diff --git a/modules/core/src/main/scala/doobie/util/query.scala b/modules/core/src/main/scala/doobie/util/query.scala index 5707df35b..1629b3b1b 100644 --- a/modules/core/src/main/scala/doobie/util/query.scala +++ b/modules/core/src/main/scala/doobie/util/query.scala @@ -27,7 +27,7 @@ object query { val DefaultChunkSize = 512 /** A query parameterized by some input type `A` yielding values of type `B`. We define here the core operations that - * are needed. Additional operations are provided on `[[Query0]]` which is the residual query after applying an `A`. + * are needed. Additional operations are provided on [[Query0]] which is the residual query after applying an `A`. * This is the type constructed by the `sql` interpolator. */ trait Query[A, B] { outer => @@ -40,8 +40,8 @@ object query { */ def sql: String - /** An optional `[[Pos]]` indicating the source location where this `[[Query]]` was constructed. This is used only - * for diagnostic purposes. + /** An optional [[Pos]] indicating the source location where this [[Query]] was constructed. This is used only for + * diagnostic purposes. * @group Diagnostics */ def pos: Option[Pos] @@ -74,7 +74,7 @@ object query { f(sql, IHPS.set(a)) /** Apply the argument `a` to construct a `Stream` with the given chunking factor, with effect type - * `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding elements of type `B`. + * [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding elements of type `B`. * @group Results */ def streamWithChunkSize(a: A, chunkSize: Int): Stream[ConnectionIO, B] = @@ -91,13 +91,13 @@ object query { ) /** Apply the argument `a` to construct a `Stream` with `DefaultChunkSize`, with effect type - * `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding elements of type `B`. + * [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding elements of type `B`. * @group Results */ def stream(a: A): Stream[ConnectionIO, B] = streamWithChunkSize(a, DefaultChunkSize) - /** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding + /** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding * an `F[B]` accumulated via the provided `CanBuildFrom`. This is the fastest way to accumulate a collection. * @group Results */ @@ -114,7 +114,7 @@ object query { toConnectionIOAlteringExecution(a, IHRS.build[F, B], fn) } - /** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding + /** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding * an `Map[(K, V)]` accumulated via the provided `CanBuildFrom`. This is the fastest way to accumulate a * collection. this function can call only when B is (K, V). * @group Results @@ -133,7 +133,7 @@ object query { ): ConnectionIO[Map[K, V]] = toConnectionIOAlteringExecution(a, IHRS.buildPair[Map, K, V](using f, read.map(ev)), fn) - /** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding + /** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding * an `F[B]` accumulated via `MonadPlus` append. This method is more general but less efficient than `to`. * @group Results */ @@ -148,8 +148,8 @@ object query { ): ConnectionIO[F[B]] = toConnectionIOAlteringExecution(a, IHRS.accumulate[F, B], fn) - /** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding - * a unique `B` and raising an exception if the resultset does not have exactly one row. See also `option`. + /** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding a + * unique `B` and raising an exception if the resultset does not have exactly one row. See also `option`. * @group Results */ def unique(a: A): ConnectionIO[B] = @@ -160,7 +160,7 @@ object query { def uniqueAlteringExecution(a: A, fn: PreparedExecution[B] => PreparedExecution[B]): ConnectionIO[B] = toConnectionIOAlteringExecution(a, IHRS.getUnique[B], fn) - /** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding + /** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding * an optional `B` and raising an exception if the resultset has more than one row. See also `unique`. * @group Results */ @@ -175,7 +175,7 @@ object query { ): ConnectionIO[Option[B]] = toConnectionIOAlteringExecution(a, IHRS.getOption[B], fn) - /** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding + /** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding * an `NonEmptyList[B]` and raising an exception if the resultset does not have at least one row. See also * `unique`. * @group Results @@ -236,7 +236,7 @@ object query { val label: String = outer.label } - /** Apply an argument, yielding a residual `[[Query0]]`. + /** Apply an argument, yielding a residual [[Query0]]. * @group Transformations */ def toQuery0(a: A): Query0[B] = @@ -331,7 +331,7 @@ object query { } /** An abstract query closed over its input arguments and yielding values of type `B`, without a specified - * disposition. Methods provided on `[[Query0]]` allow the query to be interpreted as a stream or program in + * disposition. Methods provided on [[Query0]] allow the query to be interpreted as a stream or program in * `CollectionIO`. */ trait Query0[B] { outer => @@ -367,21 +367,21 @@ object query { */ def outputAnalysis: ConnectionIO[Analysis] - /** `Stream` with default chunk factor, with effect type `[[doobie.free.connection.ConnectionIO ConnectionIO]]` + /** `Stream` with default chunk factor, with effect type [[doobie.free.connection.ConnectionIO ConnectionIO]] * yielding elements of type `B`. * @group Results */ def stream: Stream[ConnectionIO, B] = streamWithChunkSize(DefaultChunkSize) - /** `Stream` with given chunk factor, with effect type `[[doobie.free.connection.ConnectionIO ConnectionIO]]` - * yielding elements of type `B`. + /** `Stream` with given chunk factor, with effect type [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding + * elements of type `B`. * @group Results */ def streamWithChunkSize(n: Int): Stream[ConnectionIO, B] - /** Program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding an `F[B]` accumulated via the - * provided `CanBuildFrom`. This is the fastest way to accumulate a collection. + /** Program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding an `F[B]` accumulated via the provided + * `CanBuildFrom`. This is the fastest way to accumulate a collection. * @group Results */ def to[F[_]](implicit f: FactoryCompat[B, F[B]]): ConnectionIO[F[B]] @@ -390,7 +390,7 @@ object query { fn: PreparedExecution[F[B]] => PreparedExecution[F[B]] )(implicit f: FactoryCompat[B, F[B]]): ConnectionIO[F[B]] - /** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding + /** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding * an `Map[(K, V)]` accumulated via the provided `CanBuildFrom`. This is the fastest way to accumulate a * collection. this function can call only when B is (K, V). * @group Results @@ -404,7 +404,7 @@ object query { f: FactoryCompat[(K, V), Map[K, V]] ): ConnectionIO[Map[K, V]] - /** Program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding an `F[B]` accumulated via `MonadPlus` + /** Program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding an `F[B]` accumulated via `MonadPlus` * append. This method is more general but less efficient than `to`. * @group Results */ @@ -414,7 +414,7 @@ object query { fn: PreparedExecution[F[B]] => PreparedExecution[F[B]] ): ConnectionIO[F[B]] - /** Program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding a unique `B` and raising an exception + /** Program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding a unique `B` and raising an exception * if the resultset does not have exactly one row. See also `option`. * @group Results */ @@ -422,7 +422,7 @@ object query { def uniqueAlteringExecution(fn: PreparedExecution[B] => PreparedExecution[B]): ConnectionIO[B] - /** Program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding an optional `B` and raising an + /** Program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding an optional `B` and raising an * exception if the resultset has more than one row. See also `unique`. * @group Results */ @@ -432,7 +432,7 @@ object query { fn: PreparedExecution[Option[B]] => PreparedExecution[Option[B]] ): ConnectionIO[Option[B]] - /** Program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding a `NonEmptyList[B]` and raising an + /** Program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding a `NonEmptyList[B]` and raising an * exception if the resultset does not have at least one row. See also `unique`. * @group Results */ diff --git a/modules/core/src/main/scala/doobie/util/update.scala b/modules/core/src/main/scala/doobie/util/update.scala index 2b7aa9b35..3bfe099c2 100644 --- a/modules/core/src/main/scala/doobie/util/update.scala +++ b/modules/core/src/main/scala/doobie/util/update.scala @@ -46,8 +46,8 @@ object update { */ val sql: String - /** An optional `[[Pos]]` indicating the source location where this `[[Update]]` was constructed. This is used only - * for diagnostic purposes. + /** An optional [[Pos]] indicating the source location where this [[Update]] was constructed. This is used only for + * diagnostic purposes. * @group Diagnostics */ val pos: Option[Pos] @@ -230,7 +230,7 @@ object update { val label: String = u.label } - /** Apply an argument, yielding a residual `[[Update0]]`. + /** Apply an argument, yielding a residual [[Update0]]. * @group Transformations */ def toUpdate0(a: A): Update0 = @@ -297,8 +297,8 @@ object update { */ val sql: String - /** An optional `[[Pos]]` indicating the source location where this `[[Query]]` was constructed. This is used only - * for diagnostic purposes. + /** An optional [[Pos]] indicating the source location where this [[Update0]] was constructed. This is used only for + * diagnostic purposes. * @group Diagnostics */ val pos: Option[Pos] diff --git a/modules/postgres/src/main/scala/doobie/postgres/syntax/syntax.scala b/modules/postgres/src/main/scala/doobie/postgres/syntax/syntax.scala index 27e267d29..f06d0c1b2 100644 --- a/modules/postgres/src/main/scala/doobie/postgres/syntax/syntax.scala +++ b/modules/postgres/src/main/scala/doobie/postgres/syntax/syntax.scala @@ -638,16 +638,16 @@ trait ToPostgresExplainOps { class PostgresExplainQuery0Ops(self: Query0[?]) { - /** Construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` which returns the server's query - * plan for the query (i.e., `EXPLAIN` output). The query is not actually executed. + /** Construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] which returns the server's query plan + * for the query (i.e., `EXPLAIN` output). The query is not actually executed. */ def explain: ConnectionIO[List[String]] = self.inspect { (sql, prepare) => HC.prepareStatementPrimitive(s"EXPLAIN $sql")(prepare *> HPS.executeQueryUnlogged(HRS.build[List, String])) } - /** Construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` which returns the server's query - * plan for the query, with a comparison to the actual execution (i.e., `EXPLAIN ANALYZE` output). The query will be + /** Construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] which returns the server's query plan + * for the query, with a comparison to the actual execution (i.e., `EXPLAIN ANALYZE` output). The query will be * executed, but no results are returned. */ def explainAnalyze: ConnectionIO[List[String]] = @@ -660,7 +660,7 @@ class PostgresExplainQuery0Ops(self: Query0[?]) { class PostgresExplainQueryOps[A](self: Query[A, ?]) { - /** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` which + /** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] which * returns the server's query plan for the query (i.e., `EXPLAIN` output). The query is not actually executed. */ def explain(a: A): ConnectionIO[List[String]] = { @@ -669,7 +669,7 @@ class PostgresExplainQueryOps[A](self: Query[A, ?]) { } } - /** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` which + /** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] which * returns the server's query plan for the query, with a comparison to the actual execution (i.e., `EXPLAIN ANALYZE` * output). The query will be executed, but no results are returned. */ @@ -683,16 +683,16 @@ class PostgresExplainQueryOps[A](self: Query[A, ?]) { class PostgresExplainUpdate0Ops(self: Update0) { - /** Construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` which returns the server's query - * plan for the query (i.e., `EXPLAIN` output). The query is not actually executed. + /** Construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] which returns the server's query plan + * for the query (i.e., `EXPLAIN` output). The query is not actually executed. */ def explain: ConnectionIO[List[String]] = self.inspect { (sql, prepare) => HC.prepareStatementPrimitive(s"EXPLAIN $sql")(prepare *> HPS.executeQueryUnlogged(HRS.build[List, String])) } - /** Construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` which returns the server's query - * plan for the query, with a comparison to the actual execution (i.e., `EXPLAIN ANALYZE` output). The query will be + /** Construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] which returns the server's query plan + * for the query, with a comparison to the actual execution (i.e., `EXPLAIN ANALYZE` output). The query will be * executed, but no results are returned. */ def explainAnalyze: ConnectionIO[List[String]] = @@ -705,7 +705,7 @@ class PostgresExplainUpdate0Ops(self: Update0) { class PostgresExplainUpdateOps[A](self: Update[A]) { - /** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` which + /** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] which * returns the server's query plan for the query (i.e., `EXPLAIN` output). The query is not actually executed. */ def explain(a: A): ConnectionIO[List[String]] = { @@ -714,7 +714,7 @@ class PostgresExplainUpdateOps[A](self: Update[A]) { } } - /** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` which + /** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] which * returns the server's query plan for the query, with a comparison to the actual execution (i.e., `EXPLAIN ANALYZE` * output). The query will be executed, but no results are returned. */