Update patcher scaladocs links and omitted withFallback links

scalalandio · Jan 23, 2025 · 7725b67 · 7725b67
1 parent e8c7672
commit 7725b67
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 14 deletions.
diff --git a/chimney/src/main/scala-2/io/scalaland/chimney/dsl/PartialTransformerInto.scala b/chimney/src/main/scala-2/io/scalaland/chimney/dsl/PartialTransformerInto.scala
@@ -411,7 +411,8 @@ final class PartialTransformerInto[From, To, Overrides <: TransformerOverrides,
     * Fallbacks can be stacked - then they will be tried in the order in which they were added.
     *
     * @see
-    *   TODO
+    *   [[https://chimney.readthedocs.io/supported-transformations/#merging-multiple-input-sources-into-a-single-target-value]]
+    *   for more details
     *
     * @tparam FromFallback
     *   type of the fallback value which would be checked for fields when the `From` value would be missing
@@ -432,7 +433,8 @@ final class PartialTransformerInto[From, To, Overrides <: TransformerOverrides,
     * Fallbacks can be stacked - then they will be tried in the order in which they were added.
     *
     * @see
-    *   TODO
+    *   [[https://chimney.readthedocs.io/supported-transformations/#merging-multiple-input-sources-into-a-single-target-value]]
+    *   for more details
     *
     * @tparam T
     *   type of the source value that fallback is provided for

diff --git a/chimney/src/main/scala-2/io/scalaland/chimney/dsl/PatcherDefinition.scala b/chimney/src/main/scala-2/io/scalaland/chimney/dsl/PatcherDefinition.scala
@@ -35,7 +35,7 @@ final class PatcherDefinition[A, Patch, Overrides <: PatcherOverrides, Flags <:
     * By default, if `Patch` is missing a field, the original `A`'s field value is taken.
     *
     * @see
-    *   TODO
+    *   [[https://chimney.readthedocs.io/supported-patching/#updating-field-with-a-provided-value]] for more details
     *
     * @return
     *   [[io.scalaland.chimney.dsl.PatcherDefinition]]
@@ -52,7 +52,7 @@ final class PatcherDefinition[A, Patch, Overrides <: PatcherOverrides, Flags <:
     * By default, if `Patch` is missing a field, the original `A`'s field value is taken.
     *
     * @see
-    *   TODO
+    *   [[https://chimney.readthedocs.io/supported-patching/#updating-field-with-a-computed-value]] for more details
     *
     * @tparam T
     *   type of patched value field
@@ -79,7 +79,7 @@ final class PatcherDefinition[A, Patch, Overrides <: PatcherOverrides, Flags <:
     * By default, if `Patch` is missing a field, the original `A`'s field value is taken.
     *
     * @see
-    *   TODO
+    *   [[https://chimney.readthedocs.io/supported-patching/#updating-field-with-a-computed-value]] for more details
     *
     * @tparam S
     *   type of patch field

diff --git a/chimney/src/main/scala-2/io/scalaland/chimney/dsl/PatcherUsing.scala b/chimney/src/main/scala-2/io/scalaland/chimney/dsl/PatcherUsing.scala
@@ -37,7 +37,7 @@ final class PatcherUsing[A, Patch, Overrides <: PatcherOverrides, Flags <: Patch
     * By default, if `Patch` is missing a field, the original `A`'s field value is taken.
     *
     * @see
-    *   TODO
+    *   [[https://chimney.readthedocs.io/supported-patching/#updating-field-with-a-provided-value]] for more details
     *
     * @return
     *   [[io.scalaland.chimney.dsl.PatcherUsing]]
@@ -54,7 +54,7 @@ final class PatcherUsing[A, Patch, Overrides <: PatcherOverrides, Flags <: Patch
     * By default, if `Patch` is missing a field, the original `A`'s field value is taken.
     *
     * @see
-    *   TODO
+    *   [[https://chimney.readthedocs.io/supported-patching/#updating-field-with-a-computed-value]] for more details
     *
     * @tparam T
     *   type of patched value field
@@ -81,7 +81,7 @@ final class PatcherUsing[A, Patch, Overrides <: PatcherOverrides, Flags <: Patch
     * By default, if `Patch` is missing a field, the original `A`'s field value is taken.
     *
     * @see
-    *   TODO
+    *   [[https://chimney.readthedocs.io/supported-patching/#updating-field-with-a-computed-value]] for more details
     *
     * @tparam S
     *   type of patch field

diff --git a/chimney/src/main/scala-3/io/scalaland/chimney/dsl/PatcherDefinition.scala b/chimney/src/main/scala-3/io/scalaland/chimney/dsl/PatcherDefinition.scala
@@ -32,7 +32,7 @@ final class PatcherDefinition[A, Patch, Overrides <: PatcherOverrides, Flags <:
     * By default, if `Patch` is missing a field, the original `A`'s field value is taken.
     *
     * @see
-    *   TODO
+    *   [[https://chimney.readthedocs.io/supported-patching/#updating-field-with-a-provided-value]] for more details
     *
     * @return
     *   [[io.scalaland.chimney.dsl.PatcherUsing]]
@@ -49,7 +49,7 @@ final class PatcherDefinition[A, Patch, Overrides <: PatcherOverrides, Flags <:
     * By default, if `Patch` is missing a field, the original `A`'s field value is taken.
     *
     * @see
-    *   TODO
+    *   [[https://chimney.readthedocs.io/supported-patching/#updating-field-with-a-computed-value]] for more details
     *
     * @tparam T
     *   type of patched value field
@@ -76,7 +76,7 @@ final class PatcherDefinition[A, Patch, Overrides <: PatcherOverrides, Flags <:
     * By default, if `Patch` is missing a field, the original `A`'s field value is taken.
     *
     * @see
-    *   TODO
+    *   [[https://chimney.readthedocs.io/supported-patching/#updating-field-with-a-computed-value]] for more details
     *
     * @tparam S
     *   type of patch field

diff --git a/chimney/src/main/scala-3/io/scalaland/chimney/dsl/PatcherUsing.scala b/chimney/src/main/scala-3/io/scalaland/chimney/dsl/PatcherUsing.scala
@@ -36,7 +36,7 @@ final class PatcherUsing[A, Patch, Overrides <: PatcherOverrides, Flags <: Patch
     * By default, if `Patch` is missing a field, the original `A`'s field value is taken.
     *
     * @see
-    *   TODO
+    *   [[https://chimney.readthedocs.io/supported-patching/#updating-field-with-a-provided-value]] for more details
     *
     * @return
     *   [[io.scalaland.chimney.dsl.PatcherUsing]]
@@ -53,7 +53,7 @@ final class PatcherUsing[A, Patch, Overrides <: PatcherOverrides, Flags <: Patch
     * By default, if `Patch` is missing a field, the original `A`'s field value is taken.
     *
     * @see
-    *   TODO
+    *   [[https://chimney.readthedocs.io/supported-patching/#updating-field-with-a-computed-value]] for more details
     *
     * @tparam T
     *   type of patched value field
@@ -80,7 +80,7 @@ final class PatcherUsing[A, Patch, Overrides <: PatcherOverrides, Flags <: Patch
     * By default, if `Patch` is missing a field, the original `A`'s field value is taken.
     *
     * @see
-    *   TODO
+    *   [[https://chimney.readthedocs.io/supported-patching/#updating-field-with-a-computed-value]] for more details
     *
     * @tparam S
     *   type of patch field