Skip to content

Commit 10fcae9

Browse files
jatcwangjatcwang
authored
Merge pull request #2303 from danicheg/scaladocs-tweak
Fix links in some scaladocs
2 parents 721e199 + e4aaa30 commit 10fcae9

File tree

4 files changed

+42
-42
lines changed

4 files changed

+42
-42
lines changed

‎modules/core/src/main/scala/doobie/syntax/string.scala‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import doobie.util.fragment.{Elem, Fragment}
1212
import doobie.util.pos.Pos
1313

1414
/** String interpolator for SQL literals. An expression of the form `sql".. \$a ... \$b ..."` with interpolated values
15-
* of type `A` and `B` (which must have instances of `Put`) yields a value of type `[[Fragment]]`.
15+
* of type `A` and `B` (which must have instances of `Put`) yields a value of type [[Fragment]].
1616
*/
1717
final class SqlInterpolator(private val sc: StringContext) extends AnyVal {
1818

‎modules/core/src/main/scala/doobie/util/query.scala‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ object query {
2727
val DefaultChunkSize = 512
2828

2929
/** A query parameterized by some input type `A` yielding values of type `B`. We define here the core operations that
30-
* are needed. Additional operations are provided on `[[Query0]]` which is the residual query after applying an `A`.
30+
* are needed. Additional operations are provided on [[Query0]] which is the residual query after applying an `A`.
3131
* This is the type constructed by the `sql` interpolator.
3232
*/
3333
trait Query[A, B] { outer =>
@@ -40,8 +40,8 @@ object query {
4040
*/
4141
def sql: String
4242

43-
/** An optional `[[Pos]]` indicating the source location where this `[[Query]]` was constructed. This is used only
44-
* for diagnostic purposes.
43+
/** An optional [[Pos]] indicating the source location where this [[Query]] was constructed. This is used only for
44+
* diagnostic purposes.
4545
* @group Diagnostics
4646
*/
4747
def pos: Option[Pos]
@@ -74,7 +74,7 @@ object query {
7474
f(sql, IHPS.set(a))
7575

7676
/** Apply the argument `a` to construct a `Stream` with the given chunking factor, with effect type
77-
* `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding elements of type `B`.
77+
* [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding elements of type `B`.
7878
* @group Results
7979
*/
8080
def streamWithChunkSize(a: A, chunkSize: Int): Stream[ConnectionIO, B] =
@@ -91,13 +91,13 @@ object query {
9191
)
9292

9393
/** Apply the argument `a` to construct a `Stream` with `DefaultChunkSize`, with effect type
94-
* `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding elements of type `B`.
94+
* [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding elements of type `B`.
9595
* @group Results
9696
*/
9797
def stream(a: A): Stream[ConnectionIO, B] =
9898
streamWithChunkSize(a, DefaultChunkSize)
9999

100-
/** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding
100+
/** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding
101101
* an `F[B]` accumulated via the provided `CanBuildFrom`. This is the fastest way to accumulate a collection.
102102
* @group Results
103103
*/
@@ -114,7 +114,7 @@ object query {
114114
toConnectionIOAlteringExecution(a, IHRS.build[F, B], fn)
115115
}
116116

117-
/** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding
117+
/** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding
118118
* an `Map[(K, V)]` accumulated via the provided `CanBuildFrom`. This is the fastest way to accumulate a
119119
* collection. this function can call only when B is (K, V).
120120
* @group Results
@@ -133,7 +133,7 @@ object query {
133133
): ConnectionIO[Map[K, V]] =
134134
toConnectionIOAlteringExecution(a, IHRS.buildPair[Map, K, V](using f, read.map(ev)), fn)
135135

136-
/** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding
136+
/** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding
137137
* an `F[B]` accumulated via `MonadPlus` append. This method is more general but less efficient than `to`.
138138
* @group Results
139139
*/
@@ -148,8 +148,8 @@ object query {
148148
): ConnectionIO[F[B]] =
149149
toConnectionIOAlteringExecution(a, IHRS.accumulate[F, B], fn)
150150

151-
/** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding
152-
* a unique `B` and raising an exception if the resultset does not have exactly one row. See also `option`.
151+
/** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding a
152+
* unique `B` and raising an exception if the resultset does not have exactly one row. See also `option`.
153153
* @group Results
154154
*/
155155
def unique(a: A): ConnectionIO[B] =
@@ -160,7 +160,7 @@ object query {
160160
def uniqueAlteringExecution(a: A, fn: PreparedExecution[B] => PreparedExecution[B]): ConnectionIO[B] =
161161
toConnectionIOAlteringExecution(a, IHRS.getUnique[B], fn)
162162

163-
/** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding
163+
/** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding
164164
* an optional `B` and raising an exception if the resultset has more than one row. See also `unique`.
165165
* @group Results
166166
*/
@@ -175,7 +175,7 @@ object query {
175175
): ConnectionIO[Option[B]] =
176176
toConnectionIOAlteringExecution(a, IHRS.getOption[B], fn)
177177

178-
/** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding
178+
/** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding
179179
* an `NonEmptyList[B]` and raising an exception if the resultset does not have at least one row. See also
180180
* `unique`.
181181
* @group Results
@@ -236,7 +236,7 @@ object query {
236236
val label: String = outer.label
237237
}
238238

239-
/** Apply an argument, yielding a residual `[[Query0]]`.
239+
/** Apply an argument, yielding a residual [[Query0]].
240240
* @group Transformations
241241
*/
242242
def toQuery0(a: A): Query0[B] =
@@ -331,7 +331,7 @@ object query {
331331
}
332332

333333
/** An abstract query closed over its input arguments and yielding values of type `B`, without a specified
334-
* disposition. Methods provided on `[[Query0]]` allow the query to be interpreted as a stream or program in
334+
* disposition. Methods provided on [[Query0]] allow the query to be interpreted as a stream or program in
335335
* `CollectionIO`.
336336
*/
337337
trait Query0[B] { outer =>
@@ -367,21 +367,21 @@ object query {
367367
*/
368368
def outputAnalysis: ConnectionIO[Analysis]
369369

370-
/** `Stream` with default chunk factor, with effect type `[[doobie.free.connection.ConnectionIO ConnectionIO]]`
370+
/** `Stream` with default chunk factor, with effect type [[doobie.free.connection.ConnectionIO ConnectionIO]]
371371
* yielding elements of type `B`.
372372
* @group Results
373373
*/
374374
def stream: Stream[ConnectionIO, B] =
375375
streamWithChunkSize(DefaultChunkSize)
376376

377-
/** `Stream` with given chunk factor, with effect type `[[doobie.free.connection.ConnectionIO ConnectionIO]]`
378-
* yielding elements of type `B`.
377+
/** `Stream` with given chunk factor, with effect type [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding
378+
* elements of type `B`.
379379
* @group Results
380380
*/
381381
def streamWithChunkSize(n: Int): Stream[ConnectionIO, B]
382382

383-
/** Program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding an `F[B]` accumulated via the
384-
* provided `CanBuildFrom`. This is the fastest way to accumulate a collection.
383+
/** Program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding an `F[B]` accumulated via the provided
384+
* `CanBuildFrom`. This is the fastest way to accumulate a collection.
385385
* @group Results
386386
*/
387387
def to[F[_]](implicit f: FactoryCompat[B, F[B]]): ConnectionIO[F[B]]
@@ -390,7 +390,7 @@ object query {
390390
fn: PreparedExecution[F[B]] => PreparedExecution[F[B]]
391391
)(implicit f: FactoryCompat[B, F[B]]): ConnectionIO[F[B]]
392392

393-
/** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding
393+
/** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding
394394
* an `Map[(K, V)]` accumulated via the provided `CanBuildFrom`. This is the fastest way to accumulate a
395395
* collection. this function can call only when B is (K, V).
396396
* @group Results
@@ -404,7 +404,7 @@ object query {
404404
f: FactoryCompat[(K, V), Map[K, V]]
405405
): ConnectionIO[Map[K, V]]
406406

407-
/** Program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding an `F[B]` accumulated via `MonadPlus`
407+
/** Program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding an `F[B]` accumulated via `MonadPlus`
408408
* append. This method is more general but less efficient than `to`.
409409
* @group Results
410410
*/
@@ -414,15 +414,15 @@ object query {
414414
fn: PreparedExecution[F[B]] => PreparedExecution[F[B]]
415415
): ConnectionIO[F[B]]
416416

417-
/** Program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding a unique `B` and raising an exception
417+
/** Program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding a unique `B` and raising an exception
418418
* if the resultset does not have exactly one row. See also `option`.
419419
* @group Results
420420
*/
421421
def unique: ConnectionIO[B]
422422

423423
def uniqueAlteringExecution(fn: PreparedExecution[B] => PreparedExecution[B]): ConnectionIO[B]
424424

425-
/** Program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding an optional `B` and raising an
425+
/** Program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding an optional `B` and raising an
426426
* exception if the resultset has more than one row. See also `unique`.
427427
* @group Results
428428
*/
@@ -432,7 +432,7 @@ object query {
432432
fn: PreparedExecution[Option[B]] => PreparedExecution[Option[B]]
433433
): ConnectionIO[Option[B]]
434434

435-
/** Program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` yielding a `NonEmptyList[B]` and raising an
435+
/** Program in [[doobie.free.connection.ConnectionIO ConnectionIO]] yielding a `NonEmptyList[B]` and raising an
436436
* exception if the resultset does not have at least one row. See also `unique`.
437437
* @group Results
438438
*/

‎modules/core/src/main/scala/doobie/util/update.scala‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ object update {
4646
*/
4747
val sql: String
4848

49-
/** An optional `[[Pos]]` indicating the source location where this `[[Update]]` was constructed. This is used only
50-
* for diagnostic purposes.
49+
/** An optional [[Pos]] indicating the source location where this [[Update]] was constructed. This is used only for
50+
* diagnostic purposes.
5151
* @group Diagnostics
5252
*/
5353
val pos: Option[Pos]
@@ -230,7 +230,7 @@ object update {
230230
val label: String = u.label
231231
}
232232

233-
/** Apply an argument, yielding a residual `[[Update0]]`.
233+
/** Apply an argument, yielding a residual [[Update0]].
234234
* @group Transformations
235235
*/
236236
def toUpdate0(a: A): Update0 =
@@ -297,8 +297,8 @@ object update {
297297
*/
298298
val sql: String
299299

300-
/** An optional `[[Pos]]` indicating the source location where this `[[Query]]` was constructed. This is used only
301-
* for diagnostic purposes.
300+
/** An optional [[Pos]] indicating the source location where this [[Update0]] was constructed. This is used only for
301+
* diagnostic purposes.
302302
* @group Diagnostics
303303
*/
304304
val pos: Option[Pos]

‎modules/postgres/src/main/scala/doobie/postgres/syntax/syntax.scala‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -638,16 +638,16 @@ trait ToPostgresExplainOps {
638638

639639
class PostgresExplainQuery0Ops(self: Query0[?]) {
640640

641-
/** Construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` which returns the server's query
642-
* plan for the query (i.e., `EXPLAIN` output). The query is not actually executed.
641+
/** Construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] which returns the server's query plan
642+
* for the query (i.e., `EXPLAIN` output). The query is not actually executed.
643643
*/
644644
def explain: ConnectionIO[List[String]] =
645645
self.inspect { (sql, prepare) =>
646646
HC.prepareStatementPrimitive(s"EXPLAIN $sql")(prepare *> HPS.executeQueryUnlogged(HRS.build[List, String]))
647647
}
648648

649-
/** Construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` which returns the server's query
650-
* plan for the query, with a comparison to the actual execution (i.e., `EXPLAIN ANALYZE` output). The query will be
649+
/** Construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] which returns the server's query plan
650+
* for the query, with a comparison to the actual execution (i.e., `EXPLAIN ANALYZE` output). The query will be
651651
* executed, but no results are returned.
652652
*/
653653
def explainAnalyze: ConnectionIO[List[String]] =
@@ -660,7 +660,7 @@ class PostgresExplainQuery0Ops(self: Query0[?]) {
660660

661661
class PostgresExplainQueryOps[A](self: Query[A, ?]) {
662662

663-
/** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` which
663+
/** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] which
664664
* returns the server's query plan for the query (i.e., `EXPLAIN` output). The query is not actually executed.
665665
*/
666666
def explain(a: A): ConnectionIO[List[String]] = {
@@ -669,7 +669,7 @@ class PostgresExplainQueryOps[A](self: Query[A, ?]) {
669669
}
670670
}
671671

672-
/** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` which
672+
/** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] which
673673
* returns the server's query plan for the query, with a comparison to the actual execution (i.e., `EXPLAIN ANALYZE`
674674
* output). The query will be executed, but no results are returned.
675675
*/
@@ -683,16 +683,16 @@ class PostgresExplainQueryOps[A](self: Query[A, ?]) {
683683

684684
class PostgresExplainUpdate0Ops(self: Update0) {
685685

686-
/** Construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` which returns the server's query
687-
* plan for the query (i.e., `EXPLAIN` output). The query is not actually executed.
686+
/** Construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] which returns the server's query plan
687+
* for the query (i.e., `EXPLAIN` output). The query is not actually executed.
688688
*/
689689
def explain: ConnectionIO[List[String]] =
690690
self.inspect { (sql, prepare) =>
691691
HC.prepareStatementPrimitive(s"EXPLAIN $sql")(prepare *> HPS.executeQueryUnlogged(HRS.build[List, String]))
692692
}
693693

694-
/** Construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` which returns the server's query
695-
* plan for the query, with a comparison to the actual execution (i.e., `EXPLAIN ANALYZE` output). The query will be
694+
/** Construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] which returns the server's query plan
695+
* for the query, with a comparison to the actual execution (i.e., `EXPLAIN ANALYZE` output). The query will be
696696
* executed, but no results are returned.
697697
*/
698698
def explainAnalyze: ConnectionIO[List[String]] =
@@ -705,7 +705,7 @@ class PostgresExplainUpdate0Ops(self: Update0) {
705705

706706
class PostgresExplainUpdateOps[A](self: Update[A]) {
707707

708-
/** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` which
708+
/** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] which
709709
* returns the server's query plan for the query (i.e., `EXPLAIN` output). The query is not actually executed.
710710
*/
711711
def explain(a: A): ConnectionIO[List[String]] = {
@@ -714,7 +714,7 @@ class PostgresExplainUpdateOps[A](self: Update[A]) {
714714
}
715715
}
716716

717-
/** Apply the argument `a` to construct a program in `[[doobie.free.connection.ConnectionIO ConnectionIO]]` which
717+
/** Apply the argument `a` to construct a program in [[doobie.free.connection.ConnectionIO ConnectionIO]] which
718718
* returns the server's query plan for the query, with a comparison to the actual execution (i.e., `EXPLAIN ANALYZE`
719719
* output). The query will be executed, but no results are returned.
720720
*/

0 commit comments

Comments
 (0)