doc: add api-docs and website documentation

scalalandio · Sep 29, 2024 · 25eabf2 · 25eabf2
1 parent 612e396
commit 25eabf2
Show file tree

Hide file tree

Showing 2 changed files with 197 additions and 148 deletions.
diff --git a/chimney/src/main/scala-3/io/scalaland/chimney/dsl/TransformerInto.scala b/chimney/src/main/scala-3/io/scalaland/chimney/dsl/TransformerInto.scala
@@ -211,6 +211,13 @@ final class TransformerInto[From, To, Overrides <: TransformerOverrides, Flags <
   )(using IsFunction.Of[Ctor, To]): TransformerInto[From, To, ? <: TransformerOverrides, Flags] =
     ${ TransformerIntoMacros.withConstructorImpl('this, 'f) }
 
+  /** Require that all fields of the source object except fields mentioned in `selectorFrom` are used in the
+    * transformation. and fail compilation otherwise.
+    *
+    * @param selectorFrom
+    *   exception fields that are not required to be used in the transformation
+    * @return
+    */
   transparent inline def requireSourceFieldsUsedExcept(
       inline selectorFrom: From => Any*
   ): TransformerInto[From, To, ? <: TransformerOverrides, Flags] =